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

Resources

Resource Service

class Service extends CustomResource

Manages an Azure SignalR service.

Example Usage

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"],
    }],
    features: [{
        flag: "ServiceMode",
        value: "Default",
    }],
});

constructor

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

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

name The unique name of the resource.
args The arguments to use to populate this resource's properties.
opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: ServiceState, opts?: pulumi.CustomResourceOptions): Service

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is Service

Returns true if the given object is an instance of Service. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property cors

public cors: pulumi.Output<ServiceCor[]>;

A cors block as documented below.

property features

public features: pulumi.Output<ServiceFeature[]>;

A features block as documented below.

property hostname

public hostname: pulumi.Output<string>;

The FQDN of the SignalR service.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property ipAddress

public ipAddress: pulumi.Output<string>;

The publicly accessible IP of the SignalR service.

property location

public location: pulumi.Output<string>;

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

property name

public name: pulumi.Output<string>;

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

property primaryAccessKey

public primaryAccessKey: pulumi.Output<string>;

The primary access key for the SignalR service.

property primaryConnectionString

public primaryConnectionString: pulumi.Output<string>;

The primary connection string for the SignalR service.

property publicPort

public publicPort: pulumi.Output<number>;

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

property resourceGroupName

public resourceGroupName: pulumi.Output<string>;

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

property secondaryAccessKey

public secondaryAccessKey: pulumi.Output<string>;

The secondary access key for the SignalR service.

property secondaryConnectionString

public secondaryConnectionString: pulumi.Output<string>;

The secondary connection string for the SignalR service.

property serverPort

public serverPort: pulumi.Output<number>;

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

property sku

public sku: pulumi.Output<ServiceSku>;

A sku block as documented below.

property tags

public tags: pulumi.Output<{[key: string]: string} | undefined>;

A mapping of tags to assign to the resource.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Functions

Function getService

getService(args: GetServiceArgs, opts?: pulumi.InvokeOptions): Promise<GetServiceResult>

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

Example Usage

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

const example = pulumi.output(azure.signalr.getService({
    name: "test-signalr",
    resourceGroupName: "signalr-resource-group",
}, { async: true }));

Others

interface GetServiceArgs

interface GetServiceArgs

A collection of arguments for invoking getService.

property name

name: string;

Specifies the name of the SignalR service.

property resourceGroupName

resourceGroupName: string;

Specifies the name of the resource group the SignalR service is located in.

interface GetServiceResult

interface GetServiceResult

A collection of values returned by getService.

property hostname

hostname: string;

The FQDN of the SignalR service.

property id

id: string;

The provider-assigned unique ID for this managed resource.

property ipAddress

ipAddress: string;

The publicly accessible IP of the SignalR service.

property location

location: string;

Specifies the supported Azure location where the SignalR service exists.

property name

name: string;

property primaryAccessKey

primaryAccessKey: string;

The primary access key of the SignalR service.

property primaryConnectionString

primaryConnectionString: string;

The primary connection string of the SignalR service.

property publicPort

publicPort: number;

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

property resourceGroupName

resourceGroupName: string;

property secondaryAccessKey

secondaryAccessKey: string;

The secondary access key of the SignalR service.

property secondaryConnectionString

secondaryConnectionString: string;

The secondary connection string of the SignalR service.

property serverPort

serverPort: number;

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

property tags

tags: {[key: string]: string};

interface ServiceArgs

interface ServiceArgs

The set of arguments for constructing a Service resource.

property cors

cors?: pulumi.Input<pulumi.Input<ServiceCor>[]>;

A cors block as documented below.

property features

features?: pulumi.Input<pulumi.Input<ServiceFeature>[]>;

A features block as documented below.

property location

location?: pulumi.Input<string>;

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

property name

name?: pulumi.Input<string>;

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

property resourceGroupName

resourceGroupName: pulumi.Input<string>;

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

property sku

sku: pulumi.Input<ServiceSku>;

A sku block as documented below.

property tags

tags?: pulumi.Input<{[key: string]: pulumi.Input<string>}>;

A mapping of tags to assign to the resource.

interface ServiceState

interface ServiceState

Input properties used for looking up and filtering Service resources.

property cors

cors?: pulumi.Input<pulumi.Input<ServiceCor>[]>;

A cors block as documented below.

property features

features?: pulumi.Input<pulumi.Input<ServiceFeature>[]>;

A features block as documented below.

property hostname

hostname?: pulumi.Input<string>;

The FQDN of the SignalR service.

property ipAddress

ipAddress?: pulumi.Input<string>;

The publicly accessible IP of the SignalR service.

property location

location?: pulumi.Input<string>;

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

property name

name?: pulumi.Input<string>;

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

property primaryAccessKey

primaryAccessKey?: pulumi.Input<string>;

The primary access key for the SignalR service.

property primaryConnectionString

primaryConnectionString?: pulumi.Input<string>;

The primary connection string for the SignalR service.

property publicPort

publicPort?: pulumi.Input<number>;

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

property resourceGroupName

resourceGroupName?: pulumi.Input<string>;

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

property secondaryAccessKey

secondaryAccessKey?: pulumi.Input<string>;

The secondary access key for the SignalR service.

property secondaryConnectionString

secondaryConnectionString?: pulumi.Input<string>;

The secondary connection string for the SignalR service.

property serverPort

serverPort?: pulumi.Input<number>;

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

property sku

sku?: pulumi.Input<ServiceSku>;

A sku block as documented below.

property tags

tags?: pulumi.Input<{[key: string]: pulumi.Input<string>}>;

A mapping of tags to assign to the resource.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud

Module signalr

Resources

Functions

Others

Resources

Example Usage

Functions

Example Usage

Others