azure-native.storage.PrivateEndpointConnection
Explore with Pulumi AI
The Private Endpoint Connection resource.
Uses Azure REST API version 2022-09-01. In version 1.x of the Azure Native provider, it used API version 2021-02-01.
Other available API versions: 2023-01-01, 2023-04-01, 2023-05-01, 2024-01-01.
Example Usage
StorageAccountPutPrivateEndpointConnection
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;
return await Deployment.RunAsync(() => 
{
    var privateEndpointConnection = new AzureNative.Storage.PrivateEndpointConnection("privateEndpointConnection", new()
    {
        AccountName = "sto9699",
        PrivateEndpointConnectionName = "{privateEndpointConnectionName}",
        PrivateLinkServiceConnectionState = new AzureNative.Storage.Inputs.PrivateLinkServiceConnectionStateArgs
        {
            Description = "Auto-Approved",
            Status = AzureNative.Storage.PrivateEndpointServiceConnectionStatus.Approved,
        },
        ResourceGroupName = "res7687",
    });
});
package main
import (
	storage "github.com/pulumi/pulumi-azure-native-sdk/storage/v2"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := storage.NewPrivateEndpointConnection(ctx, "privateEndpointConnection", &storage.PrivateEndpointConnectionArgs{
			AccountName:                   pulumi.String("sto9699"),
			PrivateEndpointConnectionName: pulumi.String("{privateEndpointConnectionName}"),
			PrivateLinkServiceConnectionState: &storage.PrivateLinkServiceConnectionStateArgs{
				Description: pulumi.String("Auto-Approved"),
				Status:      pulumi.String(storage.PrivateEndpointServiceConnectionStatusApproved),
			},
			ResourceGroupName: pulumi.String("res7687"),
		})
		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.storage.PrivateEndpointConnection;
import com.pulumi.azurenative.storage.PrivateEndpointConnectionArgs;
import com.pulumi.azurenative.storage.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()
            .accountName("sto9699")
            .privateEndpointConnectionName("{privateEndpointConnectionName}")
            .privateLinkServiceConnectionState(PrivateLinkServiceConnectionStateArgs.builder()
                .description("Auto-Approved")
                .status("Approved")
                .build())
            .resourceGroupName("res7687")
            .build());
    }
}
import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";
const privateEndpointConnection = new azure_native.storage.PrivateEndpointConnection("privateEndpointConnection", {
    accountName: "sto9699",
    privateEndpointConnectionName: "{privateEndpointConnectionName}",
    privateLinkServiceConnectionState: {
        description: "Auto-Approved",
        status: azure_native.storage.PrivateEndpointServiceConnectionStatus.Approved,
    },
    resourceGroupName: "res7687",
});
import pulumi
import pulumi_azure_native as azure_native
private_endpoint_connection = azure_native.storage.PrivateEndpointConnection("privateEndpointConnection",
    account_name="sto9699",
    private_endpoint_connection_name="{privateEndpointConnectionName}",
    private_link_service_connection_state={
        "description": "Auto-Approved",
        "status": azure_native.storage.PrivateEndpointServiceConnectionStatus.APPROVED,
    },
    resource_group_name="res7687")
resources:
  privateEndpointConnection:
    type: azure-native:storage:PrivateEndpointConnection
    properties:
      accountName: sto9699
      privateEndpointConnectionName: '{privateEndpointConnectionName}'
      privateLinkServiceConnectionState:
        description: Auto-Approved
        status: Approved
      resourceGroupName: res7687
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,
                              account_name: Optional[str] = None,
                              private_link_service_connection_state: Optional[PrivateLinkServiceConnectionStateArgs] = None,
                              resource_group_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:storage: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 exampleprivateEndpointConnectionResourceResourceFromStorage = new AzureNative.Storage.PrivateEndpointConnection("exampleprivateEndpointConnectionResourceResourceFromStorage", new()
{
    AccountName = "string",
    PrivateLinkServiceConnectionState = new AzureNative.Storage.Inputs.PrivateLinkServiceConnectionStateArgs
    {
        ActionRequired = "string",
        Description = "string",
        Status = "string",
    },
    ResourceGroupName = "string",
    PrivateEndpointConnectionName = "string",
});
example, err := storage.NewPrivateEndpointConnection(ctx, "exampleprivateEndpointConnectionResourceResourceFromStorage", &storage.PrivateEndpointConnectionArgs{
	AccountName: pulumi.String("string"),
	PrivateLinkServiceConnectionState: &storage.PrivateLinkServiceConnectionStateArgs{
		ActionRequired: pulumi.String("string"),
		Description:    pulumi.String("string"),
		Status:         pulumi.String("string"),
	},
	ResourceGroupName:             pulumi.String("string"),
	PrivateEndpointConnectionName: pulumi.String("string"),
})
var exampleprivateEndpointConnectionResourceResourceFromStorage = new PrivateEndpointConnection("exampleprivateEndpointConnectionResourceResourceFromStorage", PrivateEndpointConnectionArgs.builder()
    .accountName("string")
    .privateLinkServiceConnectionState(PrivateLinkServiceConnectionStateArgs.builder()
        .actionRequired("string")
        .description("string")
        .status("string")
        .build())
    .resourceGroupName("string")
    .privateEndpointConnectionName("string")
    .build());
exampleprivate_endpoint_connection_resource_resource_from_storage = azure_native.storage.PrivateEndpointConnection("exampleprivateEndpointConnectionResourceResourceFromStorage",
    account_name="string",
    private_link_service_connection_state={
        "action_required": "string",
        "description": "string",
        "status": "string",
    },
    resource_group_name="string",
    private_endpoint_connection_name="string")
const exampleprivateEndpointConnectionResourceResourceFromStorage = new azure_native.storage.PrivateEndpointConnection("exampleprivateEndpointConnectionResourceResourceFromStorage", {
    accountName: "string",
    privateLinkServiceConnectionState: {
        actionRequired: "string",
        description: "string",
        status: "string",
    },
    resourceGroupName: "string",
    privateEndpointConnectionName: "string",
});
type: azure-native:storage:PrivateEndpointConnection
properties:
    accountName: string
    privateEndpointConnectionName: string
    privateLinkServiceConnectionState:
        actionRequired: string
        description: string
        status: 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
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The PrivateEndpointConnection resource accepts the following input properties:
- AccountName string
- The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only.
- PrivateLink Pulumi.Service Connection State Azure Native. Storage. Inputs. Private Link Service Connection State 
- A collection of information about the state of the connection between service consumer and provider.
- ResourceGroup stringName 
- The name of the resource group within the user's subscription. The name is case insensitive.
- PrivateEndpoint stringConnection Name 
- The name of the private endpoint connection associated with the Azure resource
- AccountName string
- The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only.
- PrivateLink PrivateService Connection State Link Service Connection State Args 
- A collection of information about the state of the connection between service consumer and provider.
- ResourceGroup stringName 
- The name of the resource group within the user's subscription. The name is case insensitive.
- PrivateEndpoint stringConnection Name 
- The name of the private endpoint connection associated with the Azure resource
- accountName String
- The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only.
- privateLink PrivateService Connection State Link Service Connection State 
- A collection of information about the state of the connection between service consumer and provider.
- resourceGroup StringName 
- The name of the resource group within the user's subscription. The name is case insensitive.
- privateEndpoint StringConnection Name 
- The name of the private endpoint connection associated with the Azure resource
- accountName string
- The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only.
- privateLink PrivateService Connection State Link Service Connection State 
- A collection of information about the state of the connection between service consumer and provider.
- resourceGroup stringName 
- The name of the resource group within the user's subscription. The name is case insensitive.
- privateEndpoint stringConnection Name 
- The name of the private endpoint connection associated with the Azure resource
- account_name str
- The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only.
- private_link_ Privateservice_ connection_ state Link Service Connection State Args 
- A collection of information about the state of the connection between service consumer and provider.
- resource_group_ strname 
- The name of the resource group within the user's subscription. The name is case insensitive.
- private_endpoint_ strconnection_ name 
- The name of the private endpoint connection associated with the Azure resource
- accountName String
- The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only.
- privateLink Property MapService Connection State 
- A collection of information about the state of the connection between service consumer and provider.
- resourceGroup StringName 
- The name of the resource group within the user's subscription. The name is case insensitive.
- privateEndpoint StringConnection Name 
- 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.
- Type string
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- PrivateEndpoint Pulumi.Azure Native. Storage. Outputs. Private Endpoint Response 
- 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.
- Type string
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- PrivateEndpoint PrivateEndpoint Response 
- 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.
- type String
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- privateEndpoint PrivateEndpoint Response 
- 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.
- type string
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- privateEndpoint PrivateEndpoint Response 
- 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.
- type str
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- private_endpoint PrivateEndpoint Response 
- 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.
- 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
- PrivateEndpoint Service Connection Status Pending 
- Pending
- PrivateEndpoint Service Connection Status Approved 
- Approved
- PrivateEndpoint Service Connection Status Rejected 
- 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          
- ActionRequired 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.Azure Native. Storage. Private Endpoint Service Connection Status 
- Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.
- ActionRequired 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 | PrivateEndpoint Service Connection Status 
- Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.
- actionRequired 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 | PrivateEndpoint Service Connection Status 
- Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.
- actionRequired 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 | PrivateEndpoint Service Connection Status 
- Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.
- action_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 | PrivateEndpoint Service Connection Status 
- Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.
- actionRequired 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            
- ActionRequired 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.
- ActionRequired 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.
- actionRequired 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.
- actionRequired 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.
- action_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.
- actionRequired 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.
Import
An existing resource can be imported using its type token, name, and identifier, e.g.
$ pulumi import azure-native:storage:PrivateEndpointConnection {privateEndpointConnectionName} /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/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