Accounts - Create
Creates or updates Account.
PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DeviceUpdate/accounts/{accountName}?api-version=2023-07-01
URI Parameters
Name | In | Required | Type | Description |
---|---|---|---|---|
account
|
path | True |
string |
Account name. Regex pattern: |
resource
|
path | True |
string |
The resource group name. |
subscription
|
path | True |
string |
The Azure subscription ID. |
api-version
|
query | True |
string |
ADU schema API version. |
Request Body
Name | Required | Type | Description |
---|---|---|---|
location | True |
string |
The geo-location where the resource lives |
identity |
The type of identity used for the resource. |
||
properties.encryption |
CMK encryption at rest properties |
||
properties.privateEndpointConnections |
List of private endpoint connections associated with the account. |
||
properties.publicNetworkAccess |
Whether or not public network access is allowed for the account. |
||
properties.sku |
Device Update Sku |
||
tags |
object |
Resource tags. |
Responses
Name | Type | Description |
---|---|---|
201 Created |
Async operation to create or update Account was created. |
|
Other Status Codes |
Error response describing the reason for operation failure. |
Security
azure_auth
Azure Active Directory OAuth2 flow.
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Name | Description |
---|---|
user_impersonation | Impersonate your user account |
Examples
Creates or updates Account
Sample Request
PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.DeviceUpdate/accounts/contoso?api-version=2023-07-01
{
"location": "westus2",
"identity": {
"type": "UserAssigned",
"userAssignedIdentities": {
"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": {}
}
},
"properties": {
"encryption": {
"keyVaultKeyUri": "https://contoso.vault.azure.net/keys/contoso",
"userAssignedIdentity": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1"
}
}
}
Sample Response
{
"name": "contoso",
"location": "westus2",
"id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.DeviceUpdate/accounts/contoso",
"type": "Microsoft.DeviceUpdate/accounts",
"identity": {
"type": "UserAssigned",
"userAssignedIdentities": {
"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": {
"principalId": "12345678-1234-4321-1234-123456789012",
"clientId": "12345678-4321-1234-1234-123456789012"
}
}
},
"properties": {
"provisioningState": "Accepted",
"hostName": "contoso.api.adu.microsoft.com",
"sku": "Free",
"encryption": {
"keyVaultKeyUri": "https://contoso.vault.azure.net/keys/contoso",
"userAssignedIdentity": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1"
},
"locations": [
{
"name": "westus2",
"role": "Primary"
},
{
"name": "westcentralus",
"role": "Failover"
}
]
}
}
Definitions
Name | Description |
---|---|
Account |
Device Update account details. |
created |
The type of identity that created the resource. |
Encryption |
The CMK encryption settings on the Device Update account. |
Error |
The resource management error additional info. |
Error |
The error detail. |
Error |
Error response |
Location | |
Managed |
Managed service identity (system assigned and/or user assigned identities) |
Managed |
Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). |
Private |
The Private Endpoint resource. |
Private |
The Private Endpoint Connection resource. |
Private |
The current provisioning state. |
Private |
The private endpoint connection status. |
Private |
A collection of information about the state of the connection between service consumer and provider. |
Provisioning |
Provisioning state. |
Public |
Whether or not public network access is allowed for the account. |
Role |
Whether the location is primary or failover |
SKU |
Device Update Sku |
system |
Metadata pertaining to creation and last modification of the resource. |
User |
User assigned identity properties |
Account
Device Update account details.
Name | Type | Default Value | Description |
---|---|---|---|
id |
string |
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
|
identity |
The type of identity used for the resource. |
||
location |
string |
The geo-location where the resource lives |
|
name |
string |
The name of the resource |
|
properties.encryption |
CMK encryption at rest properties |
||
properties.hostName |
string |
API host name. |
|
properties.locations |
Location[] |
Device Update account primary and failover location details |
|
properties.privateEndpointConnections |
List of private endpoint connections associated with the account. |
||
properties.provisioningState |
Provisioning state. |
||
properties.publicNetworkAccess | Enabled |
Whether or not public network access is allowed for the account. |
|
properties.sku | Standard |
Device Update Sku |
|
systemData |
Azure Resource Manager metadata containing createdBy and modifiedBy information. |
||
tags |
object |
Resource tags. |
|
type |
string |
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" |
createdByType
The type of identity that created the resource.
Name | Type | Description |
---|---|---|
Application |
string |
|
Key |
string |
|
ManagedIdentity |
string |
|
User |
string |
Encryption
The CMK encryption settings on the Device Update account.
Name | Type | Description |
---|---|---|
keyVaultKeyUri |
string |
The URI of the key vault |
userAssignedIdentity |
string |
The full resourceId of the user assigned identity to be used for key vault access. Identity has to be also assigned to the Account |
ErrorAdditionalInfo
The resource management error additional info.
Name | Type | Description |
---|---|---|
info |
object |
The additional info. |
type |
string |
The additional info type. |
ErrorDetail
The error detail.
Name | Type | Description |
---|---|---|
additionalInfo |
The error additional info. |
|
code |
string |
The error code. |
details |
The error details. |
|
message |
string |
The error message. |
target |
string |
The error target. |
ErrorResponse
Error response
Name | Type | Description |
---|---|---|
error |
The error object. |
Location
Name | Type | Default Value | Description |
---|---|---|---|
name |
string |
||
role | Primary |
Whether the location is primary or failover |
ManagedServiceIdentity
Managed service identity (system assigned and/or user assigned identities)
Name | Type | Description |
---|---|---|
principalId |
string |
The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. |
tenantId |
string |
The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. |
type |
Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). |
|
userAssignedIdentities |
<string,
User |
User-Assigned Identities |
ManagedServiceIdentityType
Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).
Name | Type | Description |
---|---|---|
None |
string |
|
SystemAssigned |
string |
|
SystemAssigned,UserAssigned |
string |
|
UserAssigned |
string |
PrivateEndpoint
The Private Endpoint resource.
Name | Type | Description |
---|---|---|
id |
string |
The ARM identifier for Private Endpoint |
PrivateEndpointConnection
The Private Endpoint Connection resource.
Name | Type | Description |
---|---|---|
id |
string |
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
name |
string |
The name of the resource |
properties.groupIds |
string[] |
Array of group IDs. |
properties.privateEndpoint |
The resource of private end point. |
|
properties.privateLinkServiceConnectionState |
A collection of information about the state of the connection between service consumer and provider. |
|
properties.provisioningState |
The provisioning state of the private endpoint connection resource. |
|
systemData |
Azure Resource Manager metadata containing createdBy and modifiedBy information. |
|
type |
string |
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" |
PrivateEndpointConnectionProvisioningState
The current provisioning state.
Name | Type | Description |
---|---|---|
Creating |
string |
|
Deleting |
string |
|
Failed |
string |
|
Succeeded |
string |
PrivateEndpointServiceConnectionStatus
The private endpoint connection status.
Name | Type | Description |
---|---|---|
Approved |
string |
|
Pending |
string |
|
Rejected |
string |
PrivateLinkServiceConnectionState
A collection of information about the state of the connection between service consumer and provider.
Name | Type | Description |
---|---|---|
actionsRequired |
string |
A message indicating if changes on the service provider require any updates on the consumer. |
description |
string |
The reason for approval/rejection of the connection. |
status |
Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. |
ProvisioningState
Provisioning state.
Name | Type | Description |
---|---|---|
Accepted |
string |
|
Canceled |
string |
|
Creating |
string |
|
Deleted |
string |
|
Failed |
string |
|
Succeeded |
string |
PublicNetworkAccess
Whether or not public network access is allowed for the account.
Name | Type | Description |
---|---|---|
Disabled |
string |
|
Enabled |
string |
Role
Whether the location is primary or failover
Name | Type | Description |
---|---|---|
Failover |
string |
|
Primary |
string |
SKU
Device Update Sku
Name | Type | Description |
---|---|---|
Free |
string |
|
Standard |
string |
systemData
Metadata pertaining to creation and last modification of the resource.
Name | Type | Description |
---|---|---|
createdAt |
string |
The timestamp of resource creation (UTC). |
createdBy |
string |
The identity that created the resource. |
createdByType |
The type of identity that created the resource. |
|
lastModifiedAt |
string |
The timestamp of resource last modification (UTC) |
lastModifiedBy |
string |
The identity that last modified the resource. |
lastModifiedByType |
The type of identity that last modified the resource. |
UserAssignedIdentity
User assigned identity properties
Name | Type | Description |
---|---|---|
clientId |
string |
The client ID of the assigned identity. |
principalId |
string |
The principal ID of the assigned identity. |