Microsoft.DeviceUpdate accounts 2022-12-01-preview

Article
12/28/2022

Bicep resource definition

The accounts resource type can be deployed to:

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.DeviceUpdate/accounts resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.DeviceUpdate/accounts@2022-12-01-preview' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  identity: {
    type: 'string'
    userAssignedIdentities: {}
  }
  properties: {
    encryption: {
      keyVaultKeyUri: 'string'
      userAssignedIdentity: 'string'
    }
    privateEndpointConnections: [
      {
        properties: {
          groupIds: [
            'string'
          ]
          privateEndpoint: {}
          privateLinkServiceConnectionState: {
            actionsRequired: 'string'
            description: 'string'
            status: 'string'
          }
        }
      }
    ]
    publicNetworkAccess: 'string'
    sku: 'string'
  }
}

Property values

accounts

Name	Description	Value
name	The resource name	string (required)
location	The geo-location where the resource lives	string (required)
tags	Resource tags.	Dictionary of tag names and values. See Tags in templates
identity	The type of identity used for the resource.	ManagedServiceIdentity
properties	Device Update account properties.	AccountProperties

ManagedServiceIdentity

Name	Description	Value
type	Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).	'None' 'SystemAssigned' 'SystemAssigned,UserAssigned' 'UserAssigned' (required)
userAssignedIdentities	The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests.	object

AccountProperties

Name	Description	Value
encryption	CMK encryption at rest properties	Encryption
privateEndpointConnections	List of private endpoint connections associated with the account.	PrivateEndpointConnection[]
publicNetworkAccess	Whether or not public network access is allowed for the account.	'Disabled' 'Enabled'
sku	Device Update Sku	'Free' 'Standard'

Encryption

Name	Description	Value
keyVaultKeyUri	The URI of the key vault	string
userAssignedIdentity	The full resourceId of the user assigned identity to be used for key vault access. Identity has to be also assigned to the Account	string

PrivateEndpointConnection

Name	Description	Value
properties	Resource properties.	PrivateEndpointConnectionProperties (required)

PrivateEndpointConnectionProperties

Name	Description	Value
groupIds	Array of group IDs.	string[]
privateEndpoint	The resource of private end point.	PrivateEndpoint
privateLinkServiceConnectionState	A collection of information about the state of the connection between service consumer and provider.	PrivateLinkServiceConnectionState (required)

PrivateEndpoint

This object doesn't contain any properties to set during deployment. All properties are ReadOnly.

PrivateLinkServiceConnectionState

Name	Description	Value
actionsRequired	A message indicating if changes on the service provider require any updates on the consumer.	string
description	The reason for approval/rejection of the connection.	string
status	Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.	'Approved' 'Pending' 'Rejected'

Quickstart templates

The following quickstart templates deploy this resource type.

Template	Description
Create Device Update for IoT Hub account	This template creates an account that provides public DNS record and allows to make REST API calls to Data Plane. Then user needs to create an instance under the account and link it with an IoT Hub to start using the service.
Create Device Update for IoT Hub account, instance, IoT Hub	This template creates an account, and an instance and a hub to link the instance with. It configures the hub with the necessary access polices, routes, and consumer group.

ARM template resource definition

The accounts resource type can be deployed to:

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.DeviceUpdate/accounts resource, add the following JSON to your template.

{
  "type": "Microsoft.DeviceUpdate/accounts",
  "apiVersion": "2022-12-01-preview",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "identity": {
    "type": "string",
    "userAssignedIdentities": {}
  },
  "properties": {
    "encryption": {
      "keyVaultKeyUri": "string",
      "userAssignedIdentity": "string"
    },
    "privateEndpointConnections": [
      {
        "properties": {
          "groupIds": [ "string" ],
          "privateEndpoint": {},
          "privateLinkServiceConnectionState": {
            "actionsRequired": "string",
            "description": "string",
            "status": "string"
          }
        }
      }
    ],
    "publicNetworkAccess": "string",
    "sku": "string"
  }
}

Property values

accounts

Name	Description	Value
type	The resource type	'Microsoft.DeviceUpdate/accounts'
apiVersion	The resource api version	'2022-12-01-preview'
name	The resource name	string (required)
location	The geo-location where the resource lives	string (required)
tags	Resource tags.	Dictionary of tag names and values. See Tags in templates
identity	The type of identity used for the resource.	ManagedServiceIdentity
properties	Device Update account properties.	AccountProperties

ManagedServiceIdentity

Name	Description	Value
type	Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).	'None' 'SystemAssigned' 'SystemAssigned,UserAssigned' 'UserAssigned' (required)
userAssignedIdentities	The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests.	object

AccountProperties

Name	Description	Value
encryption	CMK encryption at rest properties	Encryption
privateEndpointConnections	List of private endpoint connections associated with the account.	PrivateEndpointConnection[]
publicNetworkAccess	Whether or not public network access is allowed for the account.	'Disabled' 'Enabled'
sku	Device Update Sku	'Free' 'Standard'

Encryption

Name	Description	Value
keyVaultKeyUri	The URI of the key vault	string
userAssignedIdentity	The full resourceId of the user assigned identity to be used for key vault access. Identity has to be also assigned to the Account	string

PrivateEndpointConnection

Name	Description	Value
properties	Resource properties.	PrivateEndpointConnectionProperties (required)

PrivateEndpointConnectionProperties

Name	Description	Value
groupIds	Array of group IDs.	string[]
privateEndpoint	The resource of private end point.	PrivateEndpoint
privateLinkServiceConnectionState	A collection of information about the state of the connection between service consumer and provider.	PrivateLinkServiceConnectionState (required)

PrivateEndpoint

This object doesn't contain any properties to set during deployment. All properties are ReadOnly.

PrivateLinkServiceConnectionState

Name	Description	Value
actionsRequired	A message indicating if changes on the service provider require any updates on the consumer.	string
description	The reason for approval/rejection of the connection.	string
status	Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.	'Approved' 'Pending' 'Rejected'

Quickstart templates

The following quickstart templates deploy this resource type.

Template	Description
Create Device Update for IoT Hub account	This template creates an account that provides public DNS record and allows to make REST API calls to Data Plane. Then user needs to create an instance under the account and link it with an IoT Hub to start using the service.
Create Device Update for IoT Hub account, instance, IoT Hub	This template creates an account, and an instance and a hub to link the instance with. It configures the hub with the necessary access polices, routes, and consumer group.

Terraform (AzAPI provider) resource definition

The accounts resource type can be deployed to:

Resource groups

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

Resource format

To create a Microsoft.DeviceUpdate/accounts resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DeviceUpdate/accounts@2022-12-01-preview"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  identity {
    type = "string"
    identity_ids = []
  }
  body = jsonencode({
    properties = {
      encryption = {
        keyVaultKeyUri = "string"
        userAssignedIdentity = "string"
      }
      privateEndpointConnections = [
        {
          properties = {
            groupIds = [
              "string"
            ]
            privateEndpoint = {}
            privateLinkServiceConnectionState = {
              actionsRequired = "string"
              description = "string"
              status = "string"
            }
          }
        }
      ]
      publicNetworkAccess = "string"
      sku = "string"
    }
  })
}

Property values

accounts

Name	Description	Value
type	The resource type	"Microsoft.DeviceUpdate/accounts@2022-12-01-preview"
name	The resource name	string (required)
location	The geo-location where the resource lives	string (required)
parent_id	To deploy to a resource group, use the ID of that resource group.	string (required)
tags	Resource tags.	Dictionary of tag names and values.
identity	The type of identity used for the resource.	ManagedServiceIdentity
properties	Device Update account properties.	AccountProperties

ManagedServiceIdentity

Name	Description	Value
type	Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).	"SystemAssigned" "SystemAssigned,UserAssigned" "UserAssigned" (required)
identity_ids	The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests.	Array of user identity IDs.

AccountProperties

Name	Description	Value
encryption	CMK encryption at rest properties	Encryption
privateEndpointConnections	List of private endpoint connections associated with the account.	PrivateEndpointConnection[]
publicNetworkAccess	Whether or not public network access is allowed for the account.	"Disabled" "Enabled"
sku	Device Update Sku	"Free" "Standard"

Encryption

Name	Description	Value
keyVaultKeyUri	The URI of the key vault	string
userAssignedIdentity	The full resourceId of the user assigned identity to be used for key vault access. Identity has to be also assigned to the Account	string

PrivateEndpointConnection

Name	Description	Value
properties	Resource properties.	PrivateEndpointConnectionProperties (required)

PrivateEndpointConnectionProperties

Name	Description	Value
groupIds	Array of group IDs.	string[]
privateEndpoint	The resource of private end point.	PrivateEndpoint
privateLinkServiceConnectionState	A collection of information about the state of the connection between service consumer and provider.	PrivateLinkServiceConnectionState (required)

PrivateEndpoint

This object doesn't contain any properties to set during deployment. All properties are ReadOnly.

PrivateLinkServiceConnectionState

Name	Description	Value
actionsRequired	A message indicating if changes on the service provider require any updates on the consumer.	string
description	The reason for approval/rejection of the connection.	string
status	Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.	"Approved" "Pending" "Rejected"

Share via

Microsoft.DeviceUpdate accounts 2022-12-01-preview

Bicep resource definition

Resource format

Property values

accounts

ManagedServiceIdentity

AccountProperties

Encryption

PrivateEndpointConnection

PrivateEndpointConnectionProperties

PrivateEndpoint

PrivateLinkServiceConnectionState

Quickstart templates

ARM template resource definition

Resource format

Property values

accounts

ManagedServiceIdentity

AccountProperties

Encryption

PrivateEndpointConnection

PrivateEndpointConnectionProperties

PrivateEndpoint

PrivateLinkServiceConnectionState

Quickstart templates

Terraform (AzAPI provider) resource definition

Resource format

Property values

accounts

ManagedServiceIdentity

AccountProperties

Encryption

PrivateEndpointConnection

PrivateEndpointConnectionProperties

PrivateEndpoint

PrivateLinkServiceConnectionState

Feedback

Additional resources