Share via

Microsoft.Storage storageAccounts/privateEndpointConnections

  • Article

Bicep resource definition

The storageAccounts/privateEndpointConnections resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.Storage/storageAccounts/privateEndpointConnections resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.Storage/storageAccounts/privateEndpointConnections@2023-05-01' = {
  name: 'string'
  parent: resourceSymbolicName
  properties: {
    privateEndpoint: {}
    privateLinkServiceConnectionState: {
      actionRequired: 'string'
      description: 'string'
      status: 'string'
    }
  }
}

Property values

storageAccounts/privateEndpointConnections

Name Description Value
name The resource name

See how to set names and types for child resources in Bicep.		 string (required)
parent In Bicep, you can specify the parent resource for a child resource. You only need to add this property when the child resource is declared outside of the parent resource.

For more information, see Child resource outside parent resource.		 Symbolic name for resource of type: storageAccounts
properties Resource properties. PrivateEndpointConnectionProperties

PrivateEndpointConnectionProperties

Name Description Value
privateEndpoint The resource of private end point. PrivateEndpoint
privateLinkServiceConnectionState A collection of information about the state of the connection between service consumer and provider. PrivateLinkServiceConnectionState (required)

PrivateEndpoint

This object doesn't contain any properties to set during deployment. All properties are ReadOnly.

PrivateLinkServiceConnectionState

Name Description Value
actionRequired A message indicating if changes on the service provider require any updates on the consumer. string
description The reason for approval/rejection of the connection. string
status Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. 'Approved'
'Pending'
'Rejected'

ARM template resource definition

The storageAccounts/privateEndpointConnections resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.Storage/storageAccounts/privateEndpointConnections resource, add the following JSON to your template.

{
  "type": "Microsoft.Storage/storageAccounts/privateEndpointConnections",
  "apiVersion": "2023-05-01",
  "name": "string",
  "properties": {
    "privateEndpoint": {},
    "privateLinkServiceConnectionState": {
      "actionRequired": "string",
      "description": "string",
      "status": "string"
    }
  }
}

Property values

storageAccounts/privateEndpointConnections

Name Description Value
type The resource type 'Microsoft.Storage/storageAccounts/privateEndpointConnections'
apiVersion The resource api version '2023-05-01'
name The resource name

See how to set names and types for child resources in JSON ARM templates.		 string (required)
properties Resource properties. PrivateEndpointConnectionProperties

PrivateEndpointConnectionProperties

Name Description Value
privateEndpoint The resource of private end point. PrivateEndpoint
privateLinkServiceConnectionState A collection of information about the state of the connection between service consumer and provider. PrivateLinkServiceConnectionState (required)

PrivateEndpoint

This object doesn't contain any properties to set during deployment. All properties are ReadOnly.

PrivateLinkServiceConnectionState

Name Description Value
actionRequired A message indicating if changes on the service provider require any updates on the consumer. string
description The reason for approval/rejection of the connection. string
status Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. 'Approved'
'Pending'
'Rejected'

Terraform (AzAPI provider) resource definition

The storageAccounts/privateEndpointConnections resource type can be deployed with operations that target:

  • Resource groups

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.Storage/storageAccounts/privateEndpointConnections resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Storage/storageAccounts/privateEndpointConnections@2023-05-01"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      privateEndpoint = {}
      privateLinkServiceConnectionState = {
        actionRequired = "string"
        description = "string"
        status = "string"
      }
    }
  })
}

Property values

storageAccounts/privateEndpointConnections

Name Description Value
type The resource type "Microsoft.Storage/storageAccounts/privateEndpointConnections@2023-05-01"
name The resource name string (required)
parent_id The ID of the resource that is the parent for this resource. ID for resource of type: storageAccounts
properties Resource properties. PrivateEndpointConnectionProperties

PrivateEndpointConnectionProperties

Name Description Value
privateEndpoint The resource of private end point. PrivateEndpoint
privateLinkServiceConnectionState A collection of information about the state of the connection between service consumer and provider. PrivateLinkServiceConnectionState (required)

PrivateEndpoint

This object doesn't contain any properties to set during deployment. All properties are ReadOnly.

PrivateLinkServiceConnectionState

Name Description Value
actionRequired A message indicating if changes on the service provider require any updates on the consumer. string
description The reason for approval/rejection of the connection. string
status Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. "Approved"
"Pending"
"Rejected"