signalrservice.azure.com/v1api20240301


APIVersion

Value Description
“2024-03-01”

CustomCertificate

Generator information: - Generated from: /signalr/resource-manager/Microsoft.SignalRService/stable/2024-03-01/signalr.json - ARM URI: /​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​Microsoft.SignalRService/signalR/{resourceName}/customCertificates/{certificateName}

Used by: CustomCertificateList.

Property Description Type
metav1.TypeMeta
metav1.ObjectMeta
spec CustomCertificate_Spec
Optional
status CustomCertificate_STATUS
Optional

CustomCertificate_Spec

Property Description Type
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. string
Optional
keyVaultBaseUri Base uri of the KeyVault that stores certificate. string
Optional
keyVaultBaseUriFromConfig Base uri of the KeyVault that stores certificate. genruntime.ConfigMapReference
Optional
keyVaultSecretName Certificate secret name. string
Required
keyVaultSecretVersion Certificate secret version. string
Optional
operatorSpec The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure CustomCertificateOperatorSpec
Optional
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 signalrservice.azure.com/SignalR resource genruntime.KnownResourceReference
Required

CustomCertificate_STATUS

Property Description Type
conditions The observed state of the resource conditions.Condition[]
Optional
id Fully qualified resource ID for the resource. E.g. “/​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​{resourceProviderNamespace}/​{resourceType}/​{resourceName}” string
Optional
keyVaultBaseUri Base uri of the KeyVault that stores certificate. string
Optional
keyVaultSecretName Certificate secret name. string
Optional
keyVaultSecretVersion Certificate secret version. string
Optional
name The name of the resource string
Optional
provisioningState Provisioning state of the resource. ProvisioningState_STATUS
Optional
systemData Azure Resource Manager metadata containing createdBy and modifiedBy information. SystemData_STATUS
Optional
type The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts” string
Optional

CustomCertificateList

Generator information: - Generated from: /signalr/resource-manager/Microsoft.SignalRService/stable/2024-03-01/signalr.json - ARM URI: /​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​Microsoft.SignalRService/signalR/{resourceName}/customCertificates/{certificateName}

Property Description Type
metav1.TypeMeta
metav1.ListMeta
items CustomCertificate[]
Optional

CustomDomain

Generator information: - Generated from: /signalr/resource-manager/Microsoft.SignalRService/stable/2024-03-01/signalr.json - ARM URI: /​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​Microsoft.SignalRService/signalR/{resourceName}/customDomains/{name}

Used by: CustomDomainList.

Property Description Type
metav1.TypeMeta
metav1.ObjectMeta
spec CustomDomain_Spec
Optional
status CustomDomain_STATUS
Optional

CustomDomain_Spec

Property Description Type
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. string
Optional
customCertificate Reference to a resource. ResourceReference
Required
domainName The custom domain name. string
Required
operatorSpec The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure CustomDomainOperatorSpec
Optional
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 signalrservice.azure.com/SignalR resource genruntime.KnownResourceReference
Required

CustomDomain_STATUS

Property Description Type
conditions The observed state of the resource conditions.Condition[]
Optional
customCertificate Reference to a resource. ResourceReference_STATUS
Optional
domainName The custom domain name. string
Optional
id Fully qualified resource ID for the resource. E.g. “/​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​{resourceProviderNamespace}/​{resourceType}/​{resourceName}” string
Optional
name The name of the resource string
Optional
provisioningState Provisioning state of the resource. ProvisioningState_STATUS
Optional
systemData Azure Resource Manager metadata containing createdBy and modifiedBy information. SystemData_STATUS
Optional
type The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts” string
Optional

CustomDomainList

Generator information: - Generated from: /signalr/resource-manager/Microsoft.SignalRService/stable/2024-03-01/signalr.json - ARM URI: /​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​Microsoft.SignalRService/signalR/{resourceName}/customDomains/{name}

Property Description Type
metav1.TypeMeta
metav1.ListMeta
items CustomDomain[]
Optional

Replica

Generator information: - Generated from: /signalr/resource-manager/Microsoft.SignalRService/stable/2024-03-01/signalr.json - ARM URI: /​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​Microsoft.SignalRService/signalR/{resourceName}/replicas/{replicaName}

Used by: ReplicaList.

Property Description Type
metav1.TypeMeta
metav1.ObjectMeta
spec Replica_Spec
Optional
status Replica_STATUS
Optional

Replica_Spec

Property Description Type
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. string
Optional
location The geo-location where the resource lives string
Required
operatorSpec The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure ReplicaOperatorSpec
Optional
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 signalrservice.azure.com/SignalR resource genruntime.KnownResourceReference
Required
regionEndpointEnabled Enable or disable the regional endpoint. Default to “Enabled”. When it’s Disabled, new connections will not be routed to this endpoint, however existing connections will not be affected. string
Optional
resourceStopped Stop or start the resource. Default to “false”. When it’s true, the data plane of the resource is shutdown. When it’s false, the data plane of the resource is started. string
Optional
sku The billing information of the resource. ResourceSku
Optional
tags Resource tags. map[string]string
Optional

Replica_STATUS

Property Description Type
conditions The observed state of the resource conditions.Condition[]
Optional
id Fully qualified resource ID for the resource. E.g. “/​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​{resourceProviderNamespace}/​{resourceType}/​{resourceName}” string
Optional
location The geo-location where the resource lives string
Optional
name The name of the resource string
Optional
provisioningState Provisioning state of the resource. ProvisioningState_STATUS
Optional
regionEndpointEnabled Enable or disable the regional endpoint. Default to “Enabled”. When it’s Disabled, new connections will not be routed to this endpoint, however existing connections will not be affected. string
Optional
resourceStopped Stop or start the resource. Default to “false”. When it’s true, the data plane of the resource is shutdown. When it’s false, the data plane of the resource is started. string
Optional
sku The billing information of the resource. ResourceSku_STATUS
Optional
systemData Azure Resource Manager metadata containing createdBy and modifiedBy information. SystemData_STATUS
Optional
tags Resource tags. map[string]string
Optional
type The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts” string
Optional

ReplicaList

Generator information: - Generated from: /signalr/resource-manager/Microsoft.SignalRService/stable/2024-03-01/signalr.json - ARM URI: /​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​Microsoft.SignalRService/signalR/{resourceName}/replicas/{replicaName}

Property Description Type
metav1.TypeMeta
metav1.ListMeta
items Replica[]
Optional

SignalR

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

Used by: SignalRList.

Property Description Type
metav1.TypeMeta
metav1.ObjectMeta
spec SignalR_Spec
Optional
status SignalR_STATUS
Optional

SignalR_Spec

Property Description Type
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. string
Optional
cors Cross-Origin Resource Sharing (CORS) settings. SignalRCorsSettings
Optional
disableAadAuth DisableLocalAuth Enable or disable aad auth When set as true, connection with AuthType=aad won’t work. bool
Optional
disableLocalAuth DisableLocalAuth Enable or disable local auth with AccessKey When set as true, connection with AccessKey=xxx won’t work. bool
Optional
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. SignalRFeature[]
Optional
identity A class represent managed identities used for request and response ManagedIdentity
Optional
kind The kind of the service SignalrServiceKind
Optional
liveTraceConfiguration Live trace configuration of a Microsoft.SignalRService resource. LiveTraceConfiguration
Optional
location The geo-location where the resource lives string
Required
networkACLs Network ACLs for the resource SignalRNetworkACLs
Optional
operatorSpec The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure SignalROperatorSpec
Optional
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 genruntime.KnownResourceReference
Required
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. string
Optional
regionEndpointEnabled Enable or disable the regional endpoint. Default to “Enabled”. When it’s Disabled, new connections will not be routed to this endpoint, however existing connections will not be affected. This property is replica specific. Disable the regional endpoint without replica is not allowed. string
Optional
resourceLogConfiguration Resource log configuration of a Microsoft.SignalRService resource. ResourceLogConfiguration
Optional
resourceStopped Stop or start the resource. Default to “False”. When it’s true, the data plane of the resource is shutdown. When it’s false, the data plane of the resource is started. string
Optional
serverless Serverless settings. ServerlessSettings
Optional
sku The billing information of the resource. ResourceSku
Optional
tags Resource tags. map[string]string
Optional
tls TLS settings for the resource SignalRTlsSettings
Optional
upstream The settings for the Upstream when the service is in server-less mode. ServerlessUpstreamSettings
Optional

SignalR_STATUS

Property Description Type
conditions The observed state of the resource conditions.Condition[]
Optional
cors Cross-Origin Resource Sharing (CORS) settings. SignalRCorsSettings_STATUS
Optional
disableAadAuth DisableLocalAuth Enable or disable aad auth When set as true, connection with AuthType=aad won’t work. bool
Optional
disableLocalAuth DisableLocalAuth Enable or disable local auth with AccessKey When set as true, connection with AccessKey=xxx won’t work. bool
Optional
externalIP The publicly accessible IP of the resource. string
Optional
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. SignalRFeature_STATUS[]
Optional
hostName FQDN of the service instance. string
Optional
hostNamePrefix Deprecated. string
Optional
id Fully qualified resource ID for the resource. E.g. “/​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​{resourceProviderNamespace}/​{resourceType}/​{resourceName}” string
Optional
identity A class represent managed identities used for request and response ManagedIdentity_STATUS
Optional
kind The kind of the service SignalrServiceKind_STATUS
Optional
liveTraceConfiguration Live trace configuration of a Microsoft.SignalRService resource. LiveTraceConfiguration_STATUS
Optional
location The geo-location where the resource lives string
Optional
name The name of the resource string
Optional
networkACLs Network ACLs for the resource SignalRNetworkACLs_STATUS
Optional
privateEndpointConnections Private endpoint connections to the resource. PrivateEndpointConnection_STATUS_SignalR_SubResourceEmbedded[]
Optional
provisioningState Provisioning state of the resource. ProvisioningState_STATUS
Optional
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. string
Optional
publicPort The publicly accessible port of the resource which is designed for browser/client side usage. int
Optional
regionEndpointEnabled Enable or disable the regional endpoint. Default to “Enabled”. When it’s Disabled, new connections will not be routed to this endpoint, however existing connections will not be affected. This property is replica specific. Disable the regional endpoint without replica is not allowed. string
Optional
resourceLogConfiguration Resource log configuration of a Microsoft.SignalRService resource. ResourceLogConfiguration_STATUS
Optional
resourceStopped Stop or start the resource. Default to “False”. When it’s true, the data plane of the resource is shutdown. When it’s false, the data plane of the resource is started. string
Optional
serverless Serverless settings. ServerlessSettings_STATUS
Optional
serverPort The publicly accessible port of the resource which is designed for customer server side usage. int
Optional
sharedPrivateLinkResources The list of shared private link resources. SharedPrivateLinkResource_STATUS_SignalR_SubResourceEmbedded[]
Optional
sku The billing information of the resource. ResourceSku_STATUS
Optional
systemData Azure Resource Manager metadata containing createdBy and modifiedBy information. SystemData_STATUS
Optional
tags Resource tags. map[string]string
Optional
tls TLS settings for the resource SignalRTlsSettings_STATUS
Optional
type The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts” string
Optional
upstream The settings for the Upstream when the service is in server-less mode. ServerlessUpstreamSettings_STATUS
Optional
version Version of the resource. Probably you need the same or higher version of client SDKs. string
Optional

SignalRList

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

Property Description Type
metav1.TypeMeta
metav1.ListMeta
items SignalR[]
Optional

CustomCertificate_Spec

Used by: CustomCertificate.

Property Description Type
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. string
Optional
keyVaultBaseUri Base uri of the KeyVault that stores certificate. string
Optional
keyVaultBaseUriFromConfig Base uri of the KeyVault that stores certificate. genruntime.ConfigMapReference
Optional
keyVaultSecretName Certificate secret name. string
Required
keyVaultSecretVersion Certificate secret version. string
Optional
operatorSpec The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure CustomCertificateOperatorSpec
Optional
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 signalrservice.azure.com/SignalR resource genruntime.KnownResourceReference
Required

CustomCertificate_STATUS

Used by: CustomCertificate.

Property Description Type
conditions The observed state of the resource conditions.Condition[]
Optional
id Fully qualified resource ID for the resource. E.g. “/​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​{resourceProviderNamespace}/​{resourceType}/​{resourceName}” string
Optional
keyVaultBaseUri Base uri of the KeyVault that stores certificate. string
Optional
keyVaultSecretName Certificate secret name. string
Optional
keyVaultSecretVersion Certificate secret version. string
Optional
name The name of the resource string
Optional
provisioningState Provisioning state of the resource. ProvisioningState_STATUS
Optional
systemData Azure Resource Manager metadata containing createdBy and modifiedBy information. SystemData_STATUS
Optional
type The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts” string
Optional

CustomDomain_Spec

Used by: CustomDomain.

Property Description Type
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. string
Optional
customCertificate Reference to a resource. ResourceReference
Required
domainName The custom domain name. string
Required
operatorSpec The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure CustomDomainOperatorSpec
Optional
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 signalrservice.azure.com/SignalR resource genruntime.KnownResourceReference
Required

CustomDomain_STATUS

Used by: CustomDomain.

Property Description Type
conditions The observed state of the resource conditions.Condition[]
Optional
customCertificate Reference to a resource. ResourceReference_STATUS
Optional
domainName The custom domain name. string
Optional
id Fully qualified resource ID for the resource. E.g. “/​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​{resourceProviderNamespace}/​{resourceType}/​{resourceName}” string
Optional
name The name of the resource string
Optional
provisioningState Provisioning state of the resource. ProvisioningState_STATUS
Optional
systemData Azure Resource Manager metadata containing createdBy and modifiedBy information. SystemData_STATUS
Optional
type The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts” string
Optional

Replica_Spec

Used by: Replica.

Property Description Type
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. string
Optional
location The geo-location where the resource lives string
Required
operatorSpec The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure ReplicaOperatorSpec
Optional
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 signalrservice.azure.com/SignalR resource genruntime.KnownResourceReference
Required
regionEndpointEnabled Enable or disable the regional endpoint. Default to “Enabled”. When it’s Disabled, new connections will not be routed to this endpoint, however existing connections will not be affected. string
Optional
resourceStopped Stop or start the resource. Default to “false”. When it’s true, the data plane of the resource is shutdown. When it’s false, the data plane of the resource is started. string
Optional
sku The billing information of the resource. ResourceSku
Optional
tags Resource tags. map[string]string
Optional

Replica_STATUS

Used by: Replica.

Property Description Type
conditions The observed state of the resource conditions.Condition[]
Optional
id Fully qualified resource ID for the resource. E.g. “/​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​{resourceProviderNamespace}/​{resourceType}/​{resourceName}” string
Optional
location The geo-location where the resource lives string
Optional
name The name of the resource string
Optional
provisioningState Provisioning state of the resource. ProvisioningState_STATUS
Optional
regionEndpointEnabled Enable or disable the regional endpoint. Default to “Enabled”. When it’s Disabled, new connections will not be routed to this endpoint, however existing connections will not be affected. string
Optional
resourceStopped Stop or start the resource. Default to “false”. When it’s true, the data plane of the resource is shutdown. When it’s false, the data plane of the resource is started. string
Optional
sku The billing information of the resource. ResourceSku_STATUS
Optional
systemData Azure Resource Manager metadata containing createdBy and modifiedBy information. SystemData_STATUS
Optional
tags Resource tags. map[string]string
Optional
type The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts” string
Optional

SignalR_Spec

Used by: SignalR.

Property Description Type
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. string
Optional
cors Cross-Origin Resource Sharing (CORS) settings. SignalRCorsSettings
Optional
disableAadAuth DisableLocalAuth Enable or disable aad auth When set as true, connection with AuthType=aad won’t work. bool
Optional
disableLocalAuth DisableLocalAuth Enable or disable local auth with AccessKey When set as true, connection with AccessKey=xxx won’t work. bool
Optional
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. SignalRFeature[]
Optional
identity A class represent managed identities used for request and response ManagedIdentity
Optional
kind The kind of the service SignalrServiceKind
Optional
liveTraceConfiguration Live trace configuration of a Microsoft.SignalRService resource. LiveTraceConfiguration
Optional
location The geo-location where the resource lives string
Required
networkACLs Network ACLs for the resource SignalRNetworkACLs
Optional
operatorSpec The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure SignalROperatorSpec
Optional
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 genruntime.KnownResourceReference
Required
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. string
Optional
regionEndpointEnabled Enable or disable the regional endpoint. Default to “Enabled”. When it’s Disabled, new connections will not be routed to this endpoint, however existing connections will not be affected. This property is replica specific. Disable the regional endpoint without replica is not allowed. string
Optional
resourceLogConfiguration Resource log configuration of a Microsoft.SignalRService resource. ResourceLogConfiguration
Optional
resourceStopped Stop or start the resource. Default to “False”. When it’s true, the data plane of the resource is shutdown. When it’s false, the data plane of the resource is started. string
Optional
serverless Serverless settings. ServerlessSettings
Optional
sku The billing information of the resource. ResourceSku
Optional
tags Resource tags. map[string]string
Optional
tls TLS settings for the resource SignalRTlsSettings
Optional
upstream The settings for the Upstream when the service is in server-less mode. ServerlessUpstreamSettings
Optional

SignalR_STATUS

Used by: SignalR.

Property Description Type
conditions The observed state of the resource conditions.Condition[]
Optional
cors Cross-Origin Resource Sharing (CORS) settings. SignalRCorsSettings_STATUS
Optional
disableAadAuth DisableLocalAuth Enable or disable aad auth When set as true, connection with AuthType=aad won’t work. bool
Optional
disableLocalAuth DisableLocalAuth Enable or disable local auth with AccessKey When set as true, connection with AccessKey=xxx won’t work. bool
Optional
externalIP The publicly accessible IP of the resource. string
Optional
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. SignalRFeature_STATUS[]
Optional
hostName FQDN of the service instance. string
Optional
hostNamePrefix Deprecated. string
Optional
id Fully qualified resource ID for the resource. E.g. “/​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​{resourceProviderNamespace}/​{resourceType}/​{resourceName}” string
Optional
identity A class represent managed identities used for request and response ManagedIdentity_STATUS
Optional
kind The kind of the service SignalrServiceKind_STATUS
Optional
liveTraceConfiguration Live trace configuration of a Microsoft.SignalRService resource. LiveTraceConfiguration_STATUS
Optional
location The geo-location where the resource lives string
Optional
name The name of the resource string
Optional
networkACLs Network ACLs for the resource SignalRNetworkACLs_STATUS
Optional
privateEndpointConnections Private endpoint connections to the resource. PrivateEndpointConnection_STATUS_SignalR_SubResourceEmbedded[]
Optional
provisioningState Provisioning state of the resource. ProvisioningState_STATUS
Optional
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. string
Optional
publicPort The publicly accessible port of the resource which is designed for browser/client side usage. int
Optional
regionEndpointEnabled Enable or disable the regional endpoint. Default to “Enabled”. When it’s Disabled, new connections will not be routed to this endpoint, however existing connections will not be affected. This property is replica specific. Disable the regional endpoint without replica is not allowed. string
Optional
resourceLogConfiguration Resource log configuration of a Microsoft.SignalRService resource. ResourceLogConfiguration_STATUS
Optional
resourceStopped Stop or start the resource. Default to “False”. When it’s true, the data plane of the resource is shutdown. When it’s false, the data plane of the resource is started. string
Optional
serverless Serverless settings. ServerlessSettings_STATUS
Optional
serverPort The publicly accessible port of the resource which is designed for customer server side usage. int
Optional
sharedPrivateLinkResources The list of shared private link resources. SharedPrivateLinkResource_STATUS_SignalR_SubResourceEmbedded[]
Optional
sku The billing information of the resource. ResourceSku_STATUS
Optional
systemData Azure Resource Manager metadata containing createdBy and modifiedBy information. SystemData_STATUS
Optional
tags Resource tags. map[string]string
Optional
tls TLS settings for the resource SignalRTlsSettings_STATUS
Optional
type The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts” string
Optional
upstream The settings for the Upstream when the service is in server-less mode. ServerlessUpstreamSettings_STATUS
Optional
version Version of the resource. Probably you need the same or higher version of client SDKs. string
Optional

CustomCertificateOperatorSpec

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

Used by: CustomCertificate_Spec.

Property Description Type
configMapExpressions configures where to place operator written dynamic ConfigMaps (created with CEL expressions). core.DestinationExpression[]
Optional
secretExpressions configures where to place operator written dynamic secrets (created with CEL expressions). core.DestinationExpression[]
Optional

CustomDomainOperatorSpec

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

Used by: CustomDomain_Spec.

Property Description Type
configMapExpressions configures where to place operator written dynamic ConfigMaps (created with CEL expressions). core.DestinationExpression[]
Optional
secretExpressions configures where to place operator written dynamic secrets (created with CEL expressions). core.DestinationExpression[]
Optional

LiveTraceConfiguration

Live trace configuration of a Microsoft.SignalRService resource.

Used by: SignalR_Spec.

Property Description Type
categories Gets or sets the list of category configurations. LiveTraceCategory[]
Optional
enabled Indicates whether or not enable live trace. When it’s set to true, live trace client can connect to the service. Otherwise, live trace client can’t connect to the service, so that you are unable to receive any log, no matter what you configure in “categories”. Available values: true, false. Case insensitive. string
Optional

LiveTraceConfiguration_STATUS

Live trace configuration of a Microsoft.SignalRService resource.

Used by: SignalR_STATUS.

Property Description Type
categories Gets or sets the list of category configurations. LiveTraceCategory_STATUS[]
Optional
enabled Indicates whether or not enable live trace. When it’s set to true, live trace client can connect to the service. Otherwise, live trace client can’t connect to the service, so that you are unable to receive any log, no matter what you configure in “categories”. Available values: true, false. Case insensitive. string
Optional

ManagedIdentity

A class represent managed identities used for request and response

Used by: SignalR_Spec.

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

ManagedIdentity_STATUS

A class represent managed identities used for request and response

Used by: SignalR_STATUS.

Property Description Type
principalId Get the principal id for the system assigned identity. Only be used in response. string
Optional
tenantId Get the tenant id for the system assigned identity. Only be used in response string
Optional
type Represents the identity type: systemAssigned, userAssigned, None ManagedIdentityType_STATUS
Optional
userAssignedIdentities Get or set the user assigned identities map[string]UserAssignedIdentityProperty_STATUS
Optional

PrivateEndpointConnection_STATUS_SignalR_SubResourceEmbedded

A private endpoint connection to an azure resource

Used by: SignalR_STATUS.

Property Description Type
id Fully qualified resource ID for the resource. E.g. “/​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​{resourceProviderNamespace}/​{resourceType}/​{resourceName}” string
Optional

ProvisioningState_STATUS

Provisioning state of the resource.

Used by: CustomCertificate_STATUS, CustomDomain_STATUS, Replica_STATUS, and SignalR_STATUS.

Value Description
“Canceled”
“Creating”
“Deleting”
“Failed”
“Moving”
“Running”
“Succeeded”
“Unknown”
“Updating”

ReplicaOperatorSpec

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

Used by: Replica_Spec.

Property Description Type
configMapExpressions configures where to place operator written dynamic ConfigMaps (created with CEL expressions). core.DestinationExpression[]
Optional
secretExpressions configures where to place operator written dynamic secrets (created with CEL expressions). core.DestinationExpression[]
Optional

ResourceLogConfiguration

Resource log configuration of a Microsoft.SignalRService resource.

Used by: SignalR_Spec.

Property Description Type
categories Gets or sets the list of category configurations. ResourceLogCategory[]
Optional

ResourceLogConfiguration_STATUS

Resource log configuration of a Microsoft.SignalRService resource.

Used by: SignalR_STATUS.

Property Description Type
categories Gets or sets the list of category configurations. ResourceLogCategory_STATUS[]
Optional

ResourceReference

Reference to a resource.

Used by: CustomDomain_Spec.

Property Description Type
reference Resource ID. genruntime.ResourceReference
Optional

ResourceReference_STATUS

Reference to a resource.

Used by: CustomDomain_STATUS.

Property Description Type
id Resource ID. string
Optional

ResourceSku

The billing information of the resource.

Used by: Replica_Spec, and SignalR_Spec.

Property Description Type
capacity Optional, integer. The unit count of the resource. 1 for Free_F1/Standard_S1/Premium_P1, 100 for Premium_P2 by default. If present, following values are allowed: Free_F1: 1; Standard_S1: 1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100; Premium_P1: 1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100; Premium_P2: 100,200,300,400,500,600,700,800,900,1000; int
Optional
name The name of the SKU. Required. Allowed values: Standard_S1, Free_F1, Premium_P1, Premium_P2 string
Required
tier Optional tier of this particular SKU. ‘Standard’ or ‘Free’. Basic is deprecated, use Standard instead. SignalRSkuTier
Optional

ResourceSku_STATUS

The billing information of the resource.

Used by: Replica_STATUS, and SignalR_STATUS.

Property Description Type
capacity Optional, integer. The unit count of the resource. 1 for Free_F1/Standard_S1/Premium_P1, 100 for Premium_P2 by default. If present, following values are allowed: Free_F1: 1; Standard_S1: 1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100; Premium_P1: 1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100; Premium_P2: 100,200,300,400,500,600,700,800,900,1000; int
Optional
family Not used. Retained for future use. string
Optional
name The name of the SKU. Required. Allowed values: Standard_S1, Free_F1, Premium_P1, Premium_P2 string
Optional
size Not used. Retained for future use. string
Optional
tier Optional tier of this particular SKU. ‘Standard’ or ‘Free’. Basic is deprecated, use Standard instead. SignalRSkuTier_STATUS
Optional

ServerlessSettings

Serverless settings.

Used by: SignalR_Spec.

Property Description Type
connectionTimeoutInSeconds Gets or sets Client Connection Timeout. Optional to be set. Value in seconds. Default value is 30 seconds. Customer should set the timeout to a shorter period if messages are expected to be sent in shorter intervals, and want the client to disconnect more quickly after the last message is sent. You can set the timeout to a longer period if messages are expected to be sent in longer intervals, and they want to keep the same client connection alive during this session. The service considers the client disconnected if it hasn’t received a message (including keep-alive) in this interval. int
Optional

ServerlessSettings_STATUS

Serverless settings.

Used by: SignalR_STATUS.

Property Description Type
connectionTimeoutInSeconds Gets or sets Client Connection Timeout. Optional to be set. Value in seconds. Default value is 30 seconds. Customer should set the timeout to a shorter period if messages are expected to be sent in shorter intervals, and want the client to disconnect more quickly after the last message is sent. You can set the timeout to a longer period if messages are expected to be sent in longer intervals, and they want to keep the same client connection alive during this session. The service considers the client disconnected if it hasn’t received a message (including keep-alive) in this interval. int
Optional

ServerlessUpstreamSettings

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

Used by: SignalR_Spec.

Property Description Type
templates Gets or sets the list of Upstream URL templates. Order matters, and the first matching template takes effects. UpstreamTemplate[]
Optional

ServerlessUpstreamSettings_STATUS

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

Used by: SignalR_STATUS.

Property Description Type
templates Gets or sets the list of Upstream URL templates. Order matters, and the first matching template takes effects. UpstreamTemplate_STATUS[]
Optional

SharedPrivateLinkResource_STATUS_SignalR_SubResourceEmbedded

Describes a Shared Private Link Resource

Used by: SignalR_STATUS.

Property Description Type
id Fully qualified resource ID for the resource. E.g. “/​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​{resourceProviderNamespace}/​{resourceType}/​{resourceName}” string
Optional

SignalRCorsSettings

Cross-Origin Resource Sharing (CORS) settings.

Used by: SignalR_Spec.

Property Description Type
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. string[]
Optional

SignalRCorsSettings_STATUS

Cross-Origin Resource Sharing (CORS) settings.

Used by: SignalR_STATUS.

Property Description Type
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. string[]
Optional

SignalRFeature

Feature of a resource, which controls the runtime behavior.

Used by: SignalR_Spec.

Property Description Type
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. FeatureFlags
Required
properties Optional properties related to this feature. map[string]string
Optional
value Value of the feature flag. See Azure SignalR service document https://docs.microsoft.com/azure/azure-signalr/ for allowed values. string
Required

SignalRFeature_STATUS

Feature of a resource, which controls the runtime behavior.

Used by: SignalR_STATUS.

Property Description Type
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. FeatureFlags_STATUS
Optional
properties Optional properties related to this feature. map[string]string
Optional
value Value of the feature flag. See Azure SignalR service document https://docs.microsoft.com/azure/azure-signalr/ for allowed values. string
Optional

SignalRNetworkACLs

Network ACLs for the resource

Used by: SignalR_Spec.

Property Description Type
defaultAction Azure Networking ACL Action. ACLAction
Optional
ipRules IP rules for filtering public traffic IPRule[]
Optional
privateEndpoints ACLs for requests from private endpoints PrivateEndpointACL[]
Optional
publicNetwork Network ACL NetworkACL
Optional

SignalRNetworkACLs_STATUS

Network ACLs for the resource

Used by: SignalR_STATUS.

Property Description Type
defaultAction Azure Networking ACL Action. ACLAction_STATUS
Optional
ipRules IP rules for filtering public traffic IPRule_STATUS[]
Optional
privateEndpoints ACLs for requests from private endpoints PrivateEndpointACL_STATUS[]
Optional
publicNetwork Network ACL NetworkACL_STATUS
Optional

SignalROperatorSpec

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

Used by: SignalR_Spec.

Property Description Type
configMapExpressions configures where to place operator written dynamic ConfigMaps (created with CEL expressions). core.DestinationExpression[]
Optional
secretExpressions configures where to place operator written dynamic secrets (created with CEL expressions). core.DestinationExpression[]
Optional
secrets configures where to place Azure generated secrets. SignalROperatorSecrets
Optional

SignalrServiceKind

The kind of the service

Used by: SignalR_Spec.

Value Description
“RawWebSockets”
“SignalR”

SignalrServiceKind_STATUS

The kind of the service

Used by: SignalR_STATUS.

Value Description
“RawWebSockets”
“SignalR”

SignalRTlsSettings

TLS settings for the resource

Used by: SignalR_Spec.

Property Description Type
clientCertEnabled Request client certificate during TLS handshake if enabled. Not supported for free tier. Any input will be ignored for free tier. bool
Optional

SignalRTlsSettings_STATUS

TLS settings for the resource

Used by: SignalR_STATUS.

Property Description Type
clientCertEnabled Request client certificate during TLS handshake if enabled. Not supported for free tier. Any input will be ignored for free tier. bool
Optional

SystemData_STATUS

Metadata pertaining to creation and last modification of the resource.

Used by: CustomCertificate_STATUS, CustomDomain_STATUS, Replica_STATUS, and SignalR_STATUS.

Property Description Type
createdAt The timestamp of resource creation (UTC). string
Optional
createdBy The identity that created the resource. string
Optional
createdByType The type of identity that created the resource. SystemData_CreatedByType_STATUS
Optional
lastModifiedAt The timestamp of resource last modification (UTC) string
Optional
lastModifiedBy The identity that last modified the resource. string
Optional
lastModifiedByType The type of identity that last modified the resource. SystemData_LastModifiedByType_STATUS
Optional

ACLAction

Azure Networking ACL Action.

Used by: IPRule, and SignalRNetworkACLs.

Value Description
“Allow”
“Deny”

ACLAction_STATUS

Azure Networking ACL Action.

Used by: IPRule_STATUS, and SignalRNetworkACLs_STATUS.

Value Description
“Allow”
“Deny”

FeatureFlags

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.

Used by: SignalRFeature.

Value Description
“EnableConnectivityLogs”
“EnableLiveTrace”
“EnableMessagingLogs”
“ServiceMode”

FeatureFlags_STATUS

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.

Used by: SignalRFeature_STATUS.

Value Description
“EnableConnectivityLogs”
“EnableLiveTrace”
“EnableMessagingLogs”
“ServiceMode”

IPRule

An IP rule

Used by: SignalRNetworkACLs.

Property Description Type
action Azure Networking ACL Action. ACLAction
Optional
value An IP or CIDR or ServiceTag string
Optional

IPRule_STATUS

An IP rule

Used by: SignalRNetworkACLs_STATUS.

Property Description Type
action Azure Networking ACL Action. ACLAction_STATUS
Optional
value An IP or CIDR or ServiceTag string
Optional

LiveTraceCategory

Live trace category configuration of a Microsoft.SignalRService resource.

Used by: LiveTraceConfiguration.

Property Description Type
enabled Indicates whether or the live trace category is enabled. Available values: true, false. Case insensitive. string
Optional
name Gets or sets the live trace category’s name. Available values: ConnectivityLogs, MessagingLogs. Case insensitive. string
Optional

LiveTraceCategory_STATUS

Live trace category configuration of a Microsoft.SignalRService resource.

Used by: LiveTraceConfiguration_STATUS.

Property Description Type
enabled Indicates whether or the live trace category is enabled. Available values: true, false. Case insensitive. string
Optional
name Gets or sets the live trace category’s name. Available values: ConnectivityLogs, MessagingLogs. Case insensitive. string
Optional

ManagedIdentityType

Represents the identity type: systemAssigned, userAssigned, None

Used by: ManagedIdentity.

Value Description
“None”
“SystemAssigned”
“UserAssigned”

ManagedIdentityType_STATUS

Represents the identity type: systemAssigned, userAssigned, None

Used by: ManagedIdentity_STATUS.

Value Description
“None”
“SystemAssigned”
“UserAssigned”

NetworkACL

Network ACL

Used by: SignalRNetworkACLs.

Property Description Type
allow Allowed request types. The value can be one or more of: ClientConnection, ServerConnection, RESTAPI. SignalRRequestType[]
Optional
deny Denied request types. The value can be one or more of: ClientConnection, ServerConnection, RESTAPI. SignalRRequestType[]
Optional

NetworkACL_STATUS

Network ACL

Used by: SignalRNetworkACLs_STATUS.

Property Description Type
allow Allowed request types. The value can be one or more of: ClientConnection, ServerConnection, RESTAPI. SignalRRequestType_STATUS[]
Optional
deny Denied request types. The value can be one or more of: ClientConnection, ServerConnection, RESTAPI. SignalRRequestType_STATUS[]
Optional

PrivateEndpointACL

ACL for a private endpoint

Used by: SignalRNetworkACLs.

Property Description Type
allow Allowed request types. The value can be one or more of: ClientConnection, ServerConnection, RESTAPI. SignalRRequestType[]
Optional
deny Denied request types. The value can be one or more of: ClientConnection, ServerConnection, RESTAPI. SignalRRequestType[]
Optional
name Name of the private endpoint connection string
Required

PrivateEndpointACL_STATUS

ACL for a private endpoint

Used by: SignalRNetworkACLs_STATUS.

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

ResourceLogCategory

Resource log category configuration of a Microsoft.SignalRService resource.

Used by: ResourceLogConfiguration.

Property Description Type
enabled Indicates whether or the resource log category is enabled. Available values: true, false. Case insensitive. string
Optional
name Gets or sets the resource log category’s name. Available values: ConnectivityLogs, MessagingLogs. Case insensitive. string
Optional

ResourceLogCategory_STATUS

Resource log category configuration of a Microsoft.SignalRService resource.

Used by: ResourceLogConfiguration_STATUS.

Property Description Type
enabled Indicates whether or the resource log category is enabled. Available values: true, false. Case insensitive. string
Optional
name Gets or sets the resource log category’s name. Available values: ConnectivityLogs, MessagingLogs. Case insensitive. string
Optional

SignalROperatorSecrets

Used by: SignalROperatorSpec.

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

SignalRSkuTier

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

Used by: ResourceSku.

Value Description
“Basic”
“Free”
“Premium”
“Standard”

SignalRSkuTier_STATUS

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

Used by: ResourceSku_STATUS.

Value Description
“Basic”
“Free”
“Premium”
“Standard”

SystemData_CreatedByType_STATUS

Used by: SystemData_STATUS.

Value Description
“Application”
“Key”
“ManagedIdentity”
“User”

SystemData_LastModifiedByType_STATUS

Used by: SystemData_STATUS.

Value Description
“Application”
“Key”
“ManagedIdentity”
“User”

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.

Used by: ServerlessUpstreamSettings.

Property Description Type
auth Upstream auth settings. If not set, no auth is used for upstream messages. UpstreamAuthSettings
Optional
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”. string
Optional
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”. string
Optional
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”. string
Optional
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. string
Required

UpstreamTemplate_STATUS

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.

Used by: ServerlessUpstreamSettings_STATUS.

Property Description Type
auth Upstream auth settings. If not set, no auth is used for upstream messages. UpstreamAuthSettings_STATUS
Optional
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”. string
Optional
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”. string
Optional
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”. string
Optional
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. string
Optional

UserAssignedIdentityDetails

Information about the user assigned identity for the resource

Used by: ManagedIdentity.

Property Description Type
reference genruntime.ResourceReference
Optional

UserAssignedIdentityProperty_STATUS

Properties of user assigned identity.

Used by: ManagedIdentity_STATUS.

Property Description Type
clientId Get the client id for the user assigned identity string
Optional
principalId Get the principal id for the user assigned identity string
Optional

SignalRRequestType

The incoming request type to the service

Used by: NetworkACL, NetworkACL, PrivateEndpointACL, and PrivateEndpointACL.

Value Description
“ClientConnection”
“RESTAPI”
“ServerConnection”
“Trace”

SignalRRequestType_STATUS

The incoming request type to the service

Used by: NetworkACL_STATUS, NetworkACL_STATUS, PrivateEndpointACL_STATUS, and PrivateEndpointACL_STATUS.

Value Description
“ClientConnection”
“RESTAPI”
“ServerConnection”
“Trace”

UpstreamAuthSettings

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

Used by: UpstreamTemplate.

Property Description Type
managedIdentity Managed identity settings for upstream. ManagedIdentitySettings
Optional
type Upstream auth type enum. UpstreamAuthType
Optional

UpstreamAuthSettings_STATUS

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

Used by: UpstreamTemplate_STATUS.

Property Description Type
managedIdentity Managed identity settings for upstream. ManagedIdentitySettings_STATUS
Optional
type Upstream auth type enum. UpstreamAuthType_STATUS
Optional

ManagedIdentitySettings

Managed identity settings for upstream.

Used by: UpstreamAuthSettings.

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

ManagedIdentitySettings_STATUS

Managed identity settings for upstream.

Used by: UpstreamAuthSettings_STATUS.

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

UpstreamAuthType

Upstream auth type enum.

Used by: UpstreamAuthSettings.

Value Description
“ManagedIdentity”
“None”

UpstreamAuthType_STATUS

Upstream auth type enum.

Used by: UpstreamAuthSettings_STATUS.

Value Description
“ManagedIdentity”
“None”