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

Azure Resource Manager

Azure Resource Manager предоставляет API для управления всеми ресурсами Azure.

Этот соединитель доступен в следующих продуктах и регионах:

Услуга Class Регионы
Copilot Studio Премия Все Power Automate регионы
Логические приложения Стандарт Все регионы Logic Apps
Power Apps Премия Все Power Apps регионы
Power Automate Премия Все Power Automate регионы
Контакт
Имя Microsoft
URL Поддержка Microsoft LogicApps
Поддержка Microsoft Power Automate
Поддержка Microsoft Power Apps
Метаданные соединителя
Publisher Microsoft
Website https://azure.microsoft.com/features/resource-manager/

Известные проблемы и ограничения

  • Если возникла ошибка с сообщением "Не удалось найти допустимое соединение для имени ссылки на подключение "shared_office365" в заголовке токенов APIM, можно устранить неполадки, выполнив указанные ниже действия.
    • Очистите кэш браузера.
    • Удалите соединение, а затем снова добавьте его.
  • Действие тегов ресурсов подписки может извлечь удаленные данные тегов из-за ограничений в базовой службе, которая управляет данными тегов.
  • По проектированию соединитель ARM в Power Automate не поддерживает прямые назначения ролей пользователей для секретов Azure Key Vault.

Создание подключения

Соединитель поддерживает следующие типы проверки подлинности:
По умолчанию Параметры для создания подключения. Все регионы Недоступен для совместного использования

По умолчанию

Применимо: все регионы

Параметры для создания подключения.

Это недоступно для общего доступа. Если приложение power предоставляется другому пользователю, пользователю будет предложено явно создать новое подключение.

Ограничения регулирования

Имя Вызовы Период обновления
Вызовы API для каждого подключения 1200 60 секунд

Действия

Вывод списка поставщиков ресурсов

Выводит список поставщиков ресурсов, доступных для подписки.
Вывод списка развертываний шаблонов

Выводит список всех развертываний шаблонов группы ресурсов. Эта операция полезна для того, чтобы узнать, что было подготовлено до сих пор.
Вывод списка ресурсов по группе ресурсов

Перечисляет все ресурсы в группе ресурсов.
Вывод списка ресурсов по подписке

Считывает все ресурсы в определенной подписке. Результаты разбиены на страницы в 1000 записей.
Вывод списка тегов ресурсов подписки

Выводит список всех тегов ресурсов подписки.
Вызов операции ресурса

Вызывает операцию в ресурсе Azure.
Вызов операции ресурса в поставщике

Вызывает операцию в ресурсе Azure.
Обновление существующей группы ресурсов

Обновляет существующую группу ресурсов. Если ресурс не существует, этот запрос завершится ошибкой.
Отмена развертывания шаблона

Отмена выполняемого в настоящее время развертывания шаблона. Все ожидающие операции шаблона будут приостановлены.
Отмена регистрации поставщика ресурсов

Отменяет регистрацию поставщика из подписки. Эта операция завершится ошибкой, если в подписке есть ресурсы от этого поставщика ресурсов.
Перечисление подписок

Возвращает список всех подписок, к которым у субъекта есть доступ.
Перечислить группы ресурсов

Выводит список всех групп ресурсов в подписке. Результаты разбиены на страницы в 1000 записей.
Проверка развертывания шаблона

Проверяет шаблон развертывания. Эта операция не имеет побочных эффектов и может использоваться для тестирования развертывания шаблона для синтаксиса или логических ошибок.
Регистрация поставщика ресурсов

Регистрирует поставщика ресурсов для использования с подпиской. При этом будут подготовлены разрешения для службы в подписке.
Создание или обновление группы ресурсов

Создает или обновляет группу ресурсов. Код ответа можно использовать для различения создания (201) или обновления (200).
Создание или обновление значения тега ресурса подписки

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

Создайте или обновите имя тега ресурса подписки.
Создание или обновление развертывания шаблона

Создайте или обновите развертывание шаблона именованной группы ресурсов. Для успешного выполнения запроса ожидается шаблон и параметры.
Создание или обновление ресурса

Создает или обновляет ресурс. Код ответа можно использовать для различения создания (201) или обновления (200).
Список операций развертывания шаблонов

Выводит список всех операций развертывания шаблона. Это полезно для устранения неполадок с неудачными развертываниями шаблонов.
Список расположений подписки

Выводит список расположений, доступных для подписки.
Удаление группы ресурсов

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

Удалите значение тега ресурса подписки.
Удаление имени тега ресурса подписки

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

Удаляет развертывание шаблона группы ресурсов. Ресурсы не будут удалены; только метаданные о развертывании шаблона.
Удаление ресурса

Удаляет ресурс.
Чтение группы ресурсов

Считывает определенную группу ресурсов в подписке.
Чтение операции развертывания шаблона

Считывает определенную операцию развертывания шаблона группы ресурсов. Это полезно для устранения неполадок с неудачными развертываниями шаблонов.
Чтение подписки

Считывает сведения для конкретной подписки.
Чтение поставщика ресурсов

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

Считывает развертывание шаблона в группе ресурсов.
Чтение ресурса

Считывает объект ресурса.
Чтение ресурса в поставщике

Считывает объект ресурса.
Экспорт шаблона группы ресурсов

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

Экспортирует шаблон из предыдущего развертывания группы ресурсов.

Вывод списка поставщиков ресурсов

Идентификатор операции:
Providers_List

Выводит список поставщиков ресурсов, доступных для подписки.

Параметры

Имя Ключ Обязательно Тип Описание
Subscription
 subscriptionId True string

Уникальный идентификатор подписки Microsoft Azure. Идентификатор подписки является частью идентификатора для каждого ресурса Azure.
Верх
 $top integer

Параметры запроса. Если ничего не передается, возвращаются все значения.
Развернуть
 $expand string

Параметр запроса $expand.

Возвращаемое значение

Список поставщиков ресурсов.

Тело
ProviderListResult

Вывод списка развертываний шаблонов

Идентификатор операции:
Deployments_List

Выводит список всех развертываний шаблонов группы ресурсов. Эта операция полезна для того, чтобы узнать, что было подготовлено до сих пор.

Параметры

Имя Ключ Обязательно Тип Описание
Subscription
 subscriptionId True string

Уникальный идентификатор подписки Microsoft Azure. Идентификатор подписки является частью идентификатора для каждого ресурса Azure.
Группа ресурсов
 resourceGroupName True string

Имя группы ресурсов.
Filter
 $filter string

Фильтр, применяемый к операции.
Верх
 $top integer

Параметры запроса. Если ничего не передается, возвращаются все значения.

Возвращаемое значение

Список развертываний.

Тело
DeploymentListResult

Вывод списка ресурсов по группе ресурсов

Идентификатор операции:
ResourceGroups_ListResources

Перечисляет все ресурсы в группе ресурсов.

Параметры

Имя Ключ Обязательно Тип Описание
Subscription
 subscriptionId True string

Уникальный идентификатор подписки Microsoft Azure. Идентификатор подписки является частью идентификатора для каждого ресурса Azure.
Группа ресурсов
 resourceGroupName True string

Имя группы ресурсов.
Filter
 $filter string

Фильтр, применяемый к операции.
Развернуть
 $expand string

Параметр запроса $expand.
Верх
 $top integer

Параметры запроса. Если ничего не передается, возвращаются все значения.

Возвращаемое значение

Список ресурсов.

Тело
ResourceListResult

Вывод списка ресурсов по подписке

Идентификатор операции:
Resources_List

Считывает все ресурсы в определенной подписке. Результаты разбиены на страницы в 1000 записей.

Параметры

Имя Ключ Обязательно Тип Описание
Subscription
 subscriptionId True string

Уникальный идентификатор подписки Microsoft Azure. Идентификатор подписки является частью идентификатора для каждого ресурса Azure.
Filter
 $filter string

Фильтр, применяемый к операции.
Развернуть
 $expand string

Параметр запроса $expand.
Верх
 $top integer

Параметры запроса. Если ничего не передается, возвращаются все значения.

Возвращаемое значение

Список ресурсов.

Тело
ResourceListResult

Вывод списка тегов ресурсов подписки

Идентификатор операции:
Tags_List

Выводит список всех тегов ресурсов подписки.

Параметры

Имя Ключ Обязательно Тип Описание
Subscription
 subscriptionId True string

Уникальный идентификатор подписки Microsoft Azure. Идентификатор подписки является частью идентификатора для каждого ресурса Azure.

Возвращаемое значение

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

Тело
TagsListResult

Вызов операции ресурса

Идентификатор операции:
Resources_Invoke

Вызывает операцию в ресурсе Azure.

Параметры

Имя Ключ Обязательно Тип Описание
Subscription
 subscriptionId True string

Уникальный идентификатор подписки Microsoft Azure. Идентификатор подписки является частью идентификатора для каждого ресурса Azure.
Группа ресурсов
 resourceGroupName True string

Имя группы ресурсов.
Поставщик ресурсов
 resourceProviderNamespace True string

Пространство имен поставщика ресурсов.
Идентификатор короткого ресурса
 shortResourceId True string

Короткий идентификатор ресурса, включая имя ресурса и тип ресурса. Например, сайты или mySite
Версия клиентского API
 x-ms-api-version True string

Используемая версия API.
Название действия
 actionName True string

Имя действия ресурса для вызова

Возвращаемое значение

Ответ операции действия.

Ответ на действия
object

Вызов операции ресурса в поставщике

Идентификатор операции:
Provider_Resources_Invoke

Вызывает операцию в ресурсе Azure.

Параметры

Имя Ключ Обязательно Тип Описание
Subscription
 subscriptionId True string

Уникальный идентификатор подписки Microsoft Azure. Идентификатор подписки является частью идентификатора для каждого ресурса Azure.
Поставщик ресурсов
 resourceProviderNamespace True string

Пространство имен поставщика ресурсов.
Идентификатор короткого ресурса
 shortResourceId True string

Короткий идентификатор ресурса, включая имя ресурса и тип ресурса. Например, сайты или mySite
Версия клиентского API
 x-ms-api-version True string

Используемая версия API.

Возвращаемое значение

Ответ операции.

Ответ
object

Обновление существующей группы ресурсов

Идентификатор операции:
ResourceGroups_Patch

Обновляет существующую группу ресурсов. Если ресурс не существует, этот запрос завершится ошибкой.

Параметры

Имя Ключ Обязательно Тип Описание
Subscription
 subscriptionId True string

Уникальный идентификатор подписки Microsoft Azure. Идентификатор подписки является частью идентификатора для каждого ресурса Azure.
Группа ресурсов
 resourceGroupName True string

Имя группы ресурсов.
Идентификатор
 id string

Идентификатор группы ресурсов (например, /subscriptions/XXX/resourceGroups/YYY).
Имя
 name string

Имя группы ресурсов.
Местоположение
 location True string

Расположение группы ресурсов. Его нельзя изменить после создания группы ресурсов. Должно быть одним из поддерживаемых расположений Azure, таких как западная часть США, восточная часть США, Западная Европа, Восточная Азия и т. д.
Управляется (кем)
 managedBy string

Идентификатор ресурса, который управляет этой группой ресурсов.
Метки
 tags object

Теги, присоединенные к группе ресурсов.
Состояние подготовки
 provisioningState string

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

Возвращаемое значение

Сведения о группе ресурсов.

Тело
ResourceGroup

Отмена развертывания шаблона

Идентификатор операции:
Deployments_Cancel

Отмена выполняемого в настоящее время развертывания шаблона. Все ожидающие операции шаблона будут приостановлены.

Параметры

Имя Ключ Обязательно Тип Описание
Subscription
 subscriptionId True string

Уникальный идентификатор подписки Microsoft Azure. Идентификатор подписки является частью идентификатора для каждого ресурса Azure.
Группа ресурсов
 resourceGroupName True string

Имя группы ресурсов.
Название развертывания
 deploymentName True string

Имя развертывания шаблона группы ресурсов.

Отмена регистрации поставщика ресурсов

Идентификатор операции:
Providers_Unregister

Отменяет регистрацию поставщика из подписки. Эта операция завершится ошибкой, если в подписке есть ресурсы от этого поставщика ресурсов.

Параметры

Имя Ключ Обязательно Тип Описание
Subscription
 subscriptionId True string

Уникальный идентификатор подписки Microsoft Azure. Идентификатор подписки является частью идентификатора для каждого ресурса Azure.
Поставщик ресурсов
 resourceProviderNamespace True string

Пространство имен поставщика ресурсов.

Возвращаемое значение

Сведения о поставщике ресурсов.

Тело
Provider

Перечисление подписок

Идентификатор операции:
Subscriptions_List

Возвращает список всех подписок, к которым у субъекта есть доступ.

Возвращаемое значение

Ответ на операцию списка подписок.

Тело
SubscriptionListResult

Перечислить группы ресурсов

Идентификатор операции:
ResourceGroups_List

Выводит список всех групп ресурсов в подписке. Результаты разбиены на страницы в 1000 записей.

Параметры

Имя Ключ Обязательно Тип Описание
Subscription
 subscriptionId True string

Уникальный идентификатор подписки Microsoft Azure. Идентификатор подписки является частью идентификатора для каждого ресурса Azure.
Filter
 $filter string

Фильтр, применяемый к операции.
Верх
 $top integer

Параметры запроса. Если ничего не передается, возвращаются все значения.

Возвращаемое значение

Список групп ресурсов.

Тело
ResourceGroupListResult

Проверка развертывания шаблона

Идентификатор операции:
Deployments_Validate

Проверяет шаблон развертывания. Эта операция не имеет побочных эффектов и может использоваться для тестирования развертывания шаблона для синтаксиса или логических ошибок.

Параметры

Имя Ключ Обязательно Тип Описание
Subscription
 subscriptionId True string

Уникальный идентификатор подписки Microsoft Azure. Идентификатор подписки является частью идентификатора для каждого ресурса Azure.
Группа ресурсов
 resourceGroupName True string

Имя группы ресурсов.
Название развертывания
 deploymentName True string

Имя развертывания шаблона группы ресурсов.
Содержимое шаблона
 template object

Содержимое шаблона. Это может быть JObject или хорошо сформированная строка JSON. Используйте только один из шаблонов или TemplateLink.
Универсальный код ресурса (URI) шаблона
 uri True string

URI, ссылающийся на шаблон.
Версия содержимого шаблона
 contentVersion string

Если он включен, он должен соответствовать ContentVersion в шаблоне.
Параметры
 parameters object

Параметры развертывания. Это может быть JObject или хорошо сформированная строка JSON. Используйте только один из параметров или ParametersLink.
URI параметров
 uri True string

URI, ссылающийся на шаблон.
Версия содержимого параметров
 contentVersion string

Если он включен, он должен соответствовать ContentVersion в шаблоне.
Режим развертывания
 mode True string

Режим развертывания.
Уровень детализации
 detailLevel string

Уровень детализации отладки.

Возвращаемое значение

Сведения из ответа на развертывание шаблона.

Тело
DeploymentValidateResult

Регистрация поставщика ресурсов

Идентификатор операции:
Providers_Register

Регистрирует поставщика ресурсов для использования с подпиской. При этом будут подготовлены разрешения для службы в подписке.

Параметры

Имя Ключ Обязательно Тип Описание
Subscription
 subscriptionId True string

Уникальный идентификатор подписки Microsoft Azure. Идентификатор подписки является частью идентификатора для каждого ресурса Azure.
Поставщик ресурсов
 resourceProviderNamespace True string

Пространство имен поставщика ресурсов.

Возвращаемое значение

Сведения о поставщике ресурсов.

Тело
Provider

Создание или обновление группы ресурсов

Идентификатор операции:
ResourceGroups_CreateOrUpdate

Создает или обновляет группу ресурсов. Код ответа можно использовать для различения создания (201) или обновления (200).

Параметры

Имя Ключ Обязательно Тип Описание
Subscription
 subscriptionId True string

Уникальный идентификатор подписки Microsoft Azure. Идентификатор подписки является частью идентификатора для каждого ресурса Azure.
Имя группы ресурсов
 resourceGroupName True string

Имя группы ресурсов, которую необходимо создать или обновить.
Идентификатор
 id string

Идентификатор группы ресурсов (например, /subscriptions/XXX/resourceGroups/YYY).
Имя
 name string

Имя группы ресурсов.
Местоположение
 location True string

Расположение группы ресурсов. Его нельзя изменить после создания группы ресурсов. Должно быть одним из поддерживаемых расположений Azure, таких как западная часть США, восточная часть США, Западная Европа, Восточная Азия и т. д.
Управляется (кем)
 managedBy string

Идентификатор ресурса, который управляет этой группой ресурсов.
Метки
 tags object

Теги, присоединенные к группе ресурсов.
Состояние подготовки
 provisioningState string

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

Возвращаемое значение

Сведения о группе ресурсов.

Тело
ResourceGroup

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

Идентификатор операции:
Tags_CreateOrUpdateValue

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

Параметры

Имя Ключ Обязательно Тип Описание
Subscription
 subscriptionId True string

Уникальный идентификатор подписки Microsoft Azure. Идентификатор подписки является частью идентификатора для каждого ресурса Azure.
Имя тега
 tagName True string

Имя тега.
Значение тега
 tagValue True string

Значение тега.

Возвращаемое значение

Сведения о теге.

Тело
TagValue

Создание или обновление имени тега ресурса подписки

Идентификатор операции:
Tags_CreateOrUpdate

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

Параметры

Имя Ключ Обязательно Тип Описание
Subscription
 subscriptionId True string

Уникальный идентификатор подписки Microsoft Azure. Идентификатор подписки является частью идентификатора для каждого ресурса Azure.
Имя тега
 tagName True string

Имя тега.

Возвращаемое значение

Сведения о теге.

Тело
TagDetails

Создание или обновление развертывания шаблона

Идентификатор операции:
Deployments_CreateOrUpdate

Создайте или обновите развертывание шаблона именованной группы ресурсов. Для успешного выполнения запроса ожидается шаблон и параметры.

Параметры

Имя Ключ Обязательно Тип Описание
Subscription
 subscriptionId True string

Уникальный идентификатор подписки Microsoft Azure. Идентификатор подписки является частью идентификатора для каждого ресурса Azure.
Группа ресурсов
 resourceGroupName True string

Имя группы ресурсов.
Название развертывания
 deploymentName True string

Имя развертывания.
Содержимое шаблона
 template object

Содержимое шаблона. Это может быть JObject или хорошо сформированная строка JSON. Используйте только один из шаблонов или TemplateLink.
Универсальный код ресурса (URI) шаблона
 uri True string

URI, ссылающийся на шаблон.
Версия содержимого шаблона
 contentVersion string

Если он включен, он должен соответствовать ContentVersion в шаблоне.
Параметры
 parameters object

Параметры развертывания. Это может быть JObject или хорошо сформированная строка JSON. Используйте только один из параметров или ParametersLink.
URI параметров
 uri True string

URI, ссылающийся на шаблон.
Версия содержимого параметров
 contentVersion string

Если он включен, он должен соответствовать ContentVersion в шаблоне.
Режим развертывания
 mode True string

Режим развертывания.
Уровень детализации
 detailLevel string

Уровень детализации отладки.
Ожидание развертывания
 wait boolean

Если действие должно ждать завершения развертывания

Возвращаемое значение

Сведения о развертывании.

Тело
DeploymentExtended

Создание или обновление ресурса

Идентификатор операции:
Resources_CreateOrUpdateById

Создает или обновляет ресурс. Код ответа можно использовать для различения создания (201) или обновления (200).

Параметры

Имя Ключ Обязательно Тип Описание
Subscription
 subscriptionId True string

Уникальный идентификатор подписки Microsoft Azure. Идентификатор подписки является частью идентификатора для каждого ресурса Azure.
Группа ресурсов
 resourceGroupName True string

Имя группы ресурсов.
Поставщик ресурсов
 resourceProviderNamespace True string

Пространство имен поставщика ресурсов.
Идентификатор короткого ресурса
 shortResourceId True string

Короткий идентификатор ресурса, включая имя ресурса и тип ресурса. Например, сайты или mySite
Версия клиентского API
 x-ms-api-version True string

Используемая версия API.
Идентификатор
 id string

Идентификатор ресурса
Имя
 name string

Имя ресурса
Тип
 type string

Тип ресурса
Местоположение
 location string

Расположение ресурса
Метки
 tags object

Теги ресурсов
Идентификатор
 name string

Идентификатор плана.
Publisher
 publisher string

Идентификатор издателя.
Продукт
 product string

Идентификатор предложения.
Код повышения уровня
 promotionCode string

Код повышения.
Kind
 kind string

Тип ресурса.
Управляется (кем)
 managedBy string

Идентификатор ресурса, который управляет этим ресурсом.
Имя
 name string

Имя SKU.
Тир
 tier string

Уровень SKU.
Size
 size string

Размер SKU.
Семья
 family string

Семья SKU.
Модель
 model string

Модель SKU.
Capacity
 capacity integer

Емкость SKU.
Идентификатор субъекта
 principalId string

Идентификатор субъекта удостоверения ресурса.
Идентификатор арендатора
 tenantId string

Идентификатор клиента ресурса.
Тип
 type string

Тип удостоверения.
Свойства
 properties object

Свойства ресурса.

Возвращаемое значение

Сведения о ресурсе.

Тело
GenericResource

Список операций развертывания шаблонов

Идентификатор операции:
DeploymentOperations_List

Выводит список всех операций развертывания шаблона. Это полезно для устранения неполадок с неудачными развертываниями шаблонов.

Параметры

Имя Ключ Обязательно Тип Описание
Subscription
 subscriptionId True string

Уникальный идентификатор подписки Microsoft Azure. Идентификатор подписки является частью идентификатора для каждого ресурса Azure.
Группа ресурсов
 resourceGroupName True string

Имя группы ресурсов.
Название развертывания
 deploymentName True string

Имя развертывания шаблона группы ресурсов.
Верх
 $top integer

Параметры запроса. Если ничего не передается, возвращаются все значения.

Возвращаемое значение

Список операций развертывания.

Тело
DeploymentOperationsListResult

Список расположений подписки

Идентификатор операции:
Subscriptions_ListLocations

Выводит список расположений, доступных для подписки.

Параметры

Имя Ключ Обязательно Тип Описание
Subscription
 subscriptionId True string

Уникальный идентификатор подписки Microsoft Azure. Идентификатор подписки является частью идентификатора для каждого ресурса Azure.

Возвращаемое значение

Ответ операции списка расположений.

Тело
LocationListResult

Удаление группы ресурсов

Идентификатор операции:
ResourceGroups_Delete

Удалите определенную группу ресурсов в подписке.

Параметры

Имя Ключ Обязательно Тип Описание
Subscription
 subscriptionId True string

Уникальный идентификатор подписки Microsoft Azure. Идентификатор подписки является частью идентификатора для каждого ресурса Azure.
Группа ресурсов
 resourceGroupName True string

Имя группы ресурсов.

Удаление значения тега ресурса подписки

Идентификатор операции:
Tags_DeleteValue

Удалите значение тега ресурса подписки.

Параметры

Имя Ключ Обязательно Тип Описание
Subscription
 subscriptionId True string

Уникальный идентификатор подписки Microsoft Azure. Идентификатор подписки является частью идентификатора для каждого ресурса Azure.
Имя тега
 tagName True string

Имя тега.
Значение тега
 tagValue True string

Значение тега.

Удаление имени тега ресурса подписки

Идентификатор операции:
Tags_Delete

Удаление имени тега ресурса подписки.

Параметры

Имя Ключ Обязательно Тип Описание
Subscription
 subscriptionId True string

Уникальный идентификатор подписки Microsoft Azure. Идентификатор подписки является частью идентификатора для каждого ресурса Azure.
Имя тега
 tagName True string

Имя тега.

Удаление развертывания шаблона

Идентификатор операции:
Deployments_Delete

Удаляет развертывание шаблона группы ресурсов. Ресурсы не будут удалены; только метаданные о развертывании шаблона.

Параметры

Имя Ключ Обязательно Тип Описание
Subscription
 subscriptionId True string

Уникальный идентификатор подписки Microsoft Azure. Идентификатор подписки является частью идентификатора для каждого ресурса Azure.
Группа ресурсов
 resourceGroupName True string

Имя группы ресурсов.
Название развертывания
 deploymentName True string

Имя развертывания шаблона группы ресурсов.

Удаление ресурса

Идентификатор операции:
Resources_DeleteById

Удаляет ресурс.

Параметры

Имя Ключ Обязательно Тип Описание
Subscription
 subscriptionId True string

Уникальный идентификатор подписки Microsoft Azure. Идентификатор подписки является частью идентификатора для каждого ресурса Azure.
Группа ресурсов
 resourceGroupName True string

Имя группы ресурсов.
Поставщик ресурсов
 resourceProviderNamespace True string

Пространство имен поставщика ресурсов.
Идентификатор короткого ресурса
 shortResourceId True string

Короткий идентификатор ресурса, включая имя ресурса и тип ресурса. Например, сайты или mySite
Версия клиентского API
 x-ms-api-version True string

Используемая версия API.

Чтение группы ресурсов

Идентификатор операции:
ResourceGroups_Get

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

Параметры

Имя Ключ Обязательно Тип Описание
Subscription
 subscriptionId True string

Уникальный идентификатор подписки Microsoft Azure. Идентификатор подписки является частью идентификатора для каждого ресурса Azure.
Группа ресурсов
 resourceGroupName True string

Имя группы ресурсов.

Возвращаемое значение

Сведения о группе ресурсов.

Тело
ResourceGroup

Чтение операции развертывания шаблона

Идентификатор операции:
DeploymentOperations_Get

Считывает определенную операцию развертывания шаблона группы ресурсов. Это полезно для устранения неполадок с неудачными развертываниями шаблонов.

Параметры

Имя Ключ Обязательно Тип Описание
Subscription
 subscriptionId True string

Уникальный идентификатор подписки Microsoft Azure. Идентификатор подписки является частью идентификатора для каждого ресурса Azure.
Группа ресурсов
 resourceGroupName True string

Имя группы ресурсов.
Название развертывания
 deploymentName True string

Имя развертывания шаблона группы ресурсов.
Идентификатор операции
 operationId True string

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

Возвращаемое значение

Сведения об операциях развертывания.

Тело
DeploymentOperation

Чтение подписки

Идентификатор операции:
Subscriptions_Get

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

Параметры

Имя Ключ Обязательно Тип Описание
Subscription
 subscriptionId True string

Уникальный идентификатор подписки Microsoft Azure. Идентификатор подписки является частью идентификатора для каждого ресурса Azure.

Возвращаемое значение

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

Тело
Subscription

Чтение поставщика ресурсов

Идентификатор операции:
Providers_Get

Считывает конкретный поставщик ресурсов в подписке.

Параметры

Имя Ключ Обязательно Тип Описание
Subscription
 subscriptionId True string

Уникальный идентификатор подписки Microsoft Azure. Идентификатор подписки является частью идентификатора для каждого ресурса Azure.
Поставщик ресурсов
 resourceProviderNamespace True string

Пространство имен поставщика ресурсов.
Развернуть
 $expand string

Параметр запроса $expand.

Возвращаемое значение

Сведения о поставщике ресурсов.

Тело
Provider

Чтение развертывания шаблона

Идентификатор операции:
Deployments_Get

Считывает развертывание шаблона в группе ресурсов.

Параметры

Имя Ключ Обязательно Тип Описание
Subscription
 subscriptionId True string

Уникальный идентификатор подписки Microsoft Azure. Идентификатор подписки является частью идентификатора для каждого ресурса Azure.
Группа ресурсов
 resourceGroupName True string

Имя группы ресурсов.
Название развертывания
 deploymentName True string

Имя развертывания шаблона группы ресурсов.
Ожидание развертывания
 wait boolean

Если действие должно ждать завершения развертывания

Возвращаемое значение

Сведения о развертывании.

Тело
DeploymentExtended

Чтение ресурса

Идентификатор операции:
Resources_GetById

Считывает объект ресурса.

Параметры

Имя Ключ Обязательно Тип Описание
Subscription
 subscriptionId True string

Уникальный идентификатор подписки Microsoft Azure. Идентификатор подписки является частью идентификатора для каждого ресурса Azure.
Группа ресурсов
 resourceGroupName True string

Имя группы ресурсов.
Поставщик ресурсов
 resourceProviderNamespace True string

Пространство имен поставщика ресурсов.
Идентификатор короткого ресурса
 shortResourceId True string

Короткий идентификатор ресурса, включая имя ресурса и тип ресурса. Например, сайты или mySite
Версия клиентского API
 x-ms-api-version True string

Используемая версия API.

Возвращаемое значение

Сведения о ресурсе.

Тело
GenericResource

Чтение ресурса в поставщике

Идентификатор операции:
Provider_Resources_GetById

Считывает объект ресурса.

Параметры

Имя Ключ Обязательно Тип Описание
Subscription
 subscriptionId True string

Уникальный идентификатор подписки Microsoft Azure. Идентификатор подписки является частью идентификатора для каждого ресурса Azure.
Поставщик ресурсов
 resourceProviderNamespace True string

Пространство имен поставщика ресурсов.
Идентификатор короткого ресурса
 shortResourceId True string

Короткий идентификатор ресурса, включая имя ресурса и тип ресурса. Например, сайты или mySite
Версия клиентского API
 x-ms-api-version True string

Используемая версия API.

Возвращаемое значение

Сведения о ресурсе.

Тело
GenericResource

Экспорт шаблона группы ресурсов

Идентификатор операции:
ResourceGroups_ExportTemplate

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

Параметры

Имя Ключ Обязательно Тип Описание
Subscription
 subscriptionId True string

Уникальный идентификатор подписки Microsoft Azure. Идентификатор подписки является частью идентификатора для каждого ресурса Azure.
Группа ресурсов
 resourceGroupName True string

Имя группы ресурсов.
resources
 resources array of string

Идентификаторы ресурсов. Единственной поддерживаемой в настоящее время строкой является "*" (все ресурсы). Будущие обновления API будут поддерживать экспорт определенных ресурсов.
options
 options string

Параметры шаблона экспорта. Поддерживаемые значения: IncludeParameterDefaultValue, IncludeComments или IncludeParameterDefaultValue, IncludeComments

Возвращаемое значение

Тело
ResourceGroupExportResult

Экспорт шаблона развертывания

Идентификатор операции:
Deployments_ExportTemplate

Экспортирует шаблон из предыдущего развертывания группы ресурсов.

Параметры

Имя Ключ Обязательно Тип Описание
Subscription
 subscriptionId True string

Уникальный идентификатор подписки Microsoft Azure. Идентификатор подписки является частью идентификатора для каждого ресурса Azure.
Группа ресурсов
 resourceGroupName True string

Имя группы ресурсов.
Название развертывания
 deploymentName True string

Имя развертывания шаблона группы ресурсов.

Возвращаемое значение

Результат экспорта развертывания.

Тело
DeploymentExportResult

Определения

Местоположение

Сведения о расположении.

Имя Путь Тип Описание
Идентификатор
 id string

Полный идентификатор расположения. Например, /subscriptions/0000000000-0000-0000-0000-0000000000/locations/westus.
идентификатор подписки;
 subscriptionId string

Идентификатор подписки.
Имя расположения
 name string

Имя расположения.
Отображаемое имя
 displayName string

Отображаемое имя расположения.
Широта
 latitude string

Широта местоположения.
Долгота
 longitude string

Долгота местоположения.

LocationListResult

Ответ операции списка расположений.

Имя Путь Тип Описание
value
 value array of Location

Расположения.

Subscription

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

Имя Путь Тип Описание
Идентификатор
 id string

Полный идентификатор. Например, /subscriptions/0000000000-0000-0000-0000-00000000000000000.
идентификатор подписки;
 subscriptionId string

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

Идентификатор клиента.
Отображаемое имя
 displayName string

Отображаемое имя подписки.
Государство
 state string

Состояние подписки.
Политики подписки
 subscriptionPolicies SubscriptionPolicies

Политики подписок.
Источник авторизации
 authorizationSource string

Источник авторизации запроса. Допустимые значения — это одно или несколько сочетаний устаревших версий, RoleBased, Обходных, Direct и Management. Например, "Устаревшая версия, RoleBased".

SubscriptionPolicies

Политики подписок.

Имя Путь Тип Описание
Идентификатор расположения
 locationPlacementId string

Идентификатор расположения подписки. Идентификатор указывает, какие регионы видны для подписки. Например, подписка с идентификатором размещения Public_2014-09-01 имеет доступ к общедоступным регионам Azure.
Идентификатор квоты
 quotaId string

Идентификатор квоты подписки.
Ограничение расходов
 spendingLimit string

Ограничение расходов на подписку.

SubscriptionListResult

Ответ на операцию списка подписок.

Имя Путь Тип Описание
value
 value array of Subscription

Подписки.
Следующая ссылка
 nextLink string

URL-адрес для получения следующего набора результатов.

Ссылка на шаблон

Сущность, представляющая ссылку на шаблон.

Имя Путь Тип Описание
Универсальный код ресурса (URI) шаблона
 uri string

URI, ссылающийся на шаблон.
Версия содержимого шаблона
 contentVersion string

Если он включен, он должен соответствовать ContentVersion в шаблоне.

ПараметрыСсылка

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

Имя Путь Тип Описание
URI параметров
 uri string

URI, ссылающийся на шаблон.
Версия содержимого параметров
 contentVersion string

Если он включен, он должен соответствовать ContentVersion в шаблоне.

Настройка отладки

Имя Путь Тип Описание
Уровень детализации
 detailLevel string

Уровень детализации отладки.

DeploymentExportResult

Результат экспорта развертывания.

Имя Путь Тип Описание
Template
 template object

Содержимое шаблона.

ResourceManagementErrorWithDetails

Имя Путь Тип Описание
код
 code string

Код ошибки, возвращенный сервером.
сообщение
 message string

Сообщение об ошибке, возвращенное сервером.
target
 target string

Целевой объект ошибки.
details
 details array of object

Ошибка проверки.

AliasPathType

Тип путей для псевдонима.

Имя Путь Тип Описание
путь
 path string

Путь псевдонима.
apiVersions
 apiVersions array of string

Версии api.

AliasType

Тип псевдонима.

Имя Путь Тип Описание
имя
 name string

Имя псевдонима.
Пути
 paths array of AliasPathType

Пути для псевдонима.

ProviderResourceType

Тип ресурса, управляемый поставщиком ресурсов.

Имя Путь Тип Описание
resourceType
 resourceType string

Тип ресурса.
местоположения
 locations array of ObjectWithoutType

Коллекция расположений, в которых можно создать этот тип ресурса.
псевдонимы
 aliases array of AliasType

Псевдонимы, поддерживаемые этим типом ресурса.
apiVersions
 apiVersions array of string

Версия API.
properties
 properties object

Свойства.

Provider

Сведения о поставщике ресурсов.

Имя Путь Тип Описание
Идентификатор
 id string

Идентификатор поставщика.
Namespace
 namespace string

Пространство имен поставщика.
Состояние регистрации
 registrationState string

Состояние регистрации поставщика.
Тип ресурса
 resourceTypes array of ProviderResourceType

Коллекция типов ресурсов поставщика.

BasicDependency

Сведения о зависимости развертывания.

Имя Путь Тип Описание
id
 id string

Идентификатор зависимости.
resourceType
 resourceType string

Тип ресурса зависимостей.
resourceName
 resourceName string

Имя ресурса зависимостей.

Зависимость

Сведения о зависимости развертывания.

Имя Путь Тип Описание
dependsOn
 dependsOn array of BasicDependency

Список зависимостей.
id
 id string

Идентификатор зависимости.
resourceType
 resourceType string

Тип ресурса зависимостей.
resourceName
 resourceName string

Имя ресурса зависимостей.

DeploymentPropertiesExtended

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

Имя Путь Тип Описание
provisioningState
 provisioningState string

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

Идентификатор корреляции развертывания.
отметка времени
 timestamp date-time

Метка времени развертывания шаблона.
выходные данные
 outputs object

Пары "ключ-значение", представляющие deploymentoutput.
providers
 providers array of Provider

Список поставщиков ресурсов, необходимых для развертывания.
зависимости
 dependencies array of Dependency

Список зависимостей развертывания.
шаблон
 template object

Содержимое шаблона. Используйте только один из шаблонов или TemplateLink.
шаблонСсылка
 templateLink TemplateLink

Сущность, представляющая ссылку на шаблон.
parameters
 parameters object

Параметры развертывания. Используйте только один из параметров или ParametersLink.
параметрыСсылка
 parametersLink ParametersLink

Сущность, представляющая ссылку на параматеры развертывания.
Режим развертывания
 mode string

Режим развертывания.
debugSetting
 debugSetting DebugSetting

DeploymentValidateResult

Сведения из ответа на развертывание шаблона.

Имя Путь Тип Описание
ошибка
 error ResourceManagementErrorWithDetails
properties
 properties DeploymentPropertiesExtended

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

DeploymentExtended

Сведения о развертывании.

Имя Путь Тип Описание
Идентификатор
 id string

Идентификатор развертывания.
Имя
 name string

Имя развертывания.
properties
 properties DeploymentPropertiesExtended

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

DeploymentListResult

Список развертываний.

Имя Путь Тип Описание
value
 value array of DeploymentExtended

Список развертываний.
Следующая ссылка
 nextLink string

URL-адрес для получения следующего набора результатов.

ProviderListResult

Список поставщиков ресурсов.

Имя Путь Тип Описание
value
 value array of Provider

Список поставщиков ресурсов.
nextLink
 nextLink string

URL-адрес для получения следующего набора результатов.

GenericResource

Сведения о ресурсе.

Имя Путь Тип Описание
Идентификатор
 id string

Идентификатор ресурса
Имя
 name string

Имя ресурса
Тип
 type string

Тип ресурса
Местоположение
 location string

Расположение ресурса
Метки
 tags object

Теги ресурсов
план
 plan Plan

Планирование ресурса.
Kind
 kind string

Тип ресурса.
Управляется (кем)
 managedBy string

Идентификатор ресурса, который управляет этим ресурсом.
Артикул (SKU)
 sku Sku

Sku для ресурса.
Идентичность
 identity Identity

Удостоверение ресурса.
Свойства
 properties object

Свойства ресурса.

Plan

Планирование ресурса.

Имя Путь Тип Описание
Идентификатор
 name string

Идентификатор плана.
Publisher
 publisher string

Идентификатор издателя.
Продукт
 product string

Идентификатор предложения.
Код повышения уровня
 promotionCode string

Код повышения.

Sku

Sku для ресурса.

Имя Путь Тип Описание
Имя
 name string

Имя SKU.
Тир
 tier string

Уровень SKU.
Size
 size string

Размер SKU.
Семья
 family string

Семья SKU.
Модель
 model string

Модель SKU.
Capacity
 capacity integer

Емкость SKU.

Идентичность

Удостоверение ресурса.

Имя Путь Тип Описание
Идентификатор субъекта
 principalId string

Идентификатор субъекта удостоверения ресурса.
Идентификатор арендатора
 tenantId string

Идентификатор клиента ресурса.
Тип
 type string

Тип удостоверения.

ResourceListResult

Список ресурсов.

Имя Путь Тип Описание
value
 value array of GenericResource

Список ресурсов.
Следующая ссылка
 nextLink string

URL-адрес для получения следующего набора результатов.

ResourceGroup

Сведения о группе ресурсов.

Имя Путь Тип Описание
Идентификатор
 id string

Идентификатор группы ресурсов (например, /subscriptions/XXX/resourceGroups/YYY).
Имя
 name string

Имя группы ресурсов.
Местоположение
 location string

Расположение группы ресурсов. Его нельзя изменить после создания группы ресурсов. Должно быть одним из поддерживаемых расположений Azure, таких как западная часть США, восточная часть США, Западная Европа, Восточная Азия и т. д.
Управляется (кем)
 managedBy string

Идентификатор ресурса, который управляет этой группой ресурсов.
Метки
 tags object

Теги, присоединенные к группе ресурсов.
properties
 properties ResourceGroupProperties

Свойства группы ресурсов.

ResourceGroupProperties

Свойства группы ресурсов.

Имя Путь Тип Описание
Состояние подготовки
 provisioningState string

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

ResourceGroupListResult

Список групп ресурсов.

Имя Путь Тип Описание
value
 value array of ResourceGroup

Список групп ресурсов.
Следующая ссылка
 nextLink string

URL-адрес для получения следующего набора результатов.

TagCount

Число тегов.

Имя Путь Тип Описание
Тип
 type string

Тип счетчика.
Ценность
 value integer

Значение счетчика.

TagValue

Сведения о теге.

Имя Путь Тип Описание
Идентификатор тега
 id string

Идентификатор тега.
Значение тега
 tagValue string

Значение тега.
Число тегов
 count TagCount

Число тегов.

TagDetails

Сведения о теге.

Имя Путь Тип Описание
Идентификатор
 id string

Идентификатор тега.
Имя
 tagName string

Имя тега.
Число тегов
 count TagCount

Число тегов.
values
 values array of TagValue

Список значений тегов.

TagsListResult

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

Имя Путь Тип Описание
value
 value array of TagDetails

Список тегов.
nextLink
 nextLink string

URL-адрес для получения следующего набора результатов.

TargetResource

Целевой ресурс.

Имя Путь Тип Описание
Идентификатор
 id string

Идентификатор ресурса.
Имя
 resourceName string

Имя ресурса.
Тип
 resourceType string

Тип ресурса.

HttpMessage

Имя Путь Тип Описание
содержимое
 content object

Содержимое HTTP-сообщения.

DeploymentOperationProperties

Свойства операции развертывания.

Имя Путь Тип Описание
provisioningState
 provisioningState string

Состояние подготовки.
отметка времени
 timestamp date-time

Дата и время операции.
serviceRequestId
 serviceRequestId string

Идентификатор запроса службы операций развертывания.
код состояния
 statusCode string

Код состояния операции.
statusMessage
 statusMessage object

Сообщение о состоянии операции.
Целевой ресурс
 targetResource TargetResource

Целевой ресурс.
request
 request HttpMessage
response
 response HttpMessage

DeploymentOperation

Сведения об операциях развертывания.

Имя Путь Тип Описание
Идентификатор
 id string

Полный идентификатор операции развертывания.
Идентификатор операции
 operationId string

Идентификатор операции развертывания.
properties
 properties DeploymentOperationProperties

Свойства операции развертывания.

DeploymentOperationsListResult

Список операций развертывания.

Имя Путь Тип Описание
value
 value array of DeploymentOperation

Список развертываний.
Следующая ссылка
 nextLink string

URL-адрес для получения следующего набора результатов.

ResourceGroupExportResult

Имя Путь Тип Описание
Template
 template object

Содержимое шаблона.
ошибка
 error ResourceManagementErrorWithDetails

ObjectWithoutType

объект

Это тип object.