Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Classic
  3. API Docs
  4. webpubsub
  5. Service

We recommend using Azure Native.

Azure Classic v6.2.0 published on Friday, Sep 27, 2024 by Pulumi
pulumi/pulumi-azure

azure.webpubsub.Service

Explore with Pulumi AI

azure logo

We recommend using Azure Native.

Azure Classic v6.2.0 published on Friday, Sep 27, 2024 by Pulumi
pulumi/pulumi-azure

    Manages an Azure Web PubSub Service.

    Example Usage

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

const example = new azure.core.ResourceGroup("example", {
    name: "terraform-webpubsub",
    location: "east us",
});
const exampleService = new azure.webpubsub.Service("example", {
    name: "tfex-webpubsub",
    location: example.location,
    resourceGroupName: example.name,
    sku: "Standard_S1",
    capacity: 1,
    publicNetworkAccessEnabled: false,
    liveTrace: {
        enabled: true,
        messagingLogsEnabled: true,
        connectivityLogsEnabled: false,
    },
    identity: {
        type: "SystemAssigned",
    },
});

    import pulumi
import pulumi_azure as azure

example = azure.core.ResourceGroup("example",
    name="terraform-webpubsub",
    location="east us")
example_service = azure.webpubsub.Service("example",
    name="tfex-webpubsub",
    location=example.location,
    resource_group_name=example.name,
    sku="Standard_S1",
    capacity=1,
    public_network_access_enabled=False,
    live_trace={
        "enabled": True,
        "messaging_logs_enabled": True,
        "connectivity_logs_enabled": False,
    },
    identity={
        "type": "SystemAssigned",
    })

    package main

import (
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/core"
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/webpubsub"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := core.NewResourceGroup(ctx, "example", &core.ResourceGroupArgs{
			Name:     pulumi.String("terraform-webpubsub"),
			Location: pulumi.String("east us"),
		})
		if err != nil {
			return err
		}
		_, err = webpubsub.NewService(ctx, "example", &webpubsub.ServiceArgs{
			Name:                       pulumi.String("tfex-webpubsub"),
			Location:                   example.Location,
			ResourceGroupName:          example.Name,
			Sku:                        pulumi.String("Standard_S1"),
			Capacity:                   pulumi.Int(1),
			PublicNetworkAccessEnabled: pulumi.Bool(false),
			LiveTrace: &webpubsub.ServiceLiveTraceArgs{
				Enabled:                 pulumi.Bool(true),
				MessagingLogsEnabled:    pulumi.Bool(true),
				ConnectivityLogsEnabled: pulumi.Bool(false),
			},
			Identity: &webpubsub.ServiceIdentityArgs{
				Type: pulumi.String("SystemAssigned"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var example = new Azure.Core.ResourceGroup("example", new()
    {
        Name = "terraform-webpubsub",
        Location = "east us",
    });

    var exampleService = new Azure.WebPubSub.Service("example", new()
    {
        Name = "tfex-webpubsub",
        Location = example.Location,
        ResourceGroupName = example.Name,
        Sku = "Standard_S1",
        Capacity = 1,
        PublicNetworkAccessEnabled = false,
        LiveTrace = new Azure.WebPubSub.Inputs.ServiceLiveTraceArgs
        {
            Enabled = true,
            MessagingLogsEnabled = true,
            ConnectivityLogsEnabled = false,
        },
        Identity = new Azure.WebPubSub.Inputs.ServiceIdentityArgs
        {
            Type = "SystemAssigned",
        },
    });

});

    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.webpubsub.Service;
import com.pulumi.azure.webpubsub.ServiceArgs;
import com.pulumi.azure.webpubsub.inputs.ServiceLiveTraceArgs;
import com.pulumi.azure.webpubsub.inputs.ServiceIdentityArgs;
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 example = new ResourceGroup("example", ResourceGroupArgs.builder()
            .name("terraform-webpubsub")
            .location("east us")
            .build());

        var exampleService = new Service("exampleService", ServiceArgs.builder()
            .name("tfex-webpubsub")
            .location(example.location())
            .resourceGroupName(example.name())
            .sku("Standard_S1")
            .capacity(1)
            .publicNetworkAccessEnabled(false)
            .liveTrace(ServiceLiveTraceArgs.builder()
                .enabled(true)
                .messagingLogsEnabled(true)
                .connectivityLogsEnabled(false)
                .build())
            .identity(ServiceIdentityArgs.builder()
                .type("SystemAssigned")
                .build())
            .build());

    }
}

    resources:
  example:
    type: azure:core:ResourceGroup
    properties:
      name: terraform-webpubsub
      location: east us
  exampleService:
    type: azure:webpubsub:Service
    name: example
    properties:
      name: tfex-webpubsub
      location: ${example.location}
      resourceGroupName: ${example.name}
      sku: Standard_S1
      capacity: 1
      publicNetworkAccessEnabled: false
      liveTrace:
        enabled: true
        messagingLogsEnabled: true
        connectivityLogsEnabled: false
      identity:
        type: SystemAssigned

    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[str] = None,
            aad_auth_enabled: Optional[bool] = None,
            capacity: Optional[int] = None,
            identity: Optional[ServiceIdentityArgs] = None,
            live_trace: Optional[ServiceLiveTraceArgs] = None,
            local_auth_enabled: Optional[bool] = None,
            location: Optional[str] = None,
            name: Optional[str] = None,
            public_network_access_enabled: Optional[bool] = None,
            tags: Optional[Mapping[str, str]] = None,
            tls_client_cert_enabled: Optional[bool] = 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:webpubsub: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 exampleserviceResourceResourceFromWebpubsubservice = new Azure.WebPubSub.Service("exampleserviceResourceResourceFromWebpubsubservice", new()
{
    ResourceGroupName = "string",
    Sku = "string",
    AadAuthEnabled = false,
    Capacity = 0,
    Identity = new Azure.WebPubSub.Inputs.ServiceIdentityArgs
    {
        Type = "string",
        IdentityIds = new[]
        {
            "string",
        },
        PrincipalId = "string",
        TenantId = "string",
    },
    LiveTrace = new Azure.WebPubSub.Inputs.ServiceLiveTraceArgs
    {
        ConnectivityLogsEnabled = false,
        Enabled = false,
        HttpRequestLogsEnabled = false,
        MessagingLogsEnabled = false,
    },
    LocalAuthEnabled = false,
    Location = "string",
    Name = "string",
    PublicNetworkAccessEnabled = false,
    Tags = 
    {
        { "string", "string" },
    },
    TlsClientCertEnabled = false,
});

    example, err := webpubsub.NewService(ctx, "exampleserviceResourceResourceFromWebpubsubservice", &webpubsub.ServiceArgs{
	ResourceGroupName: pulumi.String("string"),
	Sku:               pulumi.String("string"),
	AadAuthEnabled:    pulumi.Bool(false),
	Capacity:          pulumi.Int(0),
	Identity: &webpubsub.ServiceIdentityArgs{
		Type: pulumi.String("string"),
		IdentityIds: pulumi.StringArray{
			pulumi.String("string"),
		},
		PrincipalId: pulumi.String("string"),
		TenantId:    pulumi.String("string"),
	},
	LiveTrace: &webpubsub.ServiceLiveTraceArgs{
		ConnectivityLogsEnabled: pulumi.Bool(false),
		Enabled:                 pulumi.Bool(false),
		HttpRequestLogsEnabled:  pulumi.Bool(false),
		MessagingLogsEnabled:    pulumi.Bool(false),
	},
	LocalAuthEnabled:           pulumi.Bool(false),
	Location:                   pulumi.String("string"),
	Name:                       pulumi.String("string"),
	PublicNetworkAccessEnabled: pulumi.Bool(false),
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	TlsClientCertEnabled: pulumi.Bool(false),
})

    var exampleserviceResourceResourceFromWebpubsubservice = new Service("exampleserviceResourceResourceFromWebpubsubservice", ServiceArgs.builder()
    .resourceGroupName("string")
    .sku("string")
    .aadAuthEnabled(false)
    .capacity(0)
    .identity(ServiceIdentityArgs.builder()
        .type("string")
        .identityIds("string")
        .principalId("string")
        .tenantId("string")
        .build())
    .liveTrace(ServiceLiveTraceArgs.builder()
        .connectivityLogsEnabled(false)
        .enabled(false)
        .httpRequestLogsEnabled(false)
        .messagingLogsEnabled(false)
        .build())
    .localAuthEnabled(false)
    .location("string")
    .name("string")
    .publicNetworkAccessEnabled(false)
    .tags(Map.of("string", "string"))
    .tlsClientCertEnabled(false)
    .build());

    exampleservice_resource_resource_from_webpubsubservice = azure.webpubsub.Service("exampleserviceResourceResourceFromWebpubsubservice",
    resource_group_name="string",
    sku="string",
    aad_auth_enabled=False,
    capacity=0,
    identity={
        "type": "string",
        "identityIds": ["string"],
        "principalId": "string",
        "tenantId": "string",
    },
    live_trace={
        "connectivityLogsEnabled": False,
        "enabled": False,
        "httpRequestLogsEnabled": False,
        "messagingLogsEnabled": False,
    },
    local_auth_enabled=False,
    location="string",
    name="string",
    public_network_access_enabled=False,
    tags={
        "string": "string",
    },
    tls_client_cert_enabled=False)

    const exampleserviceResourceResourceFromWebpubsubservice = new azure.webpubsub.Service("exampleserviceResourceResourceFromWebpubsubservice", {
    resourceGroupName: "string",
    sku: "string",
    aadAuthEnabled: false,
    capacity: 0,
    identity: {
        type: "string",
        identityIds: ["string"],
        principalId: "string",
        tenantId: "string",
    },
    liveTrace: {
        connectivityLogsEnabled: false,
        enabled: false,
        httpRequestLogsEnabled: false,
        messagingLogsEnabled: false,
    },
    localAuthEnabled: false,
    location: "string",
    name: "string",
    publicNetworkAccessEnabled: false,
    tags: {
        string: "string",
    },
    tlsClientCertEnabled: false,
});

    type: azure:webpubsub:Service
properties:
    aadAuthEnabled: false
    capacity: 0
    identity:
        identityIds:
            - string
        principalId: string
        tenantId: string
        type: string
    liveTrace:
        connectivityLogsEnabled: false
        enabled: false
        httpRequestLogsEnabled: false
        messagingLogsEnabled: false
    localAuthEnabled: false
    location: string
    name: string
    publicNetworkAccessEnabled: false
    resourceGroupName: string
    sku: string
    tags:
        string: string
    tlsClientCertEnabled: false

    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 Web PubSub service. Changing this forces a new resource to be created.
    Sku string
    Specifies which SKU to use. Possible values are Free_F1, Standard_S1, Premium_P1 and Premium_P2.
    AadAuthEnabled bool
    Whether to enable AAD auth? Defaults to true.
    Capacity int

    Specifies the number of units associated with this Web PubSub resource. Valid values are 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 20, 30, 40, 50, 60, 70, 80, 90, 100, 200, 300, 400, 500, 600, 700, 800, 900 and 1000.

    NOTE: The valid capacity range for sku Free_F1 is 1, for sku Premium_P2 is from 100 to 1000, and from 1 to 100 for sku Standard_S1 and Premium_P1.

    Identity ServiceIdentity
    An identity block as defined below.
    LiveTrace ServiceLiveTrace
    A live_trace block as defined below.
    LocalAuthEnabled bool
    Whether to enable local auth? Defaults to true.
    Location string
    Specifies the supported Azure location where the Web PubSub service exists. Changing this forces a new resource to be created.
    Name string
    The name of the Web PubSub service. Changing this forces a new resource to be created.
    PublicNetworkAccessEnabled bool
    Whether to enable public network access? Defaults to true.
    Tags Dictionary<string, string>
    A mapping of tags to assign to the resource.
    TlsClientCertEnabled bool
    Whether to request client certificate during TLS handshake? Defaults to false.
    ResourceGroupName string
    The name of the resource group in which to create the Web PubSub service. Changing this forces a new resource to be created.
    Sku string
    Specifies which SKU to use. Possible values are Free_F1, Standard_S1, Premium_P1 and Premium_P2.
    AadAuthEnabled bool
    Whether to enable AAD auth? Defaults to true.
    Capacity int

    Specifies the number of units associated with this Web PubSub resource. Valid values are 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 20, 30, 40, 50, 60, 70, 80, 90, 100, 200, 300, 400, 500, 600, 700, 800, 900 and 1000.

    NOTE: The valid capacity range for sku Free_F1 is 1, for sku Premium_P2 is from 100 to 1000, and from 1 to 100 for sku Standard_S1 and Premium_P1.

    Identity ServiceIdentityArgs
    An identity block as defined below.
    LiveTrace ServiceLiveTraceArgs
    A live_trace block as defined below.
    LocalAuthEnabled bool
    Whether to enable local auth? Defaults to true.
    Location string
    Specifies the supported Azure location where the Web PubSub service exists. Changing this forces a new resource to be created.
    Name string
    The name of the Web PubSub service. Changing this forces a new resource to be created.
    PublicNetworkAccessEnabled bool
    Whether to enable public network access? Defaults to true.
    Tags map[string]string
    A mapping of tags to assign to the resource.
    TlsClientCertEnabled bool
    Whether to request client certificate during TLS handshake? Defaults to false.
    resourceGroupName String
    The name of the resource group in which to create the Web PubSub service. Changing this forces a new resource to be created.
    sku String
    Specifies which SKU to use. Possible values are Free_F1, Standard_S1, Premium_P1 and Premium_P2.
    aadAuthEnabled Boolean
    Whether to enable AAD auth? Defaults to true.
    capacity Integer

    Specifies the number of units associated with this Web PubSub resource. Valid values are 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 20, 30, 40, 50, 60, 70, 80, 90, 100, 200, 300, 400, 500, 600, 700, 800, 900 and 1000.

    NOTE: The valid capacity range for sku Free_F1 is 1, for sku Premium_P2 is from 100 to 1000, and from 1 to 100 for sku Standard_S1 and Premium_P1.

    identity ServiceIdentity
    An identity block as defined below.
    liveTrace ServiceLiveTrace
    A live_trace block as defined below.
    localAuthEnabled Boolean
    Whether to enable local auth? Defaults to true.
    location String
    Specifies the supported Azure location where the Web PubSub service exists. Changing this forces a new resource to be created.
    name String
    The name of the Web PubSub service. Changing this forces a new resource to be created.
    publicNetworkAccessEnabled Boolean
    Whether to enable public network access? Defaults to true.
    tags Map<String,String>
    A mapping of tags to assign to the resource.
    tlsClientCertEnabled Boolean
    Whether to request client certificate during TLS handshake? Defaults to false.
    resourceGroupName string
    The name of the resource group in which to create the Web PubSub service. Changing this forces a new resource to be created.
    sku string
    Specifies which SKU to use. Possible values are Free_F1, Standard_S1, Premium_P1 and Premium_P2.
    aadAuthEnabled boolean
    Whether to enable AAD auth? Defaults to true.
    capacity number

    Specifies the number of units associated with this Web PubSub resource. Valid values are 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 20, 30, 40, 50, 60, 70, 80, 90, 100, 200, 300, 400, 500, 600, 700, 800, 900 and 1000.

    NOTE: The valid capacity range for sku Free_F1 is 1, for sku Premium_P2 is from 100 to 1000, and from 1 to 100 for sku Standard_S1 and Premium_P1.

    identity ServiceIdentity
    An identity block as defined below.
    liveTrace ServiceLiveTrace
    A live_trace block as defined below.
    localAuthEnabled boolean
    Whether to enable local auth? Defaults to true.
    location string
    Specifies the supported Azure location where the Web PubSub service exists. Changing this forces a new resource to be created.
    name string
    The name of the Web PubSub service. Changing this forces a new resource to be created.
    publicNetworkAccessEnabled boolean
    Whether to enable public network access? Defaults to true.
    tags {[key: string]: string}
    A mapping of tags to assign to the resource.
    tlsClientCertEnabled boolean
    Whether to request client certificate during TLS handshake? Defaults to false.
    resource_group_name str
    The name of the resource group in which to create the Web PubSub service. Changing this forces a new resource to be created.
    sku str
    Specifies which SKU to use. Possible values are Free_F1, Standard_S1, Premium_P1 and Premium_P2.
    aad_auth_enabled bool
    Whether to enable AAD auth? Defaults to true.
    capacity int

    Specifies the number of units associated with this Web PubSub resource. Valid values are 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 20, 30, 40, 50, 60, 70, 80, 90, 100, 200, 300, 400, 500, 600, 700, 800, 900 and 1000.

    NOTE: The valid capacity range for sku Free_F1 is 1, for sku Premium_P2 is from 100 to 1000, and from 1 to 100 for sku Standard_S1 and Premium_P1.

    identity ServiceIdentityArgs
    An identity block as defined below.
    live_trace ServiceLiveTraceArgs
    A live_trace block as defined below.
    local_auth_enabled bool
    Whether to enable local auth? Defaults to true.
    location str
    Specifies the supported Azure location where the Web PubSub service exists. Changing this forces a new resource to be created.
    name str
    The name of the Web PubSub service. Changing this forces a new resource to be created.
    public_network_access_enabled bool
    Whether to enable public network access? Defaults to true.
    tags Mapping[str, str]
    A mapping of tags to assign to the resource.
    tls_client_cert_enabled bool
    Whether to request client certificate during TLS handshake? Defaults to false.
    resourceGroupName String
    The name of the resource group in which to create the Web PubSub service. Changing this forces a new resource to be created.
    sku String
    Specifies which SKU to use. Possible values are Free_F1, Standard_S1, Premium_P1 and Premium_P2.
    aadAuthEnabled Boolean
    Whether to enable AAD auth? Defaults to true.
    capacity Number

    Specifies the number of units associated with this Web PubSub resource. Valid values are 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 20, 30, 40, 50, 60, 70, 80, 90, 100, 200, 300, 400, 500, 600, 700, 800, 900 and 1000.

    NOTE: The valid capacity range for sku Free_F1 is 1, for sku Premium_P2 is from 100 to 1000, and from 1 to 100 for sku Standard_S1 and Premium_P1.

    identity Property Map
    An identity block as defined below.
    liveTrace Property Map
    A live_trace block as defined below.
    localAuthEnabled Boolean
    Whether to enable local auth? Defaults to true.
    location String
    Specifies the supported Azure location where the Web PubSub service exists. Changing this forces a new resource to be created.
    name String
    The name of the Web PubSub service. Changing this forces a new resource to be created.
    publicNetworkAccessEnabled Boolean
    Whether to enable public network access? Defaults to true.
    tags Map<String>
    A mapping of tags to assign to the resource.
    tlsClientCertEnabled Boolean
    Whether to request client certificate during TLS handshake? Defaults to false.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Service resource produces the following output properties:

    ExternalIp string
    The publicly accessible IP of the Web PubSub service.
    Hostname string
    The FQDN of the Web PubSub service.
    Id string
    The provider-assigned unique ID for this managed resource.
    PrimaryAccessKey string
    The primary access key for the Web PubSub service.
    PrimaryConnectionString string
    The primary connection string for the Web PubSub service.
    PublicPort int
    The publicly accessible port of the Web PubSub service which is designed for browser/client use.
    SecondaryAccessKey string
    The secondary access key for the Web PubSub service.
    SecondaryConnectionString string
    The secondary connection string for the Web PubSub service.
    ServerPort int
    The publicly accessible port of the Web PubSub service which is designed for customer server side use.
    Version string
    ExternalIp string
    The publicly accessible IP of the Web PubSub service.
    Hostname string
    The FQDN of the Web PubSub service.
    Id string
    The provider-assigned unique ID for this managed resource.
    PrimaryAccessKey string
    The primary access key for the Web PubSub service.
    PrimaryConnectionString string
    The primary connection string for the Web PubSub service.
    PublicPort int
    The publicly accessible port of the Web PubSub service which is designed for browser/client use.
    SecondaryAccessKey string
    The secondary access key for the Web PubSub service.
    SecondaryConnectionString string
    The secondary connection string for the Web PubSub service.
    ServerPort int
    The publicly accessible port of the Web PubSub service which is designed for customer server side use.
    Version string
    externalIp String
    The publicly accessible IP of the Web PubSub service.
    hostname String
    The FQDN of the Web PubSub service.
    id String
    The provider-assigned unique ID for this managed resource.
    primaryAccessKey String
    The primary access key for the Web PubSub service.
    primaryConnectionString String
    The primary connection string for the Web PubSub service.
    publicPort Integer
    The publicly accessible port of the Web PubSub service which is designed for browser/client use.
    secondaryAccessKey String
    The secondary access key for the Web PubSub service.
    secondaryConnectionString String
    The secondary connection string for the Web PubSub service.
    serverPort Integer
    The publicly accessible port of the Web PubSub service which is designed for customer server side use.
    version String
    externalIp string
    The publicly accessible IP of the Web PubSub service.
    hostname string
    The FQDN of the Web PubSub service.
    id string
    The provider-assigned unique ID for this managed resource.
    primaryAccessKey string
    The primary access key for the Web PubSub service.
    primaryConnectionString string
    The primary connection string for the Web PubSub service.
    publicPort number
    The publicly accessible port of the Web PubSub service which is designed for browser/client use.
    secondaryAccessKey string
    The secondary access key for the Web PubSub service.
    secondaryConnectionString string
    The secondary connection string for the Web PubSub service.
    serverPort number
    The publicly accessible port of the Web PubSub service which is designed for customer server side use.
    version string
    external_ip str
    The publicly accessible IP of the Web PubSub service.
    hostname str
    The FQDN of the Web PubSub service.
    id str
    The provider-assigned unique ID for this managed resource.
    primary_access_key str
    The primary access key for the Web PubSub service.
    primary_connection_string str
    The primary connection string for the Web PubSub service.
    public_port int
    The publicly accessible port of the Web PubSub service which is designed for browser/client use.
    secondary_access_key str
    The secondary access key for the Web PubSub service.
    secondary_connection_string str
    The secondary connection string for the Web PubSub service.
    server_port int
    The publicly accessible port of the Web PubSub service which is designed for customer server side use.
    version str
    externalIp String
    The publicly accessible IP of the Web PubSub service.
    hostname String
    The FQDN of the Web PubSub service.
    id String
    The provider-assigned unique ID for this managed resource.
    primaryAccessKey String
    The primary access key for the Web PubSub service.
    primaryConnectionString String
    The primary connection string for the Web PubSub service.
    publicPort Number
    The publicly accessible port of the Web PubSub service which is designed for browser/client use.
    secondaryAccessKey String
    The secondary access key for the Web PubSub service.
    secondaryConnectionString String
    The secondary connection string for the Web PubSub service.
    serverPort Number
    The publicly accessible port of the Web PubSub service which is designed for customer server side use.
    version String

    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,
        aad_auth_enabled: Optional[bool] = None,
        capacity: Optional[int] = None,
        external_ip: Optional[str] = None,
        hostname: Optional[str] = None,
        identity: Optional[ServiceIdentityArgs] = None,
        live_trace: Optional[ServiceLiveTraceArgs] = None,
        local_auth_enabled: Optional[bool] = None,
        location: Optional[str] = None,
        name: Optional[str] = None,
        primary_access_key: Optional[str] = None,
        primary_connection_string: Optional[str] = None,
        public_network_access_enabled: Optional[bool] = 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,
        sku: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None,
        tls_client_cert_enabled: Optional[bool] = None,
        version: Optional[str] = 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:
    AadAuthEnabled bool
    Whether to enable AAD auth? Defaults to true.
    Capacity int

    Specifies the number of units associated with this Web PubSub resource. Valid values are 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 20, 30, 40, 50, 60, 70, 80, 90, 100, 200, 300, 400, 500, 600, 700, 800, 900 and 1000.

    NOTE: The valid capacity range for sku Free_F1 is 1, for sku Premium_P2 is from 100 to 1000, and from 1 to 100 for sku Standard_S1 and Premium_P1.

    ExternalIp string
    The publicly accessible IP of the Web PubSub service.
    Hostname string
    The FQDN of the Web PubSub service.
    Identity ServiceIdentity
    An identity block as defined below.
    LiveTrace ServiceLiveTrace
    A live_trace block as defined below.
    LocalAuthEnabled bool
    Whether to enable local auth? Defaults to true.
    Location string
    Specifies the supported Azure location where the Web PubSub service exists. Changing this forces a new resource to be created.
    Name string
    The name of the Web PubSub service. Changing this forces a new resource to be created.
    PrimaryAccessKey string
    The primary access key for the Web PubSub service.
    PrimaryConnectionString string
    The primary connection string for the Web PubSub service.
    PublicNetworkAccessEnabled bool
    Whether to enable public network access? Defaults to true.
    PublicPort int
    The publicly accessible port of the Web PubSub service which is designed for browser/client use.
    ResourceGroupName string
    The name of the resource group in which to create the Web PubSub service. Changing this forces a new resource to be created.
    SecondaryAccessKey string
    The secondary access key for the Web PubSub service.
    SecondaryConnectionString string
    The secondary connection string for the Web PubSub service.
    ServerPort int
    The publicly accessible port of the Web PubSub service which is designed for customer server side use.
    Sku string
    Specifies which SKU to use. Possible values are Free_F1, Standard_S1, Premium_P1 and Premium_P2.
    Tags Dictionary<string, string>
    A mapping of tags to assign to the resource.
    TlsClientCertEnabled bool
    Whether to request client certificate during TLS handshake? Defaults to false.
    Version string
    AadAuthEnabled bool
    Whether to enable AAD auth? Defaults to true.
    Capacity int

    Specifies the number of units associated with this Web PubSub resource. Valid values are 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 20, 30, 40, 50, 60, 70, 80, 90, 100, 200, 300, 400, 500, 600, 700, 800, 900 and 1000.

    NOTE: The valid capacity range for sku Free_F1 is 1, for sku Premium_P2 is from 100 to 1000, and from 1 to 100 for sku Standard_S1 and Premium_P1.

    ExternalIp string
    The publicly accessible IP of the Web PubSub service.
    Hostname string
    The FQDN of the Web PubSub service.
    Identity ServiceIdentityArgs
    An identity block as defined below.
    LiveTrace ServiceLiveTraceArgs
    A live_trace block as defined below.
    LocalAuthEnabled bool
    Whether to enable local auth? Defaults to true.
    Location string
    Specifies the supported Azure location where the Web PubSub service exists. Changing this forces a new resource to be created.
    Name string
    The name of the Web PubSub service. Changing this forces a new resource to be created.
    PrimaryAccessKey string
    The primary access key for the Web PubSub service.
    PrimaryConnectionString string
    The primary connection string for the Web PubSub service.
    PublicNetworkAccessEnabled bool
    Whether to enable public network access? Defaults to true.
    PublicPort int
    The publicly accessible port of the Web PubSub service which is designed for browser/client use.
    ResourceGroupName string
    The name of the resource group in which to create the Web PubSub service. Changing this forces a new resource to be created.
    SecondaryAccessKey string
    The secondary access key for the Web PubSub service.
    SecondaryConnectionString string
    The secondary connection string for the Web PubSub service.
    ServerPort int
    The publicly accessible port of the Web PubSub service which is designed for customer server side use.
    Sku string
    Specifies which SKU to use. Possible values are Free_F1, Standard_S1, Premium_P1 and Premium_P2.
    Tags map[string]string
    A mapping of tags to assign to the resource.
    TlsClientCertEnabled bool
    Whether to request client certificate during TLS handshake? Defaults to false.
    Version string
    aadAuthEnabled Boolean
    Whether to enable AAD auth? Defaults to true.
    capacity Integer

    Specifies the number of units associated with this Web PubSub resource. Valid values are 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 20, 30, 40, 50, 60, 70, 80, 90, 100, 200, 300, 400, 500, 600, 700, 800, 900 and 1000.

    NOTE: The valid capacity range for sku Free_F1 is 1, for sku Premium_P2 is from 100 to 1000, and from 1 to 100 for sku Standard_S1 and Premium_P1.

    externalIp String
    The publicly accessible IP of the Web PubSub service.
    hostname String
    The FQDN of the Web PubSub service.
    identity ServiceIdentity
    An identity block as defined below.
    liveTrace ServiceLiveTrace
    A live_trace block as defined below.
    localAuthEnabled Boolean
    Whether to enable local auth? Defaults to true.
    location String
    Specifies the supported Azure location where the Web PubSub service exists. Changing this forces a new resource to be created.
    name String
    The name of the Web PubSub service. Changing this forces a new resource to be created.
    primaryAccessKey String
    The primary access key for the Web PubSub service.
    primaryConnectionString String
    The primary connection string for the Web PubSub service.
    publicNetworkAccessEnabled Boolean
    Whether to enable public network access? Defaults to true.
    publicPort Integer
    The publicly accessible port of the Web PubSub service which is designed for browser/client use.
    resourceGroupName String
    The name of the resource group in which to create the Web PubSub service. Changing this forces a new resource to be created.
    secondaryAccessKey String
    The secondary access key for the Web PubSub service.
    secondaryConnectionString String
    The secondary connection string for the Web PubSub service.
    serverPort Integer
    The publicly accessible port of the Web PubSub service which is designed for customer server side use.
    sku String
    Specifies which SKU to use. Possible values are Free_F1, Standard_S1, Premium_P1 and Premium_P2.
    tags Map<String,String>
    A mapping of tags to assign to the resource.
    tlsClientCertEnabled Boolean
    Whether to request client certificate during TLS handshake? Defaults to false.
    version String
    aadAuthEnabled boolean
    Whether to enable AAD auth? Defaults to true.
    capacity number

    Specifies the number of units associated with this Web PubSub resource. Valid values are 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 20, 30, 40, 50, 60, 70, 80, 90, 100, 200, 300, 400, 500, 600, 700, 800, 900 and 1000.

    NOTE: The valid capacity range for sku Free_F1 is 1, for sku Premium_P2 is from 100 to 1000, and from 1 to 100 for sku Standard_S1 and Premium_P1.

    externalIp string
    The publicly accessible IP of the Web PubSub service.
    hostname string
    The FQDN of the Web PubSub service.
    identity ServiceIdentity
    An identity block as defined below.
    liveTrace ServiceLiveTrace
    A live_trace block as defined below.
    localAuthEnabled boolean
    Whether to enable local auth? Defaults to true.
    location string
    Specifies the supported Azure location where the Web PubSub service exists. Changing this forces a new resource to be created.
    name string
    The name of the Web PubSub service. Changing this forces a new resource to be created.
    primaryAccessKey string
    The primary access key for the Web PubSub service.
    primaryConnectionString string
    The primary connection string for the Web PubSub service.
    publicNetworkAccessEnabled boolean
    Whether to enable public network access? Defaults to true.
    publicPort number
    The publicly accessible port of the Web PubSub service which is designed for browser/client use.
    resourceGroupName string
    The name of the resource group in which to create the Web PubSub service. Changing this forces a new resource to be created.
    secondaryAccessKey string
    The secondary access key for the Web PubSub service.
    secondaryConnectionString string
    The secondary connection string for the Web PubSub service.
    serverPort number
    The publicly accessible port of the Web PubSub service which is designed for customer server side use.
    sku string
    Specifies which SKU to use. Possible values are Free_F1, Standard_S1, Premium_P1 and Premium_P2.
    tags {[key: string]: string}
    A mapping of tags to assign to the resource.
    tlsClientCertEnabled boolean
    Whether to request client certificate during TLS handshake? Defaults to false.
    version string
    aad_auth_enabled bool
    Whether to enable AAD auth? Defaults to true.
    capacity int

    Specifies the number of units associated with this Web PubSub resource. Valid values are 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 20, 30, 40, 50, 60, 70, 80, 90, 100, 200, 300, 400, 500, 600, 700, 800, 900 and 1000.

    NOTE: The valid capacity range for sku Free_F1 is 1, for sku Premium_P2 is from 100 to 1000, and from 1 to 100 for sku Standard_S1 and Premium_P1.

    external_ip str
    The publicly accessible IP of the Web PubSub service.
    hostname str
    The FQDN of the Web PubSub service.
    identity ServiceIdentityArgs
    An identity block as defined below.
    live_trace ServiceLiveTraceArgs
    A live_trace block as defined below.
    local_auth_enabled bool
    Whether to enable local auth? Defaults to true.
    location str
    Specifies the supported Azure location where the Web PubSub service exists. Changing this forces a new resource to be created.
    name str
    The name of the Web PubSub service. Changing this forces a new resource to be created.
    primary_access_key str
    The primary access key for the Web PubSub service.
    primary_connection_string str
    The primary connection string for the Web PubSub service.
    public_network_access_enabled bool
    Whether to enable public network access? Defaults to true.
    public_port int
    The publicly accessible port of the Web PubSub service which is designed for browser/client use.
    resource_group_name str
    The name of the resource group in which to create the Web PubSub service. Changing this forces a new resource to be created.
    secondary_access_key str
    The secondary access key for the Web PubSub service.
    secondary_connection_string str
    The secondary connection string for the Web PubSub service.
    server_port int
    The publicly accessible port of the Web PubSub service which is designed for customer server side use.
    sku str
    Specifies which SKU to use. Possible values are Free_F1, Standard_S1, Premium_P1 and Premium_P2.
    tags Mapping[str, str]
    A mapping of tags to assign to the resource.
    tls_client_cert_enabled bool
    Whether to request client certificate during TLS handshake? Defaults to false.
    version str
    aadAuthEnabled Boolean
    Whether to enable AAD auth? Defaults to true.
    capacity Number

    Specifies the number of units associated with this Web PubSub resource. Valid values are 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 20, 30, 40, 50, 60, 70, 80, 90, 100, 200, 300, 400, 500, 600, 700, 800, 900 and 1000.

    NOTE: The valid capacity range for sku Free_F1 is 1, for sku Premium_P2 is from 100 to 1000, and from 1 to 100 for sku Standard_S1 and Premium_P1.

    externalIp String
    The publicly accessible IP of the Web PubSub service.
    hostname String
    The FQDN of the Web PubSub service.
    identity Property Map
    An identity block as defined below.
    liveTrace Property Map
    A live_trace block as defined below.
    localAuthEnabled Boolean
    Whether to enable local auth? Defaults to true.
    location String
    Specifies the supported Azure location where the Web PubSub service exists. Changing this forces a new resource to be created.
    name String
    The name of the Web PubSub service. Changing this forces a new resource to be created.
    primaryAccessKey String
    The primary access key for the Web PubSub service.
    primaryConnectionString String
    The primary connection string for the Web PubSub service.
    publicNetworkAccessEnabled Boolean
    Whether to enable public network access? Defaults to true.
    publicPort Number
    The publicly accessible port of the Web PubSub service which is designed for browser/client use.
    resourceGroupName String
    The name of the resource group in which to create the Web PubSub service. Changing this forces a new resource to be created.
    secondaryAccessKey String
    The secondary access key for the Web PubSub service.
    secondaryConnectionString String
    The secondary connection string for the Web PubSub service.
    serverPort Number
    The publicly accessible port of the Web PubSub service which is designed for customer server side use.
    sku String
    Specifies which SKU to use. Possible values are Free_F1, Standard_S1, Premium_P1 and Premium_P2.
    tags Map<String>
    A mapping of tags to assign to the resource.
    tlsClientCertEnabled Boolean
    Whether to request client certificate during TLS handshake? Defaults to false.
    version String

    Supporting Types

    ServiceIdentity, ServiceIdentityArgs

    Type string
    Specifies the type of Managed Service Identity that should be configured on this Web PubSub. Possible values are SystemAssigned, UserAssigned.
    IdentityIds List<string>

    Specifies a list of User Assigned Managed Identity IDs to be assigned to this Web PubSub.

    NOTE: This is required when type is set to UserAssigned

    PrincipalId string
    The Principal ID associated with this Managed Service Identity.
    TenantId string
    The Tenant ID associated with this Managed Service Identity.
    Type string
    Specifies the type of Managed Service Identity that should be configured on this Web PubSub. Possible values are SystemAssigned, UserAssigned.
    IdentityIds []string

    Specifies a list of User Assigned Managed Identity IDs to be assigned to this Web PubSub.

    NOTE: This is required when type is set to UserAssigned

    PrincipalId string
    The Principal ID associated with this Managed Service Identity.
    TenantId string
    The Tenant ID associated with this Managed Service Identity.
    type String
    Specifies the type of Managed Service Identity that should be configured on this Web PubSub. Possible values are SystemAssigned, UserAssigned.
    identityIds List<String>

    Specifies a list of User Assigned Managed Identity IDs to be assigned to this Web PubSub.

    NOTE: This is required when type is set to UserAssigned

    principalId String
    The Principal ID associated with this Managed Service Identity.
    tenantId String
    The Tenant ID associated with this Managed Service Identity.
    type string
    Specifies the type of Managed Service Identity that should be configured on this Web PubSub. Possible values are SystemAssigned, UserAssigned.
    identityIds string[]

    Specifies a list of User Assigned Managed Identity IDs to be assigned to this Web PubSub.

    NOTE: This is required when type is set to UserAssigned

    principalId string
    The Principal ID associated with this Managed Service Identity.
    tenantId string
    The Tenant ID associated with this Managed Service Identity.
    type str
    Specifies the type of Managed Service Identity that should be configured on this Web PubSub. Possible values are SystemAssigned, UserAssigned.
    identity_ids Sequence[str]

    Specifies a list of User Assigned Managed Identity IDs to be assigned to this Web PubSub.

    NOTE: This is required when type is set to UserAssigned

    principal_id str
    The Principal ID associated with this Managed Service Identity.
    tenant_id str
    The Tenant ID associated with this Managed Service Identity.
    type String
    Specifies the type of Managed Service Identity that should be configured on this Web PubSub. Possible values are SystemAssigned, UserAssigned.
    identityIds List<String>

    Specifies a list of User Assigned Managed Identity IDs to be assigned to this Web PubSub.

    NOTE: This is required when type is set to UserAssigned

    principalId String
    The Principal ID associated with this Managed Service Identity.
    tenantId String
    The Tenant ID associated with this Managed Service Identity.

    ServiceLiveTrace, ServiceLiveTraceArgs

    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

    Import

    Web PubSub services can be imported using the resource id, e.g.

    $ pulumi import azure:webpubsub/service:Service example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.SignalRService/webPubSub/pubsub1

    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.

    Azure Classic v6.2.0 published on Friday, Sep 27, 2024 by Pulumi
    pulumi/pulumi-azure