signalrservice.azure.com/v1api20211001

Package v1api20211001 contains API Schema definitions for the signalrservice v1api20211001 API group

Resource Types:

ACLAction (`string` alias)

Azure Networking ACL Action.

Value	Description
"Allow"
"Deny"

ACLAction_STATUS (`string` alias)

(Appears on:SignalRNetworkACLs_STATUS)

Azure Networking ACL Action.

Value	Description
"Allow"
"Deny"

APIVersion (`string` alias)

Value	Description
"2021-10-01"

FeatureFlags (`string` alias)

(Appears on:SignalRFeature)

FeatureFlags is the supported features of Azure SignalR service. - ServiceMode: Flag for backend server for SignalR service. Values allowed: “Default”: have your own backend server; “Serverless”: your application doesn’t have a backend server; “Classic”: for backward compatibility. Support both Default and Serverless mode but not recommended; “PredefinedOnly”: for future use. - EnableConnectivityLogs: “true”/“false”, to enable/disable the connectivity log category respectively. - EnableMessagingLogs: “true”/“false”, to enable/disable the connectivity log category respectively. - EnableLiveTrace: Live Trace allows you to know what’s happening inside Azure SignalR service, it will give you live traces in real time, it will be helpful when you developing your own Azure SignalR based web application or self-troubleshooting some issues. Please note that live traces are counted as outbound messages that will be charged. Values allowed: “true”/“false”, to enable/disable live trace feature.

Value	Description
"EnableConnectivityLogs"
"EnableLiveTrace"
"EnableMessagingLogs"
"ServiceMode"

FeatureFlags_STATUS (`string` alias)

(Appears on:SignalRFeature_STATUS)

Value	Description
"EnableConnectivityLogs"
"EnableLiveTrace"
"EnableMessagingLogs"
"ServiceMode"

ManagedIdentity

(Appears on:SignalR_Spec)

A class represent managed identities used for request and response

Field	Description
`type` ManagedIdentityType	Type: Represents the identity type: systemAssigned, userAssigned, None
`userAssignedIdentities` []UserAssignedIdentityDetails	UserAssignedIdentities: Get or set the user assigned identities

ManagedIdentitySettings

(Appears on:UpstreamAuthSettings)

Managed identity settings for upstream.

Field	Description
`resource` string	Resource: The Resource indicating the App ID URI of the target resource. It also appears in the aud (audience) claim of the issued token.

ManagedIdentitySettings_STATUS

(Appears on:UpstreamAuthSettings_STATUS)

Managed identity settings for upstream.

Field	Description
`resource` string	Resource: The Resource indicating the App ID URI of the target resource. It also appears in the aud (audience) claim of the issued token.

ManagedIdentityType (`string` alias)

(Appears on:ManagedIdentity)

Represents the identity type: systemAssigned, userAssigned, None

Value	Description
"None"
"SystemAssigned"
"UserAssigned"

ManagedIdentityType_STATUS (`string` alias)

(Appears on:ManagedIdentity_STATUS)

Represents the identity type: systemAssigned, userAssigned, None

Value	Description
"None"
"SystemAssigned"
"UserAssigned"

ManagedIdentity_STATUS

(Appears on:SignalR_STATUS)

A class represent managed identities used for request and response

Field	Description
`principalId` string	PrincipalId: Get the principal id for the system assigned identity. Only be used in response.
`tenantId` string	TenantId: Get the tenant id for the system assigned identity. Only be used in response
`type` ManagedIdentityType_STATUS	Type: Represents the identity type: systemAssigned, userAssigned, None
`userAssignedIdentities` map[string]./api/signalrservice/v1api20211001.UserAssignedIdentityProperty_STATUS	UserAssignedIdentities: Get or set the user assigned identities

NetworkACL

(Appears on:SignalRNetworkACLs)

Network ACL

Field	Description
`allow` []SignalRRequestType	Allow: Allowed request types. The value can be one or more of: ClientConnection, ServerConnection, RESTAPI.
`deny` []SignalRRequestType	Deny: Denied request types. The value can be one or more of: ClientConnection, ServerConnection, RESTAPI.

NetworkACL_STATUS

(Appears on:SignalRNetworkACLs_STATUS)

Network ACL

Field	Description
`allow` []SignalRRequestType_STATUS	Allow: Allowed request types. The value can be one or more of: ClientConnection, ServerConnection, RESTAPI.
`deny` []SignalRRequestType_STATUS	Deny: Denied request types. The value can be one or more of: ClientConnection, ServerConnection, RESTAPI.

PrivateEndpointACL

(Appears on:SignalRNetworkACLs)

ACL for a private endpoint

Field	Description
`allow` []SignalRRequestType	Allow: Allowed request types. The value can be one or more of: ClientConnection, ServerConnection, RESTAPI.
`deny` []SignalRRequestType	Deny: Denied request types. The value can be one or more of: ClientConnection, ServerConnection, RESTAPI.
`name` string	Name: Name of the private endpoint connection

PrivateEndpointACL_STATUS

(Appears on:SignalRNetworkACLs_STATUS)

ACL for a private endpoint

Field	Description
`allow` []SignalRRequestType_STATUS	Allow: Allowed request types. The value can be one or more of: ClientConnection, ServerConnection, RESTAPI.
`deny` []SignalRRequestType_STATUS	Deny: Denied request types. The value can be one or more of: ClientConnection, ServerConnection, RESTAPI.
`name` string	Name: Name of the private endpoint connection

PrivateEndpointConnection_STATUS_SignalR_SubResourceEmbedded

(Appears on:SignalR_STATUS)

A private endpoint connection to an azure resource

Field	Description
`id` string	Id: Fully qualified resource Id for the resource.

ProvisioningState_STATUS (`string` alias)

(Appears on:SignalR_STATUS)

Provisioning state of the resource.

Value	Description
"Canceled"
"Creating"
"Deleting"
"Failed"
"Moving"
"Running"
"Succeeded"
"Unknown"
"Updating"

ResourceLogCategory

(Appears on:ResourceLogConfiguration)

Resource log category configuration of a Microsoft.SignalRService resource.

Field	Description
`enabled` string	Enabled: Indicates whether or the resource log category is enabled. Available values: true, false. Case insensitive.
`name` string	Name: Gets or sets the resource log category’s name. Available values: ConnectivityLogs, MessagingLogs. Case insensitive.

ResourceLogCategory_STATUS

(Appears on:ResourceLogConfiguration_STATUS)

Resource log category configuration of a Microsoft.SignalRService resource.

Field	Description
`enabled` string	Enabled: Indicates whether or the resource log category is enabled. Available values: true, false. Case insensitive.
`name` string	Name: Gets or sets the resource log category’s name. Available values: ConnectivityLogs, MessagingLogs. Case insensitive.

ResourceLogConfiguration

(Appears on:SignalR_Spec)

Resource log configuration of a Microsoft.SignalRService resource.

Field	Description
`categories` []ResourceLogCategory	Categories: Gets or sets the list of category configurations.

ResourceLogConfiguration_STATUS

(Appears on:SignalR_STATUS)

Resource log configuration of a Microsoft.SignalRService resource.

Field	Description
`categories` []ResourceLogCategory_STATUS	Categories: Gets or sets the list of category configurations.

ResourceSku

(Appears on:SignalR_Spec)

The billing information of the resource.

Field	Description
`capacity` int	Capacity: Optional, integer. The unit count of the resource. 1 by default. If present, following values are allowed: Free: 1 Standard: 1,2,5,10,20,50,100
`name` string	Name: The name of the SKU. Required. Allowed values: Standard_S1, Free_F1
`tier` SignalRSkuTier	Tier: Optional tier of this particular SKU. ‘Standard’ or ‘Free’. `Basic` is deprecated, use `Standard` instead.

ResourceSku_STATUS

(Appears on:SignalR_STATUS)

The billing information of the resource.

Field	Description
`capacity` int	Capacity: Optional, integer. The unit count of the resource. 1 by default. If present, following values are allowed: Free: 1 Standard: 1,2,5,10,20,50,100
`family` string	Family: Not used. Retained for future use.
`name` string	Name: The name of the SKU. Required. Allowed values: Standard_S1, Free_F1
`size` string	Size: Not used. Retained for future use.
`tier` SignalRSkuTier_STATUS	Tier: Optional tier of this particular SKU. ‘Standard’ or ‘Free’. `Basic` is deprecated, use `Standard` instead.

ServerlessUpstreamSettings

(Appears on:SignalR_Spec)

The settings for the Upstream when the service is in server-less mode.

Field	Description
`templates` []UpstreamTemplate	Templates: Gets or sets the list of Upstream URL templates. Order matters, and the first matching template takes effects.

ServerlessUpstreamSettings_STATUS

(Appears on:SignalR_STATUS)

The settings for the Upstream when the service is in server-less mode.

Field	Description
`templates` []UpstreamTemplate_STATUS	Templates: Gets or sets the list of Upstream URL templates. Order matters, and the first matching template takes effects.

ServiceKind (`string` alias)

(Appears on:SignalR_Spec)

The kind of the service, it can be SignalR or RawWebSockets

Value	Description
"RawWebSockets"
"SignalR"

ServiceKind_STATUS (`string` alias)

(Appears on:SignalR_STATUS)

The kind of the service, it can be SignalR or RawWebSockets

Value	Description
"RawWebSockets"
"SignalR"

SharedPrivateLinkResource_STATUS_SignalR_SubResourceEmbedded

(Appears on:SignalR_STATUS)

Describes a Shared Private Link Resource

Field	Description
`id` string	Id: Fully qualified resource Id for the resource.

SignalR

Generator information: - Generated from: /signalr/resource-manager/Microsoft.SignalRService/stable/2021-10-01/signalr.json - ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{resourceName}

Field Description

metadata
Kubernetes meta/v1.ObjectMeta Refer to the Kubernetes API documentation for the fields of the metadata field.

spec
SignalR_Spec

`azureName` string	AzureName: The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be.
`cors` SignalRCorsSettings	Cors: Cross-Origin Resource Sharing (CORS) settings.
`disableAadAuth` bool	DisableAadAuth: DisableLocalAuth Enable or disable aad auth When set as true, connection with AuthType=aad won’t work.
`disableLocalAuth` bool	DisableLocalAuth: DisableLocalAuth Enable or disable local auth with AccessKey When set as true, connection with AccessKey=xxx won’t work.
`features` []SignalRFeature	Features: List of the featureFlags. FeatureFlags that are not included in the parameters for the update operation will not be modified. And the response will only include featureFlags that are explicitly set. When a featureFlag is not explicitly set, its globally default value will be used But keep in mind, the default value doesn’t mean “false”. It varies in terms of different FeatureFlags.
`identity` ManagedIdentity	Identity: A class represent managed identities used for request and response
`kind` ServiceKind	Kind: The kind of the service, it can be SignalR or RawWebSockets
`location` string	Location: The GEO location of the resource. e.g. West US \| East US \| North Central US \| South Central US.
`networkACLs` SignalRNetworkACLs	NetworkACLs: Network ACLs for the resource
`operatorSpec` SignalROperatorSpec	OperatorSpec: The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure
`owner` genruntime.KnownResourceReference	Owner: The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a resources.azure.com/ResourceGroup resource
`publicNetworkAccess` string	PublicNetworkAccess: Enable or disable public network access. Default to “Enabled”. When it’s Enabled, network ACLs still apply. When it’s Disabled, public network access is always disabled no matter what you set in network ACLs.
`resourceLogConfiguration` ResourceLogConfiguration	ResourceLogConfiguration: Resource log configuration of a Microsoft.SignalRService resource.
`sku` ResourceSku	Sku: The billing information of the resource.
`tags` map[string]string	Tags: Tags of the service which is a list of key value pairs that describe the resource.
`tls` SignalRTlsSettings	Tls: TLS settings for the resource
`upstream` ServerlessUpstreamSettings	Upstream: The settings for the Upstream when the service is in server-less mode.

status
SignalR_STATUS

SignalRCorsSettings

(Appears on:SignalR_Spec)

Cross-Origin Resource Sharing (CORS) settings.

Field	Description
`allowedOrigins` []string	AllowedOrigins: Gets or sets the list of origins that should be allowed to make cross-origin calls (for example: http://example.com:12345). Use “*” to allow all. If omitted, allow all by default.

SignalRCorsSettings_STATUS

(Appears on:SignalR_STATUS)

Cross-Origin Resource Sharing (CORS) settings.

Field	Description
`allowedOrigins` []string	AllowedOrigins: Gets or sets the list of origins that should be allowed to make cross-origin calls (for example: http://example.com:12345). Use “*” to allow all. If omitted, allow all by default.

SignalRFeature

(Appears on:SignalR_Spec)

Feature of a resource, which controls the runtime behavior.

Field	Description
`flag` FeatureFlags	Flag: FeatureFlags is the supported features of Azure SignalR service. - ServiceMode: Flag for backend server for SignalR service. Values allowed: “Default”: have your own backend server; “Serverless”: your application doesn’t have a backend server; “Classic”: for backward compatibility. Support both Default and Serverless mode but not recommended; “PredefinedOnly”: for future use. - EnableConnectivityLogs: “true”/“false”, to enable/disable the connectivity log category respectively. - EnableMessagingLogs: “true”/“false”, to enable/disable the connectivity log category respectively. - EnableLiveTrace: Live Trace allows you to know what’s happening inside Azure SignalR service, it will give you live traces in real time, it will be helpful when you developing your own Azure SignalR based web application or self-troubleshooting some issues. Please note that live traces are counted as outbound messages that will be charged. Values allowed: “true”/“false”, to enable/disable live trace feature.
`properties` map[string]string	Properties: Optional properties related to this feature.
`value` string	Value: Value of the feature flag. See Azure SignalR service document https://docs.microsoft.com/azure/azure-signalr/ for allowed values.

SignalRFeature_STATUS

(Appears on:SignalR_STATUS)

Feature of a resource, which controls the runtime behavior.

Field	Description
`flag` FeatureFlags_STATUS	Flag: FeatureFlags is the supported features of Azure SignalR service. - ServiceMode: Flag for backend server for SignalR service. Values allowed: “Default”: have your own backend server; “Serverless”: your application doesn’t have a backend server; “Classic”: for backward compatibility. Support both Default and Serverless mode but not recommended; “PredefinedOnly”: for future use. - EnableConnectivityLogs: “true”/“false”, to enable/disable the connectivity log category respectively. - EnableMessagingLogs: “true”/“false”, to enable/disable the connectivity log category respectively. - EnableLiveTrace: Live Trace allows you to know what’s happening inside Azure SignalR service, it will give you live traces in real time, it will be helpful when you developing your own Azure SignalR based web application or self-troubleshooting some issues. Please note that live traces are counted as outbound messages that will be charged. Values allowed: “true”/“false”, to enable/disable live trace feature.
`properties` map[string]string	Properties: Optional properties related to this feature.
`value` string	Value: Value of the feature flag. See Azure SignalR service document https://docs.microsoft.com/azure/azure-signalr/ for allowed values.

SignalRNetworkACLs

(Appears on:SignalR_Spec)

Network ACLs for the resource

Field	Description
`defaultAction` ACLAction	DefaultAction: Azure Networking ACL Action.
`privateEndpoints` []PrivateEndpointACL	PrivateEndpoints: ACLs for requests from private endpoints
`publicNetwork` NetworkACL	PublicNetwork: Network ACL

SignalRNetworkACLs_STATUS

(Appears on:SignalR_STATUS)

Network ACLs for the resource

Field	Description
`defaultAction` ACLAction_STATUS	DefaultAction: Azure Networking ACL Action.
`privateEndpoints` []PrivateEndpointACL_STATUS	PrivateEndpoints: ACLs for requests from private endpoints
`publicNetwork` NetworkACL_STATUS	PublicNetwork: Network ACL

SignalROperatorSecrets

(Appears on:SignalROperatorSpec)

Field	Description
`primaryConnectionString` genruntime.SecretDestination	PrimaryConnectionString: indicates where the PrimaryConnectionString secret should be placed. If omitted, the secret will not be retrieved from Azure.
`primaryKey` genruntime.SecretDestination	PrimaryKey: indicates where the PrimaryKey secret should be placed. If omitted, the secret will not be retrieved from Azure.
`secondaryConnectionString` genruntime.SecretDestination	SecondaryConnectionString: indicates where the SecondaryConnectionString secret should be placed. If omitted, the secret will not be retrieved from Azure.
`secondaryKey` genruntime.SecretDestination	SecondaryKey: indicates where the SecondaryKey secret should be placed. If omitted, the secret will not be retrieved from Azure.

SignalROperatorSpec

(Appears on:SignalR_Spec)

Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure

Field	Description
`configMapExpressions` []genruntime/core.DestinationExpression	ConfigMapExpressions: configures where to place operator written dynamic ConfigMaps (created with CEL expressions).
`secretExpressions` []genruntime/core.DestinationExpression	SecretExpressions: configures where to place operator written dynamic secrets (created with CEL expressions).
`secrets` SignalROperatorSecrets	Secrets: configures where to place Azure generated secrets.

SignalRRequestType (`string` alias)

(Appears on:NetworkACL, PrivateEndpointACL)

The incoming request type to the service

Value	Description
"ClientConnection"
"RESTAPI"
"ServerConnection"
"Trace"

SignalRRequestType_STATUS (`string` alias)

(Appears on:NetworkACL_STATUS, PrivateEndpointACL_STATUS)

The incoming request type to the service

Value	Description
"ClientConnection"
"RESTAPI"
"ServerConnection"
"Trace"

SignalRSkuTier (`string` alias)

(Appears on:ResourceSku)

Optional tier of this particular SKU. ‘Standard’ or ‘Free’. Basic is deprecated, use Standard instead.

Value	Description
"Basic"
"Free"
"Premium"
"Standard"

SignalRSkuTier_STATUS (`string` alias)

(Appears on:ResourceSku_STATUS)

Optional tier of this particular SKU. ‘Standard’ or ‘Free’. Basic is deprecated, use Standard instead.

Value	Description
"Basic"
"Free"
"Premium"
"Standard"

SignalRTlsSettings

(Appears on:SignalR_Spec)

TLS settings for the resource

Field	Description
`clientCertEnabled` bool	ClientCertEnabled: Request client certificate during TLS handshake if enabled

SignalRTlsSettings_STATUS

(Appears on:SignalR_STATUS)

TLS settings for the resource

Field	Description
`clientCertEnabled` bool	ClientCertEnabled: Request client certificate during TLS handshake if enabled

SignalR_STATUS

(Appears on:SignalR)

Field	Description
`conditions` []genruntime/conditions.Condition	Conditions: The observed state of the resource
`cors` SignalRCorsSettings_STATUS	Cors: Cross-Origin Resource Sharing (CORS) settings.
`disableAadAuth` bool	DisableAadAuth: DisableLocalAuth Enable or disable aad auth When set as true, connection with AuthType=aad won’t work.
`disableLocalAuth` bool	DisableLocalAuth: DisableLocalAuth Enable or disable local auth with AccessKey When set as true, connection with AccessKey=xxx won’t work.
`externalIP` string	ExternalIP: The publicly accessible IP of the resource.
`features` []SignalRFeature_STATUS	Features: List of the featureFlags. FeatureFlags that are not included in the parameters for the update operation will not be modified. And the response will only include featureFlags that are explicitly set. When a featureFlag is not explicitly set, its globally default value will be used But keep in mind, the default value doesn’t mean “false”. It varies in terms of different FeatureFlags.
`hostName` string	HostName: FQDN of the service instance.
`hostNamePrefix` string	HostNamePrefix: Deprecated.
`id` string	Id: Fully qualified resource Id for the resource.
`identity` ManagedIdentity_STATUS	Identity: A class represent managed identities used for request and response
`kind` ServiceKind_STATUS	Kind: The kind of the service, it can be SignalR or RawWebSockets
`location` string	Location: The GEO location of the resource. e.g. West US \| East US \| North Central US \| South Central US.
`name` string	Name: The name of the resource.
`networkACLs` SignalRNetworkACLs_STATUS	NetworkACLs: Network ACLs for the resource
`privateEndpointConnections` []PrivateEndpointConnection_STATUS_SignalR_SubResourceEmbedded	PrivateEndpointConnections: Private endpoint connections to the resource.
`provisioningState` ProvisioningState_STATUS	ProvisioningState: Provisioning state of the resource.
`publicNetworkAccess` string	PublicNetworkAccess: Enable or disable public network access. Default to “Enabled”. When it’s Enabled, network ACLs still apply. When it’s Disabled, public network access is always disabled no matter what you set in network ACLs.
`publicPort` int	PublicPort: The publicly accessible port of the resource which is designed for browser/client side usage.
`resourceLogConfiguration` ResourceLogConfiguration_STATUS	ResourceLogConfiguration: Resource log configuration of a Microsoft.SignalRService resource.
`serverPort` int	ServerPort: The publicly accessible port of the resource which is designed for customer server side usage.
`sharedPrivateLinkResources` []SharedPrivateLinkResource_STATUS_SignalR_SubResourceEmbedded	SharedPrivateLinkResources: The list of shared private link resources.
`sku` ResourceSku_STATUS	Sku: The billing information of the resource.
`systemData` SystemData_STATUS	SystemData: Metadata pertaining to creation and last modification of the resource.
`tags` map[string]string	Tags: Tags of the service which is a list of key value pairs that describe the resource.
`tls` SignalRTlsSettings_STATUS	Tls: TLS settings for the resource
`type` string	Type: The type of the resource - e.g. “Microsoft.SignalRService/SignalR”
`upstream` ServerlessUpstreamSettings_STATUS	Upstream: The settings for the Upstream when the service is in server-less mode.
`version` string	Version: Version of the resource. Probably you need the same or higher version of client SDKs.

SignalR_Spec

(Appears on:SignalR)

Field	Description
`azureName` string	AzureName: The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be.
`cors` SignalRCorsSettings	Cors: Cross-Origin Resource Sharing (CORS) settings.
`disableAadAuth` bool	DisableAadAuth: DisableLocalAuth Enable or disable aad auth When set as true, connection with AuthType=aad won’t work.
`disableLocalAuth` bool	DisableLocalAuth: DisableLocalAuth Enable or disable local auth with AccessKey When set as true, connection with AccessKey=xxx won’t work.
`features` []SignalRFeature	Features: List of the featureFlags. FeatureFlags that are not included in the parameters for the update operation will not be modified. And the response will only include featureFlags that are explicitly set. When a featureFlag is not explicitly set, its globally default value will be used But keep in mind, the default value doesn’t mean “false”. It varies in terms of different FeatureFlags.
`identity` ManagedIdentity	Identity: A class represent managed identities used for request and response
`kind` ServiceKind	Kind: The kind of the service, it can be SignalR or RawWebSockets
`location` string	Location: The GEO location of the resource. e.g. West US \| East US \| North Central US \| South Central US.
`networkACLs` SignalRNetworkACLs	NetworkACLs: Network ACLs for the resource
`operatorSpec` SignalROperatorSpec	OperatorSpec: The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure
`owner` genruntime.KnownResourceReference	Owner: The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a resources.azure.com/ResourceGroup resource
`publicNetworkAccess` string	PublicNetworkAccess: Enable or disable public network access. Default to “Enabled”. When it’s Enabled, network ACLs still apply. When it’s Disabled, public network access is always disabled no matter what you set in network ACLs.
`resourceLogConfiguration` ResourceLogConfiguration	ResourceLogConfiguration: Resource log configuration of a Microsoft.SignalRService resource.
`sku` ResourceSku	Sku: The billing information of the resource.
`tags` map[string]string	Tags: Tags of the service which is a list of key value pairs that describe the resource.
`tls` SignalRTlsSettings	Tls: TLS settings for the resource
`upstream` ServerlessUpstreamSettings	Upstream: The settings for the Upstream when the service is in server-less mode.

SystemData_CreatedByType_STATUS (`string` alias)

(Appears on:SystemData_STATUS)

Value	Description
"Application"
"Key"
"ManagedIdentity"
"User"

SystemData_LastModifiedByType_STATUS (`string` alias)

(Appears on:SystemData_STATUS)

Value	Description
"Application"
"Key"
"ManagedIdentity"
"User"

SystemData_STATUS

(Appears on:SignalR_STATUS)

Metadata pertaining to creation and last modification of the resource.

Field	Description
`createdAt` string	CreatedAt: The timestamp of resource creation (UTC).
`createdBy` string	CreatedBy: The identity that created the resource.
`createdByType` SystemData_CreatedByType_STATUS	CreatedByType: The type of identity that created the resource.
`lastModifiedAt` string	LastModifiedAt: The timestamp of resource last modification (UTC)
`lastModifiedBy` string	LastModifiedBy: The identity that last modified the resource.
`lastModifiedByType` SystemData_LastModifiedByType_STATUS	LastModifiedByType: The type of identity that last modified the resource.

UpstreamAuthSettings

(Appears on:UpstreamTemplate)

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

Field	Description
`managedIdentity` ManagedIdentitySettings	ManagedIdentity: Managed identity settings for upstream.
`type` UpstreamAuthType	Type: Upstream auth type enum.

UpstreamAuthSettings_STATUS

(Appears on:UpstreamTemplate_STATUS)

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

Field	Description
`managedIdentity` ManagedIdentitySettings_STATUS	ManagedIdentity: Managed identity settings for upstream.
`type` UpstreamAuthType_STATUS	Type: Upstream auth type enum.

UpstreamAuthType (`string` alias)

(Appears on:UpstreamAuthSettings)

Upstream auth type enum.

Value	Description
"ManagedIdentity"
"None"

UpstreamAuthType_STATUS (`string` alias)

(Appears on:UpstreamAuthSettings_STATUS)

Upstream auth type enum.

Value	Description
"ManagedIdentity"
"None"

UpstreamTemplate

(Appears on:ServerlessUpstreamSettings)

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.

Field	Description
`auth` UpstreamAuthSettings	Auth: Upstream auth settings. If not set, no auth is used for upstream messages.
`categoryPattern` string	CategoryPattern: Gets or sets the matching pattern for category names. If not set, it matches any category. There are 3 kind of patterns supported: 1. “*”, it to matches any category name 2. Combine multiple categories with “,”, for example “connections,messages”, it matches category “connections” and “messages” 3. The single category name, for example, “connections”, it matches the category “connections”
`eventPattern` string	EventPattern: Gets or sets the matching pattern for event names. If not set, it matches any event. There are 3 kind of patterns supported: 1. “*”, it to matches any event name 2. Combine multiple events with “,”, for example “connect,disconnect”, it matches event “connect” and “disconnect” 3. The single event name, for example, “connect”, it matches “connect”
`hubPattern` string	HubPattern: Gets or sets the matching pattern for hub names. If not set, it matches any hub. There are 3 kind of patterns supported: 1. “*”, it to matches any hub name 2. Combine multiple hubs with “,”, for example “hub1,hub2”, it matches “hub1” and “hub2” 3. The single hub name, for example, “hub1”, it matches “hub1”
`urlTemplate` string	UrlTemplate: Gets or sets the Upstream URL template. You can use 3 predefined parameters {hub}, {category} {event} inside the template, the value of the Upstream URL is dynamically calculated when the client request comes in. For example, if the urlTemplate is `http://example.com/{hub}/api/{event}`, with a client request from hub `chat` connects, it will first POST to this URL: `http://example.com/chat/api/connect`.

UpstreamTemplate_STATUS

(Appears on:ServerlessUpstreamSettings_STATUS)

Field	Description
`auth` UpstreamAuthSettings_STATUS	Auth: Upstream auth settings. If not set, no auth is used for upstream messages.
`categoryPattern` string	CategoryPattern: Gets or sets the matching pattern for category names. If not set, it matches any category. There are 3 kind of patterns supported: 1. “*”, it to matches any category name 2. Combine multiple categories with “,”, for example “connections,messages”, it matches category “connections” and “messages” 3. The single category name, for example, “connections”, it matches the category “connections”
`eventPattern` string	EventPattern: Gets or sets the matching pattern for event names. If not set, it matches any event. There are 3 kind of patterns supported: 1. “*”, it to matches any event name 2. Combine multiple events with “,”, for example “connect,disconnect”, it matches event “connect” and “disconnect” 3. The single event name, for example, “connect”, it matches “connect”
`hubPattern` string	HubPattern: Gets or sets the matching pattern for hub names. If not set, it matches any hub. There are 3 kind of patterns supported: 1. “*”, it to matches any hub name 2. Combine multiple hubs with “,”, for example “hub1,hub2”, it matches “hub1” and “hub2” 3. The single hub name, for example, “hub1”, it matches “hub1”
`urlTemplate` string	UrlTemplate: Gets or sets the Upstream URL template. You can use 3 predefined parameters {hub}, {category} {event} inside the template, the value of the Upstream URL is dynamically calculated when the client request comes in. For example, if the urlTemplate is `http://example.com/{hub}/api/{event}`, with a client request from hub `chat` connects, it will first POST to this URL: `http://example.com/chat/api/connect`.

UserAssignedIdentityDetails

(Appears on:ManagedIdentity)

Information about the user assigned identity for the resource

Field	Description
`reference` genruntime.ResourceReference

UserAssignedIdentityProperty_STATUS

(Appears on:ManagedIdentity_STATUS)

Properties of user assigned identity.

Field	Description
`clientId` string	ClientId: Get the client id for the user assigned identity
`principalId` string	PrincipalId: Get the principal id for the user assigned identity

signalrservice.azure.com/v1api20211001