import * as pulumi from "@pulumi/pulumi"; import * as inputs from "../types/input"; import * as outputs from "../types/output"; /** * Manages a Web PubSub Service for Socket.IO. * * ## Example Usage * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as azure from "@pulumi/azure"; * * const example = new azure.core.ResourceGroup("example", { * name: "example", * location: "West Europe", * }); * const exampleSocketio = new azure.webpubsub.Socketio("example", { * name: "example", * resourceGroupName: example.name, * location: example.location, * sku: "Free_F1"[0], * }); * ``` * * ## API Providers * * * This resource uses the following Azure API Providers: * * * `Microsoft.SignalRService` - 2024-03-01 * * ## Import * * Web PubSub Service for Socket.IOs can be imported using the `resource id`, e.g. * * ```sh * $ pulumi import azure:webpubsub/socketio:Socketio example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.SignalRService/webPubSub/pubsub1 * ``` */ export declare class Socketio extends pulumi.CustomResource { /** * Get an existing Socketio resource's state with the given name, ID, and optional extra * properties used to qualify the lookup. * * @param name The _unique_ name of the resulting resource. * @param id The _unique_ provider ID of the resource to lookup. * @param state Any extra arguments used during the lookup. * @param opts Optional settings to control the behavior of the CustomResource. */ static get(name: string, id: pulumi.Input, state?: SocketioState, opts?: pulumi.CustomResourceOptions): Socketio; /** * Returns true if the given object is an instance of Socketio. This is designed to work even * when multiple copies of the Pulumi SDK have been loaded into the same process. */ static isInstance(obj: any): obj is Socketio; /** * Whether Azure Active Directory authentication is enabled. Defaults to `true`. */ readonly aadAuthEnabled: pulumi.Output; /** * The publicly accessible IP address of the Web PubSub Service. */ readonly externalIp: pulumi.Output; /** * The FQDN of the Web PubSub Service. */ readonly hostname: pulumi.Output; /** * An `identity` block as defined below. */ readonly identity: pulumi.Output; /** * Whether the connectivity log category for live trace is enabled. Defaults to `true`. */ readonly liveTraceConnectivityLogsEnabled: pulumi.Output; /** * Whether the live trace tool is enabled. Defaults to `true`. */ readonly liveTraceEnabled: pulumi.Output; /** * Whether the HTTP request log category for live trace is enabled. Defaults to `true`. */ readonly liveTraceHttpRequestLogsEnabled: pulumi.Output; /** * Whether the messaging log category for live trace is enabled. Defaults to `true`. */ readonly liveTraceMessagingLogsEnabled: pulumi.Output; /** * Whether local authentication using an access key is enabled. Defaults to `true`. */ readonly localAuthEnabled: pulumi.Output; /** * The Azure Region where the Web PubSub Service should exist. Changing this forces a new Web PubSub Service to be created. */ readonly location: pulumi.Output; /** * The name which should be used for this Web PubSub Service. Changing this forces a new Web PubSub Service to be created. */ readonly name: pulumi.Output; /** * The primary access key for the Web PubSub Service. */ readonly primaryAccessKey: pulumi.Output; /** * The primary connection string for the Web PubSub Service. */ readonly primaryConnectionString: pulumi.Output; /** * Whether public network access is enabled. Defaults to `Enabled`. Possible values are `Enabled` and `Disabled`. * * > **Note:** `publicNetworkAccess` cannot be set to `Disabled` when `sku` is `Free_F1`. */ readonly publicNetworkAccess: pulumi.Output; /** * The publicly accessible port for client-side usage of the Web PubSub Service. */ readonly publicPort: pulumi.Output; /** * The name of the Resource Group where the Web PubSub Service should exist. Changing this forces a new Web PubSub Service to be created. */ readonly resourceGroupName: pulumi.Output; /** * The secondary access key for the Web PubSub Service. */ readonly secondaryAccessKey: pulumi.Output; /** * The secondary connection string for the Web PubSub Service. */ readonly secondaryConnectionString: pulumi.Output; /** * The publicly accessible port for server-side usage of the Web PubSub Service. */ readonly serverPort: pulumi.Output; /** * The service mode of this Web PubSub Service. Defaults to `Default`. Possible values are `Default` and `Serverless`. */ readonly serviceMode: pulumi.Output; /** * One or more `sku` blocks as defined below. */ readonly sku: pulumi.Output; /** * A mapping of tags which should be assigned to the Web PubSub Service. */ readonly tags: pulumi.Output<{ [key: string]: string; } | undefined>; /** * Whether the service should request a client certificate during a TLS handshake. Defaults to `false`. * * > **Note:** `tlsClientCertEnabled` cannot be set to `true` when `sku` is `Free_F1`. */ readonly tlsClientCertEnabled: pulumi.Output; /** * Create a Socketio resource with the given unique name, arguments, and options. * * @param name The _unique_ name of the resource. * @param args The arguments to use to populate this resource's properties. * @param opts A bag of options that control this resource's behavior. */ constructor(name: string, args: SocketioArgs, opts?: pulumi.CustomResourceOptions); } /** * Input properties used for looking up and filtering Socketio resources. */ export interface SocketioState { /** * Whether Azure Active Directory authentication is enabled. Defaults to `true`. */ aadAuthEnabled?: pulumi.Input; /** * The publicly accessible IP address of the Web PubSub Service. */ externalIp?: pulumi.Input; /** * The FQDN of the Web PubSub Service. */ hostname?: pulumi.Input; /** * An `identity` block as defined below. */ identity?: pulumi.Input; /** * Whether the connectivity log category for live trace is enabled. Defaults to `true`. */ liveTraceConnectivityLogsEnabled?: pulumi.Input; /** * Whether the live trace tool is enabled. Defaults to `true`. */ liveTraceEnabled?: pulumi.Input; /** * Whether the HTTP request log category for live trace is enabled. Defaults to `true`. */ liveTraceHttpRequestLogsEnabled?: pulumi.Input; /** * Whether the messaging log category for live trace is enabled. Defaults to `true`. */ liveTraceMessagingLogsEnabled?: pulumi.Input; /** * Whether local authentication using an access key is enabled. Defaults to `true`. */ localAuthEnabled?: pulumi.Input; /** * The Azure Region where the Web PubSub Service should exist. Changing this forces a new Web PubSub Service to be created. */ location?: pulumi.Input; /** * The name which should be used for this Web PubSub Service. Changing this forces a new Web PubSub Service to be created. */ name?: pulumi.Input; /** * The primary access key for the Web PubSub Service. */ primaryAccessKey?: pulumi.Input; /** * The primary connection string for the Web PubSub Service. */ primaryConnectionString?: pulumi.Input; /** * Whether public network access is enabled. Defaults to `Enabled`. Possible values are `Enabled` and `Disabled`. * * > **Note:** `publicNetworkAccess` cannot be set to `Disabled` when `sku` is `Free_F1`. */ publicNetworkAccess?: pulumi.Input; /** * The publicly accessible port for client-side usage of the Web PubSub Service. */ publicPort?: pulumi.Input; /** * The name of the Resource Group where the Web PubSub Service should exist. Changing this forces a new Web PubSub Service to be created. */ resourceGroupName?: pulumi.Input; /** * The secondary access key for the Web PubSub Service. */ secondaryAccessKey?: pulumi.Input; /** * The secondary connection string for the Web PubSub Service. */ secondaryConnectionString?: pulumi.Input; /** * The publicly accessible port for server-side usage of the Web PubSub Service. */ serverPort?: pulumi.Input; /** * The service mode of this Web PubSub Service. Defaults to `Default`. Possible values are `Default` and `Serverless`. */ serviceMode?: pulumi.Input; /** * One or more `sku` blocks as defined below. */ sku?: pulumi.Input; /** * A mapping of tags which should be assigned to the Web PubSub Service. */ tags?: pulumi.Input<{ [key: string]: pulumi.Input; }>; /** * Whether the service should request a client certificate during a TLS handshake. Defaults to `false`. * * > **Note:** `tlsClientCertEnabled` cannot be set to `true` when `sku` is `Free_F1`. */ tlsClientCertEnabled?: pulumi.Input; } /** * The set of arguments for constructing a Socketio resource. */ export interface SocketioArgs { /** * Whether Azure Active Directory authentication is enabled. Defaults to `true`. */ aadAuthEnabled?: pulumi.Input; /** * An `identity` block as defined below. */ identity?: pulumi.Input; /** * Whether the connectivity log category for live trace is enabled. Defaults to `true`. */ liveTraceConnectivityLogsEnabled?: pulumi.Input; /** * Whether the live trace tool is enabled. Defaults to `true`. */ liveTraceEnabled?: pulumi.Input; /** * Whether the HTTP request log category for live trace is enabled. Defaults to `true`. */ liveTraceHttpRequestLogsEnabled?: pulumi.Input; /** * Whether the messaging log category for live trace is enabled. Defaults to `true`. */ liveTraceMessagingLogsEnabled?: pulumi.Input; /** * Whether local authentication using an access key is enabled. Defaults to `true`. */ localAuthEnabled?: pulumi.Input; /** * The Azure Region where the Web PubSub Service should exist. Changing this forces a new Web PubSub Service to be created. */ location?: pulumi.Input; /** * The name which should be used for this Web PubSub Service. Changing this forces a new Web PubSub Service to be created. */ name?: pulumi.Input; /** * Whether public network access is enabled. Defaults to `Enabled`. Possible values are `Enabled` and `Disabled`. * * > **Note:** `publicNetworkAccess` cannot be set to `Disabled` when `sku` is `Free_F1`. */ publicNetworkAccess?: pulumi.Input; /** * The name of the Resource Group where the Web PubSub Service should exist. Changing this forces a new Web PubSub Service to be created. */ resourceGroupName: pulumi.Input; /** * The service mode of this Web PubSub Service. Defaults to `Default`. Possible values are `Default` and `Serverless`. */ serviceMode?: pulumi.Input; /** * One or more `sku` blocks as defined below. */ sku: pulumi.Input; /** * A mapping of tags which should be assigned to the Web PubSub Service. */ tags?: pulumi.Input<{ [key: string]: pulumi.Input; }>; /** * Whether the service should request a client certificate during a TLS handshake. Defaults to `false`. * * > **Note:** `tlsClientCertEnabled` cannot be set to `true` when `sku` is `Free_F1`. */ tlsClientCertEnabled?: pulumi.Input; }