Microsoft.ApiManagement gateways/configConnections 2024-06-01-preview
Bicep resource definition
The gateways/configConnections 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/gateways/configConnections resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.ApiManagement/gateways/configConnections@2024-06-01-preview' = {
parent: resourceSymbolicName
name: 'string'
properties: {
hostnames: [
'string'
]
sourceId: 'string'
}
}
Property values
GatewayConfigConnectionBaseProperties
| Name | Description | Value |
|---|---|---|
| hostnames | The hostnames of the data-plane gateway to which requests can be sent. | string[] |
| sourceId | The link to the API Management service workspace. | string |
Microsoft.ApiManagement/gateways/configConnections
| Name | Description | Value |
|---|---|---|
| name | The resource name | string Constraints: Min length = 1 Max length = 1 Pattern = ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$ (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: gateways |
| properties | Properties of the API Management gateway config connection. | GatewayConfigConnectionBaseProperties (required) |
ARM template resource definition
The gateways/configConnections 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/gateways/configConnections resource, add the following JSON to your template.
{
"type": "Microsoft.ApiManagement/gateways/configConnections",
"apiVersion": "2024-06-01-preview",
"name": "string",
"properties": {
"hostnames": [ "string" ],
"sourceId": "string"
}
}
Property values
GatewayConfigConnectionBaseProperties
| Name | Description | Value |
|---|---|---|
| hostnames | The hostnames of the data-plane gateway to which requests can be sent. | string[] |
| sourceId | The link to the API Management service workspace. | string |
Microsoft.ApiManagement/gateways/configConnections
| Name | Description | Value |
|---|---|---|
| apiVersion | The api version | '2024-06-01-preview' |
| name | The resource name | string Constraints: Min length = 1 Max length = 1 Pattern = ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$ (required) |
| properties | Properties of the API Management gateway config connection. | GatewayConfigConnectionBaseProperties (required) |
| type | The resource type | 'Microsoft.ApiManagement/gateways/configConnections' |
Terraform (AzAPI provider) resource definition
The gateways/configConnections 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/gateways/configConnections resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.ApiManagement/gateways/configConnections@2024-06-01-preview"
name = "string"
body = jsonencode({
properties = {
hostnames = [
"string"
]
sourceId = "string"
}
})
}
Property values
GatewayConfigConnectionBaseProperties
| Name | Description | Value |
|---|---|---|
| hostnames | The hostnames of the data-plane gateway to which requests can be sent. | string[] |
| sourceId | The link to the API Management service workspace. | string |
Microsoft.ApiManagement/gateways/configConnections
| Name | Description | Value |
|---|---|---|
| name | The resource name | string Constraints: Min length = 1 Max length = 1 Pattern = ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$ (required) |
| parent_id | The ID of the resource that is the parent for this resource. | ID for resource of type: gateways |
| properties | Properties of the API Management gateway config connection. | GatewayConfigConnectionBaseProperties (required) |
| type | The resource type | "Microsoft.ApiManagement/gateways/configConnections@2024-06-01-preview" |