1. Packages
  2. Azure Native
  3. API Docs
  4. containerregistry
  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.37.0 published on Monday, Apr 15, 2024 by Pulumi

azure-native.containerregistry.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.37.0 published on Monday, Apr 15, 2024 by Pulumi

    An object that represents a private endpoint connection for a container registry. Azure REST API version: 2022-12-01. Prior API version in Azure Native 1.x: 2020-11-01-preview.

    Other available API versions: 2023-01-01-preview, 2023-06-01-preview, 2023-07-01, 2023-08-01-preview, 2023-11-01-preview.

    Example Usage

    PrivateEndpointConnectionCreateOrUpdate

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using AzureNative = Pulumi.AzureNative;
    
    return await Deployment.RunAsync(() => 
    {
        var privateEndpointConnection = new AzureNative.ContainerRegistry.PrivateEndpointConnection("privateEndpointConnection", new()
        {
            PrivateEndpointConnectionName = "myConnection",
            PrivateLinkServiceConnectionState = new AzureNative.ContainerRegistry.Inputs.PrivateLinkServiceConnectionStateArgs
            {
                Description = "Auto-Approved",
                Status = AzureNative.ContainerRegistry.ConnectionStatus.Approved,
            },
            RegistryName = "myRegistry",
            ResourceGroupName = "myResourceGroup",
        });
    
    });
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-azure-native-sdk/containerregistry/v2"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := containerregistry.NewPrivateEndpointConnection(ctx, "privateEndpointConnection", &containerregistry.PrivateEndpointConnectionArgs{
    			PrivateEndpointConnectionName: pulumi.String("myConnection"),
    			PrivateLinkServiceConnectionState: &containerregistry.PrivateLinkServiceConnectionStateArgs{
    				Description: pulumi.String("Auto-Approved"),
    				Status:      pulumi.String(containerregistry.ConnectionStatusApproved),
    			},
    			RegistryName:      pulumi.String("myRegistry"),
    			ResourceGroupName: pulumi.String("myResourceGroup"),
    		})
    		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.containerregistry.PrivateEndpointConnection;
    import com.pulumi.azurenative.containerregistry.PrivateEndpointConnectionArgs;
    import com.pulumi.azurenative.containerregistry.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("myConnection")
                .privateLinkServiceConnectionState(PrivateLinkServiceConnectionStateArgs.builder()
                    .description("Auto-Approved")
                    .status("Approved")
                    .build())
                .registryName("myRegistry")
                .resourceGroupName("myResourceGroup")
                .build());
    
        }
    }
    
    import pulumi
    import pulumi_azure_native as azure_native
    
    private_endpoint_connection = azure_native.containerregistry.PrivateEndpointConnection("privateEndpointConnection",
        private_endpoint_connection_name="myConnection",
        private_link_service_connection_state=azure_native.containerregistry.PrivateLinkServiceConnectionStateArgs(
            description="Auto-Approved",
            status=azure_native.containerregistry.ConnectionStatus.APPROVED,
        ),
        registry_name="myRegistry",
        resource_group_name="myResourceGroup")
    
    import * as pulumi from "@pulumi/pulumi";
    import * as azure_native from "@pulumi/azure-native";
    
    const privateEndpointConnection = new azure_native.containerregistry.PrivateEndpointConnection("privateEndpointConnection", {
        privateEndpointConnectionName: "myConnection",
        privateLinkServiceConnectionState: {
            description: "Auto-Approved",
            status: azure_native.containerregistry.ConnectionStatus.Approved,
        },
        registryName: "myRegistry",
        resourceGroupName: "myResourceGroup",
    });
    
    resources:
      privateEndpointConnection:
        type: azure-native:containerregistry:PrivateEndpointConnection
        properties:
          privateEndpointConnectionName: myConnection
          privateLinkServiceConnectionState:
            description: Auto-Approved
            status: Approved
          registryName: myRegistry
          resourceGroupName: myResourceGroup
    

    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,
                                  registry_name: Optional[str] = None,
                                  resource_group_name: Optional[str] = None,
                                  private_endpoint: Optional[PrivateEndpointArgs] = None,
                                  private_endpoint_connection_name: Optional[str] = None,
                                  private_link_service_connection_state: Optional[PrivateLinkServiceConnectionStateArgs] = 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:containerregistry: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.

    Example

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

    var exampleprivateEndpointConnectionResourceResourceFromContainerregistry = new AzureNative.ContainerRegistry.PrivateEndpointConnection("exampleprivateEndpointConnectionResourceResourceFromContainerregistry", new()
    {
        RegistryName = "string",
        ResourceGroupName = "string",
        PrivateEndpoint = new AzureNative.ContainerRegistry.Inputs.PrivateEndpointArgs
        {
            Id = "string",
        },
        PrivateEndpointConnectionName = "string",
        PrivateLinkServiceConnectionState = new AzureNative.ContainerRegistry.Inputs.PrivateLinkServiceConnectionStateArgs
        {
            ActionsRequired = "string",
            Description = "string",
            Status = "string",
        },
    });
    
    example, err := containerregistry.NewPrivateEndpointConnection(ctx, "exampleprivateEndpointConnectionResourceResourceFromContainerregistry", &containerregistry.PrivateEndpointConnectionArgs{
    RegistryName: pulumi.String("string"),
    ResourceGroupName: pulumi.String("string"),
    PrivateEndpoint: &containerregistry.PrivateEndpointArgs{
    Id: pulumi.String("string"),
    },
    PrivateEndpointConnectionName: pulumi.String("string"),
    PrivateLinkServiceConnectionState: &containerregistry.PrivateLinkServiceConnectionStateArgs{
    ActionsRequired: pulumi.String("string"),
    Description: pulumi.String("string"),
    Status: pulumi.String("string"),
    },
    })
    
    var exampleprivateEndpointConnectionResourceResourceFromContainerregistry = new PrivateEndpointConnection("exampleprivateEndpointConnectionResourceResourceFromContainerregistry", PrivateEndpointConnectionArgs.builder()        
        .registryName("string")
        .resourceGroupName("string")
        .privateEndpoint(PrivateEndpointArgs.builder()
            .id("string")
            .build())
        .privateEndpointConnectionName("string")
        .privateLinkServiceConnectionState(PrivateLinkServiceConnectionStateArgs.builder()
            .actionsRequired("string")
            .description("string")
            .status("string")
            .build())
        .build());
    
    exampleprivate_endpoint_connection_resource_resource_from_containerregistry = azure_native.containerregistry.PrivateEndpointConnection("exampleprivateEndpointConnectionResourceResourceFromContainerregistry",
        registry_name="string",
        resource_group_name="string",
        private_endpoint=azure_native.containerregistry.PrivateEndpointArgs(
            id="string",
        ),
        private_endpoint_connection_name="string",
        private_link_service_connection_state=azure_native.containerregistry.PrivateLinkServiceConnectionStateArgs(
            actions_required="string",
            description="string",
            status="string",
        ))
    
    const exampleprivateEndpointConnectionResourceResourceFromContainerregistry = new azure_native.containerregistry.PrivateEndpointConnection("exampleprivateEndpointConnectionResourceResourceFromContainerregistry", {
        registryName: "string",
        resourceGroupName: "string",
        privateEndpoint: {
            id: "string",
        },
        privateEndpointConnectionName: "string",
        privateLinkServiceConnectionState: {
            actionsRequired: "string",
            description: "string",
            status: "string",
        },
    });
    
    type: azure-native:containerregistry:PrivateEndpointConnection
    properties:
        privateEndpoint:
            id: string
        privateEndpointConnectionName: string
        privateLinkServiceConnectionState:
            actionsRequired: string
            description: string
            status: string
        registryName: string
        resourceGroupName: 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:

    RegistryName string
    The name of the container registry.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    PrivateEndpoint Pulumi.AzureNative.ContainerRegistry.Inputs.PrivateEndpoint
    The resource of private endpoint.
    PrivateEndpointConnectionName string
    The name of the private endpoint connection.
    PrivateLinkServiceConnectionState Pulumi.AzureNative.ContainerRegistry.Inputs.PrivateLinkServiceConnectionState
    A collection of information about the state of the connection between service consumer and provider.
    RegistryName string
    The name of the container registry.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    PrivateEndpoint PrivateEndpointArgs
    The resource of private endpoint.
    PrivateEndpointConnectionName string
    The name of the private endpoint connection.
    PrivateLinkServiceConnectionState PrivateLinkServiceConnectionStateArgs
    A collection of information about the state of the connection between service consumer and provider.
    registryName String
    The name of the container registry.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    privateEndpoint PrivateEndpoint
    The resource of private endpoint.
    privateEndpointConnectionName String
    The name of the private endpoint connection.
    privateLinkServiceConnectionState PrivateLinkServiceConnectionState
    A collection of information about the state of the connection between service consumer and provider.
    registryName string
    The name of the container registry.
    resourceGroupName string
    The name of the resource group. The name is case insensitive.
    privateEndpoint PrivateEndpoint
    The resource of private endpoint.
    privateEndpointConnectionName string
    The name of the private endpoint connection.
    privateLinkServiceConnectionState PrivateLinkServiceConnectionState
    A collection of information about the state of the connection between service consumer and provider.
    registry_name str
    The name of the container registry.
    resource_group_name str
    The name of the resource group. The name is case insensitive.
    private_endpoint PrivateEndpointArgs
    The resource of private endpoint.
    private_endpoint_connection_name str
    The name of the private endpoint connection.
    private_link_service_connection_state PrivateLinkServiceConnectionStateArgs
    A collection of information about the state of the connection between service consumer and provider.
    registryName String
    The name of the container registry.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    privateEndpoint Property Map
    The resource of private endpoint.
    privateEndpointConnectionName String
    The name of the private endpoint connection.
    privateLinkServiceConnectionState Property Map
    A collection of information about the state of the connection between service consumer and provider.

    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 private endpoint connection resource.
    SystemData Pulumi.AzureNative.ContainerRegistry.Outputs.SystemDataResponse
    Metadata pertaining to creation and last modification of the resource.
    Type string
    The type of the resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    The name of the resource.
    ProvisioningState string
    The provisioning state of private endpoint connection resource.
    SystemData SystemDataResponse
    Metadata pertaining to creation and last modification of the resource.
    Type string
    The type of the resource.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    The name of the resource.
    provisioningState String
    The provisioning state of private endpoint connection resource.
    systemData SystemDataResponse
    Metadata pertaining to creation and last modification of the resource.
    type String
    The type of the resource.
    id string
    The provider-assigned unique ID for this managed resource.
    name string
    The name of the resource.
    provisioningState string
    The provisioning state of private endpoint connection resource.
    systemData SystemDataResponse
    Metadata pertaining to creation and last modification of the resource.
    type string
    The type of the resource.
    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 private endpoint connection resource.
    system_data SystemDataResponse
    Metadata pertaining to creation and last modification of the resource.
    type str
    The type of the resource.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    The name of the resource.
    provisioningState String
    The provisioning state of private endpoint connection resource.
    systemData Property Map
    Metadata pertaining to creation and last modification of the resource.
    type String
    The type of the resource.

    Supporting Types

    ActionsRequired, ActionsRequiredArgs

    None
    None
    Recreate
    Recreate
    ActionsRequiredNone
    None
    ActionsRequiredRecreate
    Recreate
    None
    None
    Recreate
    Recreate
    None
    None
    Recreate
    Recreate
    NONE
    None
    RECREATE
    Recreate
    "None"
    None
    "Recreate"
    Recreate

    ConnectionStatus, ConnectionStatusArgs

    Approved
    Approved
    Pending
    Pending
    Rejected
    Rejected
    Disconnected
    Disconnected
    ConnectionStatusApproved
    Approved
    ConnectionStatusPending
    Pending
    ConnectionStatusRejected
    Rejected
    ConnectionStatusDisconnected
    Disconnected
    Approved
    Approved
    Pending
    Pending
    Rejected
    Rejected
    Disconnected
    Disconnected
    Approved
    Approved
    Pending
    Pending
    Rejected
    Rejected
    Disconnected
    Disconnected
    APPROVED
    Approved
    PENDING
    Pending
    REJECTED
    Rejected
    DISCONNECTED
    Disconnected
    "Approved"
    Approved
    "Pending"
    Pending
    "Rejected"
    Rejected
    "Disconnected"
    Disconnected

    PrivateEndpoint, PrivateEndpointArgs

    Id string
    This is private endpoint resource created with Microsoft.Network resource provider.
    Id string
    This is private endpoint resource created with Microsoft.Network resource provider.
    id String
    This is private endpoint resource created with Microsoft.Network resource provider.
    id string
    This is private endpoint resource created with Microsoft.Network resource provider.
    id str
    This is private endpoint resource created with Microsoft.Network resource provider.
    id String
    This is private endpoint resource created with Microsoft.Network resource provider.

    PrivateEndpointResponse, PrivateEndpointResponseArgs

    Id string
    This is private endpoint resource created with Microsoft.Network resource provider.
    Id string
    This is private endpoint resource created with Microsoft.Network resource provider.
    id String
    This is private endpoint resource created with Microsoft.Network resource provider.
    id string
    This is private endpoint resource created with Microsoft.Network resource provider.
    id str
    This is private endpoint resource created with Microsoft.Network resource provider.
    id String
    This is private endpoint resource created with Microsoft.Network resource provider.

    PrivateLinkServiceConnectionState, PrivateLinkServiceConnectionStateArgs

    ActionsRequired string | Pulumi.AzureNative.ContainerRegistry.ActionsRequired
    A message indicating if changes on the service provider require any updates on the consumer.
    Description string
    The description for connection status. For example if connection is rejected it can indicate reason for rejection.
    Status string | Pulumi.AzureNative.ContainerRegistry.ConnectionStatus
    The private link service connection status.
    ActionsRequired string | ActionsRequired
    A message indicating if changes on the service provider require any updates on the consumer.
    Description string
    The description for connection status. For example if connection is rejected it can indicate reason for rejection.
    Status string | ConnectionStatus
    The private link service connection status.
    actionsRequired String | ActionsRequired
    A message indicating if changes on the service provider require any updates on the consumer.
    description String
    The description for connection status. For example if connection is rejected it can indicate reason for rejection.
    status String | ConnectionStatus
    The private link service connection status.
    actionsRequired string | ActionsRequired
    A message indicating if changes on the service provider require any updates on the consumer.
    description string
    The description for connection status. For example if connection is rejected it can indicate reason for rejection.
    status string | ConnectionStatus
    The private link service connection status.
    actions_required str | ActionsRequired
    A message indicating if changes on the service provider require any updates on the consumer.
    description str
    The description for connection status. For example if connection is rejected it can indicate reason for rejection.
    status str | ConnectionStatus
    The private link service connection status.
    actionsRequired String | "None" | "Recreate"
    A message indicating if changes on the service provider require any updates on the consumer.
    description String
    The description for connection status. For example if connection is rejected it can indicate reason for rejection.
    status String | "Approved" | "Pending" | "Rejected" | "Disconnected"
    The private link service connection status.

    PrivateLinkServiceConnectionStateResponse, PrivateLinkServiceConnectionStateResponseArgs

    ActionsRequired string
    A message indicating if changes on the service provider require any updates on the consumer.
    Description string
    The description for connection status. For example if connection is rejected it can indicate reason for rejection.
    Status string
    The private link service connection status.
    ActionsRequired string
    A message indicating if changes on the service provider require any updates on the consumer.
    Description string
    The description for connection status. For example if connection is rejected it can indicate reason for rejection.
    Status string
    The private link service connection status.
    actionsRequired String
    A message indicating if changes on the service provider require any updates on the consumer.
    description String
    The description for connection status. For example if connection is rejected it can indicate reason for rejection.
    status String
    The private link service connection status.
    actionsRequired string
    A message indicating if changes on the service provider require any updates on the consumer.
    description string
    The description for connection status. For example if connection is rejected it can indicate reason for rejection.
    status string
    The private link service connection status.
    actions_required str
    A message indicating if changes on the service provider require any updates on the consumer.
    description str
    The description for connection status. For example if connection is rejected it can indicate reason for rejection.
    status str
    The private link service connection status.
    actionsRequired String
    A message indicating if changes on the service provider require any updates on the consumer.
    description String
    The description for connection status. For example if connection is rejected it can indicate reason for rejection.
    status String
    The private link service connection status.

    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 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 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 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 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 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 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:containerregistry:PrivateEndpointConnection myConnection /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/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.37.0 published on Monday, Apr 15, 2024 by Pulumi