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 accounts 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.DeviceUpdate/accounts resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.DeviceUpdate/accounts@2023-07-01' = {
scope: resourceSymbolicName or scope
identity: {
type: 'string'
userAssignedIdentities: {
{customized property}: {}
}
}
___location: 'string'
name: 'string'
properties: {
encryption: {
keyVaultKeyUri: 'string'
userAssignedIdentity: 'string'
}
privateEndpointConnections: [
{
properties: {
groupIds: [
'string'
]
privateEndpoint: {}
privateLinkServiceConnectionState: {
actionsRequired: 'string'
description: 'string'
status: 'string'
}
}
}
]
publicNetworkAccess: 'string'
sku: 'string'
}
tags: {
{customized property}: 'string'
}
}
Property Values
Microsoft.DeviceUpdate/accounts
| Name | Description | Value |
|---|---|---|
| identity | The type of identity used for the resource. | ManagedServiceIdentity |
| ___location | The geo-___location where the resource lives | string (required) |
| name | The resource name | string Constraints: Min length = 3 Max length = 24 Pattern = ^[A-Za-z0-9]+(-[A-Za-z0-9]+)*$ (required) |
| properties | Device Update account properties. | AccountProperties |
| scope | Use when creating a resource at a scope that is different than the deployment scope. | Set this property to the symbolic name of a resource to apply the extension resource. |
| tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
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 |
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. | UserAssignedIdentities |
PrivateEndpoint
| Name | Description | Value |
|---|
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) |
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' |
TrackedResourceTags
| Name | Description | Value |
|---|
UserAssignedIdentities
| Name | Description | Value |
|---|
UserAssignedIdentity
| Name | Description | Value |
|---|
Usage Examples
Azure Quickstart Samples
The following Azure Quickstart templates contain Bicep samples for deploying this resource type.
| Bicep File | 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 with operations that target:
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": "2023-07-01",
"name": "string",
"identity": {
"type": "string",
"userAssignedIdentities": {
"{customized property}": {
}
}
},
"___location": "string",
"properties": {
"encryption": {
"keyVaultKeyUri": "string",
"userAssignedIdentity": "string"
},
"privateEndpointConnections": [
{
"properties": {
"groupIds": [ "string" ],
"privateEndpoint": {
},
"privateLinkServiceConnectionState": {
"actionsRequired": "string",
"description": "string",
"status": "string"
}
}
}
],
"publicNetworkAccess": "string",
"sku": "string"
},
"tags": {
"{customized property}": "string"
}
}
Property Values
Microsoft.DeviceUpdate/accounts
| Name | Description | Value |
|---|---|---|
| apiVersion | The api version | '2023-07-01' |
| identity | The type of identity used for the resource. | ManagedServiceIdentity |
| ___location | The geo-___location where the resource lives | string (required) |
| name | The resource name | string Constraints: Min length = 3 Max length = 24 Pattern = ^[A-Za-z0-9]+(-[A-Za-z0-9]+)*$ (required) |
| properties | Device Update account properties. | AccountProperties |
| tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
| type | The resource type | 'Microsoft.DeviceUpdate/accounts' |
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 |
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. | UserAssignedIdentities |
PrivateEndpoint
| Name | Description | Value |
|---|
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) |
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' |
TrackedResourceTags
| Name | Description | Value |
|---|
UserAssignedIdentities
| Name | Description | Value |
|---|
UserAssignedIdentity
| Name | Description | Value |
|---|
Usage Examples
Azure Quickstart Templates
The following Azure 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 with operations that target:
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@2023-07-01"
name = "string"
parent_id = "string"
identity {
type = "string"
identity_ids = [
"string"
]
}
___location = "string"
tags = {
{customized property} = "string"
}
body = {
properties = {
encryption = {
keyVaultKeyUri = "string"
userAssignedIdentity = "string"
}
privateEndpointConnections = [
{
properties = {
groupIds = [
"string"
]
privateEndpoint = {
}
privateLinkServiceConnectionState = {
actionsRequired = "string"
description = "string"
status = "string"
}
}
}
]
publicNetworkAccess = "string"
sku = "string"
}
}
}
Property Values
Microsoft.DeviceUpdate/accounts
| Name | Description | Value |
|---|---|---|
| identity | The type of identity used for the resource. | ManagedServiceIdentity |
| ___location | The geo-___location where the resource lives | string (required) |
| name | The resource name | string Constraints: Min length = 3 Max length = 24 Pattern = ^[A-Za-z0-9]+(-[A-Za-z0-9]+)*$ (required) |
| parent_id | The ID of the resource to apply this extension resource to. | string (required) |
| properties | Device Update account properties. | AccountProperties |
| tags | Resource tags | Dictionary of tag names and values. |
| type | The resource type | "Microsoft.DeviceUpdate/accounts@2023-07-01" |
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 |
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. | UserAssignedIdentities |
PrivateEndpoint
| Name | Description | Value |
|---|
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) |
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' |
TrackedResourceTags
| Name | Description | Value |
|---|
UserAssignedIdentities
| Name | Description | Value |
|---|
UserAssignedIdentity
| Name | Description | Value |
|---|
Usage Examples
Terraform Samples
A basic example of deploying IoT Hub Device Update Account.
terraform {
required_providers {
azapi = {
source = "Azure/azapi"
}
}
}
provider "azapi" {
skip_provider_registration = false
}
variable "resource_name" {
type = string
default = "acctest0001"
}
variable "___location" {
type = string
default = "westeurope"
}
resource "azapi_resource" "resourceGroup" {
type = "Microsoft.Resources/resourceGroups@2020-06-01"
name = var.resource_name
___location = var.___location
}
resource "azapi_resource" "account" {
type = "Microsoft.DeviceUpdate/accounts@2022-10-01"
parent_id = azapi_resource.resourceGroup.id
name = var.resource_name
___location = var.___location
body = {
properties = {
publicNetworkAccess = "Enabled"
sku = "Standard"
}
}
schema_validation_enabled = false
response_export_values = ["*"]
}