@azure/arm-webpubsub package

Classes

WebPubSubManagementClient

Interfaces

ApplicationFirewallSettings	Application firewall settings for the resource
ClientConnectionCountRule	A base class for client connection count rules
ClientTrafficControlRule	A base class for client traffic control rules
CustomCertificate	A custom certificate.
CustomCertificateProperties	Custom certificate properties.
CustomDomain	A custom domain
CustomDomainProperties	Properties of a custom domain.
Dimension	Specifications of the Dimension of metrics.
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Common error response for all Azure Resource Manager APIs to return error details for failed operations.
EventHandler	Properties of event handler.
EventHubEndpoint	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.
EventListener	A setting defines which kinds of events should be sent to which endpoint.
EventListenerEndpoint	An endpoint specifying where Web PubSub should send events to.
EventListenerFilter	A base class for event filter which determines whether an event should be sent to an event listener.
EventNameFilter	Filter events by their name.
GroupPresenceEventFilters	Represents presence event filters for event handler configuration.
IPRule	An IP rule
LiveTraceCategory	Live trace category configuration of a Microsoft.SignalRService resource.
LiveTraceConfiguration	Live trace configuration of a Microsoft.SignalRService resource.
LogSpecification	Specifications of the Logs for Azure Monitoring.
ManagedIdentity	A class represent managed identities used for request and response
ManagedIdentitySettings	Managed identity settings for upstream.
MetricSpecification	Specifications of the Metrics for Azure Monitoring.
NameAvailability	Result of the request to check name availability. It contains a flag and possible reason of failure.
NameAvailabilityParameters	Data POST-ed to the nameAvailability action
NetworkACL	Network ACL
Operation	REST API operation supported by resource provider.
OperationDisplay	The object that describes a operation.
OperationProperties	Extra Operation properties.
OperationsListOptionalParams	Optional parameters.
OperationsOperations	Interface representing a Operations operations.
PageSettings	Options for the byPage method
PagedAsyncIterableIterator	An interface that allows async iterable iteration both to completion and by page.
PrivateEndpoint	Private endpoint
PrivateEndpointACL	ACL for a private endpoint
PrivateEndpointConnection	A private endpoint connection to an azure resource
PrivateEndpointConnectionProperties	Private endpoint connection properties
PrivateLinkResource	Private link resource
PrivateLinkResourceProperties	Private link resource properties
PrivateLinkServiceConnectionState	Connection state of the private endpoint connection
ProxyResource	The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location
RegenerateKeyParameters	Parameters describes the request to regenerate access keys
Replica	A class represent a replica resource.
ReplicaProperties	model interface ReplicaProperties
Resource	Common fields that are returned in the response for all Azure Resource Manager resources
ResourceLogCategory	Resource log category configuration of a Microsoft.SignalRService resource.
ResourceLogConfiguration	Resource log configuration of a Microsoft.SignalRService resource.
ResourceReference	Reference to a resource.
ResourceSku	The billing information of the resource.
RestorePollerOptions
ServiceSpecification	An object that describes a specification.
ShareablePrivateLinkResourceProperties	Describes the properties of a resource type that has been onboarded to private link service
ShareablePrivateLinkResourceType	Describes a resource type that has been onboarded to private link service
SharedPrivateLinkResource	Describes a Shared Private Link Resource
SharedPrivateLinkResourceProperties	Describes the properties of an existing Shared Private Link Resource
SignalRServiceUsage	Object that describes a specific usage of the resources.
SignalRServiceUsageName	Localizable String object containing the name and a localized value.
SimplePollerLike	A simple poller that can be used to poll a long running operation.
Sku	Describes an available sku."
SkuCapacity	Describes scaling information of a sku.
SkuList	The list skus operation response
SystemData	Metadata pertaining to creation and last modification of the resource.
ThrottleByJwtCustomClaimRule	Throttle the client connection by a custom JWT claim
ThrottleByJwtSignatureRule	Throttle the client connection by the JWT signature
ThrottleByUserIdRule	Throttle the client connection by the user ID
TrackedResource	The resource model definition for an Azure Resource Manager tracked top level resource which has 'tags' and a 'location'
TrafficThrottleByJwtCustomClaimRule	Throttle the client traffic by a custom JWT claim
TrafficThrottleByJwtSignatureRule	Throttle the client traffic by the JWT signature
TrafficThrottleByUserIdRule	Throttle the client traffic by the user ID
UpstreamAuthSettings	Upstream auth settings. If not set, no auth is used for upstream messages.
UsagesListOptionalParams	Optional parameters.
UsagesOperations	Interface representing a Usages operations.
UserAssignedIdentityProperty	Properties of user assigned identity.
WebPubSubCheckNameAvailabilityOptionalParams	Optional parameters.
WebPubSubCreateOrUpdateOptionalParams	Optional parameters.
WebPubSubCustomCertificatesCreateOrUpdateOptionalParams	Optional parameters.
WebPubSubCustomCertificatesDeleteOptionalParams	Optional parameters.
WebPubSubCustomCertificatesGetOptionalParams	Optional parameters.
WebPubSubCustomCertificatesListOptionalParams	Optional parameters.
WebPubSubCustomCertificatesOperations	Interface representing a WebPubSubCustomCertificates operations.
WebPubSubCustomDomainsCreateOrUpdateOptionalParams	Optional parameters.
WebPubSubCustomDomainsDeleteOptionalParams	Optional parameters.
WebPubSubCustomDomainsGetOptionalParams	Optional parameters.
WebPubSubCustomDomainsListOptionalParams	Optional parameters.
WebPubSubCustomDomainsOperations	Interface representing a WebPubSubCustomDomains operations.
WebPubSubDeleteOptionalParams	Optional parameters.
WebPubSubGetOptionalParams	Optional parameters.
WebPubSubHub	A hub setting
WebPubSubHubProperties	Properties of a hub.
WebPubSubHubsCreateOrUpdateOptionalParams	Optional parameters.
WebPubSubHubsDeleteOptionalParams	Optional parameters.
WebPubSubHubsGetOptionalParams	Optional parameters.
WebPubSubHubsListOptionalParams	Optional parameters.
WebPubSubHubsOperations	Interface representing a WebPubSubHubs operations.
WebPubSubKeys	A class represents the access keys of the resource.
WebPubSubListByResourceGroupOptionalParams	Optional parameters.
WebPubSubListBySubscriptionOptionalParams	Optional parameters.
WebPubSubListKeysOptionalParams	Optional parameters.
WebPubSubListReplicaSkusOptionalParams	Optional parameters.
WebPubSubListSkusOptionalParams	Optional parameters.
WebPubSubManagementClientOptionalParams	Optional parameters for the client.
WebPubSubNetworkACLs	Network ACLs for the resource
WebPubSubOperations	Interface representing a WebPubSub operations.
WebPubSubPrivateEndpointConnectionsDeleteOptionalParams	Optional parameters.
WebPubSubPrivateEndpointConnectionsGetOptionalParams	Optional parameters.
WebPubSubPrivateEndpointConnectionsListOptionalParams	Optional parameters.
WebPubSubPrivateEndpointConnectionsOperations	Interface representing a WebPubSubPrivateEndpointConnections operations.
WebPubSubPrivateEndpointConnectionsUpdateOptionalParams	Optional parameters.
WebPubSubPrivateLinkResourcesListOptionalParams	Optional parameters.
WebPubSubPrivateLinkResourcesOperations	Interface representing a WebPubSubPrivateLinkResources operations.
WebPubSubProperties	A class that describes the properties of the resource
WebPubSubRegenerateKeyOptionalParams	Optional parameters.
WebPubSubReplicaSharedPrivateLinkResourcesCreateOrUpdateOptionalParams	Optional parameters.
WebPubSubReplicaSharedPrivateLinkResourcesGetOptionalParams	Optional parameters.
WebPubSubReplicaSharedPrivateLinkResourcesListOptionalParams	Optional parameters.
WebPubSubReplicaSharedPrivateLinkResourcesOperations	Interface representing a WebPubSubReplicaSharedPrivateLinkResources operations.
WebPubSubReplicasCreateOrUpdateOptionalParams	Optional parameters.
WebPubSubReplicasDeleteOptionalParams	Optional parameters.
WebPubSubReplicasGetOptionalParams	Optional parameters.
WebPubSubReplicasListOptionalParams	Optional parameters.
WebPubSubReplicasOperations	Interface representing a WebPubSubReplicas operations.
WebPubSubReplicasRestartOptionalParams	Optional parameters.
WebPubSubReplicasUpdateOptionalParams	Optional parameters.
WebPubSubResource	A class represent a resource.
WebPubSubRestartOptionalParams	Optional parameters.
WebPubSubSharedPrivateLinkResourcesCreateOrUpdateOptionalParams	Optional parameters.
WebPubSubSharedPrivateLinkResourcesDeleteOptionalParams	Optional parameters.
WebPubSubSharedPrivateLinkResourcesGetOptionalParams	Optional parameters.
WebPubSubSharedPrivateLinkResourcesListOptionalParams	Optional parameters.
WebPubSubSharedPrivateLinkResourcesOperations	Interface representing a WebPubSubSharedPrivateLinkResources operations.
WebPubSubSocketIOSettings	SocketIO settings for the resource
WebPubSubTlsSettings	TLS settings for the resource
WebPubSubUpdateOptionalParams	Optional parameters.

Type Aliases

ACLAction	Azure Networking ACL Action. KnownACLAction can be used interchangeably with ACLAction, this enum contains the known values that the service supports. Known values supported by the service Allow Deny
AzureSupportedClouds	The supported values for cloud setting as a string literal type
ClientConnectionCountRuleDiscriminator	Type of ClientConnectionCountRuleDiscriminator
ClientConnectionCountRuleUnion	Alias for ClientConnectionCountRuleUnion
ClientTrafficControlRuleDiscriminator	Type of ClientTrafficControlRuleDiscriminator
ClientTrafficControlRuleUnion	Alias for ClientTrafficControlRuleUnion
ContinuablePage	An interface that describes a page of results.
CreatedByType	The kind of entity that created the resource. KnownCreatedByType can be used interchangeably with CreatedByType, this enum contains the known values that the service supports. Known values supported by the service User: The entity was created by a user. Application: The entity was created by an application. ManagedIdentity: The entity was created by a managed identity. Key: The entity was created by a key.
EventListenerEndpointDiscriminator	Type of EventListenerEndpointDiscriminator
EventListenerEndpointUnion	Alias for EventListenerEndpointUnion
EventListenerFilterDiscriminator	Type of EventListenerFilterDiscriminator
EventListenerFilterUnion	Alias for EventListenerFilterUnion
GroupPresenceEventName	Allowed event names for group presence events. KnownGroupPresenceEventName can be used interchangeably with GroupPresenceEventName, this enum contains the known values that the service supports. Known values supported by the service joined: Event triggered when a connection joins a group. left: Event triggered when a connection leaves a group.
KeyType	The type of access key. KnownKeyType can be used interchangeably with KeyType, this enum contains the known values that the service supports. Known values supported by the service Primary Secondary Salt
ManagedIdentityType	Represents the identity type: systemAssigned, userAssigned, None KnownManagedIdentityType can be used interchangeably with ManagedIdentityType, this enum contains the known values that the service supports. Known values supported by the service None SystemAssigned UserAssigned
PrivateLinkServiceConnectionStatus	Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. KnownPrivateLinkServiceConnectionStatus can be used interchangeably with PrivateLinkServiceConnectionStatus, this enum contains the known values that the service supports. Known values supported by the service Pending Approved Rejected Disconnected
ProvisioningState	Provisioning state of the resource. KnownProvisioningState can be used interchangeably with ProvisioningState, this enum contains the known values that the service supports. Known values supported by the service Unknown: Unknown provisioning state Succeeded: Resource successfully provisioned Failed: Resource provisioning failed Canceled: Resource provisioning was canceled Running: Resource provisioning is running Creating: Resource is being created Updating: Resource is being updated Deleting: Resource is being deleted Moving
ScaleType	The scale type applicable to the sku. KnownScaleType can be used interchangeably with ScaleType, this enum contains the known values that the service supports. Known values supported by the service None Manual Automatic
ServiceKind	The kind of the service KnownServiceKind can be used interchangeably with ServiceKind, this enum contains the known values that the service supports. Known values supported by the service WebPubSub SocketIO
SharedPrivateLinkResourceStatus	Status of the shared private link resource KnownSharedPrivateLinkResourceStatus can be used interchangeably with SharedPrivateLinkResourceStatus, this enum contains the known values that the service supports. Known values supported by the service Pending Approved Rejected Disconnected Timeout
UpstreamAuthType	Upstream auth type enum. KnownUpstreamAuthType can be used interchangeably with UpstreamAuthType, this enum contains the known values that the service supports. Known values supported by the service None ManagedIdentity
WebPubSubRequestType	The incoming request type to the service KnownWebPubSubRequestType can be used interchangeably with WebPubSubRequestType, this enum contains the known values that the service supports. Known values supported by the service ClientConnection ServerConnection RESTAPI Trace
WebPubSubSkuTier	Optional tier of this particular SKU. 'Standard' or 'Free'. Basic is deprecated, use Standard instead. KnownWebPubSubSkuTier can be used interchangeably with WebPubSubSkuTier, this enum contains the known values that the service supports. Known values supported by the service Free: Free tier for WebPubSub service Basic: Basic tier for WebPubSub service (deprecated, use Standard instead) Standard: Standard tier for WebPubSub service Premium: Premium tier for WebPubSub service

Enums

AzureClouds	An enum to describe Azure Cloud environments.
KnownACLAction	Azure Networking ACL Action.
KnownClientConnectionCountRuleDiscriminator	Known values of ClientConnectionCountRuleDiscriminator that the service accepts.
KnownClientTrafficControlRuleDiscriminator	Known values of ClientTrafficControlRuleDiscriminator that the service accepts.
KnownCreatedByType	The kind of entity that created the resource.
KnownEventListenerEndpointDiscriminator	Known values of EventListenerEndpointDiscriminator that the service accepts.
KnownEventListenerFilterDiscriminator	Known values of EventListenerFilterDiscriminator that the service accepts.
KnownGroupPresenceEventName	Allowed event names for group presence events.
KnownKeyType	The type of access key.
KnownManagedIdentityType	Represents the identity type: systemAssigned, userAssigned, None
KnownPrivateLinkServiceConnectionStatus	Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.
KnownProvisioningState	Provisioning state of the resource.
KnownScaleType	The scale type applicable to the sku.
KnownServiceKind	The kind of the service
KnownSharedPrivateLinkResourceStatus	Status of the shared private link resource
KnownUpstreamAuthType	Upstream auth type enum.
KnownVersions	The available API versions.
KnownWebPubSubRequestType	The incoming request type to the service
KnownWebPubSubSkuTier	Optional tier of this particular SKU. 'Standard' or 'Free'. Basic is deprecated, use Standard instead.

Functions

isRestError(unknown)	Typeguard for RestError
restorePoller<TResponse, TResult>(WebPubSubManagementClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)	Creates a poller from the serialized state of another poller. This can be useful when you want to create pollers on a different host or a poller needs to be constructed after the original one is not in scope.

Variables

RestError

A custom error type for failed pipeline requests.

Function Details

isRestError(unknown)

Typeguard for RestError

function isRestError(e: unknown): e is RestError

Parameters

e

unknown

Something caught by a catch clause.

Returns

e is RestError

restorePoller<TResponse, TResult>(WebPubSubManagementClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)

Creates a poller from the serialized state of another poller. This can be useful when you want to create pollers on a different host or a poller needs to be constructed after the original one is not in scope.

function restorePoller<TResponse, TResult>(client: WebPubSubManagementClient, serializedState: string, sourceOperation: (args: any[]) => PollerLike<OperationState<TResult>, TResult>, options?: RestorePollerOptions<TResult, PathUncheckedResponse>): PollerLike<OperationState<TResult>, TResult>

Parameters

client

WebPubSubManagementClient

serializedState

string

sourceOperation

(args: any[]) => PollerLike<OperationState<TResult>, TResult>

options

RestorePollerOptions<TResult, PathUncheckedResponse>

Returns

PollerLike<OperationState<TResult>, TResult>

Variable Details

RestError

A custom error type for failed pipeline requests.

RestError: RestErrorConstructor

Type

RestErrorConstructor