signalrservice.azure.com/v1beta20211001

signalrservice.azure.com/v1beta20211001

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

Resource Types:

    ACLAction_Status (string alias)

    (Appears on:SignalRNetworkACLs_Status, SignalRNetworkACLs_StatusARM)

    Value Description

    "Allow"

    "Deny"

    FeatureFlags_Status (string alias)

    (Appears on:SignalRFeature_Status, SignalRFeature_StatusARM)

    Value Description

    "EnableConnectivityLogs"

    "EnableLiveTrace"

    "EnableMessagingLogs"

    "ServiceMode"

    ManagedIdentity

    (Appears on:SignalR_Spec)

    Field Description
    type
    ManagedIdentityType
    userAssignedIdentities
    map[string]k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1.JSON

    UserAssignedIdentities: Get or set the user assigned identities

    ManagedIdentityARM

    (Appears on:SignalR_SpecARM)

    Field Description
    type
    ManagedIdentityType
    userAssignedIdentities
    map[string]k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1.JSON

    UserAssignedIdentities: Get or set the user assigned identities

    ManagedIdentitySettings

    (Appears on:UpstreamAuthSettings)

    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.

    ManagedIdentitySettingsARM

    (Appears on:UpstreamAuthSettingsARM)

    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)

    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_StatusARM

    (Appears on:UpstreamAuthSettings_StatusARM)

    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, ManagedIdentityARM)

    Value Description

    "None"

    "SystemAssigned"

    "UserAssigned"

    ManagedIdentityType_Status (string alias)

    (Appears on:ManagedIdentity_Status, ManagedIdentity_StatusARM)

    Value Description

    "None"

    "SystemAssigned"

    "UserAssigned"

    ManagedIdentity_Status

    (Appears on:SignalRResource_Status)

    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: Represent the identity type: systemAssigned, userAssigned, None

    userAssignedIdentities
    map[string]./api/signalrservice/v1beta20211001.UserAssignedIdentityProperty_Status

    UserAssignedIdentities: Get or set the user assigned identities

    ManagedIdentity_StatusARM

    (Appears on:SignalRResource_StatusARM)

    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: Represent the identity type: systemAssigned, userAssigned, None

    userAssignedIdentities
    map[string]./api/signalrservice/v1beta20211001.UserAssignedIdentityProperty_StatusARM

    UserAssignedIdentities: Get or set the user assigned identities

    NetworkACL

    (Appears on:SignalRNetworkACLs)

    Field Description
    allow
    []NetworkACLAllow

    Allow: Allowed request types. The value can be one or more of: ClientConnection, ServerConnection, RESTAPI.

    deny
    []NetworkACLDeny

    Deny: Denied request types. The value can be one or more of: ClientConnection, ServerConnection, RESTAPI.

    NetworkACLARM

    (Appears on:SignalRNetworkACLsARM)

    Field Description
    allow
    []NetworkACLAllow

    Allow: Allowed request types. The value can be one or more of: ClientConnection, ServerConnection, RESTAPI.

    deny
    []NetworkACLDeny

    Deny: Denied request types. The value can be one or more of: ClientConnection, ServerConnection, RESTAPI.

    NetworkACLAllow (string alias)

    (Appears on:NetworkACL, NetworkACLARM)

    Value Description

    "ClientConnection"

    "RESTAPI"

    "ServerConnection"

    "Trace"

    NetworkACLDeny (string alias)

    (Appears on:NetworkACL, NetworkACLARM)

    Value Description

    "ClientConnection"

    "RESTAPI"

    "ServerConnection"

    "Trace"

    NetworkACL_Status

    (Appears on:SignalRNetworkACLs_Status)

    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.

    NetworkACL_StatusARM

    (Appears on:SignalRNetworkACLs_StatusARM)

    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)

    Field Description
    allow
    []PrivateEndpointACLAllow

    Allow: Allowed request types. The value can be one or more of: ClientConnection, ServerConnection, RESTAPI.

    deny
    []PrivateEndpointACLDeny

    Deny: Denied request types. The value can be one or more of: ClientConnection, ServerConnection, RESTAPI.

    name
    string

    Name: Name of the private endpoint connection

    PrivateEndpointACLARM

    (Appears on:SignalRNetworkACLsARM)

    Field Description
    allow
    []PrivateEndpointACLAllow

    Allow: Allowed request types. The value can be one or more of: ClientConnection, ServerConnection, RESTAPI.

    deny
    []PrivateEndpointACLDeny

    Deny: Denied request types. The value can be one or more of: ClientConnection, ServerConnection, RESTAPI.

    name
    string

    Name: Name of the private endpoint connection

    PrivateEndpointACLAllow (string alias)

    (Appears on:PrivateEndpointACL, PrivateEndpointACLARM)

    Value Description

    "ClientConnection"

    "RESTAPI"

    "ServerConnection"

    "Trace"

    PrivateEndpointACLDeny (string alias)

    (Appears on:PrivateEndpointACL, PrivateEndpointACLARM)

    Value Description

    "ClientConnection"

    "RESTAPI"

    "ServerConnection"

    "Trace"

    PrivateEndpointACL_Status

    (Appears on:SignalRNetworkACLs_Status)

    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

    PrivateEndpointACL_StatusARM

    (Appears on:SignalRNetworkACLs_StatusARM)

    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:SignalRResource_Status)

    Field Description
    id
    string

    Id: Fully qualified resource Id for the resource.

    systemData
    SystemData_Status

    SystemData: Metadata pertaining to creation and last modification of the resource.

    PrivateEndpointConnection_Status_SignalR_SubResourceEmbeddedARM

    (Appears on:SignalRProperties_StatusARM)

    Field Description
    id
    string

    Id: Fully qualified resource Id for the resource.

    systemData
    SystemData_StatusARM

    SystemData: Metadata pertaining to creation and last modification of the resource.

    ProvisioningState_Status (string alias)

    (Appears on:SignalRProperties_StatusARM, SignalRResource_Status)

    Value Description

    "Canceled"

    "Creating"

    "Deleting"

    "Failed"

    "Moving"

    "Running"

    "Succeeded"

    "Unknown"

    "Updating"

    ResourceLogCategory

    (Appears on:ResourceLogConfiguration)

    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.

    ResourceLogCategoryARM

    (Appears on:ResourceLogConfigurationARM)

    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)

    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_StatusARM

    (Appears on:ResourceLogConfiguration_StatusARM)

    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)

    Field Description
    categories
    []ResourceLogCategory

    Categories: Gets or sets the list of category configurations.

    ResourceLogConfigurationARM

    (Appears on:SignalRPropertiesARM)

    Field Description
    categories
    []ResourceLogCategoryARM

    Categories: Gets or sets the list of category configurations.

    ResourceLogConfiguration_Status

    (Appears on:SignalRResource_Status)

    Field Description
    categories
    []ResourceLogCategory_Status

    Categories: Gets or sets the list of category configurations.

    ResourceLogConfiguration_StatusARM

    (Appears on:SignalRProperties_StatusARM)

    Field Description
    categories
    []ResourceLogCategory_StatusARM

    Categories: Gets or sets the list of category configurations.

    ResourceSku

    (Appears on:SignalR_Spec)

    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
    ResourceSkuTier

    ResourceSkuARM

    (Appears on:SignalR_SpecARM)

    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
    ResourceSkuTier

    ResourceSkuTier (string alias)

    (Appears on:ResourceSku, ResourceSkuARM)

    Value Description

    "Basic"

    "Free"

    "Premium"

    "Standard"

    ResourceSku_Status

    (Appears on:SignalRResource_Status)

    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.

    ResourceSku_StatusARM

    (Appears on:SignalRResource_StatusARM)

    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)

    Field Description
    templates
    []UpstreamTemplate

    Templates: Gets or sets the list of Upstream URL templates. Order matters, and the first matching template takes effects.

    ServerlessUpstreamSettingsARM

    (Appears on:SignalRPropertiesARM)

    Field Description
    templates
    []UpstreamTemplateARM

    Templates: Gets or sets the list of Upstream URL templates. Order matters, and the first matching template takes effects.

    ServerlessUpstreamSettings_Status

    (Appears on:SignalRResource_Status)

    Field Description
    templates
    []UpstreamTemplate_Status

    Templates: Gets or sets the list of Upstream URL templates. Order matters, and the first matching template takes effects.

    ServerlessUpstreamSettings_StatusARM

    (Appears on:SignalRProperties_StatusARM)

    Field Description
    templates
    []UpstreamTemplate_StatusARM

    Templates: Gets or sets the list of Upstream URL templates. Order matters, and the first matching template takes effects.

    ServiceKind_Status (string alias)

    (Appears on:SignalRResource_Status, SignalRResource_StatusARM)

    Value Description

    "RawWebSockets"

    "SignalR"

    SharedPrivateLinkResource_Status_SignalR_SubResourceEmbedded

    (Appears on:SignalRResource_Status)

    Field Description
    id
    string

    Id: Fully qualified resource Id for the resource.

    systemData
    SystemData_Status

    SystemData: Metadata pertaining to creation and last modification of the resource.

    SharedPrivateLinkResource_Status_SignalR_SubResourceEmbeddedARM

    (Appears on:SignalRProperties_StatusARM)

    Field Description
    id
    string

    Id: Fully qualified resource Id for the resource.

    systemData
    SystemData_StatusARM

    SystemData: Metadata pertaining to creation and last modification of the resource.

    SignalR

    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
    SignalRSpecKind
    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

    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
    SignalRResource_Status

    SignalRCorsSettings

    (Appears on:SignalR_Spec)

    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.

    SignalRCorsSettingsARM

    (Appears on:SignalRPropertiesARM)

    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:SignalRResource_Status)

    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_StatusARM

    (Appears on:SignalRProperties_StatusARM)

    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)

    Field Description
    flag
    SignalRFeatureFlag
    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.

    SignalRFeatureARM

    (Appears on:SignalRPropertiesARM)

    Field Description
    flag
    SignalRFeatureFlag
    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.

    SignalRFeatureFlag (string alias)

    (Appears on:SignalRFeature, SignalRFeatureARM)

    Value Description

    "EnableConnectivityLogs"

    "EnableLiveTrace"

    "EnableMessagingLogs"

    "ServiceMode"

    SignalRFeature_Status

    (Appears on:SignalRResource_Status)

    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.

    SignalRFeature_StatusARM

    (Appears on:SignalRProperties_StatusARM)

    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)

    Field Description
    defaultAction
    SignalRNetworkACLsDefaultAction
    privateEndpoints
    []PrivateEndpointACL

    PrivateEndpoints: ACLs for requests from private endpoints

    publicNetwork
    NetworkACL

    PublicNetwork: Network ACL

    SignalRNetworkACLsARM

    (Appears on:SignalRPropertiesARM)

    Field Description
    defaultAction
    SignalRNetworkACLsDefaultAction
    privateEndpoints
    []PrivateEndpointACLARM

    PrivateEndpoints: ACLs for requests from private endpoints

    publicNetwork
    NetworkACLARM

    PublicNetwork: Network ACL

    SignalRNetworkACLsDefaultAction (string alias)

    (Appears on:SignalRNetworkACLs, SignalRNetworkACLsARM)

    Value Description

    "Allow"

    "Deny"

    SignalRNetworkACLs_Status

    (Appears on:SignalRResource_Status)

    Field Description
    defaultAction
    ACLAction_Status

    DefaultAction: Default action when no other rule matches

    privateEndpoints
    []PrivateEndpointACL_Status

    PrivateEndpoints: ACLs for requests from private endpoints

    publicNetwork
    NetworkACL_Status

    PublicNetwork: ACL for requests from public network

    SignalRNetworkACLs_StatusARM

    (Appears on:SignalRProperties_StatusARM)

    Field Description
    defaultAction
    ACLAction_Status

    DefaultAction: Default action when no other rule matches

    privateEndpoints
    []PrivateEndpointACL_StatusARM

    PrivateEndpoints: ACLs for requests from private endpoints

    publicNetwork
    NetworkACL_StatusARM

    PublicNetwork: ACL for requests from public network

    SignalRPropertiesARM

    (Appears on:SignalR_SpecARM)

    Field Description
    cors
    SignalRCorsSettingsARM

    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
    []SignalRFeatureARM

    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.

    networkACLs
    SignalRNetworkACLsARM

    NetworkACLs: Network ACLs for 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.

    resourceLogConfiguration
    ResourceLogConfigurationARM

    ResourceLogConfiguration: Resource log configuration of a Microsoft.SignalRService resource.

    tls
    SignalRTlsSettingsARM

    Tls: TLS settings for the resource

    upstream
    ServerlessUpstreamSettingsARM

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

    SignalRProperties_StatusARM

    (Appears on:SignalRResource_StatusARM)

    Field Description
    cors
    SignalRCorsSettings_StatusARM

    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_StatusARM

    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.

    networkACLs
    SignalRNetworkACLs_StatusARM

    NetworkACLs: Network ACLs

    privateEndpointConnections
    []PrivateEndpointConnection_Status_SignalR_SubResourceEmbeddedARM

    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_StatusARM

    ResourceLogConfiguration: Resource log configuration of a Microsoft.SignalRService resource. If resourceLogConfiguration isn’t null or empty, it will override options “EnableConnectivityLog” and “EnableMessagingLogs” in features. Otherwise, use options “EnableConnectivityLog” and “EnableMessagingLogs” in features.

    serverPort
    int

    ServerPort: The publicly accessible port of the resource which is designed for customer server side usage.

    sharedPrivateLinkResources
    []SharedPrivateLinkResource_Status_SignalR_SubResourceEmbeddedARM

    SharedPrivateLinkResources: The list of shared private link resources.

    tls
    SignalRTlsSettings_StatusARM

    Tls: TLS settings.

    upstream
    ServerlessUpstreamSettings_StatusARM

    Upstream: Upstream settings 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.

    SignalRRequestType_Status (string alias)

    (Appears on:NetworkACL_Status, NetworkACL_StatusARM, PrivateEndpointACL_Status, PrivateEndpointACL_StatusARM)

    Value Description

    "ClientConnection"

    "RESTAPI"

    "ServerConnection"

    "Trace"

    SignalRResource_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: The managed identity response

    kind
    ServiceKind_Status

    Kind: The kind of the service - e.g. “SignalR” for “Microsoft.SignalRService/SignalR”

    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

    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. If resourceLogConfiguration isn’t null or empty, it will override options “EnableConnectivityLog” and “EnableMessagingLogs” in features. Otherwise, use options “EnableConnectivityLog” and “EnableMessagingLogs” in features.

    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.(e.g. Free, Standard)

    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.

    type
    string

    Type: The type of the resource - e.g. “Microsoft.SignalRService/SignalR”

    upstream
    ServerlessUpstreamSettings_Status

    Upstream: Upstream settings 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.

    SignalRResource_StatusARM

    Field Description
    id
    string

    Id: Fully qualified resource Id for the resource.

    identity
    ManagedIdentity_StatusARM

    Identity: The managed identity response

    kind
    ServiceKind_Status

    Kind: The kind of the service - e.g. “SignalR” for “Microsoft.SignalRService/SignalR”

    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.

    properties
    SignalRProperties_StatusARM

    Properties: Settings used to provision or configure the resource

    sku
    ResourceSku_StatusARM

    Sku: The billing information of the resource.(e.g. Free, Standard)

    systemData
    SystemData_StatusARM

    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.

    type
    string

    Type: The type of the resource - e.g. “Microsoft.SignalRService/SignalR”

    SignalRSkuTier_Status (string alias)

    (Appears on:ResourceSku_Status, ResourceSku_StatusARM)

    Value Description

    "Basic"

    "Free"

    "Premium"

    "Standard"

    SignalRSpecAPIVersion (string alias)

    Value Description

    "2021-10-01"

    SignalRSpecKind (string alias)

    (Appears on:SignalR_Spec, SignalR_SpecARM)

    Value Description

    "RawWebSockets"

    "SignalR"

    SignalRTlsSettings

    (Appears on:SignalR_Spec)

    Field Description
    clientCertEnabled
    bool

    ClientCertEnabled: Request client certificate during TLS handshake if enabled

    SignalRTlsSettingsARM

    (Appears on:SignalRPropertiesARM)

    Field Description
    clientCertEnabled
    bool

    ClientCertEnabled: Request client certificate during TLS handshake if enabled

    SignalRTlsSettings_Status

    (Appears on:SignalRResource_Status)

    Field Description
    clientCertEnabled
    bool

    ClientCertEnabled: Request client certificate during TLS handshake if enabled

    SignalRTlsSettings_StatusARM

    (Appears on:SignalRProperties_StatusARM)

    Field Description
    clientCertEnabled
    bool

    ClientCertEnabled: Request client certificate during TLS handshake if enabled

    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
    SignalRSpecKind
    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

    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.

    SignalR_SpecARM

    Field Description
    identity
    ManagedIdentityARM

    Identity: A class represent managed identities used for request and response

    kind
    SignalRSpecKind
    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.

    properties
    SignalRPropertiesARM

    Properties: A class that describes the properties of the resource

    sku
    ResourceSkuARM

    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.

    SystemDataStatusCreatedByType (string alias)

    (Appears on:SystemData_Status, SystemData_StatusARM)

    Value Description

    "Application"

    "Key"

    "ManagedIdentity"

    "User"

    SystemDataStatusLastModifiedByType (string alias)

    (Appears on:SystemData_Status, SystemData_StatusARM)

    Value Description

    "Application"

    "Key"

    "ManagedIdentity"

    "User"

    SystemData_Status

    (Appears on:PrivateEndpointConnection_Status_SignalR_SubResourceEmbedded, SharedPrivateLinkResource_Status_SignalR_SubResourceEmbedded, SignalRResource_Status)

    Field Description
    createdAt
    string

    CreatedAt: The timestamp of resource creation (UTC).

    createdBy
    string

    CreatedBy: The identity that created the resource.

    createdByType
    SystemDataStatusCreatedByType

    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
    SystemDataStatusLastModifiedByType

    LastModifiedByType: The type of identity that last modified the resource.

    SystemData_StatusARM

    (Appears on:PrivateEndpointConnection_Status_SignalR_SubResourceEmbeddedARM, SharedPrivateLinkResource_Status_SignalR_SubResourceEmbeddedARM, SignalRResource_StatusARM)

    Field Description
    createdAt
    string

    CreatedAt: The timestamp of resource creation (UTC).

    createdBy
    string

    CreatedBy: The identity that created the resource.

    createdByType
    SystemDataStatusCreatedByType

    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
    SystemDataStatusLastModifiedByType

    LastModifiedByType: The type of identity that last modified the resource.

    UpstreamAuthSettings

    (Appears on:UpstreamTemplate)

    Field Description
    managedIdentity
    ManagedIdentitySettings

    ManagedIdentity: Managed identity settings for upstream.

    type
    UpstreamAuthSettingsType

    UpstreamAuthSettingsARM

    (Appears on:UpstreamTemplateARM)

    Field Description
    managedIdentity
    ManagedIdentitySettingsARM

    ManagedIdentity: Managed identity settings for upstream.

    type
    UpstreamAuthSettingsType

    UpstreamAuthSettingsType (string alias)

    (Appears on:UpstreamAuthSettings, UpstreamAuthSettingsARM)

    Value Description

    "ManagedIdentity"

    "None"

    UpstreamAuthSettings_Status

    (Appears on:UpstreamTemplate_Status)

    Field Description
    managedIdentity
    ManagedIdentitySettings_Status

    ManagedIdentity: Gets or sets the managed identity settings. It’s required if the auth type is set to ManagedIdentity.

    type
    UpstreamAuthType_Status

    Type: Gets or sets the type of auth. None or ManagedIdentity is supported now.

    UpstreamAuthSettings_StatusARM

    (Appears on:UpstreamTemplate_StatusARM)

    Field Description
    managedIdentity
    ManagedIdentitySettings_StatusARM

    ManagedIdentity: Gets or sets the managed identity settings. It’s required if the auth type is set to ManagedIdentity.

    type
    UpstreamAuthType_Status

    Type: Gets or sets the type of auth. None or ManagedIdentity is supported now.

    UpstreamAuthType_Status (string alias)

    (Appears on:UpstreamAuthSettings_Status, UpstreamAuthSettings_StatusARM)

    Value Description

    "ManagedIdentity"

    "None"

    UpstreamTemplate

    (Appears on:ServerlessUpstreamSettings)

    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.

    UpstreamTemplateARM

    (Appears on:ServerlessUpstreamSettingsARM)

    Field Description
    auth
    UpstreamAuthSettingsARM

    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: Gets or sets the auth settings for an upstream. 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_StatusARM

    (Appears on:ServerlessUpstreamSettings_StatusARM)

    Field Description
    auth
    UpstreamAuthSettings_StatusARM

    Auth: Gets or sets the auth settings for an upstream. 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.

    UserAssignedIdentityProperty_Status

    (Appears on:ManagedIdentity_Status)

    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

    UserAssignedIdentityProperty_StatusARM

    (Appears on:ManagedIdentity_StatusARM)

    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