Microsoft.Network vpnGateways/vpnConnections/vpnLinkConnections/sharedKeys 2024-05-01
Bicep resource definition
The vpnGateways/vpnConnections/vpnLinkConnections/sharedKeys 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.Network/vpnGateways/vpnConnections/vpnLinkConnections/sharedKeys resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.Network/vpnGateways/vpnConnections/vpnLinkConnections/sharedKeys@2024-05-01' = {
parent: resourceSymbolicName
name: 'default'
properties: {
sharedKey: 'string'
sharedKeyLength: int
}
}
Property values
Microsoft.Network/vpnGateways/vpnConnections/vpnLinkConnections/sharedKeys
| Name | Description | Value |
|---|---|---|
| name | The resource name | 'default' (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: vpnGateways/vpnConnections/vpnLinkConnections |
| properties | Properties of the shared key. | SharedKeyProperties |
SharedKeyProperties
| Name | Description | Value |
|---|---|---|
| sharedKey | The value of the shared key for the vpn link connection. | string Constraints: Sensitive value. Pass in as a secure parameter. |
| sharedKeyLength | The length of the shared key for the vpn link connection. | int Constraints: Min value = 1 Max value = 128 |
ARM template resource definition
The vpnGateways/vpnConnections/vpnLinkConnections/sharedKeys 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.Network/vpnGateways/vpnConnections/vpnLinkConnections/sharedKeys resource, add the following JSON to your template.
{
"type": "Microsoft.Network/vpnGateways/vpnConnections/vpnLinkConnections/sharedKeys",
"apiVersion": "2024-05-01",
"name": "string",
"properties": {
"sharedKey": "string",
"sharedKeyLength": "int"
}
}
Property values
Microsoft.Network/vpnGateways/vpnConnections/vpnLinkConnections/sharedKeys
| Name | Description | Value |
|---|---|---|
| apiVersion | The api version | '2024-05-01' |
| name | The resource name | 'default' (required) |
| properties | Properties of the shared key. | SharedKeyProperties |
| type | The resource type | 'Microsoft.Network/vpnGateways/vpnConnections/vpnLinkConnections/sharedKeys' |
SharedKeyProperties
| Name | Description | Value |
|---|---|---|
| sharedKey | The value of the shared key for the vpn link connection. | string Constraints: Sensitive value. Pass in as a secure parameter. |
| sharedKeyLength | The length of the shared key for the vpn link connection. | int Constraints: Min value = 1 Max value = 128 |
Terraform (AzAPI provider) resource definition
The vpnGateways/vpnConnections/vpnLinkConnections/sharedKeys 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.Network/vpnGateways/vpnConnections/vpnLinkConnections/sharedKeys resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Network/vpnGateways/vpnConnections/vpnLinkConnections/sharedKeys@2024-05-01"
name = "string"
body = jsonencode({
properties = {
sharedKey = "string"
sharedKeyLength = int
}
})
}
Property values
Microsoft.Network/vpnGateways/vpnConnections/vpnLinkConnections/sharedKeys
| Name | Description | Value |
|---|---|---|
| name | The resource name | 'default' (required) |
| parent_id | The ID of the resource that is the parent for this resource. | ID for resource of type: vpnGateways/vpnConnections/vpnLinkConnections |
| properties | Properties of the shared key. | SharedKeyProperties |
| type | The resource type | "Microsoft.Network/vpnGateways/vpnConnections/vpnLinkConnections/sharedKeys@2024-05-01" |
SharedKeyProperties
| Name | Description | Value |
|---|---|---|
| sharedKey | The value of the shared key for the vpn link connection. | string Constraints: Sensitive value. Pass in as a secure parameter. |
| sharedKeyLength | The length of the shared key for the vpn link connection. | int Constraints: Min value = 1 Max value = 128 |