microsoft.aadiam privateLinkForAzureAd/privateEndpointConnections 2020-03-01

• Latest
• 2020-03-01

Bicep resource definition

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

resource symbolicname 'microsoft.aadiam/privateLinkForAzureAd/privateEndpointConnections@2020-03-01' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    privateEndpoint: {
      id: 'string'
    }
    privateLinkConnectionTags: {
      tags: {
        {customized property}: 'string'
      }
    }
    privateLinkServiceConnectionState: {
      actionsRequired: 'string'
      description: 'string'
      status: 'string'
    }
  }
}

Property Values

microsoft.aadiam/privateLinkForAzureAd/privateEndpointConnections

Name	Description	Value
name	The resource name	string Constraints: Min length = 1 (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: privateLinkForAzureAd
properties	Resource properties.	PrivateEndpointConnectionProperties

PrivateEndpoint

Name	Description	Value
id	Full identifier of the private endpoint resource.	string

PrivateEndpointConnectionProperties

Name	Description	Value
privateEndpoint	Properties of the private endpoint object.	PrivateEndpoint
privateLinkConnectionTags	Updated tag information to set into the PrivateLinkConnection instance.	TagsResource
privateLinkServiceConnectionState	Approval state of the private link connection.	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 or rejection.	string
status	Indicates whether the connection has been approved, rejected or removed by the given policy owner.	'Approved' 'Disconnected' 'Pending' 'Rejected'

TagsResource

Name	Description	Value
tags	Resource tags	TagsResourceTags

TagsResourceTags

Name	Description	Value

ARM template resource definition

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

{
  "type": "microsoft.aadiam/privateLinkForAzureAd/privateEndpointConnections",
  "apiVersion": "2020-03-01",
  "name": "string",
  "properties": {
    "privateEndpoint": {
      "id": "string"
    },
    "privateLinkConnectionTags": {
      "tags": {
        "{customized property}": "string"
      }
    },
    "privateLinkServiceConnectionState": {
      "actionsRequired": "string",
      "description": "string",
      "status": "string"
    }
  }
}

Property Values

microsoft.aadiam/privateLinkForAzureAd/privateEndpointConnections

Name	Description	Value
apiVersion	The api version	'2020-03-01'
name	The resource name	string Constraints: Min length = 1 (required)
properties	Resource properties.	PrivateEndpointConnectionProperties
type	The resource type	'microsoft.aadiam/privateLinkForAzureAd/privateEndpointConnections'

PrivateEndpoint

Name	Description	Value
id	Full identifier of the private endpoint resource.	string

PrivateEndpointConnectionProperties

Name	Description	Value
privateEndpoint	Properties of the private endpoint object.	PrivateEndpoint
privateLinkConnectionTags	Updated tag information to set into the PrivateLinkConnection instance.	TagsResource
privateLinkServiceConnectionState	Approval state of the private link connection.	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 or rejection.	string
status	Indicates whether the connection has been approved, rejected or removed by the given policy owner.	'Approved' 'Disconnected' 'Pending' 'Rejected'

TagsResource

Name	Description	Value
tags	Resource tags	TagsResourceTags

TagsResourceTags

Name	Description	Value

Usage Examples

Terraform (AzAPI provider) resource definition

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

resource "azapi_resource" "symbolicname" {
  type = "microsoft.aadiam/privateLinkForAzureAd/privateEndpointConnections@2020-03-01"
  name = "string"
  parent_id = "string"
  body = {
    properties = {
      privateEndpoint = {
        id = "string"
      }
      privateLinkConnectionTags = {
        tags = {
          {customized property} = "string"
        }
      }
      privateLinkServiceConnectionState = {
        actionsRequired = "string"
        description = "string"
        status = "string"
      }
    }
  }
}

Property Values

microsoft.aadiam/privateLinkForAzureAd/privateEndpointConnections

Name	Description	Value
name	The resource name	string Constraints: Min length = 1 (required)
parent_id	The ID of the resource that is the parent for this resource.	ID for resource of type: privateLinkForAzureAd
properties	Resource properties.	PrivateEndpointConnectionProperties
type	The resource type	"microsoft.aadiam/privateLinkForAzureAd/privateEndpointConnections@2020-03-01"

PrivateEndpoint

Name	Description	Value
id	Full identifier of the private endpoint resource.	string

PrivateEndpointConnectionProperties

Name	Description	Value
privateEndpoint	Properties of the private endpoint object.	PrivateEndpoint
privateLinkConnectionTags	Updated tag information to set into the PrivateLinkConnection instance.	TagsResource
privateLinkServiceConnectionState	Approval state of the private link connection.	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 or rejection.	string
status	Indicates whether the connection has been approved, rejected or removed by the given policy owner.	'Approved' 'Disconnected' 'Pending' 'Rejected'

TagsResource

Name	Description	Value
tags	Resource tags	TagsResourceTags

TagsResourceTags

Name	Description	Value