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 virtualMachines/consoles 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.NetworkCloud/virtualMachines/consoles resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.NetworkCloud/virtualMachines/consoles@2026-07-01' = {
parent: resourceSymbolicName
extendedLocation: {
name: 'string'
type: 'string'
}
location: 'string'
name: 'string'
properties: {
enabled: 'string'
expiration: 'string'
sshPublicKey: {
keyData: 'string'
}
}
tags: {
{customized property}: 'string'
}
}
Property Values
Microsoft.NetworkCloud/virtualMachines/consoles
| Name | Description | Value |
|---|---|---|
| extendedLocation | The extended location of the resource. This property is required when creating the resource. | AzureResourceManagerCommonTypesExtendedLocation (required) |
| location | The geo-location where the resource lives | string (required) |
| name | The resource name | string Constraints: Pattern = ^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: virtualMachines |
| properties | The list of the resource properties. | ConsoleProperties (required) |
| tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
AzureResourceManagerCommonTypesExtendedLocation
| Name | Description | Value |
|---|---|---|
| name | The name of the extended location. | string (required) |
| type | The type of the extended location. | 'CustomLocation' 'EdgeZone' (required) |
ConsoleProperties
| Name | Description | Value |
|---|---|---|
| enabled | The indicator of whether the console access is enabled. | 'False' 'True' (required) |
| expiration | The date and time after which the key will be disallowed access. | string |
| sshPublicKey | The SSH public key that will be provisioned for user access. The user is expected to have the corresponding SSH private key for logging in. | SshPublicKey (required) |
SshPublicKey
| Name | Description | Value |
|---|---|---|
| keyData | The SSH public key data. | string Constraints: Min length = 1 (required) |
TrackedResourceTags
| Name | Description | Value |
|---|
ARM template resource definition
The virtualMachines/consoles 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.NetworkCloud/virtualMachines/consoles resource, add the following JSON to your template.
{
"type": "Microsoft.NetworkCloud/virtualMachines/consoles",
"apiVersion": "2026-07-01",
"name": "string",
"extendedLocation": {
"name": "string",
"type": "string"
},
"location": "string",
"properties": {
"enabled": "string",
"expiration": "string",
"sshPublicKey": {
"keyData": "string"
}
},
"tags": {
"{customized property}": "string"
}
}
Property Values
Microsoft.NetworkCloud/virtualMachines/consoles
| Name | Description | Value |
|---|---|---|
| apiVersion | The api version | '2026-07-01' |
| extendedLocation | The extended location of the resource. This property is required when creating the resource. | AzureResourceManagerCommonTypesExtendedLocation (required) |
| location | The geo-location where the resource lives | string (required) |
| name | The resource name | string Constraints: Pattern = ^default$ (required) |
| properties | The list of the resource properties. | ConsoleProperties (required) |
| tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
| type | The resource type | 'Microsoft.NetworkCloud/virtualMachines/consoles' |
AzureResourceManagerCommonTypesExtendedLocation
| Name | Description | Value |
|---|---|---|
| name | The name of the extended location. | string (required) |
| type | The type of the extended location. | 'CustomLocation' 'EdgeZone' (required) |
ConsoleProperties
| Name | Description | Value |
|---|---|---|
| enabled | The indicator of whether the console access is enabled. | 'False' 'True' (required) |
| expiration | The date and time after which the key will be disallowed access. | string |
| sshPublicKey | The SSH public key that will be provisioned for user access. The user is expected to have the corresponding SSH private key for logging in. | SshPublicKey (required) |
SshPublicKey
| Name | Description | Value |
|---|---|---|
| keyData | The SSH public key data. | string Constraints: Min length = 1 (required) |
TrackedResourceTags
| Name | Description | Value |
|---|
Terraform (AzAPI provider) resource definition
The virtualMachines/consoles 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.NetworkCloud/virtualMachines/consoles resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.NetworkCloud/virtualMachines/consoles@2026-07-01"
name = "string"
parent_id = "string"
location = "string"
tags = {
{customized property} = "string"
}
body = {
extendedLocation = {
name = "string"
type = "string"
}
properties = {
enabled = "string"
expiration = "string"
sshPublicKey = {
keyData = "string"
}
}
}
}
Property Values
Microsoft.NetworkCloud/virtualMachines/consoles
| Name | Description | Value |
|---|---|---|
| extendedLocation | The extended location of the resource. This property is required when creating the resource. | AzureResourceManagerCommonTypesExtendedLocation (required) |
| location | The geo-location where the resource lives | string (required) |
| name | The resource name | string Constraints: Pattern = ^default$ (required) |
| parent_id | The ID of the resource that is the parent for this resource. | ID for resource of type: virtualMachines |
| properties | The list of the resource properties. | ConsoleProperties (required) |
| tags | Resource tags | Dictionary of tag names and values. |
| type | The resource type | "Microsoft.NetworkCloud/virtualMachines/consoles@2026-07-01" |
AzureResourceManagerCommonTypesExtendedLocation
| Name | Description | Value |
|---|---|---|
| name | The name of the extended location. | string (required) |
| type | The type of the extended location. | 'CustomLocation' 'EdgeZone' (required) |
ConsoleProperties
| Name | Description | Value |
|---|---|---|
| enabled | The indicator of whether the console access is enabled. | 'False' 'True' (required) |
| expiration | The date and time after which the key will be disallowed access. | string |
| sshPublicKey | The SSH public key that will be provisioned for user access. The user is expected to have the corresponding SSH private key for logging in. | SshPublicKey (required) |
SshPublicKey
| Name | Description | Value |
|---|---|---|
| keyData | The SSH public key data. | string Constraints: Min length = 1 (required) |
TrackedResourceTags
| Name | Description | Value |
|---|