Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native v1
  3. API Docs
  4. signalrservice
  5. getSignalR
These are the docs for Azure Native v1. We recommenend using the latest version, Azure Native v2.
Azure Native v1 v1.104.0 published on Thursday, Jul 6, 2023 by Pulumi
pulumi/pulumi-azure-native

azure-native.signalrservice.getSignalR

Explore with Pulumi AI

azure-native-v1 logo
These are the docs for Azure Native v1. We recommenend using the latest version, Azure Native v2.
Azure Native v1 v1.104.0 published on Thursday, Jul 6, 2023 by Pulumi
pulumi/pulumi-azure-native

    Get the SignalR service and its properties. API Version: 2020-05-01.

    Using getSignalR

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getSignalR(args: GetSignalRArgs, opts?: InvokeOptions): Promise<GetSignalRResult>
function getSignalROutput(args: GetSignalROutputArgs, opts?: InvokeOptions): Output<GetSignalRResult>
    def get_signal_r(resource_group_name: Optional[str] = None,
                 resource_name: Optional[str] = None,
                 opts: Optional[InvokeOptions] = None) -> GetSignalRResult
def get_signal_r_output(resource_group_name: Optional[pulumi.Input[str]] = None,
                 resource_name: Optional[pulumi.Input[str]] = None,
                 opts: Optional[InvokeOptions] = None) -> Output[GetSignalRResult]
    func LookupSignalR(ctx *Context, args *LookupSignalRArgs, opts ...InvokeOption) (*LookupSignalRResult, error)
func LookupSignalROutput(ctx *Context, args *LookupSignalROutputArgs, opts ...InvokeOption) LookupSignalRResultOutput

    > Note: This function is named LookupSignalR in the Go SDK.

    public static class GetSignalR 
{
    public static Task<GetSignalRResult> InvokeAsync(GetSignalRArgs args, InvokeOptions? opts = null)
    public static Output<GetSignalRResult> Invoke(GetSignalRInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetSignalRResult> getSignalR(GetSignalRArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

    fn::invoke:
  function: azure-native:signalrservice:getSignalR
  arguments:
    # arguments dictionary

    The following arguments are supported:

    ResourceGroupName string
    The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
    ResourceName string
    The name of the SignalR resource.
    ResourceGroupName string
    The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
    ResourceName string
    The name of the SignalR resource.
    resourceGroupName String
    The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
    resourceName String
    The name of the SignalR resource.
    resourceGroupName string
    The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
    resourceName string
    The name of the SignalR resource.
    resource_group_name str
    The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
    resource_name str
    The name of the SignalR resource.
    resourceGroupName String
    The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
    resourceName String
    The name of the SignalR resource.

    getSignalR Result

    The following output properties are available:

    ExternalIP string
    The publicly accessible IP of the SignalR service.
    HostName string
    FQDN of the SignalR service instance. Format: xxx.service.signalr.net
    HostNamePrefix string
    Prefix for the hostName of the SignalR service. Retained for future use. The hostname will be of format: <hostNamePrefix>.service.signalr.net.
    Id string
    Fully qualified resource Id for the resource.
    Name string
    The name of the resource.
    PrivateEndpointConnections List<Pulumi.AzureNative.SignalRService.Outputs.PrivateEndpointConnectionResponse>
    Private endpoint connections to the SignalR resource.
    ProvisioningState string
    Provisioning state of the resource.
    PublicPort int
    The publicly accessible port of the SignalR service which is designed for browser/client side usage.
    ServerPort int
    The publicly accessible port of the SignalR service which is designed for customer server side usage.
    Type string
    The type of the resource - e.g. "Microsoft.SignalRService/SignalR"
    Version string
    Version of the SignalR resource. Probably you need the same or higher version of client SDKs.
    Cors Pulumi.AzureNative.SignalRService.Outputs.SignalRCorsSettingsResponse
    Cross-Origin Resource Sharing (CORS) settings.
    Features List<Pulumi.AzureNative.SignalRService.Outputs.SignalRFeatureResponse>

    List of SignalR featureFlags. e.g. ServiceMode.

    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, SignalR service will use its globally default value. But keep in mind, the default value doesn't mean "false". It varies in terms of different FeatureFlags.

    Kind string
    The kind of the service - e.g. "SignalR", or "RawWebSockets" for "Microsoft.SignalRService/SignalR"
    Location string
    The GEO location of the SignalR service. e.g. West US | East US | North Central US | South Central US.
    NetworkACLs Pulumi.AzureNative.SignalRService.Outputs.SignalRNetworkACLsResponse
    Network ACLs
    Sku Pulumi.AzureNative.SignalRService.Outputs.ResourceSkuResponse
    The billing information of the resource.(e.g. Free, Standard)
    Tags Dictionary<string, string>
    Tags of the service which is a list of key value pairs that describe the resource.
    Upstream Pulumi.AzureNative.SignalRService.Outputs.ServerlessUpstreamSettingsResponse
    Upstream settings when the Azure SignalR is in server-less mode.
    ExternalIP string
    The publicly accessible IP of the SignalR service.
    HostName string
    FQDN of the SignalR service instance. Format: xxx.service.signalr.net
    HostNamePrefix string
    Prefix for the hostName of the SignalR service. Retained for future use. The hostname will be of format: <hostNamePrefix>.service.signalr.net.
    Id string
    Fully qualified resource Id for the resource.
    Name string
    The name of the resource.
    PrivateEndpointConnections []PrivateEndpointConnectionResponse
    Private endpoint connections to the SignalR resource.
    ProvisioningState string
    Provisioning state of the resource.
    PublicPort int
    The publicly accessible port of the SignalR service which is designed for browser/client side usage.
    ServerPort int
    The publicly accessible port of the SignalR service which is designed for customer server side usage.
    Type string
    The type of the resource - e.g. "Microsoft.SignalRService/SignalR"
    Version string
    Version of the SignalR resource. Probably you need the same or higher version of client SDKs.
    Cors SignalRCorsSettingsResponse
    Cross-Origin Resource Sharing (CORS) settings.
    Features []SignalRFeatureResponse

    List of SignalR featureFlags. e.g. ServiceMode.

    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, SignalR service will use its globally default value. But keep in mind, the default value doesn't mean "false". It varies in terms of different FeatureFlags.

    Kind string
    The kind of the service - e.g. "SignalR", or "RawWebSockets" for "Microsoft.SignalRService/SignalR"
    Location string
    The GEO location of the SignalR service. e.g. West US | East US | North Central US | South Central US.
    NetworkACLs SignalRNetworkACLsResponse
    Network ACLs
    Sku ResourceSkuResponse
    The billing information of the resource.(e.g. Free, Standard)
    Tags map[string]string
    Tags of the service which is a list of key value pairs that describe the resource.
    Upstream ServerlessUpstreamSettingsResponse
    Upstream settings when the Azure SignalR is in server-less mode.
    externalIP String
    The publicly accessible IP of the SignalR service.
    hostName String
    FQDN of the SignalR service instance. Format: xxx.service.signalr.net
    hostNamePrefix String
    Prefix for the hostName of the SignalR service. Retained for future use. The hostname will be of format: <hostNamePrefix>.service.signalr.net.
    id String
    Fully qualified resource Id for the resource.
    name String
    The name of the resource.
    privateEndpointConnections List<PrivateEndpointConnectionResponse>
    Private endpoint connections to the SignalR resource.
    provisioningState String
    Provisioning state of the resource.
    publicPort Integer
    The publicly accessible port of the SignalR service which is designed for browser/client side usage.
    serverPort Integer
    The publicly accessible port of the SignalR service which is designed for customer server side usage.
    type String
    The type of the resource - e.g. "Microsoft.SignalRService/SignalR"
    version String
    Version of the SignalR resource. Probably you need the same or higher version of client SDKs.
    cors SignalRCorsSettingsResponse
    Cross-Origin Resource Sharing (CORS) settings.
    features List<SignalRFeatureResponse>

    List of SignalR featureFlags. e.g. ServiceMode.

    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, SignalR service will use its globally default value. But keep in mind, the default value doesn't mean "false". It varies in terms of different FeatureFlags.

    kind String
    The kind of the service - e.g. "SignalR", or "RawWebSockets" for "Microsoft.SignalRService/SignalR"
    location String
    The GEO location of the SignalR service. e.g. West US | East US | North Central US | South Central US.
    networkACLs SignalRNetworkACLsResponse
    Network ACLs
    sku ResourceSkuResponse
    The billing information of the resource.(e.g. Free, Standard)
    tags Map<String,String>
    Tags of the service which is a list of key value pairs that describe the resource.
    upstream ServerlessUpstreamSettingsResponse
    Upstream settings when the Azure SignalR is in server-less mode.
    externalIP string
    The publicly accessible IP of the SignalR service.
    hostName string
    FQDN of the SignalR service instance. Format: xxx.service.signalr.net
    hostNamePrefix string
    Prefix for the hostName of the SignalR service. Retained for future use. The hostname will be of format: <hostNamePrefix>.service.signalr.net.
    id string
    Fully qualified resource Id for the resource.
    name string
    The name of the resource.
    privateEndpointConnections PrivateEndpointConnectionResponse[]
    Private endpoint connections to the SignalR resource.
    provisioningState string
    Provisioning state of the resource.
    publicPort number
    The publicly accessible port of the SignalR service which is designed for browser/client side usage.
    serverPort number
    The publicly accessible port of the SignalR service which is designed for customer server side usage.
    type string
    The type of the resource - e.g. "Microsoft.SignalRService/SignalR"
    version string
    Version of the SignalR resource. Probably you need the same or higher version of client SDKs.
    cors SignalRCorsSettingsResponse
    Cross-Origin Resource Sharing (CORS) settings.
    features SignalRFeatureResponse[]

    List of SignalR featureFlags. e.g. ServiceMode.

    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, SignalR service will use its globally default value. But keep in mind, the default value doesn't mean "false". It varies in terms of different FeatureFlags.

    kind string
    The kind of the service - e.g. "SignalR", or "RawWebSockets" for "Microsoft.SignalRService/SignalR"
    location string
    The GEO location of the SignalR service. e.g. West US | East US | North Central US | South Central US.
    networkACLs SignalRNetworkACLsResponse
    Network ACLs
    sku ResourceSkuResponse
    The billing information of the resource.(e.g. Free, Standard)
    tags {[key: string]: string}
    Tags of the service which is a list of key value pairs that describe the resource.
    upstream ServerlessUpstreamSettingsResponse
    Upstream settings when the Azure SignalR is in server-less mode.
    external_ip str
    The publicly accessible IP of the SignalR service.
    host_name str
    FQDN of the SignalR service instance. Format: xxx.service.signalr.net
    host_name_prefix str
    Prefix for the hostName of the SignalR service. Retained for future use. The hostname will be of format: <hostNamePrefix>.service.signalr.net.
    id str
    Fully qualified resource Id for the resource.
    name str
    The name of the resource.
    private_endpoint_connections Sequence[PrivateEndpointConnectionResponse]
    Private endpoint connections to the SignalR resource.
    provisioning_state str
    Provisioning state of the resource.
    public_port int
    The publicly accessible port of the SignalR service which is designed for browser/client side usage.
    server_port int
    The publicly accessible port of the SignalR service which is designed for customer server side usage.
    type str
    The type of the resource - e.g. "Microsoft.SignalRService/SignalR"
    version str
    Version of the SignalR resource. Probably you need the same or higher version of client SDKs.
    cors SignalRCorsSettingsResponse
    Cross-Origin Resource Sharing (CORS) settings.
    features Sequence[SignalRFeatureResponse]

    List of SignalR featureFlags. e.g. ServiceMode.

    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, SignalR service will use its globally default value. But keep in mind, the default value doesn't mean "false". It varies in terms of different FeatureFlags.

    kind str
    The kind of the service - e.g. "SignalR", or "RawWebSockets" for "Microsoft.SignalRService/SignalR"
    location str
    The GEO location of the SignalR service. e.g. West US | East US | North Central US | South Central US.
    network_acls SignalRNetworkACLsResponse
    Network ACLs
    sku ResourceSkuResponse
    The billing information of the resource.(e.g. Free, Standard)
    tags Mapping[str, str]
    Tags of the service which is a list of key value pairs that describe the resource.
    upstream ServerlessUpstreamSettingsResponse
    Upstream settings when the Azure SignalR is in server-less mode.
    externalIP String
    The publicly accessible IP of the SignalR service.
    hostName String
    FQDN of the SignalR service instance. Format: xxx.service.signalr.net
    hostNamePrefix String
    Prefix for the hostName of the SignalR service. Retained for future use. The hostname will be of format: <hostNamePrefix>.service.signalr.net.
    id String
    Fully qualified resource Id for the resource.
    name String
    The name of the resource.
    privateEndpointConnections List<Property Map>
    Private endpoint connections to the SignalR resource.
    provisioningState String
    Provisioning state of the resource.
    publicPort Number
    The publicly accessible port of the SignalR service which is designed for browser/client side usage.
    serverPort Number
    The publicly accessible port of the SignalR service which is designed for customer server side usage.
    type String
    The type of the resource - e.g. "Microsoft.SignalRService/SignalR"
    version String
    Version of the SignalR resource. Probably you need the same or higher version of client SDKs.
    cors Property Map
    Cross-Origin Resource Sharing (CORS) settings.
    features List<Property Map>

    List of SignalR featureFlags. e.g. ServiceMode.

    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, SignalR service will use its globally default value. But keep in mind, the default value doesn't mean "false". It varies in terms of different FeatureFlags.

    kind String
    The kind of the service - e.g. "SignalR", or "RawWebSockets" for "Microsoft.SignalRService/SignalR"
    location String
    The GEO location of the SignalR service. e.g. West US | East US | North Central US | South Central US.
    networkACLs Property Map
    Network ACLs
    sku Property Map
    The billing information of the resource.(e.g. Free, Standard)
    tags Map<String>
    Tags of the service which is a list of key value pairs that describe the resource.
    upstream Property Map
    Upstream settings when the Azure SignalR is in server-less mode.

    Supporting Types

    NetworkACLResponse

    Allow List<string>
    Allowed request types. The value can be one or more of: ClientConnection, ServerConnection, RESTAPI.
    Deny List<string>
    Denied request types. The value can be one or more of: ClientConnection, ServerConnection, RESTAPI.
    Allow []string
    Allowed request types. The value can be one or more of: ClientConnection, ServerConnection, RESTAPI.
    Deny []string
    Denied request types. The value can be one or more of: ClientConnection, ServerConnection, RESTAPI.
    allow List<String>
    Allowed request types. The value can be one or more of: ClientConnection, ServerConnection, RESTAPI.
    deny List<String>
    Denied request types. The value can be one or more of: ClientConnection, ServerConnection, RESTAPI.
    allow string[]
    Allowed request types. The value can be one or more of: ClientConnection, ServerConnection, RESTAPI.
    deny string[]
    Denied request types. The value can be one or more of: ClientConnection, ServerConnection, RESTAPI.
    allow Sequence[str]
    Allowed request types. The value can be one or more of: ClientConnection, ServerConnection, RESTAPI.
    deny Sequence[str]
    Denied request types. The value can be one or more of: ClientConnection, ServerConnection, RESTAPI.
    allow List<String>
    Allowed request types. The value can be one or more of: ClientConnection, ServerConnection, RESTAPI.
    deny List<String>
    Denied request types. The value can be one or more of: ClientConnection, ServerConnection, RESTAPI.

    PrivateEndpointACLResponse

    Name string
    Name of the private endpoint connection
    Allow List<string>
    Allowed request types. The value can be one or more of: ClientConnection, ServerConnection, RESTAPI.
    Deny List<string>
    Denied request types. The value can be one or more of: ClientConnection, ServerConnection, RESTAPI.
    Name string
    Name of the private endpoint connection
    Allow []string
    Allowed request types. The value can be one or more of: ClientConnection, ServerConnection, RESTAPI.
    Deny []string
    Denied request types. The value can be one or more of: ClientConnection, ServerConnection, RESTAPI.
    name String
    Name of the private endpoint connection
    allow List<String>
    Allowed request types. The value can be one or more of: ClientConnection, ServerConnection, RESTAPI.
    deny List<String>
    Denied request types. The value can be one or more of: ClientConnection, ServerConnection, RESTAPI.
    name string
    Name of the private endpoint connection
    allow string[]
    Allowed request types. The value can be one or more of: ClientConnection, ServerConnection, RESTAPI.
    deny string[]
    Denied request types. The value can be one or more of: ClientConnection, ServerConnection, RESTAPI.
    name str
    Name of the private endpoint connection
    allow Sequence[str]
    Allowed request types. The value can be one or more of: ClientConnection, ServerConnection, RESTAPI.
    deny Sequence[str]
    Denied request types. The value can be one or more of: ClientConnection, ServerConnection, RESTAPI.
    name String
    Name of the private endpoint connection
    allow List<String>
    Allowed request types. The value can be one or more of: ClientConnection, ServerConnection, RESTAPI.
    deny List<String>
    Denied request types. The value can be one or more of: ClientConnection, ServerConnection, RESTAPI.

    PrivateEndpointConnectionResponse

    Id string
    Fully qualified resource Id for the resource.
    Name string
    The name of the resource.
    ProvisioningState string
    Provisioning state of the private endpoint connection
    Type string
    The type of the resource - e.g. "Microsoft.SignalRService/SignalR"
    PrivateEndpoint Pulumi.AzureNative.SignalRService.Inputs.PrivateEndpointResponse
    Private endpoint associated with the private endpoint connection
    PrivateLinkServiceConnectionState Pulumi.AzureNative.SignalRService.Inputs.PrivateLinkServiceConnectionStateResponse
    Connection state
    Id string
    Fully qualified resource Id for the resource.
    Name string
    The name of the resource.
    ProvisioningState string
    Provisioning state of the private endpoint connection
    Type string
    The type of the resource - e.g. "Microsoft.SignalRService/SignalR"
    PrivateEndpoint PrivateEndpointResponse
    Private endpoint associated with the private endpoint connection
    PrivateLinkServiceConnectionState PrivateLinkServiceConnectionStateResponse
    Connection state
    id String
    Fully qualified resource Id for the resource.
    name String
    The name of the resource.
    provisioningState String
    Provisioning state of the private endpoint connection
    type String
    The type of the resource - e.g. "Microsoft.SignalRService/SignalR"
    privateEndpoint PrivateEndpointResponse
    Private endpoint associated with the private endpoint connection
    privateLinkServiceConnectionState PrivateLinkServiceConnectionStateResponse
    Connection state
    id string
    Fully qualified resource Id for the resource.
    name string
    The name of the resource.
    provisioningState string
    Provisioning state of the private endpoint connection
    type string
    The type of the resource - e.g. "Microsoft.SignalRService/SignalR"
    privateEndpoint PrivateEndpointResponse
    Private endpoint associated with the private endpoint connection
    privateLinkServiceConnectionState PrivateLinkServiceConnectionStateResponse
    Connection state
    id str
    Fully qualified resource Id for the resource.
    name str
    The name of the resource.
    provisioning_state str
    Provisioning state of the private endpoint connection
    type str
    The type of the resource - e.g. "Microsoft.SignalRService/SignalR"
    private_endpoint PrivateEndpointResponse
    Private endpoint associated with the private endpoint connection
    private_link_service_connection_state PrivateLinkServiceConnectionStateResponse
    Connection state
    id String
    Fully qualified resource Id for the resource.
    name String
    The name of the resource.
    provisioningState String
    Provisioning state of the private endpoint connection
    type String
    The type of the resource - e.g. "Microsoft.SignalRService/SignalR"
    privateEndpoint Property Map
    Private endpoint associated with the private endpoint connection
    privateLinkServiceConnectionState Property Map
    Connection state

    PrivateEndpointResponse

    Id string
    Full qualified Id of the private endpoint
    Id string
    Full qualified Id of the private endpoint
    id String
    Full qualified Id of the private endpoint
    id string
    Full qualified Id of the private endpoint
    id str
    Full qualified Id of the private endpoint
    id String
    Full qualified Id of the private endpoint

    PrivateLinkServiceConnectionStateResponse

    ActionsRequired string
    A message indicating if changes on the service provider require any updates on the consumer.
    Description string
    The reason for approval/rejection of the connection.
    Status string
    Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.
    ActionsRequired string
    A message indicating if changes on the service provider require any updates on the consumer.
    Description string
    The reason for approval/rejection of the connection.
    Status string
    Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.
    actionsRequired String
    A message indicating if changes on the service provider require any updates on the consumer.
    description String
    The reason for approval/rejection of the connection.
    status String
    Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.
    actionsRequired string
    A message indicating if changes on the service provider require any updates on the consumer.
    description string
    The reason for approval/rejection of the connection.
    status string
    Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.
    actions_required str
    A message indicating if changes on the service provider require any updates on the consumer.
    description str
    The reason for approval/rejection of the connection.
    status str
    Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.
    actionsRequired String
    A message indicating if changes on the service provider require any updates on the consumer.
    description String
    The reason for approval/rejection of the connection.
    status String
    Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.

    ResourceSkuResponse

    Family string
    Not used. Retained for future use.
    Name string

    The name of the SKU. Required.

    Allowed values: Standard_S1, Free_F1

    Size string
    Not used. Retained for future use.
    Capacity int

    Optional, integer. The unit count of SignalR resource. 1 by default.

    If present, following values are allowed: Free: 1 Standard: 1,2,5,10,20,50,100

    Tier string

    Optional tier of this particular SKU. 'Standard' or 'Free'.

    Basic is deprecated, use Standard instead.

    Family string
    Not used. Retained for future use.
    Name string

    The name of the SKU. Required.

    Allowed values: Standard_S1, Free_F1

    Size string
    Not used. Retained for future use.
    Capacity int

    Optional, integer. The unit count of SignalR resource. 1 by default.

    If present, following values are allowed: Free: 1 Standard: 1,2,5,10,20,50,100

    Tier string

    Optional tier of this particular SKU. 'Standard' or 'Free'.

    Basic is deprecated, use Standard instead.

    family String
    Not used. Retained for future use.
    name String

    The name of the SKU. Required.

    Allowed values: Standard_S1, Free_F1

    size String
    Not used. Retained for future use.
    capacity Integer

    Optional, integer. The unit count of SignalR resource. 1 by default.

    If present, following values are allowed: Free: 1 Standard: 1,2,5,10,20,50,100

    tier String

    Optional tier of this particular SKU. 'Standard' or 'Free'.

    Basic is deprecated, use Standard instead.

    family string
    Not used. Retained for future use.
    name string

    The name of the SKU. Required.

    Allowed values: Standard_S1, Free_F1

    size string
    Not used. Retained for future use.
    capacity number

    Optional, integer. The unit count of SignalR resource. 1 by default.

    If present, following values are allowed: Free: 1 Standard: 1,2,5,10,20,50,100

    tier string

    Optional tier of this particular SKU. 'Standard' or 'Free'.

    Basic is deprecated, use Standard instead.

    family str
    Not used. Retained for future use.
    name str

    The name of the SKU. Required.

    Allowed values: Standard_S1, Free_F1

    size str
    Not used. Retained for future use.
    capacity int

    Optional, integer. The unit count of SignalR resource. 1 by default.

    If present, following values are allowed: Free: 1 Standard: 1,2,5,10,20,50,100

    tier str

    Optional tier of this particular SKU. 'Standard' or 'Free'.

    Basic is deprecated, use Standard instead.

    family String
    Not used. Retained for future use.
    name String

    The name of the SKU. Required.

    Allowed values: Standard_S1, Free_F1

    size String
    Not used. Retained for future use.
    capacity Number

    Optional, integer. The unit count of SignalR resource. 1 by default.

    If present, following values are allowed: Free: 1 Standard: 1,2,5,10,20,50,100

    tier String

    Optional tier of this particular SKU. 'Standard' or 'Free'.

    Basic is deprecated, use Standard instead.

    ServerlessUpstreamSettingsResponse

    Templates List<Pulumi.AzureNative.SignalRService.Inputs.UpstreamTemplateResponse>
    Gets or sets the list of Upstream URL templates. Order matters, and the first matching template takes effects.
    Templates []UpstreamTemplateResponse
    Gets or sets the list of Upstream URL templates. Order matters, and the first matching template takes effects.
    templates List<UpstreamTemplateResponse>
    Gets or sets the list of Upstream URL templates. Order matters, and the first matching template takes effects.
    templates UpstreamTemplateResponse[]
    Gets or sets the list of Upstream URL templates. Order matters, and the first matching template takes effects.
    templates Sequence[UpstreamTemplateResponse]
    Gets or sets the list of Upstream URL templates. Order matters, and the first matching template takes effects.
    templates List<Property Map>
    Gets or sets the list of Upstream URL templates. Order matters, and the first matching template takes effects.

    SignalRCorsSettingsResponse

    AllowedOrigins List<string>
    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.
    AllowedOrigins []string
    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.
    allowedOrigins List<String>
    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.
    allowedOrigins string[]
    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.
    allowed_origins Sequence[str]
    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.
    allowedOrigins List<String>
    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.

    SignalRFeatureResponse

    Flag string
    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.
    Value string
    Value of the feature flag. See Azure SignalR service document https://docs.microsoft.com/azure/azure-signalr/ for allowed values.
    Properties Dictionary<string, string>
    Optional properties related to this feature.
    Flag string
    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.
    Value string
    Value of the feature flag. See Azure SignalR service document https://docs.microsoft.com/azure/azure-signalr/ for allowed values.
    Properties map[string]string
    Optional properties related to this feature.
    flag String
    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.
    value String
    Value of the feature flag. See Azure SignalR service document https://docs.microsoft.com/azure/azure-signalr/ for allowed values.
    properties Map<String,String>
    Optional properties related to this feature.
    flag string
    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.
    value string
    Value of the feature flag. See Azure SignalR service document https://docs.microsoft.com/azure/azure-signalr/ for allowed values.
    properties {[key: string]: string}
    Optional properties related to this feature.
    flag str
    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.
    value str
    Value of the feature flag. See Azure SignalR service document https://docs.microsoft.com/azure/azure-signalr/ for allowed values.
    properties Mapping[str, str]
    Optional properties related to this feature.
    flag String
    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.
    value String
    Value of the feature flag. See Azure SignalR service document https://docs.microsoft.com/azure/azure-signalr/ for allowed values.
    properties Map<String>
    Optional properties related to this feature.

    SignalRNetworkACLsResponse

    DefaultAction string
    Default action when no other rule matches
    PrivateEndpoints List<Pulumi.AzureNative.SignalRService.Inputs.PrivateEndpointACLResponse>
    ACLs for requests from private endpoints
    PublicNetwork Pulumi.AzureNative.SignalRService.Inputs.NetworkACLResponse
    ACL for requests from public network
    DefaultAction string
    Default action when no other rule matches
    PrivateEndpoints []PrivateEndpointACLResponse
    ACLs for requests from private endpoints
    PublicNetwork NetworkACLResponse
    ACL for requests from public network
    defaultAction String
    Default action when no other rule matches
    privateEndpoints List<PrivateEndpointACLResponse>
    ACLs for requests from private endpoints
    publicNetwork NetworkACLResponse
    ACL for requests from public network
    defaultAction string
    Default action when no other rule matches
    privateEndpoints PrivateEndpointACLResponse[]
    ACLs for requests from private endpoints
    publicNetwork NetworkACLResponse
    ACL for requests from public network
    default_action str
    Default action when no other rule matches
    private_endpoints Sequence[PrivateEndpointACLResponse]
    ACLs for requests from private endpoints
    public_network NetworkACLResponse
    ACL for requests from public network
    defaultAction String
    Default action when no other rule matches
    privateEndpoints List<Property Map>
    ACLs for requests from private endpoints
    publicNetwork Property Map
    ACL for requests from public network

    UpstreamTemplateResponse

    UrlTemplate string
    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.
    CategoryPattern string
    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
    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
    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
    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.
    CategoryPattern string
    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
    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
    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
    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.
    categoryPattern String
    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
    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
    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
    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.
    categoryPattern string
    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
    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
    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"
    url_template str
    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.
    category_pattern str
    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"
    event_pattern str
    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"
    hub_pattern str
    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
    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.
    categoryPattern String
    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
    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
    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"

    Package Details

    Repository
    azure-native-v1 pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native-v1 logo
    These are the docs for Azure Native v1. We recommenend using the latest version, Azure Native v2.
    Azure Native v1 v1.104.0 published on Thursday, Jul 6, 2023 by Pulumi
    pulumi/pulumi-azure-native