Accounts - Create

Creates or updates Account.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DeviceUpdate/accounts/{accountName}?api-version=2022-10-01

URI Parameters

Name In Required Type Description
accountName
path True
  • string

Account name.

Regex pattern: ^[A-Za-z0-9]+(-[A-Za-z0-9]+)*$

resourceGroupName
path True
  • string

The resource group name.

subscriptionId
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.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=2022-10-01

{
  "location": "westus2",
  "properties": {}
}

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",
  "properties": {
    "provisioningState": "Accepted",
    "hostName": "contoso.api.adu.microsoft.com",
    "privateEndpointConnections": [],
    "sku": "Standard",
    "locations": [
      {
        "name": "westus2",
        "role": "Primary"
      },
      {
        "name": "westcentralus",
        "role": "Failover"
      }
    ]
  }
}

Definitions

Account

Device Update account details.

createdByType

The type of identity that created the resource.

ErrorAdditionalInfo

The resource management error additional info.

ErrorDetail

The error detail.

ErrorResponse

Error response

Location
ManagedServiceIdentity

Managed service identity (system assigned and/or user assigned identities)

ManagedServiceIdentityType

Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).

PrivateEndpoint

The Private Endpoint resource.

PrivateEndpointConnection

The Private Endpoint Connection resource.

PrivateEndpointConnectionProvisioningState

The current provisioning state.

PrivateEndpointServiceConnectionStatus

The private endpoint connection status.

PrivateLinkServiceConnectionState

A collection of information about the state of the connection between service consumer and provider.

ProvisioningState

Provisioning state.

PublicNetworkAccess

Whether or not public network access is allowed for the account.

Role

Whether the location is primary or failover

SKU

Device Update Sku

systemData

Metadata pertaining to creation and last modification of the resource.

UserAssignedIdentity

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.hostName
  • string

API host name.

properties.locations

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

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

User-Assigned Identities
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.

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.