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 service/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.ApiManagement/service/privateEndpointConnections resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.ApiManagement/service/privateEndpointConnections@2023-09-01-preview' = {
parent: resourceSymbolicName
name: 'string'
properties: {
privateLinkServiceConnectionState: {
actionsRequired: 'string'
description: 'string'
status: 'string'
}
}
}
Property Values
Microsoft.ApiManagement/service/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: service |
| properties | The connection state of the private endpoint connection. | PrivateEndpointConnectionRequestPropertiesOrPrivateEndpointConnectionProperties |
PrivateEndpointConnectionRequestPropertiesOrPrivateEndpointConnectionProperties
| 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. | 'Approved' 'Pending' 'Rejected' |
ARM template resource definition
The service/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.ApiManagement/service/privateEndpointConnections resource, add the following JSON to your template.
{
"type": "Microsoft.ApiManagement/service/privateEndpointConnections",
"apiVersion": "2023-09-01-preview",
"name": "string",
"properties": {
"privateLinkServiceConnectionState": {
"actionsRequired": "string",
"description": "string",
"status": "string"
}
}
}
Property Values
Microsoft.ApiManagement/service/privateEndpointConnections
| Name | Description | Value |
|---|---|---|
| apiVersion | The api version | '2023-09-01-preview' |
| name | The resource name | string (required) |
| properties | The connection state of the private endpoint connection. | PrivateEndpointConnectionRequestPropertiesOrPrivateEndpointConnectionProperties |
| type | The resource type | 'Microsoft.ApiManagement/service/privateEndpointConnections' |
PrivateEndpointConnectionRequestPropertiesOrPrivateEndpointConnectionProperties
| 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. | 'Approved' 'Pending' 'Rejected' |
Usage Examples
Terraform (AzAPI provider) resource definition
The service/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.ApiManagement/service/privateEndpointConnections resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.ApiManagement/service/privateEndpointConnections@2023-09-01-preview"
name = "string"
body = {
properties = {
privateLinkServiceConnectionState = {
actionsRequired = "string"
description = "string"
status = "string"
}
}
}
}
Property Values
Microsoft.ApiManagement/service/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: service |
| properties | The connection state of the private endpoint connection. | PrivateEndpointConnectionRequestPropertiesOrPrivateEndpointConnectionProperties |
| type | The resource type | "Microsoft.ApiManagement/service/privateEndpointConnections@2023-09-01-preview" |
PrivateEndpointConnectionRequestPropertiesOrPrivateEndpointConnectionProperties
| 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. | 'Approved' 'Pending' 'Rejected' |