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

We recommend using Azure Native.

Azure v6.22.0 published on Tuesday, Apr 1, 2025 by Pulumi
pulumi/pulumi-azure

azure.webpubsub.Socketio

Explore with Pulumi AI

azure logo

We recommend using Azure Native.

Azure v6.22.0 published on Tuesday, Apr 1, 2025 by Pulumi
pulumi/pulumi-azure

    Manages a Web PubSub Service for Socket.IO.

    Create Socketio Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Socketio(name: string, args: SocketioArgs, opts?: CustomResourceOptions);
    @overload
def Socketio(resource_name: str,
             args: SocketioArgs,
             opts: Optional[ResourceOptions] = None)

@overload
def Socketio(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             resource_group_name: Optional[str] = None,
             sku: Optional[SocketioSkuArgs] = None,
             local_auth_enabled: Optional[bool] = None,
             live_trace_enabled: Optional[bool] = None,
             live_trace_http_request_logs_enabled: Optional[bool] = None,
             live_trace_messaging_logs_enabled: Optional[bool] = None,
             aad_auth_enabled: Optional[bool] = None,
             location: Optional[str] = None,
             name: Optional[str] = None,
             public_network_access: Optional[str] = None,
             live_trace_connectivity_logs_enabled: Optional[bool] = None,
             service_mode: Optional[str] = None,
             identity: Optional[SocketioIdentityArgs] = None,
             tags: Optional[Mapping[str, str]] = None,
             tls_client_cert_enabled: Optional[bool] = None)
    func NewSocketio(ctx *Context, name string, args SocketioArgs, opts ...ResourceOption) (*Socketio, error)
    public Socketio(string name, SocketioArgs args, CustomResourceOptions? opts = null)
    public Socketio(String name, SocketioArgs args)
public Socketio(String name, SocketioArgs args, CustomResourceOptions options)

    type: azure:webpubsub:Socketio
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 SocketioArgs
    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 SocketioArgs
    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 SocketioArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args SocketioArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args SocketioArgs
    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 socketioResource = new Azure.WebPubSub.Socketio("socketioResource", new()
{
    ResourceGroupName = "string",
    Sku = new Azure.WebPubSub.Inputs.SocketioSkuArgs
    {
        Name = "string",
        Capacity = 0,
    },
    LocalAuthEnabled = false,
    LiveTraceEnabled = false,
    LiveTraceHttpRequestLogsEnabled = false,
    LiveTraceMessagingLogsEnabled = false,
    AadAuthEnabled = false,
    Location = "string",
    Name = "string",
    PublicNetworkAccess = "string",
    LiveTraceConnectivityLogsEnabled = false,
    ServiceMode = "string",
    Identity = new Azure.WebPubSub.Inputs.SocketioIdentityArgs
    {
        Type = "string",
        IdentityIds = new[]
        {
            "string",
        },
        PrincipalId = "string",
        TenantId = "string",
    },
    Tags = 
    {
        { "string", "string" },
    },
    TlsClientCertEnabled = false,
});

    example, err := webpubsub.NewSocketio(ctx, "socketioResource", &webpubsub.SocketioArgs{
	ResourceGroupName: pulumi.String("string"),
	Sku: &webpubsub.SocketioSkuArgs{
		Name:     pulumi.String("string"),
		Capacity: pulumi.Int(0),
	},
	LocalAuthEnabled:                 pulumi.Bool(false),
	LiveTraceEnabled:                 pulumi.Bool(false),
	LiveTraceHttpRequestLogsEnabled:  pulumi.Bool(false),
	LiveTraceMessagingLogsEnabled:    pulumi.Bool(false),
	AadAuthEnabled:                   pulumi.Bool(false),
	Location:                         pulumi.String("string"),
	Name:                             pulumi.String("string"),
	PublicNetworkAccess:              pulumi.String("string"),
	LiveTraceConnectivityLogsEnabled: pulumi.Bool(false),
	ServiceMode:                      pulumi.String("string"),
	Identity: &webpubsub.SocketioIdentityArgs{
		Type: pulumi.String("string"),
		IdentityIds: pulumi.StringArray{
			pulumi.String("string"),
		},
		PrincipalId: pulumi.String("string"),
		TenantId:    pulumi.String("string"),
	},
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	TlsClientCertEnabled: pulumi.Bool(false),
})

    var socketioResource = new Socketio("socketioResource", SocketioArgs.builder()
    .resourceGroupName("string")
    .sku(SocketioSkuArgs.builder()
        .name("string")
        .capacity(0)
        .build())
    .localAuthEnabled(false)
    .liveTraceEnabled(false)
    .liveTraceHttpRequestLogsEnabled(false)
    .liveTraceMessagingLogsEnabled(false)
    .aadAuthEnabled(false)
    .location("string")
    .name("string")
    .publicNetworkAccess("string")
    .liveTraceConnectivityLogsEnabled(false)
    .serviceMode("string")
    .identity(SocketioIdentityArgs.builder()
        .type("string")
        .identityIds("string")
        .principalId("string")
        .tenantId("string")
        .build())
    .tags(Map.of("string", "string"))
    .tlsClientCertEnabled(false)
    .build());

    socketio_resource = azure.webpubsub.Socketio("socketioResource",
    resource_group_name="string",
    sku={
        "name": "string",
        "capacity": 0,
    },
    local_auth_enabled=False,
    live_trace_enabled=False,
    live_trace_http_request_logs_enabled=False,
    live_trace_messaging_logs_enabled=False,
    aad_auth_enabled=False,
    location="string",
    name="string",
    public_network_access="string",
    live_trace_connectivity_logs_enabled=False,
    service_mode="string",
    identity={
        "type": "string",
        "identity_ids": ["string"],
        "principal_id": "string",
        "tenant_id": "string",
    },
    tags={
        "string": "string",
    },
    tls_client_cert_enabled=False)

    const socketioResource = new azure.webpubsub.Socketio("socketioResource", {
    resourceGroupName: "string",
    sku: {
        name: "string",
        capacity: 0,
    },
    localAuthEnabled: false,
    liveTraceEnabled: false,
    liveTraceHttpRequestLogsEnabled: false,
    liveTraceMessagingLogsEnabled: false,
    aadAuthEnabled: false,
    location: "string",
    name: "string",
    publicNetworkAccess: "string",
    liveTraceConnectivityLogsEnabled: false,
    serviceMode: "string",
    identity: {
        type: "string",
        identityIds: ["string"],
        principalId: "string",
        tenantId: "string",
    },
    tags: {
        string: "string",
    },
    tlsClientCertEnabled: false,
});

    type: azure:webpubsub:Socketio
properties:
    aadAuthEnabled: false
    identity:
        identityIds:
            - string
        principalId: string
        tenantId: string
        type: string
    liveTraceConnectivityLogsEnabled: false
    liveTraceEnabled: false
    liveTraceHttpRequestLogsEnabled: false
    liveTraceMessagingLogsEnabled: false
    localAuthEnabled: false
    location: string
    name: string
    publicNetworkAccess: string
    resourceGroupName: string
    serviceMode: string
    sku:
        capacity: 0
        name: string
    tags:
        string: string
    tlsClientCertEnabled: false

    Socketio Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The Socketio resource accepts the following input properties:

    ResourceGroupName string
    The name of the Resource Group where the Web PubSub Service should exist. Changing this forces a new Web PubSub Service to be created.
    Sku SocketioSku
    The SKU to use for this Web PubSub Service. Possible values are Free_F1, Standard_S1, Premium_P1, and Premium_P2.
    AadAuthEnabled bool
    Whether Azure Active Directory authentication is enabled. Defaults to true.
    Identity SocketioIdentity
    An identity block as defined below.
    LiveTraceConnectivityLogsEnabled bool
    Whether the connectivity log category for live trace is enabled. Defaults to true.
    LiveTraceEnabled bool
    Whether the live trace tool is enabled. Defaults to true.
    LiveTraceHttpRequestLogsEnabled bool
    Whether the HTTP request log category for live trace is enabled. Defaults to true.
    LiveTraceMessagingLogsEnabled bool
    Whether the messaging log category for live trace is enabled. Defaults to true.
    LocalAuthEnabled bool
    Whether local authentication using an access key is enabled. Defaults to true.
    Location string
    The Azure Region where the Web PubSub Service should exist. Changing this forces a new Web PubSub Service to be created.
    Name string
    The name which should be used for this Web PubSub Service. Changing this forces a new Web PubSub Service to be created.
    PublicNetworkAccess string

    Whether public network access is enabled. Defaults to Enabled. Possible values are Enabled and Disabled.

    Note: public_network_access cannot be set to Disabled when sku is Free_F1.

    ServiceMode string
    The service mode of this Web PubSub Service. Defaults to Default. Possible values are Default and Serverless.
    Tags Dictionary<string, string>
    A mapping of tags which should be assigned to the Web PubSub Service.
    TlsClientCertEnabled bool

    Whether the service should request a client certificate during a TLS handshake. Defaults to false.

    Note: tls_client_cert_enabled cannot be set to true when sku is Free_F1.

    ResourceGroupName string
    The name of the Resource Group where the Web PubSub Service should exist. Changing this forces a new Web PubSub Service to be created.
    Sku SocketioSkuArgs
    The SKU to use for this Web PubSub Service. Possible values are Free_F1, Standard_S1, Premium_P1, and Premium_P2.
    AadAuthEnabled bool
    Whether Azure Active Directory authentication is enabled. Defaults to true.
    Identity SocketioIdentityArgs
    An identity block as defined below.
    LiveTraceConnectivityLogsEnabled bool
    Whether the connectivity log category for live trace is enabled. Defaults to true.
    LiveTraceEnabled bool
    Whether the live trace tool is enabled. Defaults to true.
    LiveTraceHttpRequestLogsEnabled bool
    Whether the HTTP request log category for live trace is enabled. Defaults to true.
    LiveTraceMessagingLogsEnabled bool
    Whether the messaging log category for live trace is enabled. Defaults to true.
    LocalAuthEnabled bool
    Whether local authentication using an access key is enabled. Defaults to true.
    Location string
    The Azure Region where the Web PubSub Service should exist. Changing this forces a new Web PubSub Service to be created.
    Name string
    The name which should be used for this Web PubSub Service. Changing this forces a new Web PubSub Service to be created.
    PublicNetworkAccess string

    Whether public network access is enabled. Defaults to Enabled. Possible values are Enabled and Disabled.

    Note: public_network_access cannot be set to Disabled when sku is Free_F1.

    ServiceMode string
    The service mode of this Web PubSub Service. Defaults to Default. Possible values are Default and Serverless.
    Tags map[string]string
    A mapping of tags which should be assigned to the Web PubSub Service.
    TlsClientCertEnabled bool

    Whether the service should request a client certificate during a TLS handshake. Defaults to false.

    Note: tls_client_cert_enabled cannot be set to true when sku is Free_F1.

    resourceGroupName String
    The name of the Resource Group where the Web PubSub Service should exist. Changing this forces a new Web PubSub Service to be created.
    sku SocketioSku
    The SKU to use for this Web PubSub Service. Possible values are Free_F1, Standard_S1, Premium_P1, and Premium_P2.
    aadAuthEnabled Boolean
    Whether Azure Active Directory authentication is enabled. Defaults to true.
    identity SocketioIdentity
    An identity block as defined below.
    liveTraceConnectivityLogsEnabled Boolean
    Whether the connectivity log category for live trace is enabled. Defaults to true.
    liveTraceEnabled Boolean
    Whether the live trace tool is enabled. Defaults to true.
    liveTraceHttpRequestLogsEnabled Boolean
    Whether the HTTP request log category for live trace is enabled. Defaults to true.
    liveTraceMessagingLogsEnabled Boolean
    Whether the messaging log category for live trace is enabled. Defaults to true.
    localAuthEnabled Boolean
    Whether local authentication using an access key is enabled. Defaults to true.
    location String
    The Azure Region where the Web PubSub Service should exist. Changing this forces a new Web PubSub Service to be created.
    name String
    The name which should be used for this Web PubSub Service. Changing this forces a new Web PubSub Service to be created.
    publicNetworkAccess String

    Whether public network access is enabled. Defaults to Enabled. Possible values are Enabled and Disabled.

    Note: public_network_access cannot be set to Disabled when sku is Free_F1.

    serviceMode String
    The service mode of this Web PubSub Service. Defaults to Default. Possible values are Default and Serverless.
    tags Map<String,String>
    A mapping of tags which should be assigned to the Web PubSub Service.
    tlsClientCertEnabled Boolean

    Whether the service should request a client certificate during a TLS handshake. Defaults to false.

    Note: tls_client_cert_enabled cannot be set to true when sku is Free_F1.

    resourceGroupName string
    The name of the Resource Group where the Web PubSub Service should exist. Changing this forces a new Web PubSub Service to be created.
    sku SocketioSku
    The SKU to use for this Web PubSub Service. Possible values are Free_F1, Standard_S1, Premium_P1, and Premium_P2.
    aadAuthEnabled boolean
    Whether Azure Active Directory authentication is enabled. Defaults to true.
    identity SocketioIdentity
    An identity block as defined below.
    liveTraceConnectivityLogsEnabled boolean
    Whether the connectivity log category for live trace is enabled. Defaults to true.
    liveTraceEnabled boolean
    Whether the live trace tool is enabled. Defaults to true.
    liveTraceHttpRequestLogsEnabled boolean
    Whether the HTTP request log category for live trace is enabled. Defaults to true.
    liveTraceMessagingLogsEnabled boolean
    Whether the messaging log category for live trace is enabled. Defaults to true.
    localAuthEnabled boolean
    Whether local authentication using an access key is enabled. Defaults to true.
    location string
    The Azure Region where the Web PubSub Service should exist. Changing this forces a new Web PubSub Service to be created.
    name string
    The name which should be used for this Web PubSub Service. Changing this forces a new Web PubSub Service to be created.
    publicNetworkAccess string

    Whether public network access is enabled. Defaults to Enabled. Possible values are Enabled and Disabled.

    Note: public_network_access cannot be set to Disabled when sku is Free_F1.

    serviceMode string
    The service mode of this Web PubSub Service. Defaults to Default. Possible values are Default and Serverless.
    tags {[key: string]: string}
    A mapping of tags which should be assigned to the Web PubSub Service.
    tlsClientCertEnabled boolean

    Whether the service should request a client certificate during a TLS handshake. Defaults to false.

    Note: tls_client_cert_enabled cannot be set to true when sku is Free_F1.

    resource_group_name str
    The name of the Resource Group where the Web PubSub Service should exist. Changing this forces a new Web PubSub Service to be created.
    sku SocketioSkuArgs
    The SKU to use for this Web PubSub Service. Possible values are Free_F1, Standard_S1, Premium_P1, and Premium_P2.
    aad_auth_enabled bool
    Whether Azure Active Directory authentication is enabled. Defaults to true.
    identity SocketioIdentityArgs
    An identity block as defined below.
    live_trace_connectivity_logs_enabled bool
    Whether the connectivity log category for live trace is enabled. Defaults to true.
    live_trace_enabled bool
    Whether the live trace tool is enabled. Defaults to true.
    live_trace_http_request_logs_enabled bool
    Whether the HTTP request log category for live trace is enabled. Defaults to true.
    live_trace_messaging_logs_enabled bool
    Whether the messaging log category for live trace is enabled. Defaults to true.
    local_auth_enabled bool
    Whether local authentication using an access key is enabled. Defaults to true.
    location str
    The Azure Region where the Web PubSub Service should exist. Changing this forces a new Web PubSub Service to be created.
    name str
    The name which should be used for this Web PubSub Service. Changing this forces a new Web PubSub Service to be created.
    public_network_access str

    Whether public network access is enabled. Defaults to Enabled. Possible values are Enabled and Disabled.

    Note: public_network_access cannot be set to Disabled when sku is Free_F1.

    service_mode str
    The service mode of this Web PubSub Service. Defaults to Default. Possible values are Default and Serverless.
    tags Mapping[str, str]
    A mapping of tags which should be assigned to the Web PubSub Service.
    tls_client_cert_enabled bool

    Whether the service should request a client certificate during a TLS handshake. Defaults to false.

    Note: tls_client_cert_enabled cannot be set to true when sku is Free_F1.

    resourceGroupName String
    The name of the Resource Group where the Web PubSub Service should exist. Changing this forces a new Web PubSub Service to be created.
    sku Property Map
    The SKU to use for this Web PubSub Service. Possible values are Free_F1, Standard_S1, Premium_P1, and Premium_P2.
    aadAuthEnabled Boolean
    Whether Azure Active Directory authentication is enabled. Defaults to true.
    identity Property Map
    An identity block as defined below.
    liveTraceConnectivityLogsEnabled Boolean
    Whether the connectivity log category for live trace is enabled. Defaults to true.
    liveTraceEnabled Boolean
    Whether the live trace tool is enabled. Defaults to true.
    liveTraceHttpRequestLogsEnabled Boolean
    Whether the HTTP request log category for live trace is enabled. Defaults to true.
    liveTraceMessagingLogsEnabled Boolean
    Whether the messaging log category for live trace is enabled. Defaults to true.
    localAuthEnabled Boolean
    Whether local authentication using an access key is enabled. Defaults to true.
    location String
    The Azure Region where the Web PubSub Service should exist. Changing this forces a new Web PubSub Service to be created.
    name String
    The name which should be used for this Web PubSub Service. Changing this forces a new Web PubSub Service to be created.
    publicNetworkAccess String

    Whether public network access is enabled. Defaults to Enabled. Possible values are Enabled and Disabled.

    Note: public_network_access cannot be set to Disabled when sku is Free_F1.

    serviceMode String
    The service mode of this Web PubSub Service. Defaults to Default. Possible values are Default and Serverless.
    tags Map<String>
    A mapping of tags which should be assigned to the Web PubSub Service.
    tlsClientCertEnabled Boolean

    Whether the service should request a client certificate during a TLS handshake. Defaults to false.

    Note: tls_client_cert_enabled cannot be set to true when sku is Free_F1.

    Outputs

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

    ExternalIp string
    The publicly accessible IP address 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 for client-side usage of the Web PubSub Service.
    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 for server-side usage of the Web PubSub Service.
    ExternalIp string
    The publicly accessible IP address 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 for client-side usage of the Web PubSub Service.
    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 for server-side usage of the Web PubSub Service.
    externalIp String
    The publicly accessible IP address 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 for client-side usage of the Web PubSub Service.
    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 for server-side usage of the Web PubSub Service.
    externalIp string
    The publicly accessible IP address 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 for client-side usage of the Web PubSub Service.
    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 for server-side usage of the Web PubSub Service.
    external_ip str
    The publicly accessible IP address 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 for client-side usage of the Web PubSub Service.
    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 for server-side usage of the Web PubSub Service.
    externalIp String
    The publicly accessible IP address 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 for client-side usage of the Web PubSub Service.
    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 for server-side usage of the Web PubSub Service.

    Look up Existing Socketio Resource

    Get an existing Socketio 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?: SocketioState, opts?: CustomResourceOptions): Socketio
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        aad_auth_enabled: Optional[bool] = None,
        external_ip: Optional[str] = None,
        hostname: Optional[str] = None,
        identity: Optional[SocketioIdentityArgs] = None,
        live_trace_connectivity_logs_enabled: Optional[bool] = None,
        live_trace_enabled: Optional[bool] = None,
        live_trace_http_request_logs_enabled: Optional[bool] = None,
        live_trace_messaging_logs_enabled: Optional[bool] = 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: Optional[str] = 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,
        service_mode: Optional[str] = None,
        sku: Optional[SocketioSkuArgs] = None,
        tags: Optional[Mapping[str, str]] = None,
        tls_client_cert_enabled: Optional[bool] = None) -> Socketio
    func GetSocketio(ctx *Context, name string, id IDInput, state *SocketioState, opts ...ResourceOption) (*Socketio, error)
    public static Socketio Get(string name, Input<string> id, SocketioState? state, CustomResourceOptions? opts = null)
    public static Socketio get(String name, Output<String> id, SocketioState state, CustomResourceOptions options)
    resources:  _:    type: azure:webpubsub:Socketio    get:      id: ${id}
    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 Azure Active Directory authentication is enabled. Defaults to true.
    ExternalIp string
    The publicly accessible IP address of the Web PubSub Service.
    Hostname string
    The FQDN of the Web PubSub Service.
    Identity SocketioIdentity
    An identity block as defined below.
    LiveTraceConnectivityLogsEnabled bool
    Whether the connectivity log category for live trace is enabled. Defaults to true.
    LiveTraceEnabled bool
    Whether the live trace tool is enabled. Defaults to true.
    LiveTraceHttpRequestLogsEnabled bool
    Whether the HTTP request log category for live trace is enabled. Defaults to true.
    LiveTraceMessagingLogsEnabled bool
    Whether the messaging log category for live trace is enabled. Defaults to true.
    LocalAuthEnabled bool
    Whether local authentication using an access key is enabled. Defaults to true.
    Location string
    The Azure Region where the Web PubSub Service should exist. Changing this forces a new Web PubSub Service to be created.
    Name string
    The name which should be used for this Web PubSub Service. Changing this forces a new Web PubSub Service 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.
    PublicNetworkAccess string

    Whether public network access is enabled. Defaults to Enabled. Possible values are Enabled and Disabled.

    Note: public_network_access cannot be set to Disabled when sku is Free_F1.

    PublicPort int
    The publicly accessible port for client-side usage of the Web PubSub Service.
    ResourceGroupName string
    The name of the Resource Group where the Web PubSub Service should exist. Changing this forces a new Web PubSub Service 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 for server-side usage of the Web PubSub Service.
    ServiceMode string
    The service mode of this Web PubSub Service. Defaults to Default. Possible values are Default and Serverless.
    Sku SocketioSku
    The SKU to use for this Web PubSub Service. Possible values are Free_F1, Standard_S1, Premium_P1, and Premium_P2.
    Tags Dictionary<string, string>
    A mapping of tags which should be assigned to the Web PubSub Service.
    TlsClientCertEnabled bool

    Whether the service should request a client certificate during a TLS handshake. Defaults to false.

    Note: tls_client_cert_enabled cannot be set to true when sku is Free_F1.

    AadAuthEnabled bool
    Whether Azure Active Directory authentication is enabled. Defaults to true.
    ExternalIp string
    The publicly accessible IP address of the Web PubSub Service.
    Hostname string
    The FQDN of the Web PubSub Service.
    Identity SocketioIdentityArgs
    An identity block as defined below.
    LiveTraceConnectivityLogsEnabled bool
    Whether the connectivity log category for live trace is enabled. Defaults to true.
    LiveTraceEnabled bool
    Whether the live trace tool is enabled. Defaults to true.
    LiveTraceHttpRequestLogsEnabled bool
    Whether the HTTP request log category for live trace is enabled. Defaults to true.
    LiveTraceMessagingLogsEnabled bool
    Whether the messaging log category for live trace is enabled. Defaults to true.
    LocalAuthEnabled bool
    Whether local authentication using an access key is enabled. Defaults to true.
    Location string
    The Azure Region where the Web PubSub Service should exist. Changing this forces a new Web PubSub Service to be created.
    Name string
    The name which should be used for this Web PubSub Service. Changing this forces a new Web PubSub Service 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.
    PublicNetworkAccess string

    Whether public network access is enabled. Defaults to Enabled. Possible values are Enabled and Disabled.

    Note: public_network_access cannot be set to Disabled when sku is Free_F1.

    PublicPort int
    The publicly accessible port for client-side usage of the Web PubSub Service.
    ResourceGroupName string
    The name of the Resource Group where the Web PubSub Service should exist. Changing this forces a new Web PubSub Service 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 for server-side usage of the Web PubSub Service.
    ServiceMode string
    The service mode of this Web PubSub Service. Defaults to Default. Possible values are Default and Serverless.
    Sku SocketioSkuArgs
    The SKU to use for this Web PubSub Service. Possible values are Free_F1, Standard_S1, Premium_P1, and Premium_P2.
    Tags map[string]string
    A mapping of tags which should be assigned to the Web PubSub Service.
    TlsClientCertEnabled bool

    Whether the service should request a client certificate during a TLS handshake. Defaults to false.

    Note: tls_client_cert_enabled cannot be set to true when sku is Free_F1.

    aadAuthEnabled Boolean
    Whether Azure Active Directory authentication is enabled. Defaults to true.
    externalIp String
    The publicly accessible IP address of the Web PubSub Service.
    hostname String
    The FQDN of the Web PubSub Service.
    identity SocketioIdentity
    An identity block as defined below.
    liveTraceConnectivityLogsEnabled Boolean
    Whether the connectivity log category for live trace is enabled. Defaults to true.
    liveTraceEnabled Boolean
    Whether the live trace tool is enabled. Defaults to true.
    liveTraceHttpRequestLogsEnabled Boolean
    Whether the HTTP request log category for live trace is enabled. Defaults to true.
    liveTraceMessagingLogsEnabled Boolean
    Whether the messaging log category for live trace is enabled. Defaults to true.
    localAuthEnabled Boolean
    Whether local authentication using an access key is enabled. Defaults to true.
    location String
    The Azure Region where the Web PubSub Service should exist. Changing this forces a new Web PubSub Service to be created.
    name String
    The name which should be used for this Web PubSub Service. Changing this forces a new Web PubSub Service 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.
    publicNetworkAccess String

    Whether public network access is enabled. Defaults to Enabled. Possible values are Enabled and Disabled.

    Note: public_network_access cannot be set to Disabled when sku is Free_F1.

    publicPort Integer
    The publicly accessible port for client-side usage of the Web PubSub Service.
    resourceGroupName String
    The name of the Resource Group where the Web PubSub Service should exist. Changing this forces a new Web PubSub Service 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 for server-side usage of the Web PubSub Service.
    serviceMode String
    The service mode of this Web PubSub Service. Defaults to Default. Possible values are Default and Serverless.
    sku SocketioSku
    The SKU to use for this Web PubSub Service. Possible values are Free_F1, Standard_S1, Premium_P1, and Premium_P2.
    tags Map<String,String>
    A mapping of tags which should be assigned to the Web PubSub Service.
    tlsClientCertEnabled Boolean

    Whether the service should request a client certificate during a TLS handshake. Defaults to false.

    Note: tls_client_cert_enabled cannot be set to true when sku is Free_F1.

    aadAuthEnabled boolean
    Whether Azure Active Directory authentication is enabled. Defaults to true.
    externalIp string
    The publicly accessible IP address of the Web PubSub Service.
    hostname string
    The FQDN of the Web PubSub Service.
    identity SocketioIdentity
    An identity block as defined below.
    liveTraceConnectivityLogsEnabled boolean
    Whether the connectivity log category for live trace is enabled. Defaults to true.
    liveTraceEnabled boolean
    Whether the live trace tool is enabled. Defaults to true.
    liveTraceHttpRequestLogsEnabled boolean
    Whether the HTTP request log category for live trace is enabled. Defaults to true.
    liveTraceMessagingLogsEnabled boolean
    Whether the messaging log category for live trace is enabled. Defaults to true.
    localAuthEnabled boolean
    Whether local authentication using an access key is enabled. Defaults to true.
    location string
    The Azure Region where the Web PubSub Service should exist. Changing this forces a new Web PubSub Service to be created.
    name string
    The name which should be used for this Web PubSub Service. Changing this forces a new Web PubSub Service 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.
    publicNetworkAccess string

    Whether public network access is enabled. Defaults to Enabled. Possible values are Enabled and Disabled.

    Note: public_network_access cannot be set to Disabled when sku is Free_F1.

    publicPort number
    The publicly accessible port for client-side usage of the Web PubSub Service.
    resourceGroupName string
    The name of the Resource Group where the Web PubSub Service should exist. Changing this forces a new Web PubSub Service 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 for server-side usage of the Web PubSub Service.
    serviceMode string
    The service mode of this Web PubSub Service. Defaults to Default. Possible values are Default and Serverless.
    sku SocketioSku
    The SKU to use for this Web PubSub Service. Possible values are Free_F1, Standard_S1, Premium_P1, and Premium_P2.
    tags {[key: string]: string}
    A mapping of tags which should be assigned to the Web PubSub Service.
    tlsClientCertEnabled boolean

    Whether the service should request a client certificate during a TLS handshake. Defaults to false.

    Note: tls_client_cert_enabled cannot be set to true when sku is Free_F1.

    aad_auth_enabled bool
    Whether Azure Active Directory authentication is enabled. Defaults to true.
    external_ip str
    The publicly accessible IP address of the Web PubSub Service.
    hostname str
    The FQDN of the Web PubSub Service.
    identity SocketioIdentityArgs
    An identity block as defined below.
    live_trace_connectivity_logs_enabled bool
    Whether the connectivity log category for live trace is enabled. Defaults to true.
    live_trace_enabled bool
    Whether the live trace tool is enabled. Defaults to true.
    live_trace_http_request_logs_enabled bool
    Whether the HTTP request log category for live trace is enabled. Defaults to true.
    live_trace_messaging_logs_enabled bool
    Whether the messaging log category for live trace is enabled. Defaults to true.
    local_auth_enabled bool
    Whether local authentication using an access key is enabled. Defaults to true.
    location str
    The Azure Region where the Web PubSub Service should exist. Changing this forces a new Web PubSub Service to be created.
    name str
    The name which should be used for this Web PubSub Service. Changing this forces a new Web PubSub Service 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 str

    Whether public network access is enabled. Defaults to Enabled. Possible values are Enabled and Disabled.

    Note: public_network_access cannot be set to Disabled when sku is Free_F1.

    public_port int
    The publicly accessible port for client-side usage of the Web PubSub Service.
    resource_group_name str
    The name of the Resource Group where the Web PubSub Service should exist. Changing this forces a new Web PubSub Service 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 for server-side usage of the Web PubSub Service.
    service_mode str
    The service mode of this Web PubSub Service. Defaults to Default. Possible values are Default and Serverless.
    sku SocketioSkuArgs
    The SKU to use for this Web PubSub Service. Possible values are Free_F1, Standard_S1, Premium_P1, and Premium_P2.
    tags Mapping[str, str]
    A mapping of tags which should be assigned to the Web PubSub Service.
    tls_client_cert_enabled bool

    Whether the service should request a client certificate during a TLS handshake. Defaults to false.

    Note: tls_client_cert_enabled cannot be set to true when sku is Free_F1.

    aadAuthEnabled Boolean
    Whether Azure Active Directory authentication is enabled. Defaults to true.
    externalIp String
    The publicly accessible IP address of the Web PubSub Service.
    hostname String
    The FQDN of the Web PubSub Service.
    identity Property Map
    An identity block as defined below.
    liveTraceConnectivityLogsEnabled Boolean
    Whether the connectivity log category for live trace is enabled. Defaults to true.
    liveTraceEnabled Boolean
    Whether the live trace tool is enabled. Defaults to true.
    liveTraceHttpRequestLogsEnabled Boolean
    Whether the HTTP request log category for live trace is enabled. Defaults to true.
    liveTraceMessagingLogsEnabled Boolean
    Whether the messaging log category for live trace is enabled. Defaults to true.
    localAuthEnabled Boolean
    Whether local authentication using an access key is enabled. Defaults to true.
    location String
    The Azure Region where the Web PubSub Service should exist. Changing this forces a new Web PubSub Service to be created.
    name String
    The name which should be used for this Web PubSub Service. Changing this forces a new Web PubSub Service 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.
    publicNetworkAccess String

    Whether public network access is enabled. Defaults to Enabled. Possible values are Enabled and Disabled.

    Note: public_network_access cannot be set to Disabled when sku is Free_F1.

    publicPort Number
    The publicly accessible port for client-side usage of the Web PubSub Service.
    resourceGroupName String
    The name of the Resource Group where the Web PubSub Service should exist. Changing this forces a new Web PubSub Service 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 for server-side usage of the Web PubSub Service.
    serviceMode String
    The service mode of this Web PubSub Service. Defaults to Default. Possible values are Default and Serverless.
    sku Property Map
    The SKU to use for this Web PubSub Service. Possible values are Free_F1, Standard_S1, Premium_P1, and Premium_P2.
    tags Map<String>
    A mapping of tags which should be assigned to the Web PubSub Service.
    tlsClientCertEnabled Boolean

    Whether the service should request a client certificate during a TLS handshake. Defaults to false.

    Note: tls_client_cert_enabled cannot be set to true when sku is Free_F1.

    Supporting Types

    SocketioIdentity, SocketioIdentityArgs

    Type string
    The type of Managed Identity for this Web PubSub Service. Possible Values are SystemAssigned and UserAssigned.
    IdentityIds List<string>

    Specifies a list of User Assigned Managed Identity IDs for this Web PubSub Service.

    Note: identity_ids is required when type is UserAssigned.

    PrincipalId string
    TenantId string
    Type string
    The type of Managed Identity for this Web PubSub Service. Possible Values are SystemAssigned and UserAssigned.
    IdentityIds []string

    Specifies a list of User Assigned Managed Identity IDs for this Web PubSub Service.

    Note: identity_ids is required when type is UserAssigned.

    PrincipalId string
    TenantId string
    type String
    The type of Managed Identity for this Web PubSub Service. Possible Values are SystemAssigned and UserAssigned.
    identityIds List<String>

    Specifies a list of User Assigned Managed Identity IDs for this Web PubSub Service.

    Note: identity_ids is required when type is UserAssigned.

    principalId String
    tenantId String
    type string
    The type of Managed Identity for this Web PubSub Service. Possible Values are SystemAssigned and UserAssigned.
    identityIds string[]

    Specifies a list of User Assigned Managed Identity IDs for this Web PubSub Service.

    Note: identity_ids is required when type is UserAssigned.

    principalId string
    tenantId string
    type str
    The type of Managed Identity for this Web PubSub Service. Possible Values are SystemAssigned and UserAssigned.
    identity_ids Sequence[str]

    Specifies a list of User Assigned Managed Identity IDs for this Web PubSub Service.

    Note: identity_ids is required when type is UserAssigned.

    principal_id str
    tenant_id str
    type String
    The type of Managed Identity for this Web PubSub Service. Possible Values are SystemAssigned and UserAssigned.
    identityIds List<String>

    Specifies a list of User Assigned Managed Identity IDs for this Web PubSub Service.

    Note: identity_ids is required when type is UserAssigned.

    principalId String
    tenantId String

    SocketioSku, SocketioSkuArgs

    Name string
    The name which should be used for this Web PubSub Service. Changing this forces a new Web PubSub Service to be created.
    Capacity int

    The number of units associated with this Web PubSub Service. Defaults to 1. Possible 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 range depends on which sku is used. For Free_F1 only 1 is supported, for Standard_S1 and Premium_P1 1 through 100 are supported, and for Premium_P2 the minimum capacity is 100.

    Name string
    The name which should be used for this Web PubSub Service. Changing this forces a new Web PubSub Service to be created.
    Capacity int

    The number of units associated with this Web PubSub Service. Defaults to 1. Possible 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 range depends on which sku is used. For Free_F1 only 1 is supported, for Standard_S1 and Premium_P1 1 through 100 are supported, and for Premium_P2 the minimum capacity is 100.

    name String
    The name which should be used for this Web PubSub Service. Changing this forces a new Web PubSub Service to be created.
    capacity Integer

    The number of units associated with this Web PubSub Service. Defaults to 1. Possible 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 range depends on which sku is used. For Free_F1 only 1 is supported, for Standard_S1 and Premium_P1 1 through 100 are supported, and for Premium_P2 the minimum capacity is 100.

    name string
    The name which should be used for this Web PubSub Service. Changing this forces a new Web PubSub Service to be created.
    capacity number

    The number of units associated with this Web PubSub Service. Defaults to 1. Possible 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 range depends on which sku is used. For Free_F1 only 1 is supported, for Standard_S1 and Premium_P1 1 through 100 are supported, and for Premium_P2 the minimum capacity is 100.

    name str
    The name which should be used for this Web PubSub Service. Changing this forces a new Web PubSub Service to be created.
    capacity int

    The number of units associated with this Web PubSub Service. Defaults to 1. Possible 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 range depends on which sku is used. For Free_F1 only 1 is supported, for Standard_S1 and Premium_P1 1 through 100 are supported, and for Premium_P2 the minimum capacity is 100.

    name String
    The name which should be used for this Web PubSub Service. Changing this forces a new Web PubSub Service to be created.
    capacity Number

    The number of units associated with this Web PubSub Service. Defaults to 1. Possible 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 range depends on which sku is used. For Free_F1 only 1 is supported, for Standard_S1 and Premium_P1 1 through 100 are supported, and for Premium_P2 the minimum capacity is 100.

    Import

    Web PubSub Service for Socket.IOs can be imported using the resource id, e.g.

    $ pulumi import azure:webpubsub/socketio:Socketio 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 v6.22.0 published on Tuesday, Apr 1, 2025 by Pulumi
    pulumi/pulumi-azure