Microsoft.HybridNetwork devices

Bicep resource definition

The devices 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.HybridNetwork/devices resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.HybridNetwork/devices@2022-01-01-preview' = {
  location: 'string'
  name: 'string'
  properties: {
    deviceType: 'string'
    // For remaining properties, see DevicePropertiesFormat objects
  }
  tags: {
    {customized property}: 'string'
  }
}

DevicePropertiesFormat objects

Set the deviceType property to specify the type of object.

For AzureStackEdge, use:

{
  azureStackEdge: {
    id: 'string'
  }
  deviceType: 'AzureStackEdge'
}

Property Values

Microsoft.HybridNetwork/devices

Name Description Value
location The geo-location where the resource lives string (required)
name The resource name string (required)
properties Device properties. DevicePropertiesFormat
tags Resource tags Dictionary of tag names and values. See Tags in templates

AzureStackEdgeFormat

Name Description Value
azureStackEdge The reference to the Azure stack edge device. SubResource (required)
deviceType The type of the device. 'AzureStackEdge' (required)

DevicePropertiesFormat

Name Description Value
deviceType Set to 'AzureStackEdge' for type AzureStackEdgeFormat. 'AzureStackEdge' (required)

SubResource

Name Description Value
id Resource ID. string

TrackedResourceTags

Name Description Value

ARM template resource definition

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

Usage Examples

Resource format

To create a Microsoft.HybridNetwork/devices resource, add the following JSON to your template.

{
  "type": "Microsoft.HybridNetwork/devices",
  "apiVersion": "2022-01-01-preview",
  "name": "string",
  "location": "string",
  "properties": {
    "deviceType": "string"
    // For remaining properties, see DevicePropertiesFormat objects
  },
  "tags": {
    "{customized property}": "string"
  }
}

DevicePropertiesFormat objects

Set the deviceType property to specify the type of object.

For AzureStackEdge, use:

{
  "azureStackEdge": {
    "id": "string"
  },
  "deviceType": "AzureStackEdge"
}

Property Values

Microsoft.HybridNetwork/devices

Name Description Value
apiVersion The api version '2022-01-01-preview'
location The geo-location where the resource lives string (required)
name The resource name string (required)
properties Device properties. DevicePropertiesFormat
tags Resource tags Dictionary of tag names and values. See Tags in templates
type The resource type 'Microsoft.HybridNetwork/devices'

AzureStackEdgeFormat

Name Description Value
azureStackEdge The reference to the Azure stack edge device. SubResource (required)
deviceType The type of the device. 'AzureStackEdge' (required)

DevicePropertiesFormat

Name Description Value
deviceType Set to 'AzureStackEdge' for type AzureStackEdgeFormat. 'AzureStackEdge' (required)

SubResource

Name Description Value
id Resource ID. string

TrackedResourceTags

Name Description Value

Terraform (AzAPI provider) resource definition

The devices 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.HybridNetwork/devices resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.HybridNetwork/devices@2022-01-01-preview"
  name = "string"
  parent_id = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = {
    properties = {
      deviceType = "string"
      // For remaining properties, see DevicePropertiesFormat objects
    }
  }
}

DevicePropertiesFormat objects

Set the deviceType property to specify the type of object.

For AzureStackEdge, use:

{
  azureStackEdge = {
    id = "string"
  }
  deviceType = "AzureStackEdge"
}

Property Values

Microsoft.HybridNetwork/devices

Name Description Value
location The geo-location where the resource lives string (required)
name The resource name string (required)
properties Device properties. DevicePropertiesFormat
tags Resource tags Dictionary of tag names and values.
type The resource type "Microsoft.HybridNetwork/devices@2022-01-01-preview"

AzureStackEdgeFormat

Name Description Value
azureStackEdge The reference to the Azure stack edge device. SubResource (required)
deviceType The type of the device. 'AzureStackEdge' (required)

DevicePropertiesFormat

Name Description Value
deviceType Set to 'AzureStackEdge' for type AzureStackEdgeFormat. 'AzureStackEdge' (required)

SubResource

Name Description Value
id Resource ID. string

TrackedResourceTags

Name Description Value