@pulumi/azure-native
Version:
[](https://slack.pulumi.com) [](https://npmjs.com/package/@pulumi/azure-native) [ • 11.5 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
import * as enums from "../types/enums";
/**
* 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, 2025-01-01-preview. These can be accessed by generating a local SDK package using the CLI command `pulumi package add azure-native signalrservice [ApiVersion]`. See the [version guide](../../../version-guide/#accessing-any-api-version-via-local-packages) for details.
*/
export declare class SignalR extends pulumi.CustomResource {
/**
* Get an existing SignalR 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 opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, opts?: pulumi.CustomResourceOptions): SignalR;
/**
* Returns true if the given object is an instance of SignalR. 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 SignalR;
/**
* The Azure API version of the resource.
*/
readonly azureApiVersion: pulumi.Output<string>;
/**
* Cross-Origin Resource Sharing (CORS) settings.
*/
readonly cors: pulumi.Output<outputs.signalrservice.SignalRCorsSettingsResponse | undefined>;
/**
* DisableLocalAuth
* Enable or disable aad auth
* When set as true, connection with AuthType=aad won't work.
*/
readonly disableAadAuth: pulumi.Output<boolean | undefined>;
/**
* DisableLocalAuth
* Enable or disable local auth with AccessKey
* When set as true, connection with AccessKey=xxx won't work.
*/
readonly disableLocalAuth: pulumi.Output<boolean | undefined>;
/**
* The publicly accessible IP of the resource.
*/
readonly externalIP: pulumi.Output<string>;
/**
* 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.
*/
readonly features: pulumi.Output<outputs.signalrservice.SignalRFeatureResponse[] | undefined>;
/**
* FQDN of the service instance.
*/
readonly hostName: pulumi.Output<string>;
/**
* Deprecated.
*/
readonly hostNamePrefix: pulumi.Output<string>;
/**
* A class represent managed identities used for request and response
*/
readonly identity: pulumi.Output<outputs.signalrservice.ManagedIdentityResponse | undefined>;
/**
* The kind of the service
*/
readonly kind: pulumi.Output<string | undefined>;
/**
* Live trace configuration of a Microsoft.SignalRService resource.
*/
readonly liveTraceConfiguration: pulumi.Output<outputs.signalrservice.LiveTraceConfigurationResponse | undefined>;
/**
* The geo-location where the resource lives
*/
readonly location: pulumi.Output<string>;
/**
* The name of the resource
*/
readonly name: pulumi.Output<string>;
/**
* Network ACLs for the resource
*/
readonly networkACLs: pulumi.Output<outputs.signalrservice.SignalRNetworkACLsResponse | undefined>;
/**
* Private endpoint connections to the resource.
*/
readonly privateEndpointConnections: pulumi.Output<outputs.signalrservice.PrivateEndpointConnectionResponse[]>;
/**
* Provisioning state of the resource.
*/
readonly provisioningState: pulumi.Output<string>;
/**
* 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.
*/
readonly publicNetworkAccess: pulumi.Output<string | undefined>;
/**
* The publicly accessible port of the resource which is designed for browser/client side usage.
*/
readonly publicPort: pulumi.Output<number>;
/**
* 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.
*/
readonly regionEndpointEnabled: pulumi.Output<string | undefined>;
/**
* Resource log configuration of a Microsoft.SignalRService resource.
*/
readonly resourceLogConfiguration: pulumi.Output<outputs.signalrservice.ResourceLogConfigurationResponse | undefined>;
/**
* 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.
*/
readonly resourceStopped: pulumi.Output<string | undefined>;
/**
* The publicly accessible port of the resource which is designed for customer server side usage.
*/
readonly serverPort: pulumi.Output<number>;
/**
* Serverless settings.
*/
readonly serverless: pulumi.Output<outputs.signalrservice.ServerlessSettingsResponse | undefined>;
/**
* The list of shared private link resources.
*/
readonly sharedPrivateLinkResources: pulumi.Output<outputs.signalrservice.SharedPrivateLinkResourceResponse[]>;
/**
* The billing information of the resource.
*/
readonly sku: pulumi.Output<outputs.signalrservice.ResourceSkuResponse | undefined>;
/**
* Azure Resource Manager metadata containing createdBy and modifiedBy information.
*/
readonly systemData: pulumi.Output<outputs.signalrservice.SystemDataResponse>;
/**
* Resource tags.
*/
readonly tags: pulumi.Output<{
[key: string]: string;
} | undefined>;
/**
* TLS settings for the resource
*/
readonly tls: pulumi.Output<outputs.signalrservice.SignalRTlsSettingsResponse | undefined>;
/**
* The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
*/
readonly type: pulumi.Output<string>;
/**
* The settings for the Upstream when the service is in server-less mode.
*/
readonly upstream: pulumi.Output<outputs.signalrservice.ServerlessUpstreamSettingsResponse | undefined>;
/**
* Version of the resource. Probably you need the same or higher version of client SDKs.
*/
readonly version: pulumi.Output<string>;
/**
* Create a SignalR 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: SignalRArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* The set of arguments for constructing a SignalR resource.
*/
export interface SignalRArgs {
/**
* Cross-Origin Resource Sharing (CORS) settings.
*/
cors?: pulumi.Input<inputs.signalrservice.SignalRCorsSettingsArgs>;
/**
* DisableLocalAuth
* Enable or disable aad auth
* When set as true, connection with AuthType=aad won't work.
*/
disableAadAuth?: pulumi.Input<boolean>;
/**
* DisableLocalAuth
* Enable or disable local auth with AccessKey
* When set as true, connection with AccessKey=xxx won't work.
*/
disableLocalAuth?: pulumi.Input<boolean>;
/**
* 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.
*/
features?: pulumi.Input<pulumi.Input<inputs.signalrservice.SignalRFeatureArgs>[]>;
/**
* A class represent managed identities used for request and response
*/
identity?: pulumi.Input<inputs.signalrservice.ManagedIdentityArgs>;
/**
* The kind of the service
*/
kind?: pulumi.Input<string | enums.signalrservice.ServiceKind>;
/**
* Live trace configuration of a Microsoft.SignalRService resource.
*/
liveTraceConfiguration?: pulumi.Input<inputs.signalrservice.LiveTraceConfigurationArgs>;
/**
* The geo-location where the resource lives
*/
location?: pulumi.Input<string>;
/**
* Network ACLs for the resource
*/
networkACLs?: pulumi.Input<inputs.signalrservice.SignalRNetworkACLsArgs>;
/**
* 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.
*/
publicNetworkAccess?: pulumi.Input<string>;
/**
* 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.
*/
regionEndpointEnabled?: pulumi.Input<string>;
/**
* The name of the resource group. The name is case insensitive.
*/
resourceGroupName: pulumi.Input<string>;
/**
* Resource log configuration of a Microsoft.SignalRService resource.
*/
resourceLogConfiguration?: pulumi.Input<inputs.signalrservice.ResourceLogConfigurationArgs>;
/**
* The name of the resource.
*/
resourceName?: pulumi.Input<string>;
/**
* 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.
*/
resourceStopped?: pulumi.Input<string>;
/**
* Serverless settings.
*/
serverless?: pulumi.Input<inputs.signalrservice.ServerlessSettingsArgs>;
/**
* The billing information of the resource.
*/
sku?: pulumi.Input<inputs.signalrservice.ResourceSkuArgs>;
/**
* Resource tags.
*/
tags?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
/**
* TLS settings for the resource
*/
tls?: pulumi.Input<inputs.signalrservice.SignalRTlsSettingsArgs>;
/**
* The settings for the Upstream when the service is in server-less mode.
*/
upstream?: pulumi.Input<inputs.signalrservice.ServerlessUpstreamSettingsArgs>;
}