Microsoft.Network applicationGateways/privateEndpointConnections 2022-01-01
Bicep resource definition
The applicationGateways/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.Network/applicationGateways/privateEndpointConnections resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.Network/applicationGateways/privateEndpointConnections@2022-01-01' = {
name: 'string'
properties: {
privateLinkServiceConnectionState: {
actionsRequired: 'string'
description: 'string'
status: 'string'
}
}
}
Property values
ApplicationGatewayPrivateEndpointConnectionProperties
| Name | Description | Value |
|---|---|---|
| privateLinkServiceConnectionState | A collection of information about the state of the connection between service consumer and provider. | PrivateLinkServiceConnectionState |
Microsoft.Network/applicationGateways/privateEndpointConnections
| Name | Description | Value |
|---|---|---|
| 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: applicationGateways |
| properties | Properties of the application gateway private endpoint connection. | ApplicationGatewayPrivateEndpointConnectionProperties |
PrivateLinkServiceConnectionState
| Name | Description | Value |
|---|---|---|
| actionsRequired | 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. | string |
ARM template resource definition
The applicationGateways/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.Network/applicationGateways/privateEndpointConnections resource, add the following JSON to your template.
{
"type": "Microsoft.Network/applicationGateways/privateEndpointConnections",
"apiVersion": "2022-01-01",
"name": "string",
"properties": {
"privateLinkServiceConnectionState": {
"actionsRequired": "string",
"description": "string",
"status": "string"
}
}
}
Property values
ApplicationGatewayPrivateEndpointConnectionProperties
| Name | Description | Value |
|---|---|---|
| privateLinkServiceConnectionState | A collection of information about the state of the connection between service consumer and provider. | PrivateLinkServiceConnectionState |
Microsoft.Network/applicationGateways/privateEndpointConnections
| Name | Description | Value |
|---|---|---|
| apiVersion | The api version | '2022-01-01' |
| name | The resource name | string (required) |
| properties | Properties of the application gateway private endpoint connection. | ApplicationGatewayPrivateEndpointConnectionProperties |
| type | The resource type | 'Microsoft.Network/applicationGateways/privateEndpointConnections' |
PrivateLinkServiceConnectionState
| Name | Description | Value |
|---|---|---|
| actionsRequired | 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. | string |
Terraform (AzAPI provider) resource definition
The applicationGateways/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.Network/applicationGateways/privateEndpointConnections resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Network/applicationGateways/privateEndpointConnections@2022-01-01"
name = "string"
body = jsonencode({
properties = {
privateLinkServiceConnectionState = {
actionsRequired = "string"
description = "string"
status = "string"
}
}
})
}
Property values
ApplicationGatewayPrivateEndpointConnectionProperties
| Name | Description | Value |
|---|---|---|
| privateLinkServiceConnectionState | A collection of information about the state of the connection between service consumer and provider. | PrivateLinkServiceConnectionState |
Microsoft.Network/applicationGateways/privateEndpointConnections
| Name | Description | Value |
|---|---|---|
| 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: applicationGateways |
| properties | Properties of the application gateway private endpoint connection. | ApplicationGatewayPrivateEndpointConnectionProperties |
| type | The resource type | "Microsoft.Network/applicationGateways/privateEndpointConnections@2022-01-01" |
PrivateLinkServiceConnectionState
| Name | Description | Value |
|---|---|---|
| actionsRequired | 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. | string |