Microsoft.Network privateLinkServices/privateEndpointConnections 2024-05-01

• Latest
• 2024-05-01
• 2024-03-01
• 2024-01-01
• 2023-11-01
• 2023-09-01
• 2023-06-01
• 2023-05-01
• 2023-04-01
• 2023-02-01
• 2022-11-01
• 2022-09-01
• 2022-07-01
• 2022-05-01
• 2022-01-01
• 2021-08-01
• 2021-05-01
• 2021-03-01
• 2021-02-01
• 2020-11-01
• 2020-08-01
• 2020-07-01
• 2020-06-01
• 2020-05-01
• 2020-04-01
• 2020-03-01
• 2019-12-01
• 2019-11-01
• 2019-09-01
• 2019-08-01
• 2019-07-01
• 2019-06-01
• 2019-04-01

Bicep resource definition

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

resource symbolicname 'Microsoft.Network/privateLinkServices/privateEndpointConnections@2024-05-01' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    privateLinkServiceConnectionState: {
      actionsRequired: 'string'
      description: 'string'
      status: 'string'
    }
  }
}

Property values

Microsoft.Network/privateLinkServices/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: privateLinkServices
properties	Properties of the private end point connection.	PrivateEndpointConnectionProperties

PrivateEndpointConnectionProperties

Name	Description	Value
privateLinkServiceConnectionState	A collection of information about the state of the connection between service consumer and provider.	PrivateLinkServiceConnectionState

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

{
  "type": "Microsoft.Network/privateLinkServices/privateEndpointConnections",
  "apiVersion": "2024-05-01",
  "name": "string",
  "properties": {
    "privateLinkServiceConnectionState": {
      "actionsRequired": "string",
      "description": "string",
      "status": "string"
    }
  }
}

Property values

Microsoft.Network/privateLinkServices/privateEndpointConnections

Name	Description	Value
apiVersion	The api version	'2024-05-01'
name	The resource name	string (required)
properties	Properties of the private end point connection.	PrivateEndpointConnectionProperties
type	The resource type	'Microsoft.Network/privateLinkServices/privateEndpointConnections'

PrivateEndpointConnectionProperties

Name	Description	Value
privateLinkServiceConnectionState	A collection of information about the state of the connection between service consumer and provider.	PrivateLinkServiceConnectionState

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Network/privateLinkServices/privateEndpointConnections@2024-05-01"
  name = "string"
  body = jsonencode({
    properties = {
      privateLinkServiceConnectionState = {
        actionsRequired = "string"
        description = "string"
        status = "string"
      }
    }
  })
}

Property values

Microsoft.Network/privateLinkServices/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: privateLinkServices
properties	Properties of the private end point connection.	PrivateEndpointConnectionProperties
type	The resource type	"Microsoft.Network/privateLinkServices/privateEndpointConnections@2024-05-01"

PrivateEndpointConnectionProperties

Name	Description	Value
privateLinkServiceConnectionState	A collection of information about the state of the connection between service consumer and provider.	PrivateLinkServiceConnectionState

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