Service

class Service : KotlinCustomResource

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

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

Properties

Link copied to clipboard
val aadAuthEnabled: Output<Boolean>?

Whether to enable AAD auth? Defaults to true.

Link copied to clipboard
val capacity: Output<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.

Link copied to clipboard
val externalIp: Output<String>

The publicly accessible IP of the Web PubSub service.

Link copied to clipboard
val hostname: Output<String>

The FQDN of the Web PubSub service.

Link copied to clipboard
val id: Output<String>
Link copied to clipboard

An identity block as defined below.

Link copied to clipboard

A live_trace block as defined below.

Link copied to clipboard

Whether to enable local auth? Defaults to true.

Link copied to clipboard
val location: Output<String>

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

Link copied to clipboard
val name: Output<String>

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

Link copied to clipboard

The primary access key for the Web PubSub service.

Link copied to clipboard

The primary connection string for the Web PubSub service.

Link copied to clipboard

Whether to enable public network access? Defaults to true.

Link copied to clipboard
val publicPort: Output<Int>

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

Link copied to clipboard
val pulumiChildResources: Set<KotlinResource>
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

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

Link copied to clipboard

The secondary access key for the Web PubSub service.

Link copied to clipboard

The secondary connection string for the Web PubSub service.

Link copied to clipboard
val serverPort: Output<Int>

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

Link copied to clipboard
val sku: Output<String>

Specifies which SKU to use. Possible values are Free_F1, Standard_S1, Premium_P1 and Premium_P2.

Link copied to clipboard
val tags: Output<Map<String, String>>?

A mapping of tags to assign to the resource.

Link copied to clipboard

Whether to request client certificate during TLS handshake? Defaults to false.

Link copied to clipboard
val urn: Output<String>
Link copied to clipboard
val version: Output<String>