This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.34.0 published on Thursday, Mar 28, 2024 by Pulumi
azure-native.documentdb.PrivateEndpointConnection
Explore with Pulumi AI
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.34.0 published on Thursday, Mar 28, 2024 by Pulumi
A private endpoint connection Azure REST API version: 2023-04-15. Prior API version in Azure Native 1.x: 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.
Example Usage
Approve or reject a private endpoint connection with a given name.
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;
return await Deployment.RunAsync(() =>
{
var privateEndpointConnection = new AzureNative.DocumentDB.PrivateEndpointConnection("privateEndpointConnection", new()
{
AccountName = "ddb1",
PrivateEndpointConnectionName = "privateEndpointConnectionName",
PrivateLinkServiceConnectionState = new AzureNative.DocumentDB.Inputs.PrivateLinkServiceConnectionStatePropertyArgs
{
Description = "Approved by johndoe@contoso.com",
Status = "Approved",
},
ResourceGroupName = "rg1",
});
});
package main
import (
"github.com/pulumi/pulumi-azure-native-sdk/documentdb/v2"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := documentdb.NewPrivateEndpointConnection(ctx, "privateEndpointConnection", &documentdb.PrivateEndpointConnectionArgs{
AccountName: pulumi.String("ddb1"),
PrivateEndpointConnectionName: pulumi.String("privateEndpointConnectionName"),
PrivateLinkServiceConnectionState: &documentdb.PrivateLinkServiceConnectionStatePropertyArgs{
Description: pulumi.String("Approved by johndoe@contoso.com"),
Status: pulumi.String("Approved"),
},
ResourceGroupName: pulumi.String("rg1"),
})
if err != nil {
return err
}
return nil
})
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.documentdb.PrivateEndpointConnection;
import com.pulumi.azurenative.documentdb.PrivateEndpointConnectionArgs;
import com.pulumi.azurenative.documentdb.inputs.PrivateLinkServiceConnectionStatePropertyArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var privateEndpointConnection = new PrivateEndpointConnection("privateEndpointConnection", PrivateEndpointConnectionArgs.builder()
.accountName("ddb1")
.privateEndpointConnectionName("privateEndpointConnectionName")
.privateLinkServiceConnectionState(PrivateLinkServiceConnectionStatePropertyArgs.builder()
.description("Approved by johndoe@contoso.com")
.status("Approved")
.build())
.resourceGroupName("rg1")
.build());
}
}
import pulumi
import pulumi_azure_native as azure_native
private_endpoint_connection = azure_native.documentdb.PrivateEndpointConnection("privateEndpointConnection",
account_name="ddb1",
private_endpoint_connection_name="privateEndpointConnectionName",
private_link_service_connection_state=azure_native.documentdb.PrivateLinkServiceConnectionStatePropertyArgs(
description="Approved by johndoe@contoso.com",
status="Approved",
),
resource_group_name="rg1")
import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";
const privateEndpointConnection = new azure_native.documentdb.PrivateEndpointConnection("privateEndpointConnection", {
accountName: "ddb1",
privateEndpointConnectionName: "privateEndpointConnectionName",
privateLinkServiceConnectionState: {
description: "Approved by johndoe@contoso.com",
status: "Approved",
},
resourceGroupName: "rg1",
});
resources:
privateEndpointConnection:
type: azure-native:documentdb:PrivateEndpointConnection
properties:
accountName: ddb1
privateEndpointConnectionName: privateEndpointConnectionName
privateLinkServiceConnectionState:
description: Approved by johndoe@contoso.com
status: Approved
resourceGroupName: rg1
Create PrivateEndpointConnection Resource
new PrivateEndpointConnection(name: string, args: PrivateEndpointConnectionArgs, opts?: CustomResourceOptions);
@overload
def PrivateEndpointConnection(resource_name: str,
opts: Optional[ResourceOptions] = None,
account_name: Optional[str] = None,
group_id: Optional[str] = None,
private_endpoint: Optional[PrivateEndpointPropertyArgs] = None,
private_endpoint_connection_name: Optional[str] = None,
private_link_service_connection_state: Optional[PrivateLinkServiceConnectionStatePropertyArgs] = None,
provisioning_state: Optional[str] = None,
resource_group_name: Optional[str] = None)
@overload
def PrivateEndpointConnection(resource_name: str,
args: PrivateEndpointConnectionArgs,
opts: Optional[ResourceOptions] = None)
func NewPrivateEndpointConnection(ctx *Context, name string, args PrivateEndpointConnectionArgs, opts ...ResourceOption) (*PrivateEndpointConnection, error)
public PrivateEndpointConnection(string name, PrivateEndpointConnectionArgs args, CustomResourceOptions? opts = null)
public PrivateEndpointConnection(String name, PrivateEndpointConnectionArgs args)
public PrivateEndpointConnection(String name, PrivateEndpointConnectionArgs args, CustomResourceOptions options)
type: azure-native:documentdb:PrivateEndpointConnection
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args PrivateEndpointConnectionArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args PrivateEndpointConnectionArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args PrivateEndpointConnectionArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args PrivateEndpointConnectionArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args PrivateEndpointConnectionArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
PrivateEndpointConnection Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
The PrivateEndpointConnection resource accepts the following input properties:
- Account
Name string - Cosmos DB database account name.
- Resource
Group stringName - The name of the resource group. The name is case insensitive.
- Group
Id string - Group id of the private endpoint.
- Private
Endpoint Pulumi.Azure Native. Document DB. Inputs. Private Endpoint Property - Private endpoint which the connection belongs to.
- Private
Endpoint stringConnection Name - The name of the private endpoint connection.
- Private
Link Pulumi.Service Connection State Azure Native. Document DB. Inputs. Private Link Service Connection State Property - Connection State of the Private Endpoint Connection.
- Provisioning
State string - Provisioning state of the private endpoint.
- Account
Name string - Cosmos DB database account name.
- Resource
Group stringName - The name of the resource group. The name is case insensitive.
- Group
Id string - Group id of the private endpoint.
- Private
Endpoint PrivateEndpoint Property Args - Private endpoint which the connection belongs to.
- Private
Endpoint stringConnection Name - The name of the private endpoint connection.
- Private
Link PrivateService Connection State Link Service Connection State Property Args - Connection State of the Private Endpoint Connection.
- Provisioning
State string - Provisioning state of the private endpoint.
- account
Name String - Cosmos DB database account name.
- resource
Group StringName - The name of the resource group. The name is case insensitive.
- group
Id String - Group id of the private endpoint.
- private
Endpoint PrivateEndpoint Property - Private endpoint which the connection belongs to.
- private
Endpoint StringConnection Name - The name of the private endpoint connection.
- private
Link PrivateService Connection State Link Service Connection State Property - Connection State of the Private Endpoint Connection.
- provisioning
State String - Provisioning state of the private endpoint.
- account
Name string - Cosmos DB database account name.
- resource
Group stringName - The name of the resource group. The name is case insensitive.
- group
Id string - Group id of the private endpoint.
- private
Endpoint PrivateEndpoint Property - Private endpoint which the connection belongs to.
- private
Endpoint stringConnection Name - The name of the private endpoint connection.
- private
Link PrivateService Connection State Link Service Connection State Property - Connection State of the Private Endpoint Connection.
- provisioning
State string - Provisioning state of the private endpoint.
- account_
name str - Cosmos DB database account name.
- resource_
group_ strname - The name of the resource group. The name is case insensitive.
- group_
id str - Group id of the private endpoint.
- private_
endpoint PrivateEndpoint Property Args - Private endpoint which the connection belongs to.
- private_
endpoint_ strconnection_ name - The name of the private endpoint connection.
- private_
link_ Privateservice_ connection_ state Link Service Connection State Property Args - Connection State of the Private Endpoint Connection.
- provisioning_
state str - Provisioning state of the private endpoint.
- account
Name String - Cosmos DB database account name.
- resource
Group StringName - The name of the resource group. The name is case insensitive.
- group
Id String - Group id of the private endpoint.
- private
Endpoint Property Map - Private endpoint which the connection belongs to.
- private
Endpoint StringConnection Name - The name of the private endpoint connection.
- private
Link Property MapService Connection State - Connection State of the Private Endpoint Connection.
- provisioning
State String - Provisioning state of the private endpoint.
Outputs
All input properties are implicitly available as output properties. Additionally, the PrivateEndpointConnection resource produces the following output properties:
Supporting Types
PrivateEndpointProperty, PrivateEndpointPropertyArgs
- Id string
- Resource id of the private endpoint.
- Id string
- Resource id of the private endpoint.
- id String
- Resource id of the private endpoint.
- id string
- Resource id of the private endpoint.
- id str
- Resource id of the private endpoint.
- id String
- Resource id of the private endpoint.
PrivateEndpointPropertyResponse, PrivateEndpointPropertyResponseArgs
- Id string
- Resource id of the private endpoint.
- Id string
- Resource id of the private endpoint.
- id String
- Resource id of the private endpoint.
- id string
- Resource id of the private endpoint.
- id str
- Resource id of the private endpoint.
- id String
- Resource id of the private endpoint.
PrivateLinkServiceConnectionStateProperty, PrivateLinkServiceConnectionStatePropertyArgs
- Description string
- The private link service connection description.
- Status string
- The private link service connection status.
- Description string
- The private link service connection description.
- Status string
- The private link service connection status.
- description String
- The private link service connection description.
- status String
- The private link service connection status.
- description string
- The private link service connection description.
- status string
- The private link service connection status.
- description str
- The private link service connection description.
- status str
- The private link service connection status.
- description String
- The private link service connection description.
- status String
- The private link service connection status.
PrivateLinkServiceConnectionStatePropertyResponse, PrivateLinkServiceConnectionStatePropertyResponseArgs
- Actions
Required string - Any action that is required beyond basic workflow (approve/ reject/ disconnect)
- Description string
- The private link service connection description.
- Status string
- The private link service connection status.
- Actions
Required string - Any action that is required beyond basic workflow (approve/ reject/ disconnect)
- Description string
- The private link service connection description.
- Status string
- The private link service connection status.
- actions
Required String - Any action that is required beyond basic workflow (approve/ reject/ disconnect)
- description String
- The private link service connection description.
- status String
- The private link service connection status.
- actions
Required string - Any action that is required beyond basic workflow (approve/ reject/ disconnect)
- description string
- The private link service connection description.
- status string
- The private link service connection status.
- actions_
required str - Any action that is required beyond basic workflow (approve/ reject/ disconnect)
- description str
- The private link service connection description.
- status str
- The private link service connection status.
- actions
Required String - Any action that is required beyond basic workflow (approve/ reject/ disconnect)
- description String
- The private link service connection description.
- status String
- The private link service connection status.
Import
An existing resource can be imported using its type token, name, and identifier, e.g.
$ pulumi import azure-native:documentdb:PrivateEndpointConnection privateEndpointConnectionName /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/privateEndpointConnections/{privateEndpointConnectionName}
Package Details
- Repository
- Azure Native pulumi/pulumi-azure-native
- License
- Apache-2.0
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.34.0 published on Thursday, Mar 28, 2024 by Pulumi