pulumi-azure-native-kotlin/com.pulumi.azurenative.signalrservice.kotlin/SignalRArgs

SignalRArgs

data class SignalRArgs(val cors: Output<SignalRCorsSettingsArgs>? = null, val disableAadAuth: Output<Boolean>? = null, val disableLocalAuth: Output<Boolean>? = null, val features: Output<List<SignalRFeatureArgs>>? = null, val identity: Output<ManagedIdentityArgs>? = null, val kind: Output<Either<String, ServiceKind>>? = null, val liveTraceConfiguration: Output<LiveTraceConfigurationArgs>? = null, val location: Output<String>? = null, val networkACLs: Output<SignalRNetworkACLsArgs>? = null, val publicNetworkAccess: Output<String>? = null, val resourceGroupName: Output<String>? = null, val resourceLogConfiguration: Output<ResourceLogConfigurationArgs>? = null, val resourceName: Output<String>? = null, val serverless: Output<ServerlessSettingsArgs>? = null, val sku: Output<ResourceSkuArgs>? = null, val tags: Output<Map<String, String>>? = null, val tls: Output<SignalRTlsSettingsArgs>? = null, val upstream: Output<ServerlessUpstreamSettingsArgs>? = null) : ConvertibleToJava<SignalRArgs>

A class represent a resource. Azure REST API version: 2023-02-01. Prior API version in Azure Native 1.x: 2020-05-01. Other available API versions: 2018-10-01, 2023-03-01-preview, 2023-06-01-preview, 2023-08-01-preview.

Example Usage

SignalR_CreateOrUpdate

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;
return await Deployment.RunAsync(() =>
{
    var signalR = new AzureNative.SignalRService.SignalR("signalR", new()
    {
        Cors = new AzureNative.SignalRService.Inputs.SignalRCorsSettingsArgs
        {
            AllowedOrigins = new[]
            {
                "https://foo.com",
                "https://bar.com",
            },
        },
        DisableAadAuth = false,
        DisableLocalAuth = false,
        Features = new[]
        {
            new AzureNative.SignalRService.Inputs.SignalRFeatureArgs
            {
                Flag = "ServiceMode",
                Properties = null,
                Value = "Serverless",
            },
            new AzureNative.SignalRService.Inputs.SignalRFeatureArgs
            {
                Flag = "EnableConnectivityLogs",
                Properties = null,
                Value = "True",
            },
            new AzureNative.SignalRService.Inputs.SignalRFeatureArgs
            {
                Flag = "EnableMessagingLogs",
                Properties = null,
                Value = "False",
            },
            new AzureNative.SignalRService.Inputs.SignalRFeatureArgs
            {
                Flag = "EnableLiveTrace",
                Properties = null,
                Value = "False",
            },
        },
        Identity = new AzureNative.SignalRService.Inputs.ManagedIdentityArgs
        {
            Type = "SystemAssigned",
        },
        Kind = "SignalR",
        LiveTraceConfiguration = new AzureNative.SignalRService.Inputs.LiveTraceConfigurationArgs
        {
            Categories = new[]
            {
                new AzureNative.SignalRService.Inputs.LiveTraceCategoryArgs
                {
                    Enabled = "true",
                    Name = "ConnectivityLogs",
                },
            },
            Enabled = "false",
        },
        Location = "eastus",
        NetworkACLs = new AzureNative.SignalRService.Inputs.SignalRNetworkACLsArgs
        {
            DefaultAction = "Deny",
            PrivateEndpoints = new[]
            {
                new AzureNative.SignalRService.Inputs.PrivateEndpointACLArgs
                {
                    Allow = new[]
                    {
                        "ServerConnection",
                    },
                    Name = "mysignalrservice.1fa229cd-bf3f-47f0-8c49-afb36723997e",
                },
            },
            PublicNetwork = new AzureNative.SignalRService.Inputs.NetworkACLArgs
            {
                Allow = new[]
                {
                    "ClientConnection",
                },
            },
        },
        PublicNetworkAccess = "Enabled",
        ResourceGroupName = "myResourceGroup",
        ResourceName = "mySignalRService",
        Serverless = new AzureNative.SignalRService.Inputs.ServerlessSettingsArgs
        {
            ConnectionTimeoutInSeconds = 5,
        },
        Sku = new AzureNative.SignalRService.Inputs.ResourceSkuArgs
        {
            Capacity = 1,
            Name = "Premium_P1",
            Tier = "Premium",
        },
        Tags =
        {
            { "key1", "value1" },
        },
        Tls = new AzureNative.SignalRService.Inputs.SignalRTlsSettingsArgs
        {
            ClientCertEnabled = false,
        },
        Upstream = new AzureNative.SignalRService.Inputs.ServerlessUpstreamSettingsArgs
        {
            Templates = new[]
            {
                new AzureNative.SignalRService.Inputs.UpstreamTemplateArgs
                {
                    Auth = new AzureNative.SignalRService.Inputs.UpstreamAuthSettingsArgs
                    {
                        ManagedIdentity = new AzureNative.SignalRService.Inputs.ManagedIdentitySettingsArgs
                        {
                            Resource = "api://example",
                        },
                        Type = "ManagedIdentity",
                    },
                    CategoryPattern = "*",
                    EventPattern = "connect,disconnect",
                    HubPattern = "*",
                    UrlTemplate = "https://example.com/chat/api/connect",
                },
            },
        },
    });
});
Content copied to clipboard
package main
import (
	"github.com/pulumi/pulumi-azure-native-sdk/signalrservice/v2"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := signalrservice.NewSignalR(ctx, "signalR", &signalrservice.SignalRArgs{
Cors: &signalrservice.SignalRCorsSettingsArgs{
AllowedOrigins: pulumi.StringArray{
pulumi.String("https://foo.com"),
pulumi.String("https://bar.com"),
},
},
DisableAadAuth: pulumi.Bool(false),
DisableLocalAuth: pulumi.Bool(false),
Features: []signalrservice.SignalRFeatureArgs{
{
Flag: pulumi.String("ServiceMode"),
Properties: nil,
Value: pulumi.String("Serverless"),
},
{
Flag: pulumi.String("EnableConnectivityLogs"),
Properties: nil,
Value: pulumi.String("True"),
},
{
Flag: pulumi.String("EnableMessagingLogs"),
Properties: nil,
Value: pulumi.String("False"),
},
{
Flag: pulumi.String("EnableLiveTrace"),
Properties: nil,
Value: pulumi.String("False"),
},
},
Identity: &signalrservice.ManagedIdentityArgs{
Type: pulumi.String("SystemAssigned"),
},
Kind: pulumi.String("SignalR"),
LiveTraceConfiguration: signalrservice.LiveTraceConfigurationResponse{
Categories: signalrservice.LiveTraceCategoryArray{
&signalrservice.LiveTraceCategoryArgs{
Enabled: pulumi.String("true"),
Name: pulumi.String("ConnectivityLogs"),
},
},
Enabled: pulumi.String("false"),
},
Location: pulumi.String("eastus"),
NetworkACLs: signalrservice.SignalRNetworkACLsResponse{
DefaultAction: pulumi.String("Deny"),
PrivateEndpoints: signalrservice.PrivateEndpointACLArray{
&signalrservice.PrivateEndpointACLArgs{
Allow: pulumi.StringArray{
pulumi.String("ServerConnection"),
},
Name: pulumi.String("mysignalrservice.1fa229cd-bf3f-47f0-8c49-afb36723997e"),
},
},
PublicNetwork: &signalrservice.NetworkACLArgs{
Allow: pulumi.StringArray{
pulumi.String("ClientConnection"),
},
},
},
PublicNetworkAccess: pulumi.String("Enabled"),
ResourceGroupName: pulumi.String("myResourceGroup"),
ResourceName: pulumi.String("mySignalRService"),
Serverless: &signalrservice.ServerlessSettingsArgs{
ConnectionTimeoutInSeconds: pulumi.Int(5),
},
Sku: &signalrservice.ResourceSkuArgs{
Capacity: pulumi.Int(1),
Name: pulumi.String("Premium_P1"),
Tier: pulumi.String("Premium"),
},
Tags: pulumi.StringMap{
"key1": pulumi.String("value1"),
},
Tls: &signalrservice.SignalRTlsSettingsArgs{
ClientCertEnabled: pulumi.Bool(false),
},
Upstream: signalrservice.ServerlessUpstreamSettingsResponse{
Templates: signalrservice.UpstreamTemplateArray{
interface{}{
Auth: interface{}{
ManagedIdentity: &signalrservice.ManagedIdentitySettingsArgs{
Resource: pulumi.String("api://example"),
},
Type: pulumi.String("ManagedIdentity"),
},
CategoryPattern: pulumi.String("*"),
EventPattern: pulumi.String("connect,disconnect"),
HubPattern: pulumi.String("*"),
UrlTemplate: pulumi.String("https://example.com/chat/api/connect"),
},
},
},
})
if err != nil {
return err
}
return nil
})
}
Content copied to clipboard
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.signalrservice.SignalR;
import com.pulumi.azurenative.signalrservice.SignalRArgs;
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 signalR = new SignalR("signalR", SignalRArgs.builder()
            .cors(Map.of("allowedOrigins",
                "https://foo.com",
                "https://bar.com"))
            .disableAadAuth(false)
            .disableLocalAuth(false)
            .features(
                Map.ofEntries(
                    Map.entry("flag", "ServiceMode"),
                    Map.entry("properties", ),
                    Map.entry("value", "Serverless")
                ),
                Map.ofEntries(
                    Map.entry("flag", "EnableConnectivityLogs"),
                    Map.entry("properties", ),
                    Map.entry("value", "True")
                ),
                Map.ofEntries(
                    Map.entry("flag", "EnableMessagingLogs"),
                    Map.entry("properties", ),
                    Map.entry("value", "False")
                ),
                Map.ofEntries(
                    Map.entry("flag", "EnableLiveTrace"),
                    Map.entry("properties", ),
                    Map.entry("value", "False")
                ))
            .identity(Map.of("type", "SystemAssigned"))
            .kind("SignalR")
            .liveTraceConfiguration(Map.ofEntries(
                Map.entry("categories", Map.ofEntries(
                    Map.entry("enabled", "true"),
                    Map.entry("name", "ConnectivityLogs")
                )),
                Map.entry("enabled", "false")
            ))
            .location("eastus")
            .networkACLs(Map.ofEntries(
                Map.entry("defaultAction", "Deny"),
                Map.entry("privateEndpoints", Map.ofEntries(
                    Map.entry("allow", "ServerConnection"),
                    Map.entry("name", "mysignalrservice.1fa229cd-bf3f-47f0-8c49-afb36723997e")
                )),
                Map.entry("publicNetwork", Map.of("allow", "ClientConnection"))
            ))
            .publicNetworkAccess("Enabled")
            .resourceGroupName("myResourceGroup")
            .resourceName("mySignalRService")
            .serverless(Map.of("connectionTimeoutInSeconds", 5))
            .sku(Map.ofEntries(
                Map.entry("capacity", 1),
                Map.entry("name", "Premium_P1"),
                Map.entry("tier", "Premium")
            ))
            .tags(Map.of("key1", "value1"))
            .tls(Map.of("clientCertEnabled", false))
            .upstream(Map.of("templates", Map.ofEntries(
                Map.entry("auth", Map.ofEntries(
                    Map.entry("managedIdentity", Map.of("resource", "api://example")),
                    Map.entry("type", "ManagedIdentity")
                )),
                Map.entry("categoryPattern", "*"),
                Map.entry("eventPattern", "connect,disconnect"),
                Map.entry("hubPattern", "*"),
                Map.entry("urlTemplate", "https://example.com/chat/api/connect")
            )))
            .build());
    }
}
Content copied to clipboard

Import

An existing resource can be imported using its type token, name, and identifier, e.g.

$ pulumi import azure-native:signalrservice:SignalR mySignalRService /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{resourceName}
Content copied to clipboard

Constructors

Link copied to clipboard
fun SignalRArgs(cors: Output<SignalRCorsSettingsArgs>? = null, disableAadAuth: Output<Boolean>? = null, disableLocalAuth: Output<Boolean>? = null, features: Output<List<SignalRFeatureArgs>>? = null, identity: Output<ManagedIdentityArgs>? = null, kind: Output<Either<String, ServiceKind>>? = null, liveTraceConfiguration: Output<LiveTraceConfigurationArgs>? = null, location: Output<String>? = null, networkACLs: Output<SignalRNetworkACLsArgs>? = null, publicNetworkAccess: Output<String>? = null, resourceGroupName: Output<String>? = null, resourceLogConfiguration: Output<ResourceLogConfigurationArgs>? = null, resourceName: Output<String>? = null, serverless: Output<ServerlessSettingsArgs>? = null, sku: Output<ResourceSkuArgs>? = null, tags: Output<Map<String, String>>? = null, tls: Output<SignalRTlsSettingsArgs>? = null, upstream: Output<ServerlessUpstreamSettingsArgs>? = null)

Functions

Link copied to clipboard
open override fun toJava(): SignalRArgs

Properties

Link copied to clipboard
val cors: Output<SignalRCorsSettingsArgs>? = null

Cross-Origin Resource Sharing (CORS) settings.

Link copied to clipboard
val disableAadAuth: Output<Boolean>? = null

DisableLocalAuth Enable or disable aad auth When set as true, connection with AuthType=aad won't work.

Link copied to clipboard
val disableLocalAuth: Output<Boolean>? = null

DisableLocalAuth Enable or disable local auth with AccessKey When set as true, connection with AccessKey=xxx won't work.

Link copied to clipboard
val features: Output<List<SignalRFeatureArgs>>? = null

List of the featureFlags. FeatureFlags that are not included in the parameters for the update operation will not be modified. And the response will only include featureFlags that are explicitly set. When a featureFlag is not explicitly set, its globally default value will be used But keep in mind, the default value doesn't mean "false". It varies in terms of different FeatureFlags.

Link copied to clipboard
val identity: Output<ManagedIdentityArgs>? = null

A class represent managed identities used for request and response

Link copied to clipboard
val kind: Output<Either<String, ServiceKind>>? = null

The kind of the service, it can be SignalR or RawWebSockets

Link copied to clipboard
val liveTraceConfiguration: Output<LiveTraceConfigurationArgs>? = null

Live trace configuration of a Microsoft.SignalRService resource.

Link copied to clipboard
val location: Output<String>? = null

The GEO location of the resource. e.g. West US | East US | North Central US | South Central US.

Link copied to clipboard
val networkACLs: Output<SignalRNetworkACLsArgs>? = null

Network ACLs for the resource

Link copied to clipboard
val publicNetworkAccess: Output<String>? = null

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.

Link copied to clipboard
val resourceGroupName: Output<String>? = null

The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

Link copied to clipboard
val resourceLogConfiguration: Output<ResourceLogConfigurationArgs>? = null

Resource log configuration of a Microsoft.SignalRService resource.

Link copied to clipboard
val resourceName: Output<String>? = null

The name of the resource.

Link copied to clipboard
val serverless: Output<ServerlessSettingsArgs>? = null

Serverless settings.

Link copied to clipboard
val sku: Output<ResourceSkuArgs>? = null

The billing information of the resource.

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

Tags of the service which is a list of key value pairs that describe the resource.

Link copied to clipboard
val tls: Output<SignalRTlsSettingsArgs>? = null

TLS settings for the resource

Link copied to clipboard
val upstream: Output<ServerlessUpstreamSettingsArgs>? = null

The settings for the Upstream when the service is in server-less mode.