import * as pulumi from "@pulumi/pulumi"; import * as inputs from "../types/input"; import * as outputs from "../types/output"; /** * Manages an Azure SignalR service. * * ## Example Usage * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as azure from "@pulumi/azure"; * * const example = new azure.core.ResourceGroup("example", { * name: "my-signalr", * location: "West US", * }); * const exampleService = new azure.signalr.Service("example", { * name: "tfex-signalr", * location: example.location, * resourceGroupName: example.name, * sku: { * name: "Free_F1", * capacity: 1, * }, * cors: [{ * allowedOrigins: ["http://www.example.com"], * }], * publicNetworkAccessEnabled: false, * connectivityLogsEnabled: true, * messagingLogsEnabled: true, * serviceMode: "Default", * upstreamEndpoints: [{ * categoryPatterns: [ * "connections", * "messages", * ], * eventPatterns: ["*"], * hubPatterns: ["hub1"], * urlTemplate: "http://foo.com", * }], * }); * ``` * * ## API Providers * * * This resource uses the following Azure API Providers: * * * `Microsoft.SignalRService` - 2024-03-01 * * ## Import * * SignalR services can be imported using the `resource id`, e.g. * * ```sh * $ pulumi import azure:signalr/service:Service example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/terraform-signalr/providers/Microsoft.SignalRService/signalR/tfex-signalr * ``` */ export declare class Service extends pulumi.CustomResource { /** * Get an existing Service 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?: ServiceState, opts?: pulumi.CustomResourceOptions): Service; /** * Returns true if the given object is an instance of Service. 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 Service; /** * Whether to enable AAD auth? Defaults to `true`. */ readonly aadAuthEnabled: pulumi.Output; /** * Specifies if Connectivity Logs are enabled or not. Defaults to `false`. */ readonly connectivityLogsEnabled: pulumi.Output; /** * A `cors` block as documented below. */ readonly cors: pulumi.Output; /** * The FQDN of the SignalR service. */ readonly hostname: pulumi.Output; /** * Specifies if Http Request Logs are enabled or not. Defaults to `false`. */ readonly httpRequestLogsEnabled: pulumi.Output; /** * An `identity` block as defined below. */ readonly identity: pulumi.Output; /** * The publicly accessible IP of the SignalR service. */ readonly ipAddress: pulumi.Output; /** * A `liveTrace` block as defined below. */ readonly liveTrace: pulumi.Output; /** * @deprecated `liveTraceEnabled` has been deprecated in favor of `liveTrace` and will be removed in 4.0. */ readonly liveTraceEnabled: pulumi.Output; /** * Whether to enable local auth? Defaults to `true`. */ readonly localAuthEnabled: pulumi.Output; /** * Specifies the supported Azure location where the SignalR service exists. Changing this forces a new resource to be created. */ readonly location: pulumi.Output; /** * Specifies if Messaging Logs are enabled or not. Defaults to `false`. */ readonly messagingLogsEnabled: pulumi.Output; /** * The name of the SignalR service. Changing this forces a new resource to be created. */ readonly name: pulumi.Output; /** * The primary access key for the SignalR service. */ readonly primaryAccessKey: pulumi.Output; /** * The primary connection string for the SignalR service. */ readonly primaryConnectionString: pulumi.Output; /** * Whether to enable public network access? Defaults to `true`. * * > **Note:** `publicNetworkAccessEnabled` cannot be set to `false` in `Free` sku tier. */ readonly publicNetworkAccessEnabled: pulumi.Output; /** * The publicly accessible port of the SignalR service which is designed for browser/client use. */ readonly publicPort: pulumi.Output; /** * The name of the resource group in which to create the SignalR service. Changing this forces a new resource to be created. */ readonly resourceGroupName: pulumi.Output; /** * The secondary access key for the SignalR service. */ readonly secondaryAccessKey: pulumi.Output; /** * The secondary connection string for the SignalR service. */ readonly secondaryConnectionString: pulumi.Output; /** * The publicly accessible port of the SignalR service which is designed for customer server side use. */ readonly serverPort: pulumi.Output; /** * Specifies the client connection timeout. Defaults to `30`. */ readonly serverlessConnectionTimeoutInSeconds: pulumi.Output; /** * Specifies the service mode. Possible values are `Classic`, `Default` and `Serverless`. Defaults to `Default`. */ readonly serviceMode: pulumi.Output; /** * A `sku` block as documented below. */ readonly sku: pulumi.Output; /** * A mapping of tags to assign to the resource. */ readonly tags: pulumi.Output<{ [key: string]: string; } | undefined>; /** * Whether to request client certificate during TLS handshake? Defaults to `false`. * * > **Note:** `tlsClientCertEnabled` cannot be set to `true` in `Free` sku tier. */ readonly tlsClientCertEnabled: pulumi.Output; /** * An `upstreamEndpoint` block as documented below. Using this block requires the SignalR service to be Serverless. When creating multiple blocks they will be processed in the order they are defined in. */ readonly upstreamEndpoints: pulumi.Output; /** * Create a Service 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: ServiceArgs, opts?: pulumi.CustomResourceOptions); } /** * Input properties used for looking up and filtering Service resources. */ export interface ServiceState { /** * Whether to enable AAD auth? Defaults to `true`. */ aadAuthEnabled?: pulumi.Input; /** * Specifies if Connectivity Logs are enabled or not. Defaults to `false`. */ connectivityLogsEnabled?: pulumi.Input; /** * A `cors` block as documented below. */ cors?: pulumi.Input[]>; /** * The FQDN of the SignalR service. */ hostname?: pulumi.Input; /** * Specifies if Http Request Logs are enabled or not. Defaults to `false`. */ httpRequestLogsEnabled?: pulumi.Input; /** * An `identity` block as defined below. */ identity?: pulumi.Input; /** * The publicly accessible IP of the SignalR service. */ ipAddress?: pulumi.Input; /** * A `liveTrace` block as defined below. */ liveTrace?: pulumi.Input; /** * @deprecated `liveTraceEnabled` has been deprecated in favor of `liveTrace` and will be removed in 4.0. */ liveTraceEnabled?: pulumi.Input; /** * Whether to enable local auth? Defaults to `true`. */ localAuthEnabled?: pulumi.Input; /** * Specifies the supported Azure location where the SignalR service exists. Changing this forces a new resource to be created. */ location?: pulumi.Input; /** * Specifies if Messaging Logs are enabled or not. Defaults to `false`. */ messagingLogsEnabled?: pulumi.Input; /** * The name of the SignalR service. Changing this forces a new resource to be created. */ name?: pulumi.Input; /** * The primary access key for the SignalR service. */ primaryAccessKey?: pulumi.Input; /** * The primary connection string for the SignalR service. */ primaryConnectionString?: pulumi.Input; /** * Whether to enable public network access? Defaults to `true`. * * > **Note:** `publicNetworkAccessEnabled` cannot be set to `false` in `Free` sku tier. */ publicNetworkAccessEnabled?: pulumi.Input; /** * The publicly accessible port of the SignalR service which is designed for browser/client use. */ publicPort?: pulumi.Input; /** * The name of the resource group in which to create the SignalR service. Changing this forces a new resource to be created. */ resourceGroupName?: pulumi.Input; /** * The secondary access key for the SignalR service. */ secondaryAccessKey?: pulumi.Input; /** * The secondary connection string for the SignalR service. */ secondaryConnectionString?: pulumi.Input; /** * The publicly accessible port of the SignalR service which is designed for customer server side use. */ serverPort?: pulumi.Input; /** * Specifies the client connection timeout. Defaults to `30`. */ serverlessConnectionTimeoutInSeconds?: pulumi.Input; /** * Specifies the service mode. Possible values are `Classic`, `Default` and `Serverless`. Defaults to `Default`. */ serviceMode?: pulumi.Input; /** * A `sku` block as documented below. */ sku?: pulumi.Input; /** * A mapping of tags to assign to the resource. */ tags?: pulumi.Input<{ [key: string]: pulumi.Input; }>; /** * Whether to request client certificate during TLS handshake? Defaults to `false`. * * > **Note:** `tlsClientCertEnabled` cannot be set to `true` in `Free` sku tier. */ tlsClientCertEnabled?: pulumi.Input; /** * An `upstreamEndpoint` block as documented below. Using this block requires the SignalR service to be Serverless. When creating multiple blocks they will be processed in the order they are defined in. */ upstreamEndpoints?: pulumi.Input[]>; } /** * The set of arguments for constructing a Service resource. */ export interface ServiceArgs { /** * Whether to enable AAD auth? Defaults to `true`. */ aadAuthEnabled?: pulumi.Input; /** * Specifies if Connectivity Logs are enabled or not. Defaults to `false`. */ connectivityLogsEnabled?: pulumi.Input; /** * A `cors` block as documented below. */ cors?: pulumi.Input[]>; /** * Specifies if Http Request Logs are enabled or not. Defaults to `false`. */ httpRequestLogsEnabled?: pulumi.Input; /** * An `identity` block as defined below. */ identity?: pulumi.Input; /** * A `liveTrace` block as defined below. */ liveTrace?: pulumi.Input; /** * @deprecated `liveTraceEnabled` has been deprecated in favor of `liveTrace` and will be removed in 4.0. */ liveTraceEnabled?: pulumi.Input; /** * Whether to enable local auth? Defaults to `true`. */ localAuthEnabled?: pulumi.Input; /** * Specifies the supported Azure location where the SignalR service exists. Changing this forces a new resource to be created. */ location?: pulumi.Input; /** * Specifies if Messaging Logs are enabled or not. Defaults to `false`. */ messagingLogsEnabled?: pulumi.Input; /** * The name of the SignalR service. Changing this forces a new resource to be created. */ name?: pulumi.Input; /** * Whether to enable public network access? Defaults to `true`. * * > **Note:** `publicNetworkAccessEnabled` cannot be set to `false` in `Free` sku tier. */ publicNetworkAccessEnabled?: pulumi.Input; /** * The name of the resource group in which to create the SignalR service. Changing this forces a new resource to be created. */ resourceGroupName: pulumi.Input; /** * Specifies the client connection timeout. Defaults to `30`. */ serverlessConnectionTimeoutInSeconds?: pulumi.Input; /** * Specifies the service mode. Possible values are `Classic`, `Default` and `Serverless`. Defaults to `Default`. */ serviceMode?: pulumi.Input; /** * A `sku` block as documented below. */ sku: pulumi.Input; /** * A mapping of tags to assign to the resource. */ tags?: pulumi.Input<{ [key: string]: pulumi.Input; }>; /** * Whether to request client certificate during TLS handshake? Defaults to `false`. * * > **Note:** `tlsClientCertEnabled` cannot be set to `true` in `Free` sku tier. */ tlsClientCertEnabled?: pulumi.Input; /** * An `upstreamEndpoint` block as documented below. Using this block requires the SignalR service to be Serverless. When creating multiple blocks they will be processed in the order they are defined in. */ upstreamEndpoints?: pulumi.Input[]>; }