@azure/arm-signalr package

Classes

SignalRManagementClient

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.).
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.
ServerlessSettings	Serverless settings.
ServerlessUpstreamSettings	The settings for the Upstream when the service is in server-less mode.
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
SignalR	Interface representing a SignalR.
SignalRCheckNameAvailabilityOptionalParams	Optional parameters.
SignalRCorsSettings	Cross-Origin Resource Sharing (CORS) settings.
SignalRCreateOrUpdateOptionalParams	Optional parameters.
SignalRCustomCertificates	Interface representing a SignalRCustomCertificates.
SignalRCustomCertificatesCreateOrUpdateOptionalParams	Optional parameters.
SignalRCustomCertificatesDeleteOptionalParams	Optional parameters.
SignalRCustomCertificatesGetOptionalParams	Optional parameters.
SignalRCustomCertificatesListNextOptionalParams	Optional parameters.
SignalRCustomCertificatesListOptionalParams	Optional parameters.
SignalRCustomDomains	Interface representing a SignalRCustomDomains.
SignalRCustomDomainsCreateOrUpdateOptionalParams	Optional parameters.
SignalRCustomDomainsDeleteOptionalParams	Optional parameters.
SignalRCustomDomainsGetOptionalParams	Optional parameters.
SignalRCustomDomainsListNextOptionalParams	Optional parameters.
SignalRCustomDomainsListOptionalParams	Optional parameters.
SignalRDeleteOptionalParams	Optional parameters.
SignalRFeature	Feature of a resource, which controls the runtime behavior.
SignalRGetOptionalParams	Optional parameters.
SignalRKeys	A class represents the access keys of the resource.
SignalRListByResourceGroupNextOptionalParams	Optional parameters.
SignalRListByResourceGroupOptionalParams	Optional parameters.
SignalRListBySubscriptionNextOptionalParams	Optional parameters.
SignalRListBySubscriptionOptionalParams	Optional parameters.
SignalRListKeysOptionalParams	Optional parameters.
SignalRListSkusOptionalParams	Optional parameters.
SignalRManagementClientOptionalParams	Optional parameters.
SignalRNetworkACLs	Network ACLs for the resource
SignalRPrivateEndpointConnections	Interface representing a SignalRPrivateEndpointConnections.
SignalRPrivateEndpointConnectionsDeleteOptionalParams	Optional parameters.
SignalRPrivateEndpointConnectionsGetOptionalParams	Optional parameters.
SignalRPrivateEndpointConnectionsListNextOptionalParams	Optional parameters.
SignalRPrivateEndpointConnectionsListOptionalParams	Optional parameters.
SignalRPrivateEndpointConnectionsUpdateOptionalParams	Optional parameters.
SignalRPrivateLinkResources	Interface representing a SignalRPrivateLinkResources.
SignalRPrivateLinkResourcesListNextOptionalParams	Optional parameters.
SignalRPrivateLinkResourcesListOptionalParams	Optional parameters.
SignalRRegenerateKeyOptionalParams	Optional parameters.
SignalRResource	A class represent a resource.
SignalRResourceList	Object that includes an array of resources and a possible link for next set.
SignalRRestartOptionalParams	Optional parameters.
SignalRSharedPrivateLinkResources	Interface representing a SignalRSharedPrivateLinkResources.
SignalRSharedPrivateLinkResourcesCreateOrUpdateOptionalParams	Optional parameters.
SignalRSharedPrivateLinkResourcesDeleteOptionalParams	Optional parameters.
SignalRSharedPrivateLinkResourcesGetOptionalParams	Optional parameters.
SignalRSharedPrivateLinkResourcesListNextOptionalParams	Optional parameters.
SignalRSharedPrivateLinkResourcesListOptionalParams	Optional parameters.
SignalRTlsSettings	TLS settings for the resource
SignalRUpdateOptionalParams	Optional parameters.
SignalRUsage	Object that describes a specific usage of the resources.
SignalRUsageList	Object that includes an array of the resource usages and a possible link for next set.
SignalRUsageName	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.
UpstreamTemplate	Upstream template item settings. It defines the Upstream URL of the incoming requests. The template defines the pattern of the event, the hub or the category of the incoming request that matches current URL template.
Usages	Interface representing a Usages.
UsagesListNextOptionalParams	Optional parameters.
UsagesListOptionalParams	Optional parameters.
UserAssignedIdentityProperty	Properties of user assigned identity.

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
FeatureFlags	Defines values for FeatureFlags. KnownFeatureFlags can be used interchangeably with FeatureFlags, this enum contains the known values that the service supports. Known values supported by the service ServiceMode EnableConnectivityLogs EnableMessagingLogs EnableLiveTrace
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
ServiceKind	Defines values for ServiceKind. KnownServiceKind can be used interchangeably with ServiceKind, this enum contains the known values that the service supports. Known values supported by the service SignalR RawWebSockets
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
SignalRCheckNameAvailabilityResponse	Contains response data for the checkNameAvailability operation.
SignalRCreateOrUpdateResponse	Contains response data for the createOrUpdate operation.
SignalRCustomCertificatesCreateOrUpdateResponse	Contains response data for the createOrUpdate operation.
SignalRCustomCertificatesGetResponse	Contains response data for the get operation.
SignalRCustomCertificatesListNextResponse	Contains response data for the listNext operation.
SignalRCustomCertificatesListResponse	Contains response data for the list operation.
SignalRCustomDomainsCreateOrUpdateResponse	Contains response data for the createOrUpdate operation.
SignalRCustomDomainsGetResponse	Contains response data for the get operation.
SignalRCustomDomainsListNextResponse	Contains response data for the listNext operation.
SignalRCustomDomainsListResponse	Contains response data for the list operation.
SignalRGetResponse	Contains response data for the get operation.
SignalRListByResourceGroupNextResponse	Contains response data for the listByResourceGroupNext operation.
SignalRListByResourceGroupResponse	Contains response data for the listByResourceGroup operation.
SignalRListBySubscriptionNextResponse	Contains response data for the listBySubscriptionNext operation.
SignalRListBySubscriptionResponse	Contains response data for the listBySubscription operation.
SignalRListKeysResponse	Contains response data for the listKeys operation.
SignalRListSkusResponse	Contains response data for the listSkus operation.
SignalRPrivateEndpointConnectionsGetResponse	Contains response data for the get operation.
SignalRPrivateEndpointConnectionsListNextResponse	Contains response data for the listNext operation.
SignalRPrivateEndpointConnectionsListResponse	Contains response data for the list operation.
SignalRPrivateEndpointConnectionsUpdateResponse	Contains response data for the update operation.
SignalRPrivateLinkResourcesListNextResponse	Contains response data for the listNext operation.
SignalRPrivateLinkResourcesListResponse	Contains response data for the list operation.
SignalRRegenerateKeyResponse	Contains response data for the regenerateKey operation.
SignalRRequestType	Defines values for SignalRRequestType. KnownSignalRRequestType can be used interchangeably with SignalRRequestType, this enum contains the known values that the service supports. Known values supported by the service ClientConnection ServerConnection RESTAPI Trace
SignalRSharedPrivateLinkResourcesCreateOrUpdateResponse	Contains response data for the createOrUpdate operation.
SignalRSharedPrivateLinkResourcesGetResponse	Contains response data for the get operation.
SignalRSharedPrivateLinkResourcesListNextResponse	Contains response data for the listNext operation.
SignalRSharedPrivateLinkResourcesListResponse	Contains response data for the list operation.
SignalRSkuTier	Defines values for SignalRSkuTier. KnownSignalRSkuTier can be used interchangeably with SignalRSkuTier, this enum contains the known values that the service supports. Known values supported by the service Free Basic Standard Premium
SignalRUpdateResponse	Contains response data for the update operation.
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.

Enums

KnownACLAction	Known values of ACLAction that the service accepts.
KnownCreatedByType	Known values of CreatedByType that the service accepts.
KnownFeatureFlags	Known values of FeatureFlags 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.
KnownServiceKind	Known values of ServiceKind that the service accepts.
KnownSharedPrivateLinkResourceStatus	Known values of SharedPrivateLinkResourceStatus that the service accepts.
KnownSignalRRequestType	Known values of SignalRRequestType that the service accepts.
KnownSignalRSkuTier	Known values of SignalRSkuTier that the service accepts.
KnownUpstreamAuthType	Known values of UpstreamAuthType 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.