Deployments - List By Resource Group

Служба:

Resource Management

Версия API:

2021-04-01

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

GET https://management.azure.com/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Resources/deployments/?api-version=2021-04-01

С использованием необязательных параметров:

GET https://management.azure.com/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Resources/deployments/?$filter={$filter}&$top={$top}&api-version=2021-04-01

Параметры URI

Имя	В	Обязательно	Тип	Описание
resourceGroupName	path	True	string minLength: 1 maxLength: 90 pattern: ^[-\w\._\(\)]+$	Имя группы ресурсов с развертываниями, которые нужно получить. Имя не учитывает регистр.
subscriptionId	path	True	string	Идентификатор подписки Microsoft Azure.
api-version	query	True	string	Версия API, используемая для этой операции.
$filter	query		string	Фильтр, применяемый к операции. Например, можно использовать $filter=provisioningState eq "{state}".
$top	query		integer (int32)	Количество результатов, которые нужно получить. Если значение NULL передается, возвращает все развертывания.

Ответы

Имя	Тип	Описание
200 OK	DeploymentListResult	ОК. Возвращает массив развертываний.
Other Status Codes	CloudError	Ответ на ошибку, описывающий причину сбоя операции.

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

azure_auth

Поток OAuth2 Azure Active Directory

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

Области

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

Определения

Имя	Описание
Alias	Тип псевдонима.
AliasPath	Тип путей для псевдонима.
AliasPathAttributes	Атрибуты маркера, к которому ссылается путь псевдонима.
AliasPathMetadata
AliasPathTokenType	Тип маркера, на который ссылается путь псевдонима.
AliasPattern	Тип шаблона для пути псевдонима.
AliasPatternType	Тип шаблона псевдонима
AliasType	Тип псевдонима.
ApiProfile
BasicDependency	Сведения о зависимости развертывания.
CloudError	Ответ об ошибке для запроса на управление ресурсами.
DebugSetting	Параметр отладки.
Dependency	Сведения о зависимости развертывания.
DeploymentExtended	Сведения о развертывании.
DeploymentListResult	Список развертываний.
DeploymentMode	Режим, используемый для развертывания ресурсов. Это значение может быть добавочным или завершенным. В добавочном режиме ресурсы развертываются без удаления существующих ресурсов, не включенных в шаблон. В полном режиме ресурсы развертываются и существующие ресурсы в группе ресурсов, не включенные в шаблон, удаляются. Будьте осторожны при использовании режима завершения, так как вы можете непреднамеренно удалить ресурсы.
DeploymentPropertiesExtended	Свойства развертывания с дополнительными сведениями.
ErrorAdditionalInfo	Дополнительные сведения об ошибке управления ресурсами.
ErrorResponse	Ответ на ошибку
OnErrorDeploymentExtended	Развертывание по поведению ошибок с дополнительными сведениями.
OnErrorDeploymentType	Развертывание по типу поведения ошибки. Возможные значения: LastSuccessful и SpecificDeployment.
ParametersLink	Сущность, представляющая ссылку на параметры развертывания.
Provider	Сведения о поставщике ресурсов.
ProviderAuthorizationConsentState	Состояние согласия на авторизацию поставщика.
ProviderExtendedLocation	Расширенное расположение поставщика.
ProviderResourceType	Тип ресурса, управляемый поставщиком ресурсов.
ProvisioningState	Обозначает состояние подготовки.
ResourceReference	Модель идентификатора ресурса.
TemplateLink	Сущность, представляющая ссылку на шаблон.
ZoneMapping

Alias

Object

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

Имя	Тип	Описание
defaultMetadata	AliasPathMetadata	Метаданные пути псевдонима по умолчанию. Применяется к пути по умолчанию и к любому пути псевдонима, у которых нет метаданных
defaultPath	string	Путь по умолчанию для псевдонима.
defaultPattern	AliasPattern	Шаблон по умолчанию для псевдонима.
name	string	Имя псевдонима.
paths	AliasPath[]	Пути для псевдонима.
type	AliasType	Тип псевдонима.

AliasPath

Object

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

Имя	Тип	Описание
apiVersions	string[]	Версии API.
metadata	AliasPathMetadata	Метаданные пути псевдонима. Если отсутствует, вернитесь к метаданным по умолчанию псевдонима.
path	string	Путь псевдонима.
pattern	AliasPattern	Шаблон для пути псевдонима.

AliasPathAttributes

Перечисление

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

Значение	Описание
Modifiable	Маркер, на который ссылается путь псевдонима, можно изменить с помощью политик с эффектом "изменить".
None	Маркер, на который ссылается путь псевдонима, не имеет атрибутов.

AliasPathMetadata

Object

Имя	Тип	Описание
attributes	AliasPathAttributes	Атрибуты маркера, к которому ссылается путь псевдонима.
type	AliasPathTokenType	Тип маркера, на который ссылается путь псевдонима.

AliasPathTokenType

Перечисление

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

Значение	Описание
Any	Тип токена может быть любым.
Array	Тип токена — массив.
Boolean	Тип токена является логическим.
Integer	Тип токена является целым числом.
NotSpecified	Тип токена не указан.
Number	Тип токена — число.
Object	Тип токена — объект.
String	Тип токена — строка.

AliasPattern

Object

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

Имя	Тип	Описание
phrase	string	Фраза шаблона псевдонима.
type	AliasPatternType	Тип шаблона псевдонима
variable	string	Переменная шаблона псевдонима.

AliasPatternType

Перечисление

Тип шаблона псевдонима

Значение	Описание
Extract	Извлечение является единственным допустимым значением.
NotSpecified	NotSpecified не допускается.

AliasType

Перечисление

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

Значение	Описание
Mask	Значение псевдонима — секрет.
NotSpecified	Тип псевдонима неизвестен (так же, как и не предоставляющий тип псевдонима).
PlainText	Значение псевдонима не является секретом.

ApiProfile

Object

Имя	Тип	Описание
apiVersion	string	Версия API.
profileVersion	string	Версия профиля.

BasicDependency

Object

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

Имя	Тип	Описание
id	string	Идентификатор зависимости.
resourceName	string	Имя ресурса зависимостей.
resourceType	string	Тип ресурса зависимостей.

CloudError

Object

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

Имя	Тип	Описание
error	ErrorResponse	Ответ на ошибку Распространенный ответ об ошибке для всех API Azure Resource Manager для возврата сведений об ошибке для неудачных операций. (Это также следует формату ответа на ошибку OData.)

DebugSetting

Object

Параметр отладки.

Имя	Тип	Описание
detailLevel	string	Указывает тип сведений для входа в журнал для отладки. Допустимые значения не имеют значения, requestContent, responseContent или requestContent и responseContent, разделенные запятой. Значение по умолчанию — нет. При настройке этого значения внимательно рассмотрите тип информации, которую вы передаете во время развертывания. Ведение журнала сведений о запросе или ответе может потенциально предоставлять конфиденциальные данные, полученные с помощью операций развертывания.

Dependency

Object

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

Имя	Тип	Описание
dependsOn	BasicDependency[]	Список зависимостей.
id	string	Идентификатор зависимости.
resourceName	string	Имя ресурса зависимостей.
resourceType	string	Тип ресурса зависимостей.

DeploymentExtended

Object

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

Имя	Тип	Описание
id	string	Идентификатор развертывания.
location	string	расположение развертывания.
name	string	Имя развертывания.
properties	DeploymentPropertiesExtended	Свойства развертывания.
tags	object	Теги развертывания
type	string	Тип развертывания.

DeploymentListResult

Object

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

Имя	Тип	Описание
nextLink	string	URL-адрес, используемый для получения следующего набора результатов.
value	DeploymentExtended[]	Массив развертываний.

DeploymentMode

Перечисление

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

Значение	Описание
Complete
Incremental

DeploymentPropertiesExtended

Object

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

Имя	Тип	Описание
correlationId	string	Идентификатор корреляции развертывания.
debugSetting	DebugSetting	Параметр отладки развертывания.
dependencies	Dependency[]	Список зависимостей развертывания.
duration	string	Длительность развертывания шаблона.
error	ErrorResponse	Ответ на ошибку Ошибка развертывания.
mode	DeploymentMode	Режим развертывания. Возможные значения— добавочные и полные.
onErrorDeployment	OnErrorDeploymentExtended	Развертывание по поведению ошибок.
outputResources	ResourceReference[]	Массив подготовленных ресурсов.
outputs	object	Пары "ключ-значение", представляющие выходные данные развертывания.
parameters	object	Параметры развертывания.
parametersLink	ParametersLink	Универсальный код ресурса (URI), ссылающийся на параметры.
providers	Provider[]	Список поставщиков ресурсов, необходимых для развертывания.
provisioningState	ProvisioningState	Обозначает состояние подготовки.
templateHash	string	Хэш, созданный для шаблона.
templateLink	TemplateLink	Универсальный код ресурса (URI), ссылающийся на шаблон.
timestamp	string (date-time)	Метка времени развертывания шаблона.
validatedResources	ResourceReference[]	Массив проверенных ресурсов.

ErrorAdditionalInfo

Object

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

Имя	Тип	Описание
info	object	Дополнительные сведения.
type	string	Дополнительный тип сведений.

ErrorResponse

Object

Ответ на ошибку

Имя	Тип	Описание
additionalInfo	ErrorAdditionalInfo[]	Дополнительные сведения об ошибке.
code	string	Код ошибки.
details	ErrorResponse[]	Сведения об ошибке.
message	string	Сообщение об ошибке.
target	string	Целевой объект ошибки.

OnErrorDeploymentExtended

Object

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

Имя	Тип	Описание
deploymentName	string	Развертывание, используемое в случае ошибки.
provisioningState	string	Состояние подготовки для развертывания ошибок.
type	OnErrorDeploymentType	Развертывание по типу поведения ошибки. Возможные значения: LastSuccessful и SpecificDeployment.

OnErrorDeploymentType

Перечисление

Развертывание по типу поведения ошибки. Возможные значения: LastSuccessful и SpecificDeployment.

Значение	Описание
LastSuccessful
SpecificDeployment

ParametersLink

Object

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

Имя	Тип	Описание
contentVersion	string	Если этот параметр включен, должен соответствовать ContentVersion в шаблоне.
uri	string	URI файла параметров.

Provider

Object

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

Имя	Тип	Описание
id	string	Идентификатор поставщика.
namespace	string	Пространство имен поставщика ресурсов.
providerAuthorizationConsentState	ProviderAuthorizationConsentState	Состояние согласия на авторизацию поставщика.
registrationPolicy	string	Политика регистрации поставщика ресурсов.
registrationState	string	Состояние регистрации поставщика ресурсов.
resourceTypes	ProviderResourceType[]	Коллекция типов ресурсов поставщика.

ProviderAuthorizationConsentState

Перечисление

Состояние согласия на авторизацию поставщика.

Значение	Описание
Consented
NotRequired
NotSpecified
Required

ProviderExtendedLocation

Object

Расширенное расположение поставщика.

Имя	Тип	Описание
extendedLocations	string[]	Расширенные расположения для расположения Azure.
location	string	Расположение Azure.
type	string	Тип расширенного расположения.

ProviderResourceType

Object

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

Имя	Тип	Описание
aliases	Alias[]	Псевдонимы, поддерживаемые этим типом ресурса.
apiProfiles	ApiProfile[]	Профили API для поставщика ресурсов.
apiVersions	string[]	Версия API.
capabilities	string	Дополнительные возможности, предоставляемые этим типом ресурсов.
defaultApiVersion	string	Версия API по умолчанию.
locationMappings	ProviderExtendedLocation[]	Сопоставления расположений, поддерживаемые этим типом ресурса.
locations	string[]	Коллекция расположений, в которых можно создать этот тип ресурса.
properties	object	Свойства.
resourceType	string	Тип ресурса.
zoneMappings	ZoneMapping[]

ProvisioningState

Перечисление

Обозначает состояние подготовки.

Значение	Описание
Accepted
Canceled
Created
Creating
Deleted
Deleting
Failed
NotSpecified
Ready
Running
Succeeded
Updating

ResourceReference

Object

Модель идентификатора ресурса.

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

TemplateLink

Object

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

Имя	Тип	Описание
contentVersion	string	Если этот параметр включен, должен соответствовать ContentVersion в шаблоне.
id	string	Идентификатор ресурса спецификации шаблона. Используйте свойство идентификатора или URI, но не оба.
queryString	string	Строка запроса (например, маркер SAS), используемая с универсальным кодом ресурса (URI) templateLink.
relativePath	string	Свойство relativePath можно использовать для развертывания связанного шаблона в расположении относительно родительского элемента. Если родительский шаблон связан с TemplateSpec, это будет ссылаться на артефакт в TemplateSpec. Если родительский объект связан с универсальным кодом ресурса (URI), дочернее развертывание будет сочетанием родительских и относительных URIPath.
uri	string	Универсальный код ресурса (URI) шаблона для развертывания. Используйте URI или свойство id, но не оба.

ZoneMapping

Object

Имя	Тип	Описание
location	string	Расположение сопоставления зоны.
zones	string[]