Поделиться через


Accounts - List By Subscription

Возвращает список учетных записей.

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DeviceUpdate/accounts?api-version=2023-07-01

Параметры URI

Имя В Обязательно Тип Описание
subscriptionId
path True

string

Идентификатор подписки Azure.

api-version
query True

string

Версия API схемы ADU.

Ответы

Имя Тип Описание
200 OK

AccountList

Список учетных записей.

Other Status Codes

ErrorResponse

Ответ об ошибке, описывающий причину сбоя операции.

Безопасность

azure_auth

Поток OAuth2 в Azure Active Directory.

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize

Области

Имя Описание
user_impersonation Олицетворение учетной записи пользователя

Примеры

Get list of Accounts

Образец запроса

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.DeviceUpdate/accounts?api-version=2023-07-01

Пример ответа

{
  "nextLink": "string",
  "value": [
    {
      "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": "Succeeded",
        "hostName": "contoso.api.adu.microsoft.com",
        "sku": "Standard",
        "locations": [
          {
            "name": "westus2",
            "role": "Primary"
          },
          {
            "name": "westcentralus",
            "role": "Failover"
          }
        ],
        "privateEndpointConnections": [
          {
            "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.DeviceUpdate/accounts/contoso/privateEndpointConnections/peexample01",
            "name": "peexample01",
            "type": "Microsoft.DeviceUpdate/accounts/privateEndpointConnections",
            "properties": {
              "provisioningState": "Succeeded",
              "privateEndpoint": {
                "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.Network/privateEndpoints/peexample01"
              },
              "privateLinkServiceConnectionState": {
                "status": "Approved",
                "description": "Auto-Approved",
                "actionsRequired": "None"
              },
              "groupIds": [
                "groupId"
              ]
            }
          }
        ]
      }
    }
  ]
}

Определения

Имя Описание
Account

Сведения об учетной записи обновления устройства.

AccountList

Список учетных записей.

createdByType

Тип удостоверения, создавшего ресурс.

Encryption

Параметры шифрования CMK в учетной записи обновления устройства.

ErrorAdditionalInfo

Дополнительные сведения об ошибке управления ресурсами.

ErrorDetail

Сведения об ошибке.

ErrorResponse

Сообщение об ошибке

Location
ManagedServiceIdentity

Управляемое удостоверение службы (назначаемые системой и /или назначенные пользователем удостоверения)

ManagedServiceIdentityType

Тип управляемого удостоверения службы (где разрешены типы SystemAssigned и UserAssigned).

PrivateEndpoint

Ресурс частной конечной точки.

PrivateEndpointConnection

Ресурс подключения к частной конечной точке.

PrivateEndpointConnectionProvisioningState

Текущее состояние подготовки.

PrivateEndpointServiceConnectionStatus

Состояние подключения к частной конечной точке.

PrivateLinkServiceConnectionState

Коллекция сведений о состоянии соединения между потребителем службы и поставщиком.

ProvisioningState

Состояние подготовки.

PublicNetworkAccess

Разрешен ли доступ к общедоступной сети для учетной записи.

Role

Является ли расположение основным или отработка отказа

SKU

Номер SKU обновления устройства

systemData

Метаданные, относящиеся к созданию и последнему изменению ресурса.

UserAssignedIdentity

Свойства удостоверения, назначаемые пользователем

Account

Сведения об учетной записи обновления устройства.

Имя Тип Default value Описание
id

string

Полный идентификатор ресурса. Пример : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

identity

ManagedServiceIdentity

Тип удостоверения, используемого для ресурса.

location

string

Географическое расположение, в котором находится ресурс

name

string

Имя ресурса.

properties.encryption

Encryption

Свойства шифрования неактивных данных CMK

properties.hostName

string

Имя узла API.

properties.locations

Location[]

Сведения о первичном расположении учетной записи обновления устройства и расположении отработки отказа

properties.privateEndpointConnections

PrivateEndpointConnection[]

Список подключений к частной конечной точке, связанных с учетной записью.

properties.provisioningState

ProvisioningState

Состояние подготовки.

properties.publicNetworkAccess

PublicNetworkAccess

Enabled

Разрешен ли доступ к общедоступной сети для учетной записи.

properties.sku

SKU

Standard

Номер SKU обновления устройства

systemData

systemData

Azure Resource Manager метаданные, содержащие сведения о createdBy и modifiedBy.

tags

object

Теги ресурсов.

type

string

Тип ресурса. Например, "Microsoft.Compute/virtualMachines" или "Microsoft.Storage/storageAccounts"

AccountList

Список учетных записей.

Имя Тип Описание
nextLink

string

Ссылка, используемая для получения следующей страницы списка учетных записей.

value

Account[]

Список учетных записей.

createdByType

Тип удостоверения, создавшего ресурс.

Имя Тип Описание
Application

string

Key

string

ManagedIdentity

string

User

string

Encryption

Параметры шифрования CMK в учетной записи обновления устройства.

Имя Тип Описание
keyVaultKeyUri

string

Универсальный код ресурса (URI) хранилища ключей

userAssignedIdentity

string

Полный идентификатор ресурса, назначаемого пользователем, который будет использоваться для доступа к хранилищу ключей. Удостоверение также должно быть назначено учетной записи

ErrorAdditionalInfo

Дополнительные сведения об ошибке управления ресурсами.

Имя Тип Описание
info

object

Дополнительные сведения.

type

string

Тип дополнительных сведений.

ErrorDetail

Сведения об ошибке.

Имя Тип Описание
additionalInfo

ErrorAdditionalInfo[]

Дополнительные сведения об ошибке.

code

string

Код ошибки.

details

ErrorDetail[]

Сведения об ошибке.

message

string

Сообщение об ошибке.

target

string

Целевой объект ошибки.

ErrorResponse

Сообщение об ошибке

Имя Тип Описание
error

ErrorDetail

Объект ошибки.

Location

Имя Тип Default value Описание
name

string

role

Role

Primary

Является ли расположение основным или отработка отказа

ManagedServiceIdentity

Управляемое удостоверение службы (назначаемые системой и /или назначенные пользователем удостоверения)

Имя Тип Описание
principalId

string

Идентификатор субъекта-службы назначенного системой удостоверения. Это свойство предоставляется только для удостоверения, назначаемого системой.

tenantId

string

Идентификатор клиента удостоверения, назначаемого системой. Это свойство предоставляется только для удостоверения, назначаемого системой.

type

ManagedServiceIdentityType

Тип управляемого удостоверения службы (где разрешены типы SystemAssigned и UserAssigned).

userAssignedIdentities

<string,  UserAssignedIdentity>

Удостоверения User-Assigned
Набор назначенных пользователем удостоверений, связанных с ресурсом. Ключи словаря userAssignedIdentities будут иметь идентификаторы ресурсов ARM в формате :/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. Значения словаря могут быть пустыми объектами ({}) в запросах.

ManagedServiceIdentityType

Тип управляемого удостоверения службы (где разрешены типы SystemAssigned и UserAssigned).

Имя Тип Описание
None

string

SystemAssigned

string

SystemAssigned,UserAssigned

string

UserAssigned

string

PrivateEndpoint

Ресурс частной конечной точки.

Имя Тип Описание
id

string

Идентификатор ARM для частной конечной точки

PrivateEndpointConnection

Ресурс подключения к частной конечной точке.

Имя Тип Описание
id

string

Полный идентификатор ресурса. Пример : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

name

string

Имя ресурса.

properties.groupIds

string[]

Массив идентификаторов групп.

properties.privateEndpoint

PrivateEndpoint

Ресурс частной конечной точки.

properties.privateLinkServiceConnectionState

PrivateLinkServiceConnectionState

Коллекция сведений о состоянии соединения между потребителем службы и поставщиком.

properties.provisioningState

PrivateEndpointConnectionProvisioningState

Состояние подготовки ресурса подключения к частной конечной точке.

systemData

systemData

Azure Resource Manager метаданные, содержащие сведения о createdBy и modifiedBy.

type

string

Тип ресурса. Например, "Microsoft.Compute/virtualMachines" или "Microsoft.Storage/storageAccounts"

PrivateEndpointConnectionProvisioningState

Текущее состояние подготовки.

Имя Тип Описание
Creating

string

Deleting

string

Failed

string

Succeeded

string

PrivateEndpointServiceConnectionStatus

Состояние подключения к частной конечной точке.

Имя Тип Описание
Approved

string

Pending

string

Rejected

string

PrivateLinkServiceConnectionState

Коллекция сведений о состоянии соединения между потребителем службы и поставщиком.

Имя Тип Описание
actionsRequired

string

Сообщение, указывающее, требуют ли изменения в поставщике услуг каких-либо обновлений для потребителя.

description

string

Причина утверждения или отклонения подключения.

status

PrivateEndpointServiceConnectionStatus

Указывает, было ли подключение утверждено, отклонено или удалено владельцем службы.

ProvisioningState

Состояние подготовки.

Имя Тип Описание
Accepted

string

Canceled

string

Creating

string

Deleted

string

Failed

string

Succeeded

string

PublicNetworkAccess

Разрешен ли доступ к общедоступной сети для учетной записи.

Имя Тип Описание
Disabled

string

Enabled

string

Role

Является ли расположение основным или отработка отказа

Имя Тип Описание
Failover

string

Primary

string

SKU

Номер SKU обновления устройства

Имя Тип Описание
Free

string

Standard

string

systemData

Метаданные, относящиеся к созданию и последнему изменению ресурса.

Имя Тип Описание
createdAt

string

Метка времени создания ресурса (UTC).

createdBy

string

Удостоверение, создающее ресурс.

createdByType

createdByType

Тип удостоверения, создавшего ресурс.

lastModifiedAt

string

Метка времени последнего изменения ресурса (UTC)

lastModifiedBy

string

Удостоверение, которое в последний раз изменял ресурс.

lastModifiedByType

createdByType

Тип удостоверения, изменяющего ресурс в последний раз.

UserAssignedIdentity

Свойства удостоверения, назначаемые пользователем

Имя Тип Описание
clientId

string

Идентификатор клиента назначенного удостоверения.

principalId

string

Идентификатор субъекта назначенного удостоверения.