1. Docs
  2. Reference
  3. API
  4. pulumi_azure
  5. signalr

This page documents the language specification for the azure package. If you're looking for help working with the inputs, outputs, or functions of azure resources in a Pulumi program, please see the resource documentation for examples and API reference.

signalr

This provider is a derived work of the Terraform Provider distributed under MPL 2.0. If you encounter a bug or missing feature, first check the pulumi/pulumi-azure repo; however, if that doesn’t turn up anything, please consult the source terraform-providers/terraform-provider-azurerm repo.

class pulumi_azure.signalr.AwaitableGetServiceResult(hostname=None, id=None, ip_address=None, location=None, name=None, primary_access_key=None, primary_connection_string=None, public_port=None, resource_group_name=None, secondary_access_key=None, secondary_connection_string=None, server_port=None, tags=None)
class pulumi_azure.signalr.GetServiceResult(hostname=None, id=None, ip_address=None, location=None, name=None, primary_access_key=None, primary_connection_string=None, public_port=None, resource_group_name=None, secondary_access_key=None, secondary_connection_string=None, server_port=None, tags=None)

A collection of values returned by getService.

hostname = None

The FQDN of the SignalR service.

id = None

The provider-assigned unique ID for this managed resource.

ip_address = None

The publicly accessible IP of the SignalR service.

location = None

Specifies the supported Azure location where the SignalR service exists.

primary_access_key = None

The primary access key of the SignalR service.

primary_connection_string = None

The primary connection string of the SignalR service.

public_port = None

The publicly accessible port of the SignalR service which is designed for browser/client use.

secondary_access_key = None

The secondary access key of the SignalR service.

secondary_connection_string = None

The secondary connection string of the SignalR service.

server_port = None

The publicly accessible port of the SignalR service which is designed for customer server side use.

class pulumi_azure.signalr.Service(resource_name, opts=None, cors=None, features=None, location=None, name=None, resource_group_name=None, sku=None, tags=None, __props__=None, __name__=None, __opts__=None)

Manages an Azure SignalR service.

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={
        "name": "Free_F1",
        "capacity": 1,
    },
    cors=[{
        "allowedOrigins": ["http://www.example.com"],
    }],
    features=[{
        "flag": "ServiceMode",
        "value": "Default",
    }])
Parameters

  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • cors (pulumi.Input[list]) – A cors block as documented below.

  • features (pulumi.Input[list]) – A features block as documented below.

  • location (pulumi.Input[str]) – Specifies the supported Azure location where the SignalR service exists. Changing this forces a new resource to be created.

  • name (pulumi.Input[str]) – The name of the SignalR service. Changing this forces a new resource to be created.

  • resource_group_name (pulumi.Input[str]) – The name of the resource group in which to create the SignalR service. Changing this forces a new resource to be created.

  • sku (pulumi.Input[dict]) – A sku block as documented below.

  • tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource.

The cors object supports the following:

  • allowedOrigins (pulumi.Input[list]) - A list of origins which should be able to make cross-origin calls. * can be used to allow all calls.

The features object supports the following:

  • flag (pulumi.Input[str]) - The kind of Feature. Possible values are EnableConnectivityLogs, EnableMessagingLogs, and ServiceMode.

  • value (pulumi.Input[str]) - A value of a feature flag. Possible values are Classic, Default and Serverless.

The sku object supports the following:

  • capacity (pulumi.Input[float]) - Specifies the number of units associated with this SignalR service. Valid values are 1, 2, 5, 10, 20, 50 and 100.

  • name (pulumi.Input[str]) - Specifies which tier to use. Valid values are Free_F1 and Standard_S1.

cors: pulumi.Output[list] = None

A cors block as documented below.

  • allowedOrigins (list) - A list of origins which should be able to make cross-origin calls. * can be used to allow all calls.

features: pulumi.Output[list] = None

A features block as documented below.

  • flag (str) - The kind of Feature. Possible values are EnableConnectivityLogs, EnableMessagingLogs, and ServiceMode.

  • value (str) - A value of a feature flag. Possible values are Classic, Default and Serverless.

hostname: pulumi.Output[str] = None

The FQDN of the SignalR service.

ip_address: pulumi.Output[str] = None

The publicly accessible IP of the SignalR service.

location: pulumi.Output[str] = None

Specifies the supported Azure location where the SignalR service exists. Changing this forces a new resource to be created.

name: pulumi.Output[str] = None

The name of the SignalR service. Changing this forces a new resource to be created.

primary_access_key: pulumi.Output[str] = None

The primary access key for the SignalR service.

primary_connection_string: pulumi.Output[str] = None

The primary connection string for the SignalR service.

public_port: pulumi.Output[float] = None

The publicly accessible port of the SignalR service which is designed for browser/client use.

resource_group_name: pulumi.Output[str] = None

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: pulumi.Output[str] = None

The secondary access key for the SignalR service.

secondary_connection_string: pulumi.Output[str] = None

The secondary connection string for the SignalR service.

server_port: pulumi.Output[float] = None

The publicly accessible port of the SignalR service which is designed for customer server side use.

sku: pulumi.Output[dict] = None

A sku block as documented below.

  • capacity (float) - 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.

tags: pulumi.Output[dict] = None

A mapping of tags to assign to the resource.

static get(resource_name, id, opts=None, cors=None, features=None, hostname=None, ip_address=None, location=None, name=None, primary_access_key=None, primary_connection_string=None, public_port=None, resource_group_name=None, secondary_access_key=None, secondary_connection_string=None, server_port=None, sku=None, tags=None)

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

Parameters

  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • cors (pulumi.Input[list]) – A cors block as documented below.

  • features (pulumi.Input[list]) – A features block as documented below.

  • hostname (pulumi.Input[str]) – The FQDN of the SignalR service.

  • ip_address (pulumi.Input[str]) – The publicly accessible IP of the SignalR service.

  • location (pulumi.Input[str]) – Specifies the supported Azure location where the SignalR service exists. Changing this forces a new resource to be created.

  • name (pulumi.Input[str]) – The name of the SignalR service. Changing this forces a new resource to be created.

  • primary_access_key (pulumi.Input[str]) – The primary access key for the SignalR service.

  • primary_connection_string (pulumi.Input[str]) – The primary connection string for the SignalR service.

  • public_port (pulumi.Input[float]) – The publicly accessible port of the SignalR service which is designed for browser/client use.

  • resource_group_name (pulumi.Input[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 (pulumi.Input[str]) – The secondary access key for the SignalR service.

  • secondary_connection_string (pulumi.Input[str]) – The secondary connection string for the SignalR service.

  • server_port (pulumi.Input[float]) – The publicly accessible port of the SignalR service which is designed for customer server side use.

  • sku (pulumi.Input[dict]) – A sku block as documented below.

  • tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource.

The cors object supports the following:

  • allowedOrigins (pulumi.Input[list]) - A list of origins which should be able to make cross-origin calls. * can be used to allow all calls.

The features object supports the following:

  • flag (pulumi.Input[str]) - The kind of Feature. Possible values are EnableConnectivityLogs, EnableMessagingLogs, and ServiceMode.

  • value (pulumi.Input[str]) - A value of a feature flag. Possible values are Classic, Default and Serverless.

The sku object supports the following:

  • capacity (pulumi.Input[float]) - Specifies the number of units associated with this SignalR service. Valid values are 1, 2, 5, 10, 20, 50 and 100.

  • name (pulumi.Input[str]) - Specifies which tier to use. Valid values are Free_F1 and Standard_S1.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

pulumi_azure.signalr.get_service(name=None, resource_group_name=None, opts=None)

Use this data source to access information about an existing Azure SignalR service.

import pulumi
import pulumi_azure as azure

example = azure.signalr.get_service(name="test-signalr",
    resource_group_name="signalr-resource-group")
Parameters

  • name (str) – Specifies the name of the SignalR service.

  • resource_group_name (str) – Specifies the name of the resource group the SignalR service is located in.