Microsoft.DeviceUpdate accounts
The accounts 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.
To create a Microsoft.DeviceUpdate/accounts resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.DeviceUpdate/accounts@2023-07-01' = {
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'
}
}
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' |
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 |
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 |
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 = 3 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 |
Name | Description | Value |
---|
Name | Description | Value |
---|---|---|
properties | Resource properties. | PrivateEndpointConnectionProperties (required) |
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) |
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' |
Name | Description | Value |
---|
Name | Description | Value |
---|
Name | Description | Value |
---|
The following quickstart samples deploy 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. |
The accounts 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.
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"
}
}
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' |
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 |
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 |
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 = 3 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' |
Name | Description | Value |
---|
Name | Description | Value |
---|---|---|
properties | Resource properties. | PrivateEndpointConnectionProperties (required) |
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) |
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' |
Name | Description | Value |
---|
Name | Description | Value |
---|
Name | Description | Value |
---|
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. |
The accounts resource type can be deployed with operations that target:
- Resource groups
For a list of changed properties in each API version, see change log.
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"
identity = {
type = "string"
userAssignedIdentities = {
{customized property} = {
}
}
}
location = "string"
tags = {
{customized property} = "string"
}
body = jsonencode({
properties = {
encryption = {
keyVaultKeyUri = "string"
userAssignedIdentity = "string"
}
privateEndpointConnections = [
{
properties = {
groupIds = [
"string"
]
privateEndpoint = {
}
privateLinkServiceConnectionState = {
actionsRequired = "string"
description = "string"
status = "string"
}
}
}
]
publicNetworkAccess = "string"
sku = "string"
}
})
}
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' |
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 |
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 |
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 = 3 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. |
type | The resource type | "Microsoft.DeviceUpdate/accounts@2023-07-01" |
Name | Description | Value |
---|
Name | Description | Value |
---|---|---|
properties | Resource properties. | PrivateEndpointConnectionProperties (required) |
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) |
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' |
Name | Description | Value |
---|
Name | Description | Value |
---|
Name | Description | Value |
---|