@kengachu-pulumi/azure-native-documentdb
Version:
Pulumi Azure Native package for documentdb
80 lines (79 loc) • 3.07 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as types from "./types";
/**
* Gets a private endpoint connection.
*
* Uses Azure REST API version 2023-04-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 function getPrivateEndpointConnection(args: GetPrivateEndpointConnectionArgs, opts?: pulumi.InvokeOptions): Promise<GetPrivateEndpointConnectionResult>;
export interface GetPrivateEndpointConnectionArgs {
/**
* Cosmos DB database account name.
*/
accountName: string;
/**
* The name of the private endpoint connection.
*/
privateEndpointConnectionName: string;
/**
* The name of the resource group. The name is case insensitive.
*/
resourceGroupName: string;
}
/**
* A private endpoint connection
*/
export interface GetPrivateEndpointConnectionResult {
/**
* Group id of the private endpoint.
*/
readonly groupId?: string;
/**
* Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
*/
readonly id: string;
/**
* The name of the resource
*/
readonly name: string;
/**
* Private endpoint which the connection belongs to.
*/
readonly privateEndpoint?: types.outputs.PrivateEndpointPropertyResponse;
/**
* Connection State of the Private Endpoint Connection.
*/
readonly privateLinkServiceConnectionState?: types.outputs.PrivateLinkServiceConnectionStatePropertyResponse;
/**
* Provisioning state of the private endpoint.
*/
readonly provisioningState?: string;
/**
* The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
*/
readonly type: string;
}
/**
* Gets a private endpoint connection.
*
* Uses Azure REST API version 2023-04-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 function getPrivateEndpointConnectionOutput(args: GetPrivateEndpointConnectionOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetPrivateEndpointConnectionResult>;
export interface GetPrivateEndpointConnectionOutputArgs {
/**
* Cosmos DB database account name.
*/
accountName: pulumi.Input<string>;
/**
* The name of the private endpoint connection.
*/
privateEndpointConnectionName: pulumi.Input<string>;
/**
* The name of the resource group. The name is case insensitive.
*/
resourceGroupName: pulumi.Input<string>;
}