Share via

Microsoft.RecoveryServices vaults/privateEndpointConnections

  • Article

Bicep resource definition

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

resource symbolicname 'Microsoft.RecoveryServices/vaults/privateEndpointConnections@2024-04-30-preview' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  parent: resourceSymbolicName
  eTag: 'string'
  properties: {
    groupIds: [
      'string'
    ]
    groupIds: [
      'string'
    ]
    privateEndpoint: {
      id: 'string'
    }
    privateLinkServiceConnectionState: {
      actionsRequired: 'string'
      description: 'string'
      status: 'string'
    }
    provisioningState: 'string'
  }
}

Property values

vaults/privateEndpointConnections

Name Description Value
name The resource name

See how to set names and types for child resources in Bicep.		 string (required)
location Resource location. string
tags Resource tags. Dictionary of tag names and values. See Tags in templates
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: vaults
eTag Optional ETag. string
properties PrivateEndpointConnectionResource properties PrivateEndpointConnection

PrivateEndpointConnection

Name Description Value
groupIds Group Ids for the Private Endpoint String array containing any of:
'AzureBackup'
'AzureBackup_secondary'
'AzureSiteRecovery'
groupIds Group Ids for the Private Endpoint String array containing any of:
'AzureBackup'
'AzureBackup_secondary'
'AzureSiteRecovery'
privateEndpoint Gets or sets private endpoint associated with the private endpoint connection PrivateEndpoint
privateLinkServiceConnectionState Gets or sets private link service connection state PrivateLinkServiceConnectionState
provisioningState Gets or sets provisioning state of the private endpoint connection 'Deleting'
'Failed'
'Pending'
'Succeeded'

PrivateEndpoint

Name Description Value
id Gets or sets id string

PrivateLinkServiceConnectionState

Name Description Value
actionsRequired Gets or sets actions required string
description Gets or sets description string
status Gets or sets the status 'Approved'
'Disconnected'
'Pending'
'Rejected'

ARM template resource definition

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

{
  "type": "Microsoft.RecoveryServices/vaults/privateEndpointConnections",
  "apiVersion": "2024-04-30-preview",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "eTag": "string",
  "properties": {
    "groupIds": [ "string" ],
    "groupIds": [ "string" ],
    "privateEndpoint": {
      "id": "string"
    },
    "privateLinkServiceConnectionState": {
      "actionsRequired": "string",
      "description": "string",
      "status": "string"
    },
    "provisioningState": "string"
  }
}

Property values

vaults/privateEndpointConnections

Name Description Value
type The resource type 'Microsoft.RecoveryServices/vaults/privateEndpointConnections'
apiVersion The resource api version '2024-04-30-preview'
name The resource name

See how to set names and types for child resources in JSON ARM templates.		 string (required)
location Resource location. string
tags Resource tags. Dictionary of tag names and values. See Tags in templates
eTag Optional ETag. string
properties PrivateEndpointConnectionResource properties PrivateEndpointConnection

PrivateEndpointConnection

Name Description Value
groupIds Group Ids for the Private Endpoint String array containing any of:
'AzureBackup'
'AzureBackup_secondary'
'AzureSiteRecovery'
groupIds Group Ids for the Private Endpoint String array containing any of:
'AzureBackup'
'AzureBackup_secondary'
'AzureSiteRecovery'
privateEndpoint Gets or sets private endpoint associated with the private endpoint connection PrivateEndpoint
privateLinkServiceConnectionState Gets or sets private link service connection state PrivateLinkServiceConnectionState
provisioningState Gets or sets provisioning state of the private endpoint connection 'Deleting'
'Failed'
'Pending'
'Succeeded'

PrivateEndpoint

Name Description Value
id Gets or sets id string

PrivateLinkServiceConnectionState

Name Description Value
actionsRequired Gets or sets actions required string
description Gets or sets description string
status Gets or sets the status 'Approved'
'Disconnected'
'Pending'
'Rejected'

Terraform (AzAPI provider) resource definition

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.RecoveryServices/vaults/privateEndpointConnections@2024-04-30-preview"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  body = jsonencode({
    properties = {
      groupIds = [
        "string"
      ]
      groupIds = [
        "string"
      ]
      privateEndpoint = {
        id = "string"
      }
      privateLinkServiceConnectionState = {
        actionsRequired = "string"
        description = "string"
        status = "string"
      }
      provisioningState = "string"
    }
    eTag = "string"
  })
}

Property values

vaults/privateEndpointConnections

Name Description Value
type The resource type "Microsoft.RecoveryServices/vaults/privateEndpointConnections@2024-04-30-preview"
name The resource name string (required)
location Resource location. string
parent_id The ID of the resource that is the parent for this resource. ID for resource of type: vaults
tags Resource tags. Dictionary of tag names and values.
eTag Optional ETag. string
properties PrivateEndpointConnectionResource properties PrivateEndpointConnection

PrivateEndpointConnection

Name Description Value
groupIds Group Ids for the Private Endpoint String array containing any of:
"AzureBackup"
"AzureBackup_secondary"
"AzureSiteRecovery"
groupIds Group Ids for the Private Endpoint String array containing any of:
"AzureBackup"
"AzureBackup_secondary"
"AzureSiteRecovery"
privateEndpoint Gets or sets private endpoint associated with the private endpoint connection PrivateEndpoint
privateLinkServiceConnectionState Gets or sets private link service connection state PrivateLinkServiceConnectionState
provisioningState Gets or sets provisioning state of the private endpoint connection "Deleting"
"Failed"
"Pending"
"Succeeded"

PrivateEndpoint

Name Description Value
id Gets or sets id string

PrivateLinkServiceConnectionState

Name Description Value
actionsRequired Gets or sets actions required string
description Gets or sets description string
status Gets or sets the status "Approved"
"Disconnected"
"Pending"
"Rejected"