Web Pub Sub
A class represent a resource. Uses Azure REST API version 2024-03-01. In version 2.x of the Azure Native provider, it used API version 2023-02-01. Other available API versions: 2023-02-01, 2023-03-01-preview, 2023-06-01-preview, 2023-08-01-preview, 2024-01-01-preview, 2024-04-01-preview, 2024-08-01-preview, 2024-10-01-preview. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native webpubsub [ApiVersion]
. See the ../../../version-guide/#accessing-any-api-version-via-local-packages for details.
Example Usage
WebPubSub_CreateOrUpdate
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;
return await Deployment.RunAsync(() =>
{
var webPubSub = new AzureNative.WebPubSub.WebPubSub("webPubSub", new()
{
DisableAadAuth = false,
DisableLocalAuth = false,
Identity = new AzureNative.WebPubSub.Inputs.ManagedIdentityArgs
{
Type = AzureNative.WebPubSub.ManagedIdentityType.SystemAssigned,
},
Kind = AzureNative.WebPubSub.ServiceKind.WebPubSub,
LiveTraceConfiguration = new AzureNative.WebPubSub.Inputs.LiveTraceConfigurationArgs
{
Categories = new[]
{
new AzureNative.WebPubSub.Inputs.LiveTraceCategoryArgs
{
Enabled = "true",
Name = "ConnectivityLogs",
},
},
Enabled = "false",
},
Location = "eastus",
NetworkACLs = new AzureNative.WebPubSub.Inputs.WebPubSubNetworkACLsArgs
{
DefaultAction = AzureNative.WebPubSub.ACLAction.Deny,
PrivateEndpoints = new[]
{
new AzureNative.WebPubSub.Inputs.PrivateEndpointACLArgs
{
Allow = new[]
{
AzureNative.WebPubSub.WebPubSubRequestType.ServerConnection,
},
Name = "mywebpubsubservice.1fa229cd-bf3f-47f0-8c49-afb36723997e",
},
},
PublicNetwork = new AzureNative.WebPubSub.Inputs.NetworkACLArgs
{
Allow = new[]
{
AzureNative.WebPubSub.WebPubSubRequestType.ClientConnection,
},
},
},
PublicNetworkAccess = "Enabled",
ResourceGroupName = "myResourceGroup",
ResourceName = "myWebPubSubService",
Sku = new AzureNative.WebPubSub.Inputs.ResourceSkuArgs
{
Capacity = 1,
Name = "Premium_P1",
Tier = AzureNative.WebPubSub.WebPubSubSkuTier.Premium,
},
SocketIO = new AzureNative.WebPubSub.Inputs.WebPubSubSocketIOSettingsArgs
{
ServiceMode = "Serverless",
},
Tags =
{
{ "key1", "value1" },
},
Tls = new AzureNative.WebPubSub.Inputs.WebPubSubTlsSettingsArgs
{
ClientCertEnabled = false,
},
});
});
package main
import (
webpubsub "github.com/pulumi/pulumi-azure-native-sdk/webpubsub/v2"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := webpubsub.NewWebPubSub(ctx, "webPubSub", &webpubsub.WebPubSubArgs{
DisableAadAuth: pulumi.Bool(false),
DisableLocalAuth: pulumi.Bool(false),
Identity: &webpubsub.ManagedIdentityArgs{
Type: pulumi.String(webpubsub.ManagedIdentityTypeSystemAssigned),
},
Kind: pulumi.String(webpubsub.ServiceKindWebPubSub),
LiveTraceConfiguration: &webpubsub.LiveTraceConfigurationArgs{
Categories: webpubsub.LiveTraceCategoryArray{
&webpubsub.LiveTraceCategoryArgs{
Enabled: pulumi.String("true"),
Name: pulumi.String("ConnectivityLogs"),
},
},
Enabled: pulumi.String("false"),
},
Location: pulumi.String("eastus"),
NetworkACLs: &webpubsub.WebPubSubNetworkACLsArgs{
DefaultAction: pulumi.String(webpubsub.ACLActionDeny),
PrivateEndpoints: webpubsub.PrivateEndpointACLArray{
&webpubsub.PrivateEndpointACLArgs{
Allow: pulumi.StringArray{
pulumi.String(webpubsub.WebPubSubRequestTypeServerConnection),
},
Name: pulumi.String("mywebpubsubservice.1fa229cd-bf3f-47f0-8c49-afb36723997e"),
},
},
PublicNetwork: &webpubsub.NetworkACLArgs{
Allow: pulumi.StringArray{
pulumi.String(webpubsub.WebPubSubRequestTypeClientConnection),
},
},
},
PublicNetworkAccess: pulumi.String("Enabled"),
ResourceGroupName: pulumi.String("myResourceGroup"),
ResourceName: pulumi.String("myWebPubSubService"),
Sku: &webpubsub.ResourceSkuArgs{
Capacity: pulumi.Int(1),
Name: pulumi.String("Premium_P1"),
Tier: pulumi.String(webpubsub.WebPubSubSkuTierPremium),
},
SocketIO: &webpubsub.WebPubSubSocketIOSettingsArgs{
ServiceMode: pulumi.String("Serverless"),
},
Tags: pulumi.StringMap{
"key1": pulumi.String("value1"),
},
Tls: &webpubsub.WebPubSubTlsSettingsArgs{
ClientCertEnabled: pulumi.Bool(false),
},
})
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.azurenative.webpubsub.WebPubSub;
import com.pulumi.azurenative.webpubsub.WebPubSubArgs;
import com.pulumi.azurenative.webpubsub.inputs.ManagedIdentityArgs;
import com.pulumi.azurenative.webpubsub.inputs.LiveTraceConfigurationArgs;
import com.pulumi.azurenative.webpubsub.inputs.WebPubSubNetworkACLsArgs;
import com.pulumi.azurenative.webpubsub.inputs.NetworkACLArgs;
import com.pulumi.azurenative.webpubsub.inputs.ResourceSkuArgs;
import com.pulumi.azurenative.webpubsub.inputs.WebPubSubSocketIOSettingsArgs;
import com.pulumi.azurenative.webpubsub.inputs.WebPubSubTlsSettingsArgs;
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 webPubSub = new WebPubSub("webPubSub", WebPubSubArgs.builder()
.disableAadAuth(false)
.disableLocalAuth(false)
.identity(ManagedIdentityArgs.builder()
.type("SystemAssigned")
.build())
.kind("WebPubSub")
.liveTraceConfiguration(LiveTraceConfigurationArgs.builder()
.categories(LiveTraceCategoryArgs.builder()
.enabled("true")
.name("ConnectivityLogs")
.build())
.enabled("false")
.build())
.location("eastus")
.networkACLs(WebPubSubNetworkACLsArgs.builder()
.defaultAction("Deny")
.privateEndpoints(PrivateEndpointACLArgs.builder()
.allow("ServerConnection")
.name("mywebpubsubservice.1fa229cd-bf3f-47f0-8c49-afb36723997e")
.build())
.publicNetwork(NetworkACLArgs.builder()
.allow("ClientConnection")
.build())
.build())
.publicNetworkAccess("Enabled")
.resourceGroupName("myResourceGroup")
.resourceName("myWebPubSubService")
.sku(ResourceSkuArgs.builder()
.capacity(1)
.name("Premium_P1")
.tier("Premium")
.build())
.socketIO(WebPubSubSocketIOSettingsArgs.builder()
.serviceMode("Serverless")
.build())
.tags(Map.of("key1", "value1"))
.tls(WebPubSubTlsSettingsArgs.builder()
.clientCertEnabled(false)
.build())
.build());
}
}
Import
An existing resource can be imported using its type token, name, and identifier, e.g.
$ pulumi import azure-native:webpubsub:WebPubSub myWebPubSubService /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}
Properties
The Azure API version of the resource.
DisableLocalAuth Enable or disable aad auth When set as true, connection with AuthType=aad won't work.
DisableLocalAuth Enable or disable local auth with AccessKey When set as true, connection with AccessKey=xxx won't work.
The publicly accessible IP of the resource.
Deprecated.
A class represent managed identities used for request and response
Live trace configuration of a Microsoft.SignalRService resource.
Network ACLs for the resource
Private endpoint connections to the resource.
Provisioning state of the resource.
Enable or disable public network access. Default to "Enabled". When it's Enabled, network ACLs still apply. When it's Disabled, public network access is always disabled no matter what you set in network ACLs.
The publicly accessible port of the resource which is designed for browser/client side usage.
Enable or disable the regional endpoint. Default to "Enabled". When it's Disabled, new connections will not be routed to this endpoint, however existing connections will not be affected. This property is replica specific. Disable the regional endpoint without replica is not allowed.
Resource log configuration of a Microsoft.SignalRService resource.
Stop or start the resource. Default to "False". When it's true, the data plane of the resource is shutdown. When it's false, the data plane of the resource is started.
The publicly accessible port of the resource which is designed for customer server side usage.
The list of shared private link resources.
The billing information of the resource.
SocketIO settings for the resource
Azure Resource Manager metadata containing createdBy and modifiedBy information.
TLS settings for the resource