Docs Packages
  1. Packages
  2. Azure Classic
  3. API Docs
  4. signalr
  5. Service

We recommend using Azure Native.

Azure Classic v5.81.0 published on Monday, Jun 24, 2024 by Pulumi
pulumi/pulumi-azure

azure.signalr.Service

Explore with Pulumi AI

azure logo

We recommend using Azure Native.

Azure Classic v5.81.0 published on Monday, Jun 24, 2024 by Pulumi
pulumi/pulumi-azure

    Manages an Azure SignalR service.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const example = new azure.core.ResourceGroup("example", {
    name: "my-signalr",
    location: "West US",
});
const exampleService = new azure.signalr.Service("example", {
    name: "tfex-signalr",
    location: example.location,
    resourceGroupName: example.name,
    sku: {
        name: "Free_F1",
        capacity: 1,
    },
    cors: [{
        allowedOrigins: ["http://www.example.com"],
    }],
    publicNetworkAccessEnabled: false,
    connectivityLogsEnabled: true,
    messagingLogsEnabled: true,
    serviceMode: "Default",
    upstreamEndpoints: [{
        categoryPatterns: [
            "connections",
            "messages",
        ],
        eventPatterns: ["*"],
        hubPatterns: ["hub1"],
        urlTemplate: "http://foo.com",
    }],
});

    import pulumi
import pulumi_azure as azure

example = azure.core.ResourceGroup("example",
    name="my-signalr",
    location="West US")
example_service = azure.signalr.Service("example",
    name="tfex-signalr",
    location=example.location,
    resource_group_name=example.name,
    sku=azure.signalr.ServiceSkuArgs(
        name="Free_F1",
        capacity=1,
    ),
    cors=[azure.signalr.ServiceCorArgs(
        allowed_origins=["http://www.example.com"],
    )],
    public_network_access_enabled=False,
    connectivity_logs_enabled=True,
    messaging_logs_enabled=True,
    service_mode="Default",
    upstream_endpoints=[azure.signalr.ServiceUpstreamEndpointArgs(
        category_patterns=[
            "connections",
            "messages",
        ],
        event_patterns=["*"],
        hub_patterns=["hub1"],
        url_template="http://foo.com",
    )])

    package main

import (
	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/core"
	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/signalr"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := core.NewResourceGroup(ctx, "example", &core.ResourceGroupArgs{
			Name:     pulumi.String("my-signalr"),
			Location: pulumi.String("West US"),
		})
		if err != nil {
			return err
		}
		_, err = signalr.NewService(ctx, "example", &signalr.ServiceArgs{
			Name:              pulumi.String("tfex-signalr"),
			Location:          example.Location,
			ResourceGroupName: example.Name,
			Sku: &signalr.ServiceSkuArgs{
				Name:     pulumi.String("Free_F1"),
				Capacity: pulumi.Int(1),
			},
			Cors: signalr.ServiceCorArray{
				&signalr.ServiceCorArgs{
					AllowedOrigins: pulumi.StringArray{
						pulumi.String("http://www.example.com"),
					},
				},
			},
			PublicNetworkAccessEnabled: pulumi.Bool(false),
			ConnectivityLogsEnabled:    pulumi.Bool(true),
			MessagingLogsEnabled:       pulumi.Bool(true),
			ServiceMode:                pulumi.String("Default"),
			UpstreamEndpoints: signalr.ServiceUpstreamEndpointArray{
				&signalr.ServiceUpstreamEndpointArgs{
					CategoryPatterns: pulumi.StringArray{
						pulumi.String("connections"),
						pulumi.String("messages"),
					},
					EventPatterns: pulumi.StringArray{
						pulumi.String("*"),
					},
					HubPatterns: pulumi.StringArray{
						pulumi.String("hub1"),
					},
					UrlTemplate: pulumi.String("http://foo.com"),
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Azure = Pulumi.Azure;

return await Deployment.RunAsync(() => 
{
    var example = new Azure.Core.ResourceGroup("example", new()
    {
        Name = "my-signalr",
        Location = "West US",
    });

    var exampleService = new Azure.SignalR.Service("example", new()
    {
        Name = "tfex-signalr",
        Location = example.Location,
        ResourceGroupName = example.Name,
        Sku = new Azure.SignalR.Inputs.ServiceSkuArgs
        {
            Name = "Free_F1",
            Capacity = 1,
        },
        Cors = new[]
        {
            new Azure.SignalR.Inputs.ServiceCorArgs
            {
                AllowedOrigins = new[]
                {
                    "http://www.example.com",
                },
            },
        },
        PublicNetworkAccessEnabled = false,
        ConnectivityLogsEnabled = true,
        MessagingLogsEnabled = true,
        ServiceMode = "Default",
        UpstreamEndpoints = new[]
        {
            new Azure.SignalR.Inputs.ServiceUpstreamEndpointArgs
            {
                CategoryPatterns = new[]
                {
                    "connections",
                    "messages",
                },
                EventPatterns = new[]
                {
                    "*",
                },
                HubPatterns = new[]
                {
                    "hub1",
                },
                UrlTemplate = "http://foo.com",
            },
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azure.core.ResourceGroup;
import com.pulumi.azure.core.ResourceGroupArgs;
import com.pulumi.azure.signalr.Service;
import com.pulumi.azure.signalr.ServiceArgs;
import com.pulumi.azure.signalr.inputs.ServiceSkuArgs;
import com.pulumi.azure.signalr.inputs.ServiceCorArgs;
import com.pulumi.azure.signalr.inputs.ServiceUpstreamEndpointArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var example = new ResourceGroup("example", ResourceGroupArgs.builder()
            .name("my-signalr")
            .location("West US")
            .build());

        var exampleService = new Service("exampleService", ServiceArgs.builder()
            .name("tfex-signalr")
            .location(example.location())
            .resourceGroupName(example.name())
            .sku(ServiceSkuArgs.builder()
                .name("Free_F1")
                .capacity(1)
                .build())
            .cors(ServiceCorArgs.builder()
                .allowedOrigins("http://www.example.com")
                .build())
            .publicNetworkAccessEnabled(false)
            .connectivityLogsEnabled(true)
            .messagingLogsEnabled(true)
            .serviceMode("Default")
            .upstreamEndpoints(ServiceUpstreamEndpointArgs.builder()
                .categoryPatterns(                
                    "connections",
                    "messages")
                .eventPatterns("*")
                .hubPatterns("hub1")
                .urlTemplate("http://foo.com")
                .build())
            .build());

    }
}

    resources:
  example:
    type: azure:core:ResourceGroup
    properties:
      name: my-signalr
      location: West US
  exampleService:
    type: azure:signalr:Service
    name: example
    properties:
      name: tfex-signalr
      location: ${example.location}
      resourceGroupName: ${example.name}
      sku:
        name: Free_F1
        capacity: 1
      cors:
        - allowedOrigins:
            - http://www.example.com
      publicNetworkAccessEnabled: false
      connectivityLogsEnabled: true
      messagingLogsEnabled: true
      serviceMode: Default
      upstreamEndpoints:
        - categoryPatterns:
            - connections
            - messages
          eventPatterns:
            - '*'
          hubPatterns:
            - hub1
          urlTemplate: http://foo.com

    Create Service Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Service(name: string, args: ServiceArgs, opts?: CustomResourceOptions);
    @overload
def Service(resource_name: str,
            args: ServiceArgs,
            opts: Optional[ResourceOptions] = None)

@overload
def Service(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            resource_group_name: Optional[str] = None,
            sku: Optional[ServiceSkuArgs] = None,
            identity: Optional[ServiceIdentityArgs] = None,
            public_network_access_enabled: Optional[bool] = None,
            aad_auth_enabled: Optional[bool] = None,
            live_trace: Optional[ServiceLiveTraceArgs] = None,
            live_trace_enabled: Optional[bool] = None,
            local_auth_enabled: Optional[bool] = None,
            location: Optional[str] = None,
            messaging_logs_enabled: Optional[bool] = None,
            name: Optional[str] = None,
            http_request_logs_enabled: Optional[bool] = None,
            cors: Optional[Sequence[ServiceCorArgs]] = None,
            serverless_connection_timeout_in_seconds: Optional[int] = None,
            service_mode: Optional[str] = None,
            connectivity_logs_enabled: Optional[bool] = None,
            tags: Optional[Mapping[str, str]] = None,
            tls_client_cert_enabled: Optional[bool] = None,
            upstream_endpoints: Optional[Sequence[ServiceUpstreamEndpointArgs]] = None)
    func NewService(ctx *Context, name string, args ServiceArgs, opts ...ResourceOption) (*Service, error)
    public Service(string name, ServiceArgs args, CustomResourceOptions? opts = null)
    public Service(String name, ServiceArgs args)
public Service(String name, ServiceArgs args, CustomResourceOptions options)

    type: azure:signalr:Service
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args ServiceArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args ServiceArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args ServiceArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ServiceArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ServiceArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var exampleserviceResourceResourceFromSignalrservice = new Azure.SignalR.Service("exampleserviceResourceResourceFromSignalrservice", new()
{
    ResourceGroupName = "string",
    Sku = new Azure.SignalR.Inputs.ServiceSkuArgs
    {
        Capacity = 0,
        Name = "string",
    },
    Identity = new Azure.SignalR.Inputs.ServiceIdentityArgs
    {
        Type = "string",
        IdentityIds = new[]
        {
            "string",
        },
        PrincipalId = "string",
        TenantId = "string",
    },
    PublicNetworkAccessEnabled = false,
    AadAuthEnabled = false,
    LiveTrace = new Azure.SignalR.Inputs.ServiceLiveTraceArgs
    {
        ConnectivityLogsEnabled = false,
        Enabled = false,
        HttpRequestLogsEnabled = false,
        MessagingLogsEnabled = false,
    },
    LocalAuthEnabled = false,
    Location = "string",
    MessagingLogsEnabled = false,
    Name = "string",
    HttpRequestLogsEnabled = false,
    Cors = new[]
    {
        new Azure.SignalR.Inputs.ServiceCorArgs
        {
            AllowedOrigins = new[]
            {
                "string",
            },
        },
    },
    ServerlessConnectionTimeoutInSeconds = 0,
    ServiceMode = "string",
    ConnectivityLogsEnabled = false,
    Tags = 
    {
        { "string", "string" },
    },
    TlsClientCertEnabled = false,
    UpstreamEndpoints = new[]
    {
        new Azure.SignalR.Inputs.ServiceUpstreamEndpointArgs
        {
            CategoryPatterns = new[]
            {
                "string",
            },
            EventPatterns = new[]
            {
                "string",
            },
            HubPatterns = new[]
            {
                "string",
            },
            UrlTemplate = "string",
            UserAssignedIdentityId = "string",
        },
    },
});

    example, err := signalr.NewService(ctx, "exampleserviceResourceResourceFromSignalrservice", &signalr.ServiceArgs{
	ResourceGroupName: pulumi.String("string"),
	Sku: &signalr.ServiceSkuArgs{
		Capacity: pulumi.Int(0),
		Name:     pulumi.String("string"),
	},
	Identity: &signalr.ServiceIdentityArgs{
		Type: pulumi.String("string"),
		IdentityIds: pulumi.StringArray{
			pulumi.String("string"),
		},
		PrincipalId: pulumi.String("string"),
		TenantId:    pulumi.String("string"),
	},
	PublicNetworkAccessEnabled: pulumi.Bool(false),
	AadAuthEnabled:             pulumi.Bool(false),
	LiveTrace: &signalr.ServiceLiveTraceArgs{
		ConnectivityLogsEnabled: pulumi.Bool(false),
		Enabled:                 pulumi.Bool(false),
		HttpRequestLogsEnabled:  pulumi.Bool(false),
		MessagingLogsEnabled:    pulumi.Bool(false),
	},
	LocalAuthEnabled:       pulumi.Bool(false),
	Location:               pulumi.String("string"),
	MessagingLogsEnabled:   pulumi.Bool(false),
	Name:                   pulumi.String("string"),
	HttpRequestLogsEnabled: pulumi.Bool(false),
	Cors: signalr.ServiceCorArray{
		&signalr.ServiceCorArgs{
			AllowedOrigins: pulumi.StringArray{
				pulumi.String("string"),
			},
		},
	},
	ServerlessConnectionTimeoutInSeconds: pulumi.Int(0),
	ServiceMode:                          pulumi.String("string"),
	ConnectivityLogsEnabled:              pulumi.Bool(false),
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	TlsClientCertEnabled: pulumi.Bool(false),
	UpstreamEndpoints: signalr.ServiceUpstreamEndpointArray{
		&signalr.ServiceUpstreamEndpointArgs{
			CategoryPatterns: pulumi.StringArray{
				pulumi.String("string"),
			},
			EventPatterns: pulumi.StringArray{
				pulumi.String("string"),
			},
			HubPatterns: pulumi.StringArray{
				pulumi.String("string"),
			},
			UrlTemplate:            pulumi.String("string"),
			UserAssignedIdentityId: pulumi.String("string"),
		},
	},
})

    var exampleserviceResourceResourceFromSignalrservice = new Service("exampleserviceResourceResourceFromSignalrservice", ServiceArgs.builder()
    .resourceGroupName("string")
    .sku(ServiceSkuArgs.builder()
        .capacity(0)
        .name("string")
        .build())
    .identity(ServiceIdentityArgs.builder()
        .type("string")
        .identityIds("string")
        .principalId("string")
        .tenantId("string")
        .build())
    .publicNetworkAccessEnabled(false)
    .aadAuthEnabled(false)
    .liveTrace(ServiceLiveTraceArgs.builder()
        .connectivityLogsEnabled(false)
        .enabled(false)
        .httpRequestLogsEnabled(false)
        .messagingLogsEnabled(false)
        .build())
    .localAuthEnabled(false)
    .location("string")
    .messagingLogsEnabled(false)
    .name("string")
    .httpRequestLogsEnabled(false)
    .cors(ServiceCorArgs.builder()
        .allowedOrigins("string")
        .build())
    .serverlessConnectionTimeoutInSeconds(0)
    .serviceMode("string")
    .connectivityLogsEnabled(false)
    .tags(Map.of("string", "string"))
    .tlsClientCertEnabled(false)
    .upstreamEndpoints(ServiceUpstreamEndpointArgs.builder()
        .categoryPatterns("string")
        .eventPatterns("string")
        .hubPatterns("string")
        .urlTemplate("string")
        .userAssignedIdentityId("string")
        .build())
    .build());

    exampleservice_resource_resource_from_signalrservice = azure.signalr.Service("exampleserviceResourceResourceFromSignalrservice",
    resource_group_name="string",
    sku=azure.signalr.ServiceSkuArgs(
        capacity=0,
        name="string",
    ),
    identity=azure.signalr.ServiceIdentityArgs(
        type="string",
        identity_ids=["string"],
        principal_id="string",
        tenant_id="string",
    ),
    public_network_access_enabled=False,
    aad_auth_enabled=False,
    live_trace=azure.signalr.ServiceLiveTraceArgs(
        connectivity_logs_enabled=False,
        enabled=False,
        http_request_logs_enabled=False,
        messaging_logs_enabled=False,
    ),
    local_auth_enabled=False,
    location="string",
    messaging_logs_enabled=False,
    name="string",
    http_request_logs_enabled=False,
    cors=[azure.signalr.ServiceCorArgs(
        allowed_origins=["string"],
    )],
    serverless_connection_timeout_in_seconds=0,
    service_mode="string",
    connectivity_logs_enabled=False,
    tags={
        "string": "string",
    },
    tls_client_cert_enabled=False,
    upstream_endpoints=[azure.signalr.ServiceUpstreamEndpointArgs(
        category_patterns=["string"],
        event_patterns=["string"],
        hub_patterns=["string"],
        url_template="string",
        user_assigned_identity_id="string",
    )])

    const exampleserviceResourceResourceFromSignalrservice = new azure.signalr.Service("exampleserviceResourceResourceFromSignalrservice", {
    resourceGroupName: "string",
    sku: {
        capacity: 0,
        name: "string",
    },
    identity: {
        type: "string",
        identityIds: ["string"],
        principalId: "string",
        tenantId: "string",
    },
    publicNetworkAccessEnabled: false,
    aadAuthEnabled: false,
    liveTrace: {
        connectivityLogsEnabled: false,
        enabled: false,
        httpRequestLogsEnabled: false,
        messagingLogsEnabled: false,
    },
    localAuthEnabled: false,
    location: "string",
    messagingLogsEnabled: false,
    name: "string",
    httpRequestLogsEnabled: false,
    cors: [{
        allowedOrigins: ["string"],
    }],
    serverlessConnectionTimeoutInSeconds: 0,
    serviceMode: "string",
    connectivityLogsEnabled: false,
    tags: {
        string: "string",
    },
    tlsClientCertEnabled: false,
    upstreamEndpoints: [{
        categoryPatterns: ["string"],
        eventPatterns: ["string"],
        hubPatterns: ["string"],
        urlTemplate: "string",
        userAssignedIdentityId: "string",
    }],
});

    type: azure:signalr:Service
properties:
    aadAuthEnabled: false
    connectivityLogsEnabled: false
    cors:
        - allowedOrigins:
            - string
    httpRequestLogsEnabled: false
    identity:
        identityIds:
            - string
        principalId: string
        tenantId: string
        type: string
    liveTrace:
        connectivityLogsEnabled: false
        enabled: false
        httpRequestLogsEnabled: false
        messagingLogsEnabled: false
    localAuthEnabled: false
    location: string
    messagingLogsEnabled: false
    name: string
    publicNetworkAccessEnabled: false
    resourceGroupName: string
    serverlessConnectionTimeoutInSeconds: 0
    serviceMode: string
    sku:
        capacity: 0
        name: string
    tags:
        string: string
    tlsClientCertEnabled: false
    upstreamEndpoints:
        - categoryPatterns:
            - string
          eventPatterns:
            - string
          hubPatterns:
            - string
          urlTemplate: string
          userAssignedIdentityId: string

    Service Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The Service resource accepts the following input properties:

    ResourceGroupName string
    The name of the resource group in which to create the SignalR service. Changing this forces a new resource to be created.
    Sku ServiceSku
    A sku block as documented below.
    AadAuthEnabled bool
    Whether to enable AAD auth? Defaults to true.
    ConnectivityLogsEnabled bool
    Specifies if Connectivity Logs are enabled or not. Defaults to false.
    Cors List<ServiceCor>
    A cors block as documented below.
    HttpRequestLogsEnabled bool
    Specifies if Http Request Logs are enabled or not. Defaults to false.
    Identity ServiceIdentity
    An identity block as defined below.
    LiveTrace ServiceLiveTrace
    A live_trace block as defined below.
    LiveTraceEnabled bool
    Specifies if Live Trace is enabled or not. Defaults to false.

    Deprecated: live_trace_enabled has been deprecated in favor of live_trace and will be removed in 4.0.

    LocalAuthEnabled bool
    Whether to enable local auth? Defaults to true.
    Location string
    Specifies the supported Azure location where the SignalR service exists. Changing this forces a new resource to be created.
    MessagingLogsEnabled bool
    Specifies if Messaging Logs are enabled or not. Defaults to false.
    Name string
    The name of the SignalR service. Changing this forces a new resource to be created.
    PublicNetworkAccessEnabled bool

    Whether to enable public network access? Defaults to true.

    Note: public_network_access_enabled cannot be set to false in Free sku tier.

    ServerlessConnectionTimeoutInSeconds int
    Specifies the client connection timeout. Defaults to 30.
    ServiceMode string
    Specifies the service mode. Possible values are Classic, Default and Serverless. Defaults to Default.
    Tags Dictionary<string, string>
    A mapping of tags to assign to the resource.
    TlsClientCertEnabled bool

    Whether to request client certificate during TLS handshake? Defaults to false.

    Note: tls_client_cert_enabled cannot be set to true in Free sku tier.

    UpstreamEndpoints List<ServiceUpstreamEndpoint>
    An upstream_endpoint block as documented below. Using this block requires the SignalR service to be Serverless. When creating multiple blocks they will be processed in the order they are defined in.
    ResourceGroupName string
    The name of the resource group in which to create the SignalR service. Changing this forces a new resource to be created.
    Sku ServiceSkuArgs
    A sku block as documented below.
    AadAuthEnabled bool
    Whether to enable AAD auth? Defaults to true.
    ConnectivityLogsEnabled bool
    Specifies if Connectivity Logs are enabled or not. Defaults to false.
    Cors []ServiceCorArgs
    A cors block as documented below.
    HttpRequestLogsEnabled bool
    Specifies if Http Request Logs are enabled or not. Defaults to false.
    Identity ServiceIdentityArgs
    An identity block as defined below.
    LiveTrace ServiceLiveTraceArgs
    A live_trace block as defined below.
    LiveTraceEnabled bool
    Specifies if Live Trace is enabled or not. Defaults to false.

    Deprecated: live_trace_enabled has been deprecated in favor of live_trace and will be removed in 4.0.

    LocalAuthEnabled bool
    Whether to enable local auth? Defaults to true.
    Location string
    Specifies the supported Azure location where the SignalR service exists. Changing this forces a new resource to be created.
    MessagingLogsEnabled bool
    Specifies if Messaging Logs are enabled or not. Defaults to false.
    Name string
    The name of the SignalR service. Changing this forces a new resource to be created.
    PublicNetworkAccessEnabled bool

    Whether to enable public network access? Defaults to true.

    Note: public_network_access_enabled cannot be set to false in Free sku tier.

    ServerlessConnectionTimeoutInSeconds int
    Specifies the client connection timeout. Defaults to 30.
    ServiceMode string
    Specifies the service mode. Possible values are Classic, Default and Serverless. Defaults to Default.
    Tags map[string]string
    A mapping of tags to assign to the resource.
    TlsClientCertEnabled bool

    Whether to request client certificate during TLS handshake? Defaults to false.

    Note: tls_client_cert_enabled cannot be set to true in Free sku tier.

    UpstreamEndpoints []ServiceUpstreamEndpointArgs
    An upstream_endpoint block as documented below. Using this block requires the SignalR service to be Serverless. When creating multiple blocks they will be processed in the order they are defined in.
    resourceGroupName String
    The name of the resource group in which to create the SignalR service. Changing this forces a new resource to be created.
    sku ServiceSku
    A sku block as documented below.
    aadAuthEnabled Boolean
    Whether to enable AAD auth? Defaults to true.
    connectivityLogsEnabled Boolean
    Specifies if Connectivity Logs are enabled or not. Defaults to false.
    cors List<ServiceCor>
    A cors block as documented below.
    httpRequestLogsEnabled Boolean
    Specifies if Http Request Logs are enabled or not. Defaults to false.
    identity ServiceIdentity
    An identity block as defined below.
    liveTrace ServiceLiveTrace
    A live_trace block as defined below.
    liveTraceEnabled Boolean
    Specifies if Live Trace is enabled or not. Defaults to false.

    Deprecated: live_trace_enabled has been deprecated in favor of live_trace and will be removed in 4.0.

    localAuthEnabled Boolean
    Whether to enable local auth? Defaults to true.
    location String
    Specifies the supported Azure location where the SignalR service exists. Changing this forces a new resource to be created.
    messagingLogsEnabled Boolean
    Specifies if Messaging Logs are enabled or not. Defaults to false.
    name String
    The name of the SignalR service. Changing this forces a new resource to be created.
    publicNetworkAccessEnabled Boolean

    Whether to enable public network access? Defaults to true.

    Note: public_network_access_enabled cannot be set to false in Free sku tier.

    serverlessConnectionTimeoutInSeconds Integer
    Specifies the client connection timeout. Defaults to 30.
    serviceMode String
    Specifies the service mode. Possible values are Classic, Default and Serverless. Defaults to Default.
    tags Map<String,String>
    A mapping of tags to assign to the resource.
    tlsClientCertEnabled Boolean

    Whether to request client certificate during TLS handshake? Defaults to false.

    Note: tls_client_cert_enabled cannot be set to true in Free sku tier.

    upstreamEndpoints List<ServiceUpstreamEndpoint>
    An upstream_endpoint block as documented below. Using this block requires the SignalR service to be Serverless. When creating multiple blocks they will be processed in the order they are defined in.
    resourceGroupName string
    The name of the resource group in which to create the SignalR service. Changing this forces a new resource to be created.
    sku ServiceSku
    A sku block as documented below.
    aadAuthEnabled boolean
    Whether to enable AAD auth? Defaults to true.
    connectivityLogsEnabled boolean
    Specifies if Connectivity Logs are enabled or not. Defaults to false.
    cors ServiceCor[]
    A cors block as documented below.
    httpRequestLogsEnabled boolean
    Specifies if Http Request Logs are enabled or not. Defaults to false.
    identity ServiceIdentity
    An identity block as defined below.
    liveTrace ServiceLiveTrace
    A live_trace block as defined below.
    liveTraceEnabled boolean
    Specifies if Live Trace is enabled or not. Defaults to false.

    Deprecated: live_trace_enabled has been deprecated in favor of live_trace and will be removed in 4.0.

    localAuthEnabled boolean
    Whether to enable local auth? Defaults to true.
    location string
    Specifies the supported Azure location where the SignalR service exists. Changing this forces a new resource to be created.
    messagingLogsEnabled boolean
    Specifies if Messaging Logs are enabled or not. Defaults to false.
    name string
    The name of the SignalR service. Changing this forces a new resource to be created.
    publicNetworkAccessEnabled boolean

    Whether to enable public network access? Defaults to true.

    Note: public_network_access_enabled cannot be set to false in Free sku tier.

    serverlessConnectionTimeoutInSeconds number
    Specifies the client connection timeout. Defaults to 30.
    serviceMode string
    Specifies the service mode. Possible values are Classic, Default and Serverless. Defaults to Default.
    tags {[key: string]: string}
    A mapping of tags to assign to the resource.
    tlsClientCertEnabled boolean

    Whether to request client certificate during TLS handshake? Defaults to false.

    Note: tls_client_cert_enabled cannot be set to true in Free sku tier.

    upstreamEndpoints ServiceUpstreamEndpoint[]
    An upstream_endpoint block as documented below. Using this block requires the SignalR service to be Serverless. When creating multiple blocks they will be processed in the order they are defined in.
    resource_group_name str
    The name of the resource group in which to create the SignalR service. Changing this forces a new resource to be created.
    sku ServiceSkuArgs
    A sku block as documented below.
    aad_auth_enabled bool
    Whether to enable AAD auth? Defaults to true.
    connectivity_logs_enabled bool
    Specifies if Connectivity Logs are enabled or not. Defaults to false.
    cors Sequence[ServiceCorArgs]
    A cors block as documented below.
    http_request_logs_enabled bool
    Specifies if Http Request Logs are enabled or not. Defaults to false.
    identity ServiceIdentityArgs
    An identity block as defined below.
    live_trace ServiceLiveTraceArgs
    A live_trace block as defined below.
    live_trace_enabled bool
    Specifies if Live Trace is enabled or not. Defaults to false.

    Deprecated: live_trace_enabled has been deprecated in favor of live_trace and will be removed in 4.0.

    local_auth_enabled bool
    Whether to enable local auth? Defaults to true.
    location str
    Specifies the supported Azure location where the SignalR service exists. Changing this forces a new resource to be created.
    messaging_logs_enabled bool
    Specifies if Messaging Logs are enabled or not. Defaults to false.
    name str
    The name of the SignalR service. Changing this forces a new resource to be created.
    public_network_access_enabled bool

    Whether to enable public network access? Defaults to true.

    Note: public_network_access_enabled cannot be set to false in Free sku tier.

    serverless_connection_timeout_in_seconds int
    Specifies the client connection timeout. Defaults to 30.
    service_mode str
    Specifies the service mode. Possible values are Classic, Default and Serverless. Defaults to Default.
    tags Mapping[str, str]
    A mapping of tags to assign to the resource.
    tls_client_cert_enabled bool

    Whether to request client certificate during TLS handshake? Defaults to false.

    Note: tls_client_cert_enabled cannot be set to true in Free sku tier.

    upstream_endpoints Sequence[ServiceUpstreamEndpointArgs]
    An upstream_endpoint block as documented below. Using this block requires the SignalR service to be Serverless. When creating multiple blocks they will be processed in the order they are defined in.
    resourceGroupName String
    The name of the resource group in which to create the SignalR service. Changing this forces a new resource to be created.
    sku Property Map
    A sku block as documented below.
    aadAuthEnabled Boolean
    Whether to enable AAD auth? Defaults to true.
    connectivityLogsEnabled Boolean
    Specifies if Connectivity Logs are enabled or not. Defaults to false.
    cors List<Property Map>
    A cors block as documented below.
    httpRequestLogsEnabled Boolean
    Specifies if Http Request Logs are enabled or not. Defaults to false.
    identity Property Map
    An identity block as defined below.
    liveTrace Property Map
    A live_trace block as defined below.
    liveTraceEnabled Boolean
    Specifies if Live Trace is enabled or not. Defaults to false.

    Deprecated: live_trace_enabled has been deprecated in favor of live_trace and will be removed in 4.0.

    localAuthEnabled Boolean
    Whether to enable local auth? Defaults to true.
    location String
    Specifies the supported Azure location where the SignalR service exists. Changing this forces a new resource to be created.
    messagingLogsEnabled Boolean
    Specifies if Messaging Logs are enabled or not. Defaults to false.
    name String
    The name of the SignalR service. Changing this forces a new resource to be created.
    publicNetworkAccessEnabled Boolean

    Whether to enable public network access? Defaults to true.

    Note: public_network_access_enabled cannot be set to false in Free sku tier.

    serverlessConnectionTimeoutInSeconds Number
    Specifies the client connection timeout. Defaults to 30.
    serviceMode String
    Specifies the service mode. Possible values are Classic, Default and Serverless. Defaults to Default.
    tags Map<String>
    A mapping of tags to assign to the resource.
    tlsClientCertEnabled Boolean

    Whether to request client certificate during TLS handshake? Defaults to false.

    Note: tls_client_cert_enabled cannot be set to true in Free sku tier.

    upstreamEndpoints List<Property Map>
    An upstream_endpoint block as documented below. Using this block requires the SignalR service to be Serverless. When creating multiple blocks they will be processed in the order they are defined in.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Service resource produces the following output properties:

    Hostname string
    The FQDN of the SignalR service.
    Id string
    The provider-assigned unique ID for this managed resource.
    IpAddress string
    The publicly accessible IP of the SignalR service.
    PrimaryAccessKey string
    The primary access key for the SignalR service.
    PrimaryConnectionString string
    The primary connection string for the SignalR service.
    PublicPort int
    The publicly accessible port of the SignalR service which is designed for browser/client use.
    SecondaryAccessKey string
    The secondary access key for the SignalR service.
    SecondaryConnectionString string
    The secondary connection string for the SignalR service.
    ServerPort int
    The publicly accessible port of the SignalR service which is designed for customer server side use.
    Hostname string
    The FQDN of the SignalR service.
    Id string
    The provider-assigned unique ID for this managed resource.
    IpAddress string
    The publicly accessible IP of the SignalR service.
    PrimaryAccessKey string
    The primary access key for the SignalR service.
    PrimaryConnectionString string
    The primary connection string for the SignalR service.
    PublicPort int
    The publicly accessible port of the SignalR service which is designed for browser/client use.
    SecondaryAccessKey string
    The secondary access key for the SignalR service.
    SecondaryConnectionString string
    The secondary connection string for the SignalR service.
    ServerPort int
    The publicly accessible port of the SignalR service which is designed for customer server side use.
    hostname String
    The FQDN of the SignalR service.
    id String
    The provider-assigned unique ID for this managed resource.
    ipAddress String
    The publicly accessible IP of the SignalR service.
    primaryAccessKey String
    The primary access key for the SignalR service.
    primaryConnectionString String
    The primary connection string for the SignalR service.
    publicPort Integer
    The publicly accessible port of the SignalR service which is designed for browser/client use.
    secondaryAccessKey String
    The secondary access key for the SignalR service.
    secondaryConnectionString String
    The secondary connection string for the SignalR service.
    serverPort Integer
    The publicly accessible port of the SignalR service which is designed for customer server side use.
    hostname string
    The FQDN of the SignalR service.
    id string
    The provider-assigned unique ID for this managed resource.
    ipAddress string
    The publicly accessible IP of the SignalR service.
    primaryAccessKey string
    The primary access key for the SignalR service.
    primaryConnectionString string
    The primary connection string for the SignalR service.
    publicPort number
    The publicly accessible port of the SignalR service which is designed for browser/client use.
    secondaryAccessKey string
    The secondary access key for the SignalR service.
    secondaryConnectionString string
    The secondary connection string for the SignalR service.
    serverPort number
    The publicly accessible port of the SignalR service which is designed for customer server side use.
    hostname str
    The FQDN of the SignalR service.
    id str
    The provider-assigned unique ID for this managed resource.
    ip_address str
    The publicly accessible IP of the SignalR service.
    primary_access_key str
    The primary access key for the SignalR service.
    primary_connection_string str
    The primary connection string for the SignalR service.
    public_port int
    The publicly accessible port of the SignalR service which is designed for browser/client use.
    secondary_access_key str
    The secondary access key for the SignalR service.
    secondary_connection_string str
    The secondary connection string for the SignalR service.
    server_port int
    The publicly accessible port of the SignalR service which is designed for customer server side use.
    hostname String
    The FQDN of the SignalR service.
    id String
    The provider-assigned unique ID for this managed resource.
    ipAddress String
    The publicly accessible IP of the SignalR service.
    primaryAccessKey String
    The primary access key for the SignalR service.
    primaryConnectionString String
    The primary connection string for the SignalR service.
    publicPort Number
    The publicly accessible port of the SignalR service which is designed for browser/client use.
    secondaryAccessKey String
    The secondary access key for the SignalR service.
    secondaryConnectionString String
    The secondary connection string for the SignalR service.
    serverPort Number
    The publicly accessible port of the SignalR service which is designed for customer server side use.

    Look up Existing Service Resource

    Get an existing Service resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: ServiceState, opts?: CustomResourceOptions): Service
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        aad_auth_enabled: Optional[bool] = None,
        connectivity_logs_enabled: Optional[bool] = None,
        cors: Optional[Sequence[ServiceCorArgs]] = None,
        hostname: Optional[str] = None,
        http_request_logs_enabled: Optional[bool] = None,
        identity: Optional[ServiceIdentityArgs] = None,
        ip_address: Optional[str] = None,
        live_trace: Optional[ServiceLiveTraceArgs] = None,
        live_trace_enabled: Optional[bool] = None,
        local_auth_enabled: Optional[bool] = None,
        location: Optional[str] = None,
        messaging_logs_enabled: Optional[bool] = None,
        name: Optional[str] = None,
        primary_access_key: Optional[str] = None,
        primary_connection_string: Optional[str] = None,
        public_network_access_enabled: Optional[bool] = None,
        public_port: Optional[int] = None,
        resource_group_name: Optional[str] = None,
        secondary_access_key: Optional[str] = None,
        secondary_connection_string: Optional[str] = None,
        server_port: Optional[int] = None,
        serverless_connection_timeout_in_seconds: Optional[int] = None,
        service_mode: Optional[str] = None,
        sku: Optional[ServiceSkuArgs] = None,
        tags: Optional[Mapping[str, str]] = None,
        tls_client_cert_enabled: Optional[bool] = None,
        upstream_endpoints: Optional[Sequence[ServiceUpstreamEndpointArgs]] = None) -> Service
    func GetService(ctx *Context, name string, id IDInput, state *ServiceState, opts ...ResourceOption) (*Service, error)
    public static Service Get(string name, Input<string> id, ServiceState? state, CustomResourceOptions? opts = null)
    public static Service get(String name, Output<String> id, ServiceState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    AadAuthEnabled bool
    Whether to enable AAD auth? Defaults to true.
    ConnectivityLogsEnabled bool
    Specifies if Connectivity Logs are enabled or not. Defaults to false.
    Cors List<ServiceCor>
    A cors block as documented below.
    Hostname string
    The FQDN of the SignalR service.
    HttpRequestLogsEnabled bool
    Specifies if Http Request Logs are enabled or not. Defaults to false.
    Identity ServiceIdentity
    An identity block as defined below.
    IpAddress string
    The publicly accessible IP of the SignalR service.
    LiveTrace ServiceLiveTrace
    A live_trace block as defined below.
    LiveTraceEnabled bool
    Specifies if Live Trace is enabled or not. Defaults to false.

    Deprecated: live_trace_enabled has been deprecated in favor of live_trace and will be removed in 4.0.

    LocalAuthEnabled bool
    Whether to enable local auth? Defaults to true.
    Location string
    Specifies the supported Azure location where the SignalR service exists. Changing this forces a new resource to be created.
    MessagingLogsEnabled bool
    Specifies if Messaging Logs are enabled or not. Defaults to false.
    Name string
    The name of the SignalR service. Changing this forces a new resource to be created.
    PrimaryAccessKey string
    The primary access key for the SignalR service.
    PrimaryConnectionString string
    The primary connection string for the SignalR service.
    PublicNetworkAccessEnabled bool

    Whether to enable public network access? Defaults to true.

    Note: public_network_access_enabled cannot be set to false in Free sku tier.

    PublicPort int
    The publicly accessible port of the SignalR service which is designed for browser/client use.
    ResourceGroupName string
    The name of the resource group in which to create the SignalR service. Changing this forces a new resource to be created.
    SecondaryAccessKey string
    The secondary access key for the SignalR service.
    SecondaryConnectionString string
    The secondary connection string for the SignalR service.
    ServerPort int
    The publicly accessible port of the SignalR service which is designed for customer server side use.
    ServerlessConnectionTimeoutInSeconds int
    Specifies the client connection timeout. Defaults to 30.
    ServiceMode string
    Specifies the service mode. Possible values are Classic, Default and Serverless. Defaults to Default.
    Sku ServiceSku
    A sku block as documented below.
    Tags Dictionary<string, string>
    A mapping of tags to assign to the resource.
    TlsClientCertEnabled bool

    Whether to request client certificate during TLS handshake? Defaults to false.

    Note: tls_client_cert_enabled cannot be set to true in Free sku tier.

    UpstreamEndpoints List<ServiceUpstreamEndpoint>
    An upstream_endpoint block as documented below. Using this block requires the SignalR service to be Serverless. When creating multiple blocks they will be processed in the order they are defined in.
    AadAuthEnabled bool
    Whether to enable AAD auth? Defaults to true.
    ConnectivityLogsEnabled bool
    Specifies if Connectivity Logs are enabled or not. Defaults to false.
    Cors []ServiceCorArgs
    A cors block as documented below.
    Hostname string
    The FQDN of the SignalR service.
    HttpRequestLogsEnabled bool
    Specifies if Http Request Logs are enabled or not. Defaults to false.
    Identity ServiceIdentityArgs
    An identity block as defined below.
    IpAddress string
    The publicly accessible IP of the SignalR service.
    LiveTrace ServiceLiveTraceArgs
    A live_trace block as defined below.
    LiveTraceEnabled bool
    Specifies if Live Trace is enabled or not. Defaults to false.

    Deprecated: live_trace_enabled has been deprecated in favor of live_trace and will be removed in 4.0.

    LocalAuthEnabled bool
    Whether to enable local auth? Defaults to true.
    Location string
    Specifies the supported Azure location where the SignalR service exists. Changing this forces a new resource to be created.
    MessagingLogsEnabled bool
    Specifies if Messaging Logs are enabled or not. Defaults to false.
    Name string
    The name of the SignalR service. Changing this forces a new resource to be created.
    PrimaryAccessKey string
    The primary access key for the SignalR service.
    PrimaryConnectionString string
    The primary connection string for the SignalR service.
    PublicNetworkAccessEnabled bool

    Whether to enable public network access? Defaults to true.

    Note: public_network_access_enabled cannot be set to false in Free sku tier.

    PublicPort int
    The publicly accessible port of the SignalR service which is designed for browser/client use.
    ResourceGroupName string
    The name of the resource group in which to create the SignalR service. Changing this forces a new resource to be created.
    SecondaryAccessKey string
    The secondary access key for the SignalR service.
    SecondaryConnectionString string
    The secondary connection string for the SignalR service.
    ServerPort int
    The publicly accessible port of the SignalR service which is designed for customer server side use.
    ServerlessConnectionTimeoutInSeconds int
    Specifies the client connection timeout. Defaults to 30.
    ServiceMode string
    Specifies the service mode. Possible values are Classic, Default and Serverless. Defaults to Default.
    Sku ServiceSkuArgs
    A sku block as documented below.
    Tags map[string]string
    A mapping of tags to assign to the resource.
    TlsClientCertEnabled bool

    Whether to request client certificate during TLS handshake? Defaults to false.

    Note: tls_client_cert_enabled cannot be set to true in Free sku tier.

    UpstreamEndpoints []ServiceUpstreamEndpointArgs
    An upstream_endpoint block as documented below. Using this block requires the SignalR service to be Serverless. When creating multiple blocks they will be processed in the order they are defined in.
    aadAuthEnabled Boolean
    Whether to enable AAD auth? Defaults to true.
    connectivityLogsEnabled Boolean
    Specifies if Connectivity Logs are enabled or not. Defaults to false.
    cors List<ServiceCor>
    A cors block as documented below.
    hostname String
    The FQDN of the SignalR service.
    httpRequestLogsEnabled Boolean
    Specifies if Http Request Logs are enabled or not. Defaults to false.
    identity ServiceIdentity
    An identity block as defined below.
    ipAddress String
    The publicly accessible IP of the SignalR service.
    liveTrace ServiceLiveTrace
    A live_trace block as defined below.
    liveTraceEnabled Boolean
    Specifies if Live Trace is enabled or not. Defaults to false.

    Deprecated: live_trace_enabled has been deprecated in favor of live_trace and will be removed in 4.0.

    localAuthEnabled Boolean
    Whether to enable local auth? Defaults to true.
    location String
    Specifies the supported Azure location where the SignalR service exists. Changing this forces a new resource to be created.
    messagingLogsEnabled Boolean
    Specifies if Messaging Logs are enabled or not. Defaults to false.
    name String
    The name of the SignalR service. Changing this forces a new resource to be created.
    primaryAccessKey String
    The primary access key for the SignalR service.
    primaryConnectionString String
    The primary connection string for the SignalR service.
    publicNetworkAccessEnabled Boolean

    Whether to enable public network access? Defaults to true.

    Note: public_network_access_enabled cannot be set to false in Free sku tier.

    publicPort Integer
    The publicly accessible port of the SignalR service which is designed for browser/client use.
    resourceGroupName String
    The name of the resource group in which to create the SignalR service. Changing this forces a new resource to be created.
    secondaryAccessKey String
    The secondary access key for the SignalR service.
    secondaryConnectionString String
    The secondary connection string for the SignalR service.
    serverPort Integer
    The publicly accessible port of the SignalR service which is designed for customer server side use.
    serverlessConnectionTimeoutInSeconds Integer
    Specifies the client connection timeout. Defaults to 30.
    serviceMode String
    Specifies the service mode. Possible values are Classic, Default and Serverless. Defaults to Default.
    sku ServiceSku
    A sku block as documented below.
    tags Map<String,String>
    A mapping of tags to assign to the resource.
    tlsClientCertEnabled Boolean

    Whether to request client certificate during TLS handshake? Defaults to false.

    Note: tls_client_cert_enabled cannot be set to true in Free sku tier.

    upstreamEndpoints List<ServiceUpstreamEndpoint>
    An upstream_endpoint block as documented below. Using this block requires the SignalR service to be Serverless. When creating multiple blocks they will be processed in the order they are defined in.
    aadAuthEnabled boolean
    Whether to enable AAD auth? Defaults to true.
    connectivityLogsEnabled boolean
    Specifies if Connectivity Logs are enabled or not. Defaults to false.
    cors ServiceCor[]
    A cors block as documented below.
    hostname string
    The FQDN of the SignalR service.
    httpRequestLogsEnabled boolean
    Specifies if Http Request Logs are enabled or not. Defaults to false.
    identity ServiceIdentity
    An identity block as defined below.
    ipAddress string
    The publicly accessible IP of the SignalR service.
    liveTrace ServiceLiveTrace
    A live_trace block as defined below.
    liveTraceEnabled boolean
    Specifies if Live Trace is enabled or not. Defaults to false.

    Deprecated: live_trace_enabled has been deprecated in favor of live_trace and will be removed in 4.0.

    localAuthEnabled boolean
    Whether to enable local auth? Defaults to true.
    location string
    Specifies the supported Azure location where the SignalR service exists. Changing this forces a new resource to be created.
    messagingLogsEnabled boolean
    Specifies if Messaging Logs are enabled or not. Defaults to false.
    name string
    The name of the SignalR service. Changing this forces a new resource to be created.
    primaryAccessKey string
    The primary access key for the SignalR service.
    primaryConnectionString string
    The primary connection string for the SignalR service.
    publicNetworkAccessEnabled boolean

    Whether to enable public network access? Defaults to true.

    Note: public_network_access_enabled cannot be set to false in Free sku tier.

    publicPort number
    The publicly accessible port of the SignalR service which is designed for browser/client use.
    resourceGroupName string
    The name of the resource group in which to create the SignalR service. Changing this forces a new resource to be created.
    secondaryAccessKey string
    The secondary access key for the SignalR service.
    secondaryConnectionString string
    The secondary connection string for the SignalR service.
    serverPort number
    The publicly accessible port of the SignalR service which is designed for customer server side use.
    serverlessConnectionTimeoutInSeconds number
    Specifies the client connection timeout. Defaults to 30.
    serviceMode string
    Specifies the service mode. Possible values are Classic, Default and Serverless. Defaults to Default.
    sku ServiceSku
    A sku block as documented below.
    tags {[key: string]: string}
    A mapping of tags to assign to the resource.
    tlsClientCertEnabled boolean

    Whether to request client certificate during TLS handshake? Defaults to false.

    Note: tls_client_cert_enabled cannot be set to true in Free sku tier.

    upstreamEndpoints ServiceUpstreamEndpoint[]
    An upstream_endpoint block as documented below. Using this block requires the SignalR service to be Serverless. When creating multiple blocks they will be processed in the order they are defined in.
    aad_auth_enabled bool
    Whether to enable AAD auth? Defaults to true.
    connectivity_logs_enabled bool
    Specifies if Connectivity Logs are enabled or not. Defaults to false.
    cors Sequence[ServiceCorArgs]
    A cors block as documented below.
    hostname str
    The FQDN of the SignalR service.
    http_request_logs_enabled bool
    Specifies if Http Request Logs are enabled or not. Defaults to false.
    identity ServiceIdentityArgs
    An identity block as defined below.
    ip_address str
    The publicly accessible IP of the SignalR service.
    live_trace ServiceLiveTraceArgs
    A live_trace block as defined below.
    live_trace_enabled bool
    Specifies if Live Trace is enabled or not. Defaults to false.

    Deprecated: live_trace_enabled has been deprecated in favor of live_trace and will be removed in 4.0.

    local_auth_enabled bool
    Whether to enable local auth? Defaults to true.
    location str
    Specifies the supported Azure location where the SignalR service exists. Changing this forces a new resource to be created.
    messaging_logs_enabled bool
    Specifies if Messaging Logs are enabled or not. Defaults to false.
    name str
    The name of the SignalR service. Changing this forces a new resource to be created.
    primary_access_key str
    The primary access key for the SignalR service.
    primary_connection_string str
    The primary connection string for the SignalR service.
    public_network_access_enabled bool

    Whether to enable public network access? Defaults to true.

    Note: public_network_access_enabled cannot be set to false in Free sku tier.

    public_port int
    The publicly accessible port of the SignalR service which is designed for browser/client use.
    resource_group_name str
    The name of the resource group in which to create the SignalR service. Changing this forces a new resource to be created.
    secondary_access_key str
    The secondary access key for the SignalR service.
    secondary_connection_string str
    The secondary connection string for the SignalR service.
    server_port int
    The publicly accessible port of the SignalR service which is designed for customer server side use.
    serverless_connection_timeout_in_seconds int
    Specifies the client connection timeout. Defaults to 30.
    service_mode str
    Specifies the service mode. Possible values are Classic, Default and Serverless. Defaults to Default.
    sku ServiceSkuArgs
    A sku block as documented below.
    tags Mapping[str, str]
    A mapping of tags to assign to the resource.
    tls_client_cert_enabled bool

    Whether to request client certificate during TLS handshake? Defaults to false.

    Note: tls_client_cert_enabled cannot be set to true in Free sku tier.

    upstream_endpoints Sequence[ServiceUpstreamEndpointArgs]
    An upstream_endpoint block as documented below. Using this block requires the SignalR service to be Serverless. When creating multiple blocks they will be processed in the order they are defined in.
    aadAuthEnabled Boolean
    Whether to enable AAD auth? Defaults to true.
    connectivityLogsEnabled Boolean
    Specifies if Connectivity Logs are enabled or not. Defaults to false.
    cors List<Property Map>
    A cors block as documented below.
    hostname String
    The FQDN of the SignalR service.
    httpRequestLogsEnabled Boolean
    Specifies if Http Request Logs are enabled or not. Defaults to false.
    identity Property Map
    An identity block as defined below.
    ipAddress String
    The publicly accessible IP of the SignalR service.
    liveTrace Property Map
    A live_trace block as defined below.
    liveTraceEnabled Boolean
    Specifies if Live Trace is enabled or not. Defaults to false.

    Deprecated: live_trace_enabled has been deprecated in favor of live_trace and will be removed in 4.0.

    localAuthEnabled Boolean
    Whether to enable local auth? Defaults to true.
    location String
    Specifies the supported Azure location where the SignalR service exists. Changing this forces a new resource to be created.
    messagingLogsEnabled Boolean
    Specifies if Messaging Logs are enabled or not. Defaults to false.
    name String
    The name of the SignalR service. Changing this forces a new resource to be created.
    primaryAccessKey String
    The primary access key for the SignalR service.
    primaryConnectionString String
    The primary connection string for the SignalR service.
    publicNetworkAccessEnabled Boolean

    Whether to enable public network access? Defaults to true.

    Note: public_network_access_enabled cannot be set to false in Free sku tier.

    publicPort Number
    The publicly accessible port of the SignalR service which is designed for browser/client use.
    resourceGroupName String
    The name of the resource group in which to create the SignalR service. Changing this forces a new resource to be created.
    secondaryAccessKey String
    The secondary access key for the SignalR service.
    secondaryConnectionString String
    The secondary connection string for the SignalR service.
    serverPort Number
    The publicly accessible port of the SignalR service which is designed for customer server side use.
    serverlessConnectionTimeoutInSeconds Number
    Specifies the client connection timeout. Defaults to 30.
    serviceMode String
    Specifies the service mode. Possible values are Classic, Default and Serverless. Defaults to Default.
    sku Property Map
    A sku block as documented below.
    tags Map<String>
    A mapping of tags to assign to the resource.
    tlsClientCertEnabled Boolean

    Whether to request client certificate during TLS handshake? Defaults to false.

    Note: tls_client_cert_enabled cannot be set to true in Free sku tier.

    upstreamEndpoints List<Property Map>
    An upstream_endpoint block as documented below. Using this block requires the SignalR service to be Serverless. When creating multiple blocks they will be processed in the order they are defined in.

    Supporting Types

    ServiceCor, ServiceCorArgs

    AllowedOrigins List<string>
    A list of origins which should be able to make cross-origin calls. * can be used to allow all calls.
    AllowedOrigins []string
    A list of origins which should be able to make cross-origin calls. * can be used to allow all calls.
    allowedOrigins List<String>
    A list of origins which should be able to make cross-origin calls. * can be used to allow all calls.
    allowedOrigins string[]
    A list of origins which should be able to make cross-origin calls. * can be used to allow all calls.
    allowed_origins Sequence[str]
    A list of origins which should be able to make cross-origin calls. * can be used to allow all calls.
    allowedOrigins List<String>
    A list of origins which should be able to make cross-origin calls. * can be used to allow all calls.

    ServiceIdentity, ServiceIdentityArgs

    Type string
    Specifies the type of Managed Service Identity that should be configured on this signalR. Possible values are SystemAssigned, UserAssigned.
    IdentityIds List<string>

    Specifies a list of User Assigned Managed Identity IDs to be assigned to this signalR.

    NOTE: This is required when type is set to UserAssigned

    PrincipalId string
    TenantId string
    Type string
    Specifies the type of Managed Service Identity that should be configured on this signalR. Possible values are SystemAssigned, UserAssigned.
    IdentityIds []string

    Specifies a list of User Assigned Managed Identity IDs to be assigned to this signalR.

    NOTE: This is required when type is set to UserAssigned

    PrincipalId string
    TenantId string
    type String
    Specifies the type of Managed Service Identity that should be configured on this signalR. Possible values are SystemAssigned, UserAssigned.
    identityIds List<String>

    Specifies a list of User Assigned Managed Identity IDs to be assigned to this signalR.

    NOTE: This is required when type is set to UserAssigned

    principalId String
    tenantId String
    type string
    Specifies the type of Managed Service Identity that should be configured on this signalR. Possible values are SystemAssigned, UserAssigned.
    identityIds string[]

    Specifies a list of User Assigned Managed Identity IDs to be assigned to this signalR.

    NOTE: This is required when type is set to UserAssigned

    principalId string
    tenantId string
    type str
    Specifies the type of Managed Service Identity that should be configured on this signalR. Possible values are SystemAssigned, UserAssigned.
    identity_ids Sequence[str]

    Specifies a list of User Assigned Managed Identity IDs to be assigned to this signalR.

    NOTE: This is required when type is set to UserAssigned

    principal_id str
    tenant_id str
    type String
    Specifies the type of Managed Service Identity that should be configured on this signalR. Possible values are SystemAssigned, UserAssigned.
    identityIds List<String>

    Specifies a list of User Assigned Managed Identity IDs to be assigned to this signalR.

    NOTE: This is required when type is set to UserAssigned

    principalId String
    tenantId String

    ServiceLiveTrace, ServiceLiveTraceArgs

    ConnectivityLogsEnabled bool
    Whether the log category ConnectivityLogs is enabled? Defaults to true
    Enabled bool
    Whether the live trace is enabled? Defaults to true.
    HttpRequestLogsEnabled bool
    Whether the log category HttpRequestLogs is enabled? Defaults to true
    MessagingLogsEnabled bool
    Whether the log category MessagingLogs is enabled? Defaults to true
    ConnectivityLogsEnabled bool
    Whether the log category ConnectivityLogs is enabled? Defaults to true
    Enabled bool
    Whether the live trace is enabled? Defaults to true.
    HttpRequestLogsEnabled bool
    Whether the log category HttpRequestLogs is enabled? Defaults to true
    MessagingLogsEnabled bool
    Whether the log category MessagingLogs is enabled? Defaults to true
    connectivityLogsEnabled Boolean
    Whether the log category ConnectivityLogs is enabled? Defaults to true
    enabled Boolean
    Whether the live trace is enabled? Defaults to true.
    httpRequestLogsEnabled Boolean
    Whether the log category HttpRequestLogs is enabled? Defaults to true
    messagingLogsEnabled Boolean
    Whether the log category MessagingLogs is enabled? Defaults to true
    connectivityLogsEnabled boolean
    Whether the log category ConnectivityLogs is enabled? Defaults to true
    enabled boolean
    Whether the live trace is enabled? Defaults to true.
    httpRequestLogsEnabled boolean
    Whether the log category HttpRequestLogs is enabled? Defaults to true
    messagingLogsEnabled boolean
    Whether the log category MessagingLogs is enabled? Defaults to true
    connectivity_logs_enabled bool
    Whether the log category ConnectivityLogs is enabled? Defaults to true
    enabled bool
    Whether the live trace is enabled? Defaults to true.
    http_request_logs_enabled bool
    Whether the log category HttpRequestLogs is enabled? Defaults to true
    messaging_logs_enabled bool
    Whether the log category MessagingLogs is enabled? Defaults to true
    connectivityLogsEnabled Boolean
    Whether the log category ConnectivityLogs is enabled? Defaults to true
    enabled Boolean
    Whether the live trace is enabled? Defaults to true.
    httpRequestLogsEnabled Boolean
    Whether the log category HttpRequestLogs is enabled? Defaults to true
    messagingLogsEnabled Boolean
    Whether the log category MessagingLogs is enabled? Defaults to true

    ServiceSku, ServiceSkuArgs

    Capacity int

    Specifies the number of units associated with this SignalR service. Valid values are 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 20, 30, 40, 50, 60, 70, 80, 90, 100, 200, 300, 400, 500, 600, 700, 800, 900 and 1000.

    NOTE: The valid capacity range for sku Free_F1 is 1, for sku Premium_P2 is from 100 to 1000, and from 1 to 100 for sku Standard_S1 and Premium_P1.

    Name string
    Specifies which tier to use. Valid values are Free_F1, Standard_S1, Premium_P1 and Premium_P2.
    Capacity int

    Specifies the number of units associated with this SignalR service. Valid values are 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 20, 30, 40, 50, 60, 70, 80, 90, 100, 200, 300, 400, 500, 600, 700, 800, 900 and 1000.

    NOTE: The valid capacity range for sku Free_F1 is 1, for sku Premium_P2 is from 100 to 1000, and from 1 to 100 for sku Standard_S1 and Premium_P1.

    Name string
    Specifies which tier to use. Valid values are Free_F1, Standard_S1, Premium_P1 and Premium_P2.
    capacity Integer

    Specifies the number of units associated with this SignalR service. Valid values are 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 20, 30, 40, 50, 60, 70, 80, 90, 100, 200, 300, 400, 500, 600, 700, 800, 900 and 1000.

    NOTE: The valid capacity range for sku Free_F1 is 1, for sku Premium_P2 is from 100 to 1000, and from 1 to 100 for sku Standard_S1 and Premium_P1.

    name String
    Specifies which tier to use. Valid values are Free_F1, Standard_S1, Premium_P1 and Premium_P2.
    capacity number

    Specifies the number of units associated with this SignalR service. Valid values are 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 20, 30, 40, 50, 60, 70, 80, 90, 100, 200, 300, 400, 500, 600, 700, 800, 900 and 1000.

    NOTE: The valid capacity range for sku Free_F1 is 1, for sku Premium_P2 is from 100 to 1000, and from 1 to 100 for sku Standard_S1 and Premium_P1.

    name string
    Specifies which tier to use. Valid values are Free_F1, Standard_S1, Premium_P1 and Premium_P2.
    capacity int

    Specifies the number of units associated with this SignalR service. Valid values are 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 20, 30, 40, 50, 60, 70, 80, 90, 100, 200, 300, 400, 500, 600, 700, 800, 900 and 1000.

    NOTE: The valid capacity range for sku Free_F1 is 1, for sku Premium_P2 is from 100 to 1000, and from 1 to 100 for sku Standard_S1 and Premium_P1.

    name str
    Specifies which tier to use. Valid values are Free_F1, Standard_S1, Premium_P1 and Premium_P2.
    capacity Number

    Specifies the number of units associated with this SignalR service. Valid values are 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 20, 30, 40, 50, 60, 70, 80, 90, 100, 200, 300, 400, 500, 600, 700, 800, 900 and 1000.

    NOTE: The valid capacity range for sku Free_F1 is 1, for sku Premium_P2 is from 100 to 1000, and from 1 to 100 for sku Standard_S1 and Premium_P1.

    name String
    Specifies which tier to use. Valid values are Free_F1, Standard_S1, Premium_P1 and Premium_P2.

    ServiceUpstreamEndpoint, ServiceUpstreamEndpointArgs

    CategoryPatterns List<string>
    The categories to match on, or * for all.
    EventPatterns List<string>
    The events to match on, or * for all.
    HubPatterns List<string>
    The hubs to match on, or * for all.
    UrlTemplate string
    The upstream URL Template. This can be a url or a template such as http://host.com/{hub}/api/{category}/{event}.
    UserAssignedIdentityId string
    Specifies the Managed Identity IDs to be assigned to this signalR upstream setting by using resource uuid as both system assigned and user assigned identity is supported.
    CategoryPatterns []string
    The categories to match on, or * for all.
    EventPatterns []string
    The events to match on, or * for all.
    HubPatterns []string
    The hubs to match on, or * for all.
    UrlTemplate string
    The upstream URL Template. This can be a url or a template such as http://host.com/{hub}/api/{category}/{event}.
    UserAssignedIdentityId string
    Specifies the Managed Identity IDs to be assigned to this signalR upstream setting by using resource uuid as both system assigned and user assigned identity is supported.
    categoryPatterns List<String>
    The categories to match on, or * for all.
    eventPatterns List<String>
    The events to match on, or * for all.
    hubPatterns List<String>
    The hubs to match on, or * for all.
    urlTemplate String
    The upstream URL Template. This can be a url or a template such as http://host.com/{hub}/api/{category}/{event}.
    userAssignedIdentityId String
    Specifies the Managed Identity IDs to be assigned to this signalR upstream setting by using resource uuid as both system assigned and user assigned identity is supported.
    categoryPatterns string[]
    The categories to match on, or * for all.
    eventPatterns string[]
    The events to match on, or * for all.
    hubPatterns string[]
    The hubs to match on, or * for all.
    urlTemplate string
    The upstream URL Template. This can be a url or a template such as http://host.com/{hub}/api/{category}/{event}.
    userAssignedIdentityId string
    Specifies the Managed Identity IDs to be assigned to this signalR upstream setting by using resource uuid as both system assigned and user assigned identity is supported.
    category_patterns Sequence[str]
    The categories to match on, or * for all.
    event_patterns Sequence[str]
    The events to match on, or * for all.
    hub_patterns Sequence[str]
    The hubs to match on, or * for all.
    url_template str
    The upstream URL Template. This can be a url or a template such as http://host.com/{hub}/api/{category}/{event}.
    user_assigned_identity_id str
    Specifies the Managed Identity IDs to be assigned to this signalR upstream setting by using resource uuid as both system assigned and user assigned identity is supported.
    categoryPatterns List<String>
    The categories to match on, or * for all.
    eventPatterns List<String>
    The events to match on, or * for all.
    hubPatterns List<String>
    The hubs to match on, or * for all.
    urlTemplate String
    The upstream URL Template. This can be a url or a template such as http://host.com/{hub}/api/{category}/{event}.
    userAssignedIdentityId String
    Specifies the Managed Identity IDs to be assigned to this signalR upstream setting by using resource uuid as both system assigned and user assigned identity is supported.

    Import

    SignalR services can be imported using the resource id, e.g.

    $ pulumi import azure:signalr/service:Service example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/terraform-signalr/providers/Microsoft.SignalRService/signalR/tfex-signalr

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    Azure Classic pulumi/pulumi-azure
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the azurerm Terraform Provider.
    azure logo

    We recommend using Azure Native.

    Azure Classic v5.81.0 published on Monday, Jun 24, 2024 by Pulumi
    pulumi/pulumi-azure