Class Service

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",
                },
            },
        },
        Features = 
        {
            new Azure.SignalR.Inputs.ServiceFeatureArgs
            {
                Flag = "ServiceMode",
                Value = "Default",
            },
        },
    });
}

}

Inheritance

System.Object

Resource

CustomResource

Service

Inherited Members

CustomResource.Id

Resource.GetResourceType()

Resource.GetResourceName()

Resource.Urn

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Pulumi.Azure.SignalR

Assembly: Pulumi.Azure.dll

Syntax

public class Service : CustomResource

Constructors

Service(String, ServiceArgs, CustomResourceOptions)

Create a Service resource with the given unique name, arguments, and options.

Declaration

public Service(string name, ServiceArgs args, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resource
ServiceArgs	args	The arguments used to populate this resource's properties
CustomResourceOptions	options	A bag of options that control this resource's behavior

Properties

Cors

A cors block as documented below.

Declaration

public Output<ImmutableArray<ServiceCor>> Cors { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableArray<ServiceCor>>

Features

A features block as documented below.

Declaration

public Output<ImmutableArray<ServiceFeature>> Features { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableArray<ServiceFeature>>

Hostname

The FQDN of the SignalR service.

Declaration

public Output<string> Hostname { get; }

Property Value

Type	Description
Output<System.String>

IpAddress

The publicly accessible IP of the SignalR service.

Declaration

public Output<string> IpAddress { get; }

Property Value

Type	Description
Output<System.String>

Location

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

Declaration

public Output<string> Location { get; }

Property Value

Type	Description
Output<System.String>

Name

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

Declaration

public Output<string> Name { get; }

Property Value

Type	Description
Output<System.String>

PrimaryAccessKey

The primary access key for the SignalR service.

Declaration

public Output<string> PrimaryAccessKey { get; }

Property Value

Type	Description
Output<System.String>

PrimaryConnectionString

The primary connection string for the SignalR service.

Declaration

public Output<string> PrimaryConnectionString { get; }

Property Value

Type	Description
Output<System.String>

PublicPort

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

Declaration

public Output<int> PublicPort { get; }

Property Value

Type	Description
Output<System.Int32>

ResourceGroupName

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

Declaration

public Output<string> ResourceGroupName { get; }

Property Value

Type	Description
Output<System.String>

SecondaryAccessKey

The secondary access key for the SignalR service.

Declaration

public Output<string> SecondaryAccessKey { get; }

Property Value

Type	Description
Output<System.String>

SecondaryConnectionString

The secondary connection string for the SignalR service.

Declaration

public Output<string> SecondaryConnectionString { get; }

Property Value

Type	Description
Output<System.String>

ServerPort

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

Declaration

public Output<int> ServerPort { get; }

Property Value

Type	Description
Output<System.Int32>

Sku

A sku block as documented below.

Declaration

public Output<ServiceSku> Sku { get; }

Property Value

Type	Description
Output<ServiceSku>

Tags

A mapping of tags to assign to the resource.

Declaration

public Output<ImmutableDictionary<string, string>> Tags { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableDictionary<System.String, System.String>>

Methods

Get(String, Input<String>, ServiceState, CustomResourceOptions)

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

Declaration

public static Service Get(string name, Input<string> id, ServiceState state = null, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resulting resource.
Input<System.String>	id	The unique provider ID of the resource to lookup.
ServiceState	state	Any extra arguments used during the lookup.
CustomResourceOptions	options	A bag of options that control this resource's behavior

Returns

Type	Description
Service