Microsoft.Web hostingEnvironments/privateEndpointConnections 2024-04-01

• Latest
• 2024-11-01
• 2024-04-01
• 2023-12-01
• 2023-01-01
• 2022-09-01
• 2022-03-01
• 2021-03-01
• 2021-02-01
• 2021-01-15
• 2021-01-01
• 2020-12-01

Bicep resource definition

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

• Resource groups - See resource group deployment commands

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

Resource format

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

resource symbolicname 'Microsoft.Web/hostingEnvironments/privateEndpointConnections@2024-04-01' = {
  parent: resourceSymbolicName
  kind: 'string'
  name: 'string'
  properties: {
    ipAddresses: [
      'string'
    ]
    privateEndpoint: {}
    privateLinkServiceConnectionState: {
      actionsRequired: 'string'
      description: 'string'
      status: 'string'
    }
  }
}

Property Values

Microsoft.Web/hostingEnvironments/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: hostingEnvironments
properties	RemotePrivateEndpointConnectionARMResource resource specific properties	RemotePrivateEndpointConnectionARMResourceProperties

ArmIdWrapper

Name	Description	Value

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 hostingEnvironments/privateEndpointConnections resource type can be deployed with operations that target:

• Resource groups - See resource group deployment commands

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

Resource format

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

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

Property Values

Microsoft.Web/hostingEnvironments/privateEndpointConnections

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

ArmIdWrapper

Name	Description	Value

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

Usage Examples

Terraform (AzAPI provider) resource definition

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Web/hostingEnvironments/privateEndpointConnections@2024-04-01"
  name = "string"
  parent_id = "string"
  body = {
    kind = "string"
    properties = {
      ipAddresses = [
        "string"
      ]
      privateEndpoint = {
      }
      privateLinkServiceConnectionState = {
        actionsRequired = "string"
        description = "string"
        status = "string"
      }
    }
  }
}

Property Values

Microsoft.Web/hostingEnvironments/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: hostingEnvironments
properties	RemotePrivateEndpointConnectionARMResource resource specific properties	RemotePrivateEndpointConnectionARMResourceProperties
type	The resource type	"Microsoft.Web/hostingEnvironments/privateEndpointConnections@2024-04-01"

ArmIdWrapper

Name	Description	Value

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