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

The settings for event handler in webpubsub service

Link copied to clipboard
data class EventHandlerTemplateResponse(val auth: UpstreamAuthSettingsResponse? = null, val systemEventPattern: String? = null, val urlTemplate: String, val userEventPattern: String? = null)

EventHandler template item settings.

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 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 GetWebPubSubResult(val eventHandler: EventHandlerSettingsResponse? = null, val externalIP: String, val features: List<WebPubSubFeatureResponse>? = null, val hostName: String, val id: String, val identity: ManagedIdentityResponse? = 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 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 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 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 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 WebPubSubFeatureResponse(val flag: String, val properties: Map<String, String>? = null, val value: String)

Feature of a resource, which controls the runtime behavior.

Link copied to clipboard
data class WebPubSubHubPropertiesResponse(val anonymousConnectPolicy: String? = null, val eventHandlers: List<EventHandlerResponse>? = 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