Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. kubernetesconfiguration
  5. PrivateEndpointConnection
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.63.0 published on Tuesday, Sep 24, 2024 by Pulumi
pulumi/pulumi-azure-native

azure-native.kubernetesconfiguration.PrivateEndpointConnection

Explore with Pulumi AI

azure-native logo
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.63.0 published on Tuesday, Sep 24, 2024 by Pulumi
pulumi/pulumi-azure-native

    The Private Endpoint Connection resource. Azure REST API version: 2022-04-02-preview. Prior API version in Azure Native 1.x: 2022-04-02-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.KubernetesConfiguration.PrivateEndpointConnection("privateEndpointConnection", new()
    {
        PrivateEndpointConnectionName = "private-endpoint-connection-name",
        PrivateLinkServiceConnectionState = new AzureNative.KubernetesConfiguration.Inputs.PrivateLinkServiceConnectionStateArgs
        {
            Description = "Approved by johndoe@contoso.com",
            Status = AzureNative.KubernetesConfiguration.PrivateEndpointServiceConnectionStatus.Approved,
        },
        ResourceGroupName = "myResourceGroup",
        ScopeName = "myPrivateLinkScope",
    });

});

    package main

import (
	kubernetesconfiguration "github.com/pulumi/pulumi-azure-native-sdk/kubernetesconfiguration/v2"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := kubernetesconfiguration.NewPrivateEndpointConnection(ctx, "privateEndpointConnection", &kubernetesconfiguration.PrivateEndpointConnectionArgs{
			PrivateEndpointConnectionName: pulumi.String("private-endpoint-connection-name"),
			PrivateLinkServiceConnectionState: &kubernetesconfiguration.PrivateLinkServiceConnectionStateArgs{
				Description: pulumi.String("Approved by johndoe@contoso.com"),
				Status:      pulumi.String(kubernetesconfiguration.PrivateEndpointServiceConnectionStatusApproved),
			},
			ResourceGroupName: pulumi.String("myResourceGroup"),
			ScopeName:         pulumi.String("myPrivateLinkScope"),
		})
		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.kubernetesconfiguration.PrivateEndpointConnection;
import com.pulumi.azurenative.kubernetesconfiguration.PrivateEndpointConnectionArgs;
import com.pulumi.azurenative.kubernetesconfiguration.inputs.PrivateLinkServiceConnectionStateArgs;
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()
            .privateEndpointConnectionName("private-endpoint-connection-name")
            .privateLinkServiceConnectionState(PrivateLinkServiceConnectionStateArgs.builder()
                .description("Approved by johndoe@contoso.com")
                .status("Approved")
                .build())
            .resourceGroupName("myResourceGroup")
            .scopeName("myPrivateLinkScope")
            .build());

    }
}

    import pulumi
import pulumi_azure_native as azure_native

private_endpoint_connection = azure_native.kubernetesconfiguration.PrivateEndpointConnection("privateEndpointConnection",
    private_endpoint_connection_name="private-endpoint-connection-name",
    private_link_service_connection_state={
        "description": "Approved by johndoe@contoso.com",
        "status": azure_native.kubernetesconfiguration.PrivateEndpointServiceConnectionStatus.APPROVED,
    },
    resource_group_name="myResourceGroup",
    scope_name="myPrivateLinkScope")

    import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";

const privateEndpointConnection = new azure_native.kubernetesconfiguration.PrivateEndpointConnection("privateEndpointConnection", {
    privateEndpointConnectionName: "private-endpoint-connection-name",
    privateLinkServiceConnectionState: {
        description: "Approved by johndoe@contoso.com",
        status: azure_native.kubernetesconfiguration.PrivateEndpointServiceConnectionStatus.Approved,
    },
    resourceGroupName: "myResourceGroup",
    scopeName: "myPrivateLinkScope",
});

    resources:
  privateEndpointConnection:
    type: azure-native:kubernetesconfiguration:PrivateEndpointConnection
    properties:
      privateEndpointConnectionName: private-endpoint-connection-name
      privateLinkServiceConnectionState:
        description: Approved by johndoe@contoso.com
        status: Approved
      resourceGroupName: myResourceGroup
      scopeName: myPrivateLinkScope

    Create PrivateEndpointConnection Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new PrivateEndpointConnection(name: string, args: PrivateEndpointConnectionArgs, opts?: CustomResourceOptions);
    @overload
def PrivateEndpointConnection(resource_name: str,
                              args: PrivateEndpointConnectionArgs,
                              opts: Optional[ResourceOptions] = None)

@overload
def PrivateEndpointConnection(resource_name: str,
                              opts: Optional[ResourceOptions] = None,
                              private_link_service_connection_state: Optional[PrivateLinkServiceConnectionStateArgs] = None,
                              resource_group_name: Optional[str] = None,
                              scope_name: Optional[str] = None,
                              private_endpoint_connection_name: Optional[str] = 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:kubernetesconfiguration:PrivateEndpointConnection
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    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.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var exampleprivateEndpointConnectionResourceResourceFromKubernetesconfiguration = new AzureNative.KubernetesConfiguration.PrivateEndpointConnection("exampleprivateEndpointConnectionResourceResourceFromKubernetesconfiguration", new()
{
    PrivateLinkServiceConnectionState = new AzureNative.KubernetesConfiguration.Inputs.PrivateLinkServiceConnectionStateArgs
    {
        ActionsRequired = "string",
        Description = "string",
        Status = "string",
    },
    ResourceGroupName = "string",
    ScopeName = "string",
    PrivateEndpointConnectionName = "string",
});

    example, err := kubernetesconfiguration.NewPrivateEndpointConnection(ctx, "exampleprivateEndpointConnectionResourceResourceFromKubernetesconfiguration", &kubernetesconfiguration.PrivateEndpointConnectionArgs{
	PrivateLinkServiceConnectionState: &kubernetesconfiguration.PrivateLinkServiceConnectionStateArgs{
		ActionsRequired: pulumi.String("string"),
		Description:     pulumi.String("string"),
		Status:          pulumi.String("string"),
	},
	ResourceGroupName:             pulumi.String("string"),
	ScopeName:                     pulumi.String("string"),
	PrivateEndpointConnectionName: pulumi.String("string"),
})

    var exampleprivateEndpointConnectionResourceResourceFromKubernetesconfiguration = new PrivateEndpointConnection("exampleprivateEndpointConnectionResourceResourceFromKubernetesconfiguration", PrivateEndpointConnectionArgs.builder()
    .privateLinkServiceConnectionState(PrivateLinkServiceConnectionStateArgs.builder()
        .actionsRequired("string")
        .description("string")
        .status("string")
        .build())
    .resourceGroupName("string")
    .scopeName("string")
    .privateEndpointConnectionName("string")
    .build());

    exampleprivate_endpoint_connection_resource_resource_from_kubernetesconfiguration = azure_native.kubernetesconfiguration.PrivateEndpointConnection("exampleprivateEndpointConnectionResourceResourceFromKubernetesconfiguration",
    private_link_service_connection_state={
        "actionsRequired": "string",
        "description": "string",
        "status": "string",
    },
    resource_group_name="string",
    scope_name="string",
    private_endpoint_connection_name="string")

    const exampleprivateEndpointConnectionResourceResourceFromKubernetesconfiguration = new azure_native.kubernetesconfiguration.PrivateEndpointConnection("exampleprivateEndpointConnectionResourceResourceFromKubernetesconfiguration", {
    privateLinkServiceConnectionState: {
        actionsRequired: "string",
        description: "string",
        status: "string",
    },
    resourceGroupName: "string",
    scopeName: "string",
    privateEndpointConnectionName: "string",
});

    type: azure-native:kubernetesconfiguration:PrivateEndpointConnection
properties:
    privateEndpointConnectionName: string
    privateLinkServiceConnectionState:
        actionsRequired: string
        description: string
        status: string
    resourceGroupName: string
    scopeName: string

    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:

    PrivateLinkServiceConnectionState Pulumi.AzureNative.KubernetesConfiguration.Inputs.PrivateLinkServiceConnectionState
    A collection of information about the state of the connection between service consumer and provider.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    ScopeName string
    The name of the Azure Arc PrivateLinkScope resource.
    PrivateEndpointConnectionName string
    The name of the private endpoint connection associated with the Azure resource
    PrivateLinkServiceConnectionState PrivateLinkServiceConnectionStateArgs
    A collection of information about the state of the connection between service consumer and provider.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    ScopeName string
    The name of the Azure Arc PrivateLinkScope resource.
    PrivateEndpointConnectionName string
    The name of the private endpoint connection associated with the Azure resource
    privateLinkServiceConnectionState PrivateLinkServiceConnectionState
    A collection of information about the state of the connection between service consumer and provider.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    scopeName String
    The name of the Azure Arc PrivateLinkScope resource.
    privateEndpointConnectionName String
    The name of the private endpoint connection associated with the Azure resource
    privateLinkServiceConnectionState PrivateLinkServiceConnectionState
    A collection of information about the state of the connection between service consumer and provider.
    resourceGroupName string
    The name of the resource group. The name is case insensitive.
    scopeName string
    The name of the Azure Arc PrivateLinkScope resource.
    privateEndpointConnectionName string
    The name of the private endpoint connection associated with the Azure resource
    private_link_service_connection_state PrivateLinkServiceConnectionStateArgs
    A collection of information about the state of the connection between service consumer and provider.
    resource_group_name str
    The name of the resource group. The name is case insensitive.
    scope_name str
    The name of the Azure Arc PrivateLinkScope resource.
    private_endpoint_connection_name str
    The name of the private endpoint connection associated with the Azure resource
    privateLinkServiceConnectionState Property Map
    A collection of information about the state of the connection between service consumer and provider.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    scopeName String
    The name of the Azure Arc PrivateLinkScope resource.
    privateEndpointConnectionName String
    The name of the private endpoint connection associated with the Azure resource

    Outputs

    All input properties are implicitly available as output properties. Additionally, the PrivateEndpointConnection resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    The name of the resource
    ProvisioningState string
    The provisioning state of the private endpoint connection resource.
    SystemData Pulumi.AzureNative.KubernetesConfiguration.Outputs.SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    Type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    PrivateEndpoint Pulumi.AzureNative.KubernetesConfiguration.Outputs.PrivateEndpointResponse
    The resource of private end point.
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    The name of the resource
    ProvisioningState string
    The provisioning state of the private endpoint connection resource.
    SystemData SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    Type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    PrivateEndpoint PrivateEndpointResponse
    The resource of private end point.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    The name of the resource
    provisioningState String
    The provisioning state of the private endpoint connection resource.
    systemData SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type String
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    privateEndpoint PrivateEndpointResponse
    The resource of private end point.
    id string
    The provider-assigned unique ID for this managed resource.
    name string
    The name of the resource
    provisioningState string
    The provisioning state of the private endpoint connection resource.
    systemData SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    privateEndpoint PrivateEndpointResponse
    The resource of private end point.
    id str
    The provider-assigned unique ID for this managed resource.
    name str
    The name of the resource
    provisioning_state str
    The provisioning state of the private endpoint connection resource.
    system_data SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type str
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    private_endpoint PrivateEndpointResponse
    The resource of private end point.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    The name of the resource
    provisioningState String
    The provisioning state of the private endpoint connection resource.
    systemData Property Map
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type String
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    privateEndpoint Property Map
    The resource of private end point.

    Supporting Types

    PrivateEndpointResponse, PrivateEndpointResponseArgs

    Id string
    The ARM identifier for Private Endpoint
    Id string
    The ARM identifier for Private Endpoint
    id String
    The ARM identifier for Private Endpoint
    id string
    The ARM identifier for Private Endpoint
    id str
    The ARM identifier for Private Endpoint
    id String
    The ARM identifier for Private Endpoint

    PrivateEndpointServiceConnectionStatus, PrivateEndpointServiceConnectionStatusArgs

    Pending
    Pending
    Approved
    Approved
    Rejected
    Rejected
    PrivateEndpointServiceConnectionStatusPending
    Pending
    PrivateEndpointServiceConnectionStatusApproved
    Approved
    PrivateEndpointServiceConnectionStatusRejected
    Rejected
    Pending
    Pending
    Approved
    Approved
    Rejected
    Rejected
    Pending
    Pending
    Approved
    Approved
    Rejected
    Rejected
    PENDING
    Pending
    APPROVED
    Approved
    REJECTED
    Rejected
    "Pending"
    Pending
    "Approved"
    Approved
    "Rejected"
    Rejected

    PrivateLinkServiceConnectionState, PrivateLinkServiceConnectionStateArgs

    ActionsRequired string
    A message indicating if changes on the service provider require any updates on the consumer.
    Description string
    The reason for approval/rejection of the connection.
    Status string | Pulumi.AzureNative.KubernetesConfiguration.PrivateEndpointServiceConnectionStatus
    Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.
    ActionsRequired string
    A message indicating if changes on the service provider require any updates on the consumer.
    Description string
    The reason for approval/rejection of the connection.
    Status string | PrivateEndpointServiceConnectionStatus
    Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.
    actionsRequired String
    A message indicating if changes on the service provider require any updates on the consumer.
    description String
    The reason for approval/rejection of the connection.
    status String | PrivateEndpointServiceConnectionStatus
    Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.
    actionsRequired string
    A message indicating if changes on the service provider require any updates on the consumer.
    description string
    The reason for approval/rejection of the connection.
    status string | PrivateEndpointServiceConnectionStatus
    Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.
    actions_required str
    A message indicating if changes on the service provider require any updates on the consumer.
    description str
    The reason for approval/rejection of the connection.
    status str | PrivateEndpointServiceConnectionStatus
    Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.
    actionsRequired String
    A message indicating if changes on the service provider require any updates on the consumer.
    description String
    The reason for approval/rejection of the connection.
    status String | "Pending" | "Approved" | "Rejected"
    Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.

    PrivateLinkServiceConnectionStateResponse, PrivateLinkServiceConnectionStateResponseArgs

    ActionsRequired string
    A message indicating if changes on the service provider require any updates on the consumer.
    Description string
    The reason for approval/rejection of the connection.
    Status string
    Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.
    ActionsRequired string
    A message indicating if changes on the service provider require any updates on the consumer.
    Description string
    The reason for approval/rejection of the connection.
    Status string
    Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.
    actionsRequired String
    A message indicating if changes on the service provider require any updates on the consumer.
    description String
    The reason for approval/rejection of the connection.
    status String
    Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.
    actionsRequired string
    A message indicating if changes on the service provider require any updates on the consumer.
    description string
    The reason for approval/rejection of the connection.
    status string
    Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.
    actions_required str
    A message indicating if changes on the service provider require any updates on the consumer.
    description str
    The reason for approval/rejection of the connection.
    status str
    Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.
    actionsRequired String
    A message indicating if changes on the service provider require any updates on the consumer.
    description String
    The reason for approval/rejection of the connection.
    status String
    Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.

    SystemDataResponse, SystemDataResponseArgs

    CreatedAt string
    The timestamp of resource creation (UTC).
    CreatedBy string
    The identity that created the resource.
    CreatedByType string
    The type of identity that created the resource.
    LastModifiedAt string
    The timestamp of resource last modification (UTC)
    LastModifiedBy string
    The identity that last modified the resource.
    LastModifiedByType string
    The type of identity that last modified the resource.
    CreatedAt string
    The timestamp of resource creation (UTC).
    CreatedBy string
    The identity that created the resource.
    CreatedByType string
    The type of identity that created the resource.
    LastModifiedAt string
    The timestamp of resource last modification (UTC)
    LastModifiedBy string
    The identity that last modified the resource.
    LastModifiedByType string
    The type of identity that last modified the resource.
    createdAt String
    The timestamp of resource creation (UTC).
    createdBy String
    The identity that created the resource.
    createdByType String
    The type of identity that created the resource.
    lastModifiedAt String
    The timestamp of resource last modification (UTC)
    lastModifiedBy String
    The identity that last modified the resource.
    lastModifiedByType String
    The type of identity that last modified the resource.
    createdAt string
    The timestamp of resource creation (UTC).
    createdBy string
    The identity that created the resource.
    createdByType string
    The type of identity that created the resource.
    lastModifiedAt string
    The timestamp of resource last modification (UTC)
    lastModifiedBy string
    The identity that last modified the resource.
    lastModifiedByType string
    The type of identity that last modified the resource.
    created_at str
    The timestamp of resource creation (UTC).
    created_by str
    The identity that created the resource.
    created_by_type str
    The type of identity that created the resource.
    last_modified_at str
    The timestamp of resource last modification (UTC)
    last_modified_by str
    The identity that last modified the resource.
    last_modified_by_type str
    The type of identity that last modified the resource.
    createdAt String
    The timestamp of resource creation (UTC).
    createdBy String
    The identity that created the resource.
    createdByType String
    The type of identity that created the resource.
    lastModifiedAt String
    The timestamp of resource last modification (UTC)
    lastModifiedBy String
    The identity that last modified the resource.
    lastModifiedByType String
    The type of identity that last modified the resource.

    Import

    An existing resource can be imported using its type token, name, and identifier, e.g.

    $ pulumi import azure-native:kubernetesconfiguration:PrivateEndpointConnection private-endpoint-connection-name /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KubernetesConfiguration/privateLinkScopes/{scopeName}/privateEndpointConnections/{privateEndpointConnectionName}

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    Azure Native pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native logo
    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.63.0 published on Tuesday, Sep 24, 2024 by Pulumi
    pulumi/pulumi-azure-native