@pulumi/azure-native
Version:
[](https://slack.pulumi.com) [](https://npmjs.com/package/@pulumi/azure-native) [ • 4.91 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
* A class represent a replica resource.
*
* Uses Azure REST API version 2024-03-01. In version 2.x of the Azure Native provider, it used API version 2023-03-01-preview.
*
* Other available API versions: 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 SignalRReplica extends pulumi.CustomResource {
/**
* Get an existing SignalRReplica 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): SignalRReplica;
/**
* Returns true if the given object is an instance of SignalRReplica. 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 SignalRReplica;
/**
* The Azure API version of the resource.
*/
readonly azureApiVersion: pulumi.Output<string>;
/**
* The geo-location where the resource lives
*/
readonly location: pulumi.Output<string>;
/**
* The name of the resource
*/
readonly name: pulumi.Output<string>;
/**
* Provisioning state of the resource.
*/
readonly provisioningState: pulumi.Output<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.
*/
readonly regionEndpointEnabled: pulumi.Output<string | 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 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>;
/**
* The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
*/
readonly type: pulumi.Output<string>;
/**
* Create a SignalRReplica 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: SignalRReplicaArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* The set of arguments for constructing a SignalRReplica resource.
*/
export interface SignalRReplicaArgs {
/**
* The geo-location where the resource lives
*/
location?: 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.
*/
regionEndpointEnabled?: pulumi.Input<string>;
/**
* The name of the replica.
*/
replicaName?: pulumi.Input<string>;
/**
* The name of the resource group. The name is case insensitive.
*/
resourceGroupName: pulumi.Input<string>;
/**
* 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>;
/**
* The billing information of the resource.
*/
sku?: pulumi.Input<inputs.signalrservice.ResourceSkuArgs>;
/**
* Resource tags.
*/
tags?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
}