Azure Classic v5.38.0, Mar 21 23

azure.signalr.Service

Manages an Azure SignalR service.

Example Usage

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

return await Deployment.RunAsync(() => 
{
    var exampleResourceGroup = new Azure.Core.ResourceGroup("exampleResourceGroup", new()
    {
        Location = "West US",
    });

    var exampleService = new Azure.SignalR.Service("exampleService", new()
    {
        Location = exampleResourceGroup.Location,
        ResourceGroupName = exampleResourceGroup.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",
                },
            },
        },
        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 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 {
		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
	})
}

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 exampleResourceGroup = new ResourceGroup("exampleResourceGroup", ResourceGroupArgs.builder()        
            .location("West US")
            .build());

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

    }
}

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",
    )])

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",
    }],
});

resources:
  exampleResourceGroup:
    type: azure:core:ResourceGroup
    properties:
      location: West US
  exampleService:
    type: azure:signalr:Service
    properties:
      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

Create Service Resource

new Service(name: string, args: ServiceArgs, opts?: CustomResourceOptions);

@overload
def Service(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            connectivity_logs_enabled: Optional[bool] = None,
            cors: Optional[Sequence[ServiceCorArgs]] = None,
            live_trace: Optional[ServiceLiveTraceArgs] = None,
            live_trace_enabled: Optional[bool] = None,
            location: Optional[str] = None,
            messaging_logs_enabled: Optional[bool] = None,
            name: Optional[str] = None,
            resource_group_name: Optional[str] = None,
            service_mode: Optional[str] = None,
            sku: Optional[ServiceSkuArgs] = None,
            tags: Optional[Mapping[str, str]] = None,
            upstream_endpoints: Optional[Sequence[ServiceUpstreamEndpointArgs]] = None)
@overload
def Service(resource_name: str,
            args: ServiceArgs,
            opts: Optional[ResourceOptions] = 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.

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.

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 ServiceSkuArgs

A sku block as documented below.

ConnectivityLogsEnabled bool

Specifies if Connectivity Logs are enabled or not. Defaults to false.

Cors List<ServiceCorArgs>

A cors block as documented 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.

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

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.

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

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 Boolean

Specifies if Connectivity Logs are enabled or not. Defaults to false.

cors List<ServiceCorArgs>

A cors block as documented below.

liveTrace ServiceLiveTraceArgs

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.

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

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 boolean

Specifies if Connectivity Logs are enabled or not. Defaults to false.

cors ServiceCorArgs[]

A cors block as documented below.

liveTrace ServiceLiveTraceArgs

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.

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

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.

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.

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]

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.

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.

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>

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,
        hostname: Optional[str] = None,
        ip_address: Optional[str] = None,
        live_trace: Optional[ServiceLiveTraceArgs] = 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)

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:

ConnectivityLogsEnabled bool

Specifies if Connectivity Logs are enabled or not. Defaults to false.

Cors List<ServiceCorArgs>

A cors block as documented below.

Hostname string

The FQDN of the SignalR service.

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.

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 Dictionary<string, string>

A mapping of tags to assign to the resource.

UpstreamEndpoints List<ServiceUpstreamEndpointArgs>

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.

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.

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

connectivityLogsEnabled Boolean

Specifies if Connectivity Logs are enabled or not. Defaults to false.

cors List<ServiceCorArgs>

A cors block as documented below.

hostname String

The FQDN of the SignalR service.

ipAddress String

The publicly accessible IP of the SignalR service.

liveTrace ServiceLiveTraceArgs

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.

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 ServiceSkuArgs

A sku block as documented below.

tags Map<String,String>

A mapping of tags to assign to the resource.

upstreamEndpoints List<ServiceUpstreamEndpointArgs>

connectivityLogsEnabled boolean

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.

ipAddress string

The publicly accessible IP of the SignalR service.

liveTrace ServiceLiveTraceArgs

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.

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 ServiceSkuArgs

A sku block as documented below.

tags {[key: string]: string}

A mapping of tags to assign to the resource.

upstreamEndpoints ServiceUpstreamEndpointArgs[]

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.

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.

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]

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.

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.

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>

Supporting Types

ServiceCor

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.

ServiceLiveTrace

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

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, Standard_S1 and Premium_P1.

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, Standard_S1 and Premium_P1.

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, Standard_S1 and Premium_P1.

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, Standard_S1 and Premium_P1.

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, Standard_S1 and Premium_P1.

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, Standard_S1 and Premium_P1.

ServiceUpstreamEndpoint

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

Package Details

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

azure.signalr.Service

Example Usage

Create Service Resource

Service Resource Properties

Inputs

Outputs

Look up Existing Service Resource

Supporting Types

ServiceCor

ServiceLiveTrace

ServiceSku

ServiceUpstreamEndpoint

Import

Package Details

Contents