@kengachu-pulumi/azure-native-documentdb
Version:
Pulumi Azure Native package for documentdb
93 lines (92 loc) • 3.9 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as types from "./types";
/**
* A private endpoint connection
*
* Uses Azure REST API version 2023-04-15. In version 1.x of the Azure Native provider, it used API version 2021-03-15.
*
* Other available API versions: 2023-09-15, 2023-09-15-preview, 2023-11-15, 2023-11-15-preview, 2024-02-15-preview, 2024-03-01-preview, 2024-05-15, 2024-05-15-preview, 2024-06-01-preview, 2024-07-01, 2024-08-15, 2024-09-01-preview, 2024-10-01-preview, 2024-11-15, 2024-12-01-preview.
*/
export declare class PrivateEndpointConnection extends pulumi.CustomResource {
/**
* Get an existing PrivateEndpointConnection 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): PrivateEndpointConnection;
/** @internal */
static readonly __pulumiType = "azure-native:documentdb:PrivateEndpointConnection";
/**
* Returns true if the given object is an instance of PrivateEndpointConnection. 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 PrivateEndpointConnection;
/**
* Group id of the private endpoint.
*/
readonly groupId: pulumi.Output<string | undefined>;
/**
* The name of the resource
*/
readonly name: pulumi.Output<string>;
/**
* Private endpoint which the connection belongs to.
*/
readonly privateEndpoint: pulumi.Output<types.outputs.PrivateEndpointPropertyResponse | undefined>;
/**
* Connection State of the Private Endpoint Connection.
*/
readonly privateLinkServiceConnectionState: pulumi.Output<types.outputs.PrivateLinkServiceConnectionStatePropertyResponse | undefined>;
/**
* Provisioning state of the private endpoint.
*/
readonly provisioningState: pulumi.Output<string | undefined>;
/**
* The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
*/
readonly type: pulumi.Output<string>;
/**
* Create a PrivateEndpointConnection 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: PrivateEndpointConnectionArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* The set of arguments for constructing a PrivateEndpointConnection resource.
*/
export interface PrivateEndpointConnectionArgs {
/**
* Cosmos DB database account name.
*/
accountName: pulumi.Input<string>;
/**
* Group id of the private endpoint.
*/
groupId?: pulumi.Input<string>;
/**
* Private endpoint which the connection belongs to.
*/
privateEndpoint?: pulumi.Input<types.inputs.PrivateEndpointPropertyArgs>;
/**
* The name of the private endpoint connection.
*/
privateEndpointConnectionName?: pulumi.Input<string>;
/**
* Connection State of the Private Endpoint Connection.
*/
privateLinkServiceConnectionState?: pulumi.Input<types.inputs.PrivateLinkServiceConnectionStatePropertyArgs>;
/**
* Provisioning state of the private endpoint.
*/
provisioningState?: pulumi.Input<string>;
/**
* The name of the resource group. The name is case insensitive.
*/
resourceGroupName: pulumi.Input<string>;
}