Sign in Dashboard Get started
  1. Packages
  2. Packages
  3. Azure Classic
  4. API Docs
  5. signalr
  6. Service

We recommend using Azure Native.

Viewing docs for Azure v4.42.0 (Older version)
published on Monday, Mar 9, 2026 by Pulumi
Go to latest version
Schema (JSON)
pulumi/pulumi-azure

azure.signalr.Service

azure logo

We recommend using Azure Native.

Viewing docs for Azure v4.42.0 (Older version)
published on Monday, Mar 9, 2026 by Pulumi
Go to latest version
Schema (JSON)
pulumi/pulumi-azure

    Manages an Azure SignalR service.

    Example Usage

    using Pulumi;
using Azure = Pulumi.Azure;

class MyStack : Stack
{
    public MyStack()
    {
        var exampleResourceGroup = new Azure.Core.ResourceGroup("exampleResourceGroup", new Azure.Core.ResourceGroupArgs
        {
            Location = "West US",
        });
        var exampleService = new Azure.SignalR.Service("exampleService", new Azure.SignalR.ServiceArgs
        {
            Location = exampleResourceGroup.Location,
            ResourceGroupName = exampleResourceGroup.Name,
            Sku = new Azure.SignalR.Inputs.ServiceSkuArgs
            {
                Name = "Free_F1",
                Capacity = 1,
            },
            Cors = 
            {
                new Azure.SignalR.Inputs.ServiceCorArgs
                {
                    AllowedOrigins = 
                    {
                        "http://www.example.com",
                    },
                },
            },
            ConnectivityLogsEnabled = true,
            MessagingLogsEnabled = true,
            ServiceMode = "Default",
            UpstreamEndpoints = 
            {
                new Azure.SignalR.Inputs.ServiceUpstreamEndpointArgs
                {
                    CategoryPatterns = 
                    {
                        "connections",
                        "messages",
                    },
                    EventPatterns = 
                    {
                        "*",
                    },
                    HubPatterns = 
                    {
                        "hub1",
                    },
                    UrlTemplate = "http://foo.com",
                },
            },
        });
    }

}

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		exampleResourceGroup, err := core.NewResourceGroup(ctx, "exampleResourceGroup", &core.ResourceGroupArgs{
			Location: pulumi.String("West US"),
		})
		if err != nil {
			return err
		}
		_, err = signalr.NewService(ctx, "exampleService", &signalr.ServiceArgs{
			Location:          exampleResourceGroup.Location,
			ResourceGroupName: exampleResourceGroup.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"),
					},
				},
			},
			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
	})
}

    Example coming soon!

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

const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "West US"});
const exampleService = new azure.signalr.Service("exampleService", {
    location: exampleResourceGroup.location,
    resourceGroupName: exampleResourceGroup.name,
    sku: {
        name: "Free_F1",
        capacity: 1,
    },
    cors: [{
        allowedOrigins: ["http://www.example.com"],
    }],
    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_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West US")
example_service = azure.signalr.Service("exampleService",
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name,
    sku=azure.signalr.ServiceSkuArgs(
        name="Free_F1",
        capacity=1,
    ),
    cors=[azure.signalr.ServiceCorArgs(
        allowed_origins=["http://www.example.com"],
    )],
    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",
    )])

    Example coming soon!

    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,
            connectivity_logs_enabled: Optional[bool] = None,
            cors: Optional[Sequence[ServiceCorArgs]] = None,
            features: Optional[Sequence[ServiceFeatureArgs]] = None,
            live_trace_enabled: Optional[bool] = None,
            location: Optional[str] = None,
            messaging_logs_enabled: Optional[bool] = None,
            name: Optional[str] = None,
            service_mode: Optional[str] = None,
            tags: Optional[Mapping[str, str]] = 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",
    },
    ConnectivityLogsEnabled = false,
    Cors = new[]
    {
        new Azure.SignalR.Inputs.ServiceCorArgs
        {
            AllowedOrigins = new[]
            {
                "string",
            },
        },
    },
    LiveTraceEnabled = false,
    Location = "string",
    MessagingLogsEnabled = false,
    Name = "string",
    ServiceMode = "string",
    Tags = 
    {
        { "string", "string" },
    },
    UpstreamEndpoints = new[]
    {
        new Azure.SignalR.Inputs.ServiceUpstreamEndpointArgs
        {
            CategoryPatterns = new[]
            {
                "string",
            },
            EventPatterns = new[]
            {
                "string",
            },
            HubPatterns = new[]
            {
                "string",
            },
            UrlTemplate = "string",
        },
    },
});

    example, err := signalr.NewService(ctx, "exampleserviceResourceResourceFromSignalrservice", &signalr.ServiceArgs{
	ResourceGroupName: pulumi.String("string"),
	Sku: &signalr.ServiceSkuArgs{
		Capacity: pulumi.Int(0),
		Name:     pulumi.String("string"),
	},
	ConnectivityLogsEnabled: pulumi.Bool(false),
	Cors: signalr.ServiceCorArray{
		&signalr.ServiceCorArgs{
			AllowedOrigins: pulumi.StringArray{
				pulumi.String("string"),
			},
		},
	},
	LiveTraceEnabled:     pulumi.Bool(false),
	Location:             pulumi.String("string"),
	MessagingLogsEnabled: pulumi.Bool(false),
	Name:                 pulumi.String("string"),
	ServiceMode:          pulumi.String("string"),
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	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"),
		},
	},
})

    var exampleserviceResourceResourceFromSignalrservice = new com.pulumi.azure.signalr.Service("exampleserviceResourceResourceFromSignalrservice", com.pulumi.azure.signalr.ServiceArgs.builder()
    .resourceGroupName("string")
    .sku(ServiceSkuArgs.builder()
        .capacity(0)
        .name("string")
        .build())
    .connectivityLogsEnabled(false)
    .cors(ServiceCorArgs.builder()
        .allowedOrigins("string")
        .build())
    .liveTraceEnabled(false)
    .location("string")
    .messagingLogsEnabled(false)
    .name("string")
    .serviceMode("string")
    .tags(Map.of("string", "string"))
    .upstreamEndpoints(ServiceUpstreamEndpointArgs.builder()
        .categoryPatterns("string")
        .eventPatterns("string")
        .hubPatterns("string")
        .urlTemplate("string")
        .build())
    .build());

    exampleservice_resource_resource_from_signalrservice = azure.signalr.Service("exampleserviceResourceResourceFromSignalrservice",
    resource_group_name="string",
    sku={
        "capacity": 0,
        "name": "string",
    },
    connectivity_logs_enabled=False,
    cors=[{
        "allowed_origins": ["string"],
    }],
    live_trace_enabled=False,
    location="string",
    messaging_logs_enabled=False,
    name="string",
    service_mode="string",
    tags={
        "string": "string",
    },
    upstream_endpoints=[{
        "category_patterns": ["string"],
        "event_patterns": ["string"],
        "hub_patterns": ["string"],
        "url_template": "string",
    }])

    const exampleserviceResourceResourceFromSignalrservice = new azure.signalr.Service("exampleserviceResourceResourceFromSignalrservice", {
    resourceGroupName: "string",
    sku: {
        capacity: 0,
        name: "string",
    },
    connectivityLogsEnabled: false,
    cors: [{
        allowedOrigins: ["string"],
    }],
    liveTraceEnabled: false,
    location: "string",
    messagingLogsEnabled: false,
    name: "string",
    serviceMode: "string",
    tags: {
        string: "string",
    },
    upstreamEndpoints: [{
        categoryPatterns: ["string"],
        eventPatterns: ["string"],
        hubPatterns: ["string"],
        urlTemplate: "string",
    }],
});

    type: azure:signalr:Service
properties:
    connectivityLogsEnabled: false
    cors:
        - allowedOrigins:
            - string
    liveTraceEnabled: false
    location: string
    messagingLogsEnabled: false
    name: string
    resourceGroupName: string
    serviceMode: string
    sku:
        capacity: 0
        name: string
    tags:
        string: string
    upstreamEndpoints:
        - categoryPatterns:
            - string
          eventPatterns:
            - string
          hubPatterns:
            - string
          urlTemplate: 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

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    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.
    ConnectivityLogsEnabled bool
    Specifies if Connectivity Logs are enabled or not. Defaults to false.
    Cors List<ServiceCor>
    A cors block as documented below.
    Features List<ServiceFeature>
    A features block as documented below.

    Deprecated: Deprecated in favour of connectivity_logs_enabled, messaging_logs_enabled, live_trace_enabled and service_mode

    LiveTraceEnabled bool
    Specifies if Live Trace is enabled or not. Defaults to false.
    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.
    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.
    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.
    ConnectivityLogsEnabled bool
    Specifies if Connectivity Logs are enabled or not. Defaults to false.
    Cors []ServiceCorArgs
    A cors block as documented below.
    Features []ServiceFeatureArgs
    A features block as documented below.

    Deprecated: Deprecated in favour of connectivity_logs_enabled, messaging_logs_enabled, live_trace_enabled and service_mode

    LiveTraceEnabled bool
    Specifies if Live Trace is enabled or not. Defaults to false.
    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.
    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.
    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.
    connectivityLogsEnabled Boolean
    Specifies if Connectivity Logs are enabled or not. Defaults to false.
    cors List<ServiceCor>
    A cors block as documented below.
    features List<ServiceFeature>
    A features block as documented below.

    Deprecated: Deprecated in favour of connectivity_logs_enabled, messaging_logs_enabled, live_trace_enabled and service_mode

    liveTraceEnabled Boolean
    Specifies if Live Trace is enabled or not. Defaults to false.
    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.
    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.
    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.
    connectivityLogsEnabled boolean
    Specifies if Connectivity Logs are enabled or not. Defaults to false.
    cors ServiceCor[]
    A cors block as documented below.
    features ServiceFeature[]
    A features block as documented below.

    Deprecated: Deprecated in favour of connectivity_logs_enabled, messaging_logs_enabled, live_trace_enabled and service_mode

    liveTraceEnabled boolean
    Specifies if Live Trace is enabled or not. Defaults to false.
    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.
    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.
    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.
    connectivity_logs_enabled bool
    Specifies if Connectivity Logs are enabled or not. Defaults to false.
    cors Sequence[ServiceCorArgs]
    A cors block as documented below.
    features Sequence[ServiceFeatureArgs]
    A features block as documented below.

    Deprecated: Deprecated in favour of connectivity_logs_enabled, messaging_logs_enabled, live_trace_enabled and service_mode

    live_trace_enabled bool
    Specifies if Live Trace is enabled or not. Defaults to false.
    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.
    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.
    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.
    connectivityLogsEnabled Boolean
    Specifies if Connectivity Logs are enabled or not. Defaults to false.
    cors List<Property Map>
    A cors block as documented below.
    features List<Property Map>
    A features block as documented below.

    Deprecated: Deprecated in favour of connectivity_logs_enabled, messaging_logs_enabled, live_trace_enabled and service_mode

    liveTraceEnabled Boolean
    Specifies if Live Trace is enabled or not. Defaults to false.
    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.
    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.
    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,
        connectivity_logs_enabled: Optional[bool] = None,
        cors: Optional[Sequence[ServiceCorArgs]] = None,
        features: Optional[Sequence[ServiceFeatureArgs]] = None,
        hostname: Optional[str] = None,
        ip_address: Optional[str] = None,
        live_trace_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_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,
        service_mode: Optional[str] = None,
        sku: Optional[ServiceSkuArgs] = None,
        tags: Optional[Mapping[str, str]] = 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)
    resources:  _:    type: azure:signalr:Service    get:      id: ${id}
    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:
    ConnectivityLogsEnabled bool
    Specifies if Connectivity Logs are enabled or not. Defaults to false.
    Cors List<ServiceCor>
    A cors block as documented below.
    Features List<ServiceFeature>
    A features block as documented below.

    Deprecated: Deprecated in favour of connectivity_logs_enabled, messaging_logs_enabled, live_trace_enabled and service_mode

    Hostname string
    The FQDN of the SignalR service.
    IpAddress string
    The publicly accessible IP of the SignalR service.
    LiveTraceEnabled bool
    Specifies if Live Trace is enabled or not. Defaults to false.
    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.
    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.
    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.
    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.
    ConnectivityLogsEnabled bool
    Specifies if Connectivity Logs are enabled or not. Defaults to false.
    Cors []ServiceCorArgs
    A cors block as documented below.
    Features []ServiceFeatureArgs
    A features block as documented below.

    Deprecated: Deprecated in favour of connectivity_logs_enabled, messaging_logs_enabled, live_trace_enabled and service_mode

    Hostname string
    The FQDN of the SignalR service.
    IpAddress string
    The publicly accessible IP of the SignalR service.
    LiveTraceEnabled bool
    Specifies if Live Trace is enabled or not. Defaults to false.
    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.
    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.
    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.
    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.
    connectivityLogsEnabled Boolean
    Specifies if Connectivity Logs are enabled or not. Defaults to false.
    cors List<ServiceCor>
    A cors block as documented below.
    features List<ServiceFeature>
    A features block as documented below.

    Deprecated: Deprecated in favour of connectivity_logs_enabled, messaging_logs_enabled, live_trace_enabled and service_mode

    hostname String
    The FQDN of the SignalR service.
    ipAddress String
    The publicly accessible IP of the SignalR service.
    liveTraceEnabled Boolean
    Specifies if Live Trace is enabled or not. Defaults to false.
    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.
    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.
    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.
    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.
    connectivityLogsEnabled boolean
    Specifies if Connectivity Logs are enabled or not. Defaults to false.
    cors ServiceCor[]
    A cors block as documented below.
    features ServiceFeature[]
    A features block as documented below.

    Deprecated: Deprecated in favour of connectivity_logs_enabled, messaging_logs_enabled, live_trace_enabled and service_mode

    hostname string
    The FQDN of the SignalR service.
    ipAddress string
    The publicly accessible IP of the SignalR service.
    liveTraceEnabled boolean
    Specifies if Live Trace is enabled or not. Defaults to false.
    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.
    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.
    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.
    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.
    connectivity_logs_enabled bool
    Specifies if Connectivity Logs are enabled or not. Defaults to false.
    cors Sequence[ServiceCorArgs]
    A cors block as documented below.
    features Sequence[ServiceFeatureArgs]
    A features block as documented below.

    Deprecated: Deprecated in favour of connectivity_logs_enabled, messaging_logs_enabled, live_trace_enabled and service_mode

    hostname str
    The FQDN of the SignalR service.
    ip_address str
    The publicly accessible IP of the SignalR service.
    live_trace_enabled bool
    Specifies if Live Trace is enabled or not. Defaults to false.
    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_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.
    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.
    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.
    connectivityLogsEnabled Boolean
    Specifies if Connectivity Logs are enabled or not. Defaults to false.
    cors List<Property Map>
    A cors block as documented below.
    features List<Property Map>
    A features block as documented below.

    Deprecated: Deprecated in favour of connectivity_logs_enabled, messaging_logs_enabled, live_trace_enabled and service_mode

    hostname String
    The FQDN of the SignalR service.
    ipAddress String
    The publicly accessible IP of the SignalR service.
    liveTraceEnabled Boolean
    Specifies if Live Trace is enabled or not. Defaults to false.
    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.
    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.
    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.
    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.

    ServiceFeature, ServiceFeatureArgs

    Flag string
    The kind of Feature. Possible values are EnableConnectivityLogs, EnableMessagingLogs, EnableLiveTrace and ServiceMode.
    Value string
    A value of a feature flag. Possible values are Classic, Default and Serverless.
    Flag string
    The kind of Feature. Possible values are EnableConnectivityLogs, EnableMessagingLogs, EnableLiveTrace and ServiceMode.
    Value string
    A value of a feature flag. Possible values are Classic, Default and Serverless.
    flag String
    The kind of Feature. Possible values are EnableConnectivityLogs, EnableMessagingLogs, EnableLiveTrace and ServiceMode.
    value String
    A value of a feature flag. Possible values are Classic, Default and Serverless.
    flag string
    The kind of Feature. Possible values are EnableConnectivityLogs, EnableMessagingLogs, EnableLiveTrace and ServiceMode.
    value string
    A value of a feature flag. Possible values are Classic, Default and Serverless.
    flag str
    The kind of Feature. Possible values are EnableConnectivityLogs, EnableMessagingLogs, EnableLiveTrace and ServiceMode.
    value str
    A value of a feature flag. Possible values are Classic, Default and Serverless.
    flag String
    The kind of Feature. Possible values are EnableConnectivityLogs, EnableMessagingLogs, EnableLiveTrace and ServiceMode.
    value String
    A value of a feature flag. Possible values are Classic, Default and Serverless.

    ServiceSku, ServiceSkuArgs

    Capacity int
    Specifies the number of units associated with this SignalR service. Valid values are 1, 2, 5, 10, 20, 50 and 100.
    Name string
    Specifies which tier to use. Valid values are Free_F1 and Standard_S1.
    Capacity int
    Specifies the number of units associated with this SignalR service. Valid values are 1, 2, 5, 10, 20, 50 and 100.
    Name string
    Specifies which tier to use. Valid values are Free_F1 and Standard_S1.
    capacity Integer
    Specifies the number of units associated with this SignalR service. Valid values are 1, 2, 5, 10, 20, 50 and 100.
    name String
    Specifies which tier to use. Valid values are Free_F1 and Standard_S1.
    capacity number
    Specifies the number of units associated with this SignalR service. Valid values are 1, 2, 5, 10, 20, 50 and 100.
    name string
    Specifies which tier to use. Valid values are Free_F1 and Standard_S1.
    capacity int
    Specifies the number of units associated with this SignalR service. Valid values are 1, 2, 5, 10, 20, 50 and 100.
    name str
    Specifies which tier to use. Valid values are Free_F1 and Standard_S1.
    capacity Number
    Specifies the number of units associated with this SignalR service. Valid values are 1, 2, 5, 10, 20, 50 and 100.
    name String
    Specifies which tier to use. Valid values are Free_F1 and Standard_S1.

    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}.
    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}.
    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}.
    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}.
    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}.
    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}.

    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.

    Viewing docs for Azure v4.42.0 (Older version)
    published on Monday, Mar 9, 2026 by Pulumi
    Go to latest version
    Schema (JSON)
    pulumi/pulumi-azure

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial