Share via

Microsoft.Web sites/privateEndpointConnections 2021-01-15

  • Article

Bicep resource definition

The sites/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.Web/sites/privateEndpointConnections resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.Web/sites/privateEndpointConnections@2021-01-15' = {
  kind: 'string'
  name: 'string'
  properties: {
    ipAddresses: [
      'string'
    ]
    privateEndpoint: {}
    privateLinkServiceConnectionState: {
      actionsRequired: 'string'
      description: 'string'
      status: 'string'
    }
  }
}

Property values

ArmIdWrapper

Name Description Value

Microsoft.Web/sites/privateEndpointConnections

Name Description Value
kind Kind of resource. string
name The resource name 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: sites
properties RemotePrivateEndpointConnectionARMResource resource specific properties RemotePrivateEndpointConnectionARMResourceProperties

PrivateLinkConnectionState

Name Description Value
actionsRequired ActionsRequired for a private link connection string
description Description of a private link connection string
status Status of a private link connection string

RemotePrivateEndpointConnectionARMResourceProperties

Name Description Value
ipAddresses Private IPAddresses mapped to the remote private endpoint string[]
privateEndpoint PrivateEndpoint of a remote private endpoint connection ArmIdWrapper
privateLinkServiceConnectionState The state of a private link connection PrivateLinkConnectionState

ARM template resource definition

The sites/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.Web/sites/privateEndpointConnections resource, add the following JSON to your template.

{
  "type": "Microsoft.Web/sites/privateEndpointConnections",
  "apiVersion": "2021-01-15",
  "name": "string",
  "kind": "string",
  "properties": {
    "ipAddresses": [ "string" ],
    "privateEndpoint": {
    },
    "privateLinkServiceConnectionState": {
      "actionsRequired": "string",
      "description": "string",
      "status": "string"
    }
  }
}

Property values

ArmIdWrapper

Name Description Value

Microsoft.Web/sites/privateEndpointConnections

Name Description Value
apiVersion The api version '2021-01-15'
kind Kind of resource. string
name The resource name string (required)
properties RemotePrivateEndpointConnectionARMResource resource specific properties RemotePrivateEndpointConnectionARMResourceProperties
type The resource type 'Microsoft.Web/sites/privateEndpointConnections'

PrivateLinkConnectionState

Name Description Value
actionsRequired ActionsRequired for a private link connection string
description Description of a private link connection string
status Status of a private link connection string

RemotePrivateEndpointConnectionARMResourceProperties

Name Description Value
ipAddresses Private IPAddresses mapped to the remote private endpoint string[]
privateEndpoint PrivateEndpoint of a remote private endpoint connection ArmIdWrapper
privateLinkServiceConnectionState The state of a private link connection PrivateLinkConnectionState

Terraform (AzAPI provider) resource definition

The sites/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.Web/sites/privateEndpointConnections resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Web/sites/privateEndpointConnections@2021-01-15"
  name = "string"
  kind = "string"
  body = jsonencode({
    properties = {
      ipAddresses = [
        "string"
      ]
      privateEndpoint = {
      }
      privateLinkServiceConnectionState = {
        actionsRequired = "string"
        description = "string"
        status = "string"
      }
    }
  })
}

Property values

ArmIdWrapper

Name Description Value

Microsoft.Web/sites/privateEndpointConnections

Name Description Value
kind Kind of resource. string
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: sites
properties RemotePrivateEndpointConnectionARMResource resource specific properties RemotePrivateEndpointConnectionARMResourceProperties
type The resource type "Microsoft.Web/sites/privateEndpointConnections@2021-01-15"

PrivateLinkConnectionState

Name Description Value
actionsRequired ActionsRequired for a private link connection string
description Description of a private link connection string
status Status of a private link connection string

RemotePrivateEndpointConnectionARMResourceProperties

Name Description Value
ipAddresses Private IPAddresses mapped to the remote private endpoint string[]
privateEndpoint PrivateEndpoint of a remote private endpoint connection ArmIdWrapper
privateLinkServiceConnectionState The state of a private link connection PrivateLinkConnectionState