Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
Bicep resource definition
The namespaces/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.Relay/namespaces/privateEndpointConnections resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.Relay/namespaces/privateEndpointConnections@2018-01-01-preview' = {
parent: resourceSymbolicName
location: 'string'
name: 'string'
properties: {
privateEndpoint: {
id: 'string'
}
privateLinkServiceConnectionState: {
actionRequired: 'string'
description: 'string'
status: 'string'
}
}
tags: {
{customized property}: 'string'
}
}
Property Values
Microsoft.Relay/namespaces/privateEndpointConnections
| Name | Description | Value |
|---|---|---|
| location | Resource location. | string (required) |
| 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: namespaces |
| properties | Resource properties. | PrivateEndpointConnectionProperties |
| tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
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 |
| privateLinkServiceConnectionState | Approval state of the private link connection. | PrivateLinkServiceConnectionState |
PrivateLinkServiceConnectionState
| Name | Description | Value |
|---|---|---|
| actionRequired | 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 Relay Namespace owner. | 'Approved' 'Disconnected' 'Pending' 'Rejected' |
TrackedResourceTags
| Name | Description | Value |
|---|
ARM template resource definition
The namespaces/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.
Usage Examples
Resource format
To create a Microsoft.Relay/namespaces/privateEndpointConnections resource, add the following JSON to your template.
{
"type": "Microsoft.Relay/namespaces/privateEndpointConnections",
"apiVersion": "2018-01-01-preview",
"name": "string",
"location": "string",
"properties": {
"privateEndpoint": {
"id": "string"
},
"privateLinkServiceConnectionState": {
"actionRequired": "string",
"description": "string",
"status": "string"
}
},
"tags": {
"{customized property}": "string"
}
}
Property Values
Microsoft.Relay/namespaces/privateEndpointConnections
| Name | Description | Value |
|---|---|---|
| apiVersion | The api version | '2018-01-01-preview' |
| location | Resource location. | string (required) |
| name | The resource name | string Constraints: Min length = 1 (required) |
| properties | Resource properties. | PrivateEndpointConnectionProperties |
| tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
| type | The resource type | 'Microsoft.Relay/namespaces/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 |
| privateLinkServiceConnectionState | Approval state of the private link connection. | PrivateLinkServiceConnectionState |
PrivateLinkServiceConnectionState
| Name | Description | Value |
|---|---|---|
| actionRequired | 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 Relay Namespace owner. | 'Approved' 'Disconnected' 'Pending' 'Rejected' |
TrackedResourceTags
| Name | Description | Value |
|---|
Terraform (AzAPI provider) resource definition
The namespaces/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.Relay/namespaces/privateEndpointConnections resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Relay/namespaces/privateEndpointConnections@2018-01-01-preview"
name = "string"
parent_id = "string"
location = "string"
tags = {
{customized property} = "string"
}
body = {
properties = {
privateEndpoint = {
id = "string"
}
privateLinkServiceConnectionState = {
actionRequired = "string"
description = "string"
status = "string"
}
}
}
}
Property Values
Microsoft.Relay/namespaces/privateEndpointConnections
| Name | Description | Value |
|---|---|---|
| location | Resource location. | string (required) |
| 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: namespaces |
| properties | Resource properties. | PrivateEndpointConnectionProperties |
| tags | Resource tags | Dictionary of tag names and values. |
| type | The resource type | "Microsoft.Relay/namespaces/privateEndpointConnections@2018-01-01-preview" |
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 |
| privateLinkServiceConnectionState | Approval state of the private link connection. | PrivateLinkServiceConnectionState |
PrivateLinkServiceConnectionState
| Name | Description | Value |
|---|---|---|
| actionRequired | 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 Relay Namespace owner. | 'Approved' 'Disconnected' 'Pending' 'Rejected' |
TrackedResourceTags
| Name | Description | Value |
|---|