Microsoft.Portal consoles

Bicep resource definition

The consoles resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.Portal/consoles resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.Portal/consoles@2018-10-01' = {
  name: 'string'
  properties: {
    osType: 'string'
    provisioningState: 'string'
    uri: 'string'
  }
}

Property Values

Microsoft.Portal/consoles

Name Description Value
name The resource name string (required)
properties Cloud shell properties for creating a console. ConsoleCreatePropertiesOrConsoleProperties (required)

ConsoleCreatePropertiesOrConsoleProperties

Name Description Value
osType The operating system type of the cloud shell. 'Linux'
'Windows' (required)
provisioningState Provisioning state of the console. 'Accepted'
'Canceled'
'Creating'
'Failed'
'NotSpecified'
'Pending'
'Repairing'
'Succeeded'
'Updating'
uri Uri of the console. string

ARM template resource definition

The consoles resource type can be deployed with operations that target:

Usage Examples

Resource format

To create a Microsoft.Portal/consoles resource, add the following JSON to your template.

{
  "type": "Microsoft.Portal/consoles",
  "apiVersion": "2018-10-01",
  "name": "string",
  "properties": {
    "osType": "string",
    "provisioningState": "string",
    "uri": "string"
  }
}

Property Values

Microsoft.Portal/consoles

Name Description Value
apiVersion The api version '2018-10-01'
name The resource name string (required)
properties Cloud shell properties for creating a console. ConsoleCreatePropertiesOrConsoleProperties (required)
type The resource type 'Microsoft.Portal/consoles'

ConsoleCreatePropertiesOrConsoleProperties

Name Description Value
osType The operating system type of the cloud shell. 'Linux'
'Windows' (required)
provisioningState Provisioning state of the console. 'Accepted'
'Canceled'
'Creating'
'Failed'
'NotSpecified'
'Pending'
'Repairing'
'Succeeded'
'Updating'
uri Uri of the console. string

Terraform (AzAPI provider) resource definition

The consoles resource type can be deployed with operations that target:

  • Tenant For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.Portal/consoles resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Portal/consoles@2018-10-01"
  name = "string"
  parent_id = "string"
  body = {
    properties = {
      osType = "string"
      provisioningState = "string"
      uri = "string"
    }
  }
}

Property Values

Microsoft.Portal/consoles

Name Description Value
name The resource name string (required)
properties Cloud shell properties for creating a console. ConsoleCreatePropertiesOrConsoleProperties (required)
type The resource type "Microsoft.Portal/consoles@2018-10-01"

ConsoleCreatePropertiesOrConsoleProperties

Name Description Value
osType The operating system type of the cloud shell. 'Linux'
'Windows' (required)
provisioningState Provisioning state of the console. 'Accepted'
'Canceled'
'Creating'
'Failed'
'NotSpecified'
'Pending'
'Repairing'
'Succeeded'
'Updating'
uri Uri of the console. string
  • Last updated on