@azure/arm-webpubsub package

Classes

WebPubSubManagementClient

Interfaces

CustomCertificate	A custom certificate.
CustomCertificateList	Custom certificates list.
CustomDomain	A custom domain
CustomDomainList	Custom domains list
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. (This also follows the OData error response format.).
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.
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.
OperationList	Result of the request to list REST API operations. It contains a list of operations.
OperationProperties	Extra Operation properties.
Operations	Interface representing a Operations.
OperationsListNextOptionalParams	Optional parameters.
OperationsListOptionalParams	Optional parameters.
PrivateEndpoint	Private endpoint
PrivateEndpointACL	ACL for a private endpoint
PrivateEndpointConnection	A private endpoint connection to an azure resource
PrivateEndpointConnectionList	A list of private endpoint connections
PrivateLinkResource	Private link resource
PrivateLinkResourceList	Contains a list of PrivateLinkResource and a possible link to query more results
PrivateLinkServiceConnectionState	Connection state of the private endpoint connection
ProxyResource	The resource model definition for a ARM proxy resource. It will have everything other than required location and tags
RegenerateKeyParameters	Parameters describes the request to regenerate access keys
Resource	The core properties of ARM 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.
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
SharedPrivateLinkResourceList	A list of shared private link resources
SignalRServiceUsage	Object that describes a specific usage of the resources.
SignalRServiceUsageList	Object that includes an array of the resource usages and a possible link for next set.
SignalRServiceUsageName	Localizable String object containing the name and a localized value.
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.
TrackedResource	The resource model definition for a ARM tracked top level resource.
UpstreamAuthSettings	Upstream auth settings. If not set, no auth is used for upstream messages.
Usages	Interface representing a Usages.
UsagesListNextOptionalParams	Optional parameters.
UsagesListOptionalParams	Optional parameters.
UserAssignedIdentityProperty	Properties of user assigned identity.
WebPubSub	Interface representing a WebPubSub.
WebPubSubCheckNameAvailabilityOptionalParams	Optional parameters.
WebPubSubCreateOrUpdateOptionalParams	Optional parameters.
WebPubSubCustomCertificates	Interface representing a WebPubSubCustomCertificates.
WebPubSubCustomCertificatesCreateOrUpdateOptionalParams	Optional parameters.
WebPubSubCustomCertificatesDeleteOptionalParams	Optional parameters.
WebPubSubCustomCertificatesGetOptionalParams	Optional parameters.
WebPubSubCustomCertificatesListNextOptionalParams	Optional parameters.
WebPubSubCustomCertificatesListOptionalParams	Optional parameters.
WebPubSubCustomDomains	Interface representing a WebPubSubCustomDomains.
WebPubSubCustomDomainsCreateOrUpdateOptionalParams	Optional parameters.
WebPubSubCustomDomainsDeleteOptionalParams	Optional parameters.
WebPubSubCustomDomainsGetOptionalParams	Optional parameters.
WebPubSubCustomDomainsListNextOptionalParams	Optional parameters.
WebPubSubCustomDomainsListOptionalParams	Optional parameters.
WebPubSubDeleteOptionalParams	Optional parameters.
WebPubSubGetOptionalParams	Optional parameters.
WebPubSubHub	A hub setting
WebPubSubHubList	Hub setting list
WebPubSubHubProperties	Properties of a hub.
WebPubSubHubs	Interface representing a WebPubSubHubs.
WebPubSubHubsCreateOrUpdateOptionalParams	Optional parameters.
WebPubSubHubsDeleteOptionalParams	Optional parameters.
WebPubSubHubsGetOptionalParams	Optional parameters.
WebPubSubHubsListNextOptionalParams	Optional parameters.
WebPubSubHubsListOptionalParams	Optional parameters.
WebPubSubKeys	A class represents the access keys of the resource.
WebPubSubListByResourceGroupNextOptionalParams	Optional parameters.
WebPubSubListByResourceGroupOptionalParams	Optional parameters.
WebPubSubListBySubscriptionNextOptionalParams	Optional parameters.
WebPubSubListBySubscriptionOptionalParams	Optional parameters.
WebPubSubListKeysOptionalParams	Optional parameters.
WebPubSubListSkusOptionalParams	Optional parameters.
WebPubSubManagementClientOptionalParams	Optional parameters.
WebPubSubNetworkACLs	Network ACLs for the resource
WebPubSubPrivateEndpointConnections	Interface representing a WebPubSubPrivateEndpointConnections.
WebPubSubPrivateEndpointConnectionsDeleteOptionalParams	Optional parameters.
WebPubSubPrivateEndpointConnectionsGetOptionalParams	Optional parameters.
WebPubSubPrivateEndpointConnectionsListNextOptionalParams	Optional parameters.
WebPubSubPrivateEndpointConnectionsListOptionalParams	Optional parameters.
WebPubSubPrivateEndpointConnectionsUpdateOptionalParams	Optional parameters.
WebPubSubPrivateLinkResources	Interface representing a WebPubSubPrivateLinkResources.
WebPubSubPrivateLinkResourcesListNextOptionalParams	Optional parameters.
WebPubSubPrivateLinkResourcesListOptionalParams	Optional parameters.
WebPubSubRegenerateKeyOptionalParams	Optional parameters.
WebPubSubResource	A class represent a resource.
WebPubSubResourceList	Object that includes an array of resources and a possible link for next set.
WebPubSubRestartOptionalParams	Optional parameters.
WebPubSubSharedPrivateLinkResources	Interface representing a WebPubSubSharedPrivateLinkResources.
WebPubSubSharedPrivateLinkResourcesCreateOrUpdateOptionalParams	Optional parameters.
WebPubSubSharedPrivateLinkResourcesDeleteOptionalParams	Optional parameters.
WebPubSubSharedPrivateLinkResourcesGetOptionalParams	Optional parameters.
WebPubSubSharedPrivateLinkResourcesListNextOptionalParams	Optional parameters.
WebPubSubSharedPrivateLinkResourcesListOptionalParams	Optional parameters.
WebPubSubTlsSettings	TLS settings for the resource
WebPubSubUpdateOptionalParams	Optional parameters.

Type Aliases

ACLAction	Defines values for ACLAction. 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
CreatedByType	Defines values for CreatedByType. KnownCreatedByType can be used interchangeably with CreatedByType, this enum contains the known values that the service supports. Known values supported by the service User Application ManagedIdentity Key
EventListenerEndpointDiscriminator	Defines values for EventListenerEndpointDiscriminator. KnownEventListenerEndpointDiscriminator can be used interchangeably with EventListenerEndpointDiscriminator, this enum contains the known values that the service supports. Known values supported by the service EventHub
EventListenerEndpointUnion
EventListenerFilterDiscriminator	Defines values for EventListenerFilterDiscriminator. KnownEventListenerFilterDiscriminator can be used interchangeably with EventListenerFilterDiscriminator, this enum contains the known values that the service supports. Known values supported by the service EventName
EventListenerFilterUnion
KeyType	Defines values for KeyType. 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	Defines values for ManagedIdentityType. 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
OperationsListNextResponse	Contains response data for the listNext operation.
OperationsListResponse	Contains response data for the list operation.
PrivateLinkServiceConnectionStatus	Defines values for PrivateLinkServiceConnectionStatus. 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	Defines values for ProvisioningState. KnownProvisioningState can be used interchangeably with ProvisioningState, this enum contains the known values that the service supports. Known values supported by the service Unknown Succeeded Failed Canceled Running Creating Updating Deleting Moving
ScaleType	Defines values for ScaleType. 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
SharedPrivateLinkResourceStatus	Defines values for SharedPrivateLinkResourceStatus. 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	Defines values for UpstreamAuthType. 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
UsagesListNextResponse	Contains response data for the listNext operation.
UsagesListResponse	Contains response data for the list operation.
WebPubSubCheckNameAvailabilityResponse	Contains response data for the checkNameAvailability operation.
WebPubSubCreateOrUpdateResponse	Contains response data for the createOrUpdate operation.
WebPubSubCustomCertificatesCreateOrUpdateResponse	Contains response data for the createOrUpdate operation.
WebPubSubCustomCertificatesGetResponse	Contains response data for the get operation.
WebPubSubCustomCertificatesListNextResponse	Contains response data for the listNext operation.
WebPubSubCustomCertificatesListResponse	Contains response data for the list operation.
WebPubSubCustomDomainsCreateOrUpdateResponse	Contains response data for the createOrUpdate operation.
WebPubSubCustomDomainsGetResponse	Contains response data for the get operation.
WebPubSubCustomDomainsListNextResponse	Contains response data for the listNext operation.
WebPubSubCustomDomainsListResponse	Contains response data for the list operation.
WebPubSubGetResponse	Contains response data for the get operation.
WebPubSubHubsCreateOrUpdateResponse	Contains response data for the createOrUpdate operation.
WebPubSubHubsGetResponse	Contains response data for the get operation.
WebPubSubHubsListNextResponse	Contains response data for the listNext operation.
WebPubSubHubsListResponse	Contains response data for the list operation.
WebPubSubListByResourceGroupNextResponse	Contains response data for the listByResourceGroupNext operation.
WebPubSubListByResourceGroupResponse	Contains response data for the listByResourceGroup operation.
WebPubSubListBySubscriptionNextResponse	Contains response data for the listBySubscriptionNext operation.
WebPubSubListBySubscriptionResponse	Contains response data for the listBySubscription operation.
WebPubSubListKeysResponse	Contains response data for the listKeys operation.
WebPubSubListSkusResponse	Contains response data for the listSkus operation.
WebPubSubPrivateEndpointConnectionsGetResponse	Contains response data for the get operation.
WebPubSubPrivateEndpointConnectionsListNextResponse	Contains response data for the listNext operation.
WebPubSubPrivateEndpointConnectionsListResponse	Contains response data for the list operation.
WebPubSubPrivateEndpointConnectionsUpdateResponse	Contains response data for the update operation.
WebPubSubPrivateLinkResourcesListNextResponse	Contains response data for the listNext operation.
WebPubSubPrivateLinkResourcesListResponse	Contains response data for the list operation.
WebPubSubRegenerateKeyResponse	Contains response data for the regenerateKey operation.
WebPubSubRequestType	Defines values for WebPubSubRequestType. 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
WebPubSubSharedPrivateLinkResourcesCreateOrUpdateResponse	Contains response data for the createOrUpdate operation.
WebPubSubSharedPrivateLinkResourcesGetResponse	Contains response data for the get operation.
WebPubSubSharedPrivateLinkResourcesListNextResponse	Contains response data for the listNext operation.
WebPubSubSharedPrivateLinkResourcesListResponse	Contains response data for the list operation.
WebPubSubSkuTier	Defines values for WebPubSubSkuTier. KnownWebPubSubSkuTier can be used interchangeably with WebPubSubSkuTier, this enum contains the known values that the service supports. Known values supported by the service Free Basic Standard Premium
WebPubSubUpdateResponse	Contains response data for the update operation.

Enums

KnownACLAction	Known values of ACLAction that the service accepts.
KnownCreatedByType	Known values of CreatedByType that the service accepts.
KnownEventListenerEndpointDiscriminator	Known values of EventListenerEndpointDiscriminator that the service accepts.
KnownEventListenerFilterDiscriminator	Known values of EventListenerFilterDiscriminator that the service accepts.
KnownKeyType	Known values of KeyType that the service accepts.
KnownManagedIdentityType	Known values of ManagedIdentityType that the service accepts.
KnownPrivateLinkServiceConnectionStatus	Known values of PrivateLinkServiceConnectionStatus that the service accepts.
KnownProvisioningState	Known values of ProvisioningState that the service accepts.
KnownScaleType	Known values of ScaleType that the service accepts.
KnownSharedPrivateLinkResourceStatus	Known values of SharedPrivateLinkResourceStatus that the service accepts.
KnownUpstreamAuthType	Known values of UpstreamAuthType that the service accepts.
KnownWebPubSubRequestType	Known values of WebPubSubRequestType that the service accepts.
KnownWebPubSubSkuTier	Known values of WebPubSubSkuTier that the service accepts.

Functions

getContinuationToken(unknown)

Given the last .value produced by the byPage iterator, returns a continuation token that can be used to begin paging from that point later.

Function Details

getContinuationToken(unknown)

Given the last .value produced by the byPage iterator, returns a continuation token that can be used to begin paging from that point later.

function getContinuationToken(page: unknown): string | undefined

Parameters

page

unknown

An object from accessing value on the IteratorResult from a byPage iterator.

Returns

string | undefined

The continuation token that can be passed into byPage() during future calls.