Package-level declarations

Types

Link copied to clipboard
data class EventHandlerResponse(val auth: UpstreamAuthSettingsResponse? = null, val systemEvents: List<String>? = null, val urlTemplate: String, val userEventPattern: String? = null)

Properties of event handler.

Link copied to clipboard
data class EventHubEndpointResponse(val eventHubName: String, val fullyQualifiedNamespace: String, val type: String)

An Event Hub endpoint. The managed identity of Web PubSub service must be enabled, and the identity should have the "Azure Event Hubs Data sender" role to access Event Hub.

Link copied to clipboard

A setting defines which kinds of events should be sent to which endpoint.

Link copied to clipboard
data class EventNameFilterResponse(val systemEvents: List<String>? = null, val type: String, val userEventPattern: String? = null)

Filter events by their name.

Link copied to clipboard
data class GetWebPubSubCustomCertificateResult(val id: String, val keyVaultBaseUri: String, val keyVaultSecretName: String, val keyVaultSecretVersion: String? = null, val name: String, val provisioningState: String, val systemData: SystemDataResponse, val type: String)

A custom certificate.

Link copied to clipboard
data class GetWebPubSubCustomDomainResult(val customCertificate: ResourceReferenceResponse, val domainName: String, val id: String, val name: String, val provisioningState: String, val systemData: SystemDataResponse, val type: String)

A custom domain

Link copied to clipboard
data class GetWebPubSubHubResult(val id: String, val name: String, val properties: WebPubSubHubPropertiesResponse, val systemData: SystemDataResponse, val type: String)

A hub setting

data class GetWebPubSubPrivateEndpointConnectionResult(val groupIds: List<String>, val id: String, val name: String, val privateEndpoint: PrivateEndpointResponse? = null, val privateLinkServiceConnectionState: PrivateLinkServiceConnectionStateResponse? = null, val provisioningState: String, val systemData: SystemDataResponse, val type: String)

A private endpoint connection to an azure resource

Link copied to clipboard
data class GetWebPubSubReplicaResult(val id: String, val location: String, val name: String, val provisioningState: String, val sku: ResourceSkuResponse? = null, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val type: String)

A class represent a replica resource.

Link copied to clipboard
data class GetWebPubSubResult(val disableAadAuth: Boolean? = null, val disableLocalAuth: Boolean? = null, val externalIP: String, val hostName: String, val hostNamePrefix: String, val id: String, val identity: ManagedIdentityResponse? = null, val liveTraceConfiguration: LiveTraceConfigurationResponse? = null, val location: String? = null, val name: String, val networkACLs: WebPubSubNetworkACLsResponse? = null, val privateEndpointConnections: List<PrivateEndpointConnectionResponse>, val provisioningState: String, val publicNetworkAccess: String? = null, val publicPort: Int, val resourceLogConfiguration: ResourceLogConfigurationResponse? = null, val serverPort: Int, val sharedPrivateLinkResources: List<SharedPrivateLinkResourceResponse>, val sku: ResourceSkuResponse? = null, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val tls: WebPubSubTlsSettingsResponse? = null, val type: String, val version: String)

A class represent a resource.

data class GetWebPubSubSharedPrivateLinkResourceResult(val groupId: String, val id: String, val name: String, val privateLinkResourceId: String, val provisioningState: String, val requestMessage: String? = null, val status: String, val systemData: SystemDataResponse, val type: String)

Describes a Shared Private Link Resource

Link copied to clipboard
data class ListWebPubSubKeysResult(val primaryConnectionString: String? = null, val primaryKey: String? = null, val secondaryConnectionString: String? = null, val secondaryKey: String? = null)

A class represents the access keys of the resource.

Link copied to clipboard
data class LiveTraceCategoryResponse(val enabled: String? = null, val name: String? = null)

Live trace category configuration of a Microsoft.SignalRService resource.

Link copied to clipboard
data class LiveTraceConfigurationResponse(val categories: List<LiveTraceCategoryResponse>? = null, val enabled: String? = null)

Live trace configuration of a Microsoft.SignalRService resource.

Link copied to clipboard
data class ManagedIdentityResponse(val principalId: String, val tenantId: String, val type: String? = null, val userAssignedIdentities: Map<String, UserAssignedIdentityPropertyResponse>? = null)

A class represent managed identities used for request and response

Link copied to clipboard
data class ManagedIdentitySettingsResponse(val resource: String? = null)

Managed identity settings for upstream.

Link copied to clipboard
data class NetworkACLResponse(val allow: List<String>? = null, val deny: List<String>? = null)

Network ACL

Link copied to clipboard
data class PrivateEndpointACLResponse(val allow: List<String>? = null, val deny: List<String>? = null, val name: String)

ACL for a private endpoint

Link copied to clipboard
data class PrivateEndpointConnectionResponse(val groupIds: List<String>, val id: String, val name: String, val privateEndpoint: PrivateEndpointResponse? = null, val privateLinkServiceConnectionState: PrivateLinkServiceConnectionStateResponse? = null, val provisioningState: String, val systemData: SystemDataResponse, val type: String)

A private endpoint connection to an azure resource

Link copied to clipboard
data class PrivateEndpointResponse(val id: String? = null)

Private endpoint

data class PrivateLinkServiceConnectionStateResponse(val actionsRequired: String? = null, val description: String? = null, val status: String? = null)

Connection state of the private endpoint connection

Link copied to clipboard
data class ResourceLogCategoryResponse(val enabled: String? = null, val name: String? = null)

Resource log category configuration of a Microsoft.SignalRService resource.

Link copied to clipboard

Resource log configuration of a Microsoft.SignalRService resource.

Link copied to clipboard
data class ResourceReferenceResponse(val id: String? = null)

Reference to a resource.

Link copied to clipboard
data class ResourceSkuResponse(val capacity: Int? = null, val family: String, val name: String, val size: String, val tier: String? = null)

The billing information of the resource.

Link copied to clipboard
data class SharedPrivateLinkResourceResponse(val groupId: String, val id: String, val name: String, val privateLinkResourceId: String, val provisioningState: String, val requestMessage: String? = null, val status: String, val systemData: SystemDataResponse, val type: String)

Describes a Shared Private Link Resource

Link copied to clipboard
data class SystemDataResponse(val createdAt: String? = null, val createdBy: String? = null, val createdByType: String? = null, val lastModifiedAt: String? = null, val lastModifiedBy: String? = null, val lastModifiedByType: String? = null)

Metadata pertaining to creation and last modification of the resource.

Link copied to clipboard
data class UpstreamAuthSettingsResponse(val managedIdentity: ManagedIdentitySettingsResponse? = null, val type: String? = null)

Upstream auth settings. If not set, no auth is used for upstream messages.

Link copied to clipboard
data class UserAssignedIdentityPropertyResponse(val clientId: String, val principalId: String)

Properties of user assigned identity.

Link copied to clipboard
data class WebPubSubHubPropertiesResponse(val anonymousConnectPolicy: String? = null, val eventHandlers: List<EventHandlerResponse>? = null, val eventListeners: List<EventListenerResponse>? = null)

Properties of a hub.

Link copied to clipboard
data class WebPubSubNetworkACLsResponse(val defaultAction: String? = null, val privateEndpoints: List<PrivateEndpointACLResponse>? = null, val publicNetwork: NetworkACLResponse? = null)

Network ACLs for the resource

Link copied to clipboard
data class WebPubSubTlsSettingsResponse(val clientCertEnabled: Boolean? = null)

TLS settings for the resource