Deployments - Create Or Update At Management Group Scope
Развертывает ресурсы в группе управления область.
Шаблон и параметры можно указать непосредственно в запросе или ссылке на JSON-файлы.
PUT https://management.azure.com/providers/Microsoft.Management/managementGroups/{groupId}/providers/Microsoft.Resources/deployments/{deploymentName}?api-version=2021-04-01
Параметры URI
Имя | В | Обязательно | Тип | Описание |
---|---|---|---|---|
deployment
|
path | True |
string |
Имя развертывания. Шаблон регулярного выражения: |
group
|
path | True |
string |
Идентификатор группы управления. |
api-version
|
query | True |
string |
Версия API, используемая для данной операции. |
Текст запроса
Имя | Обязательно | Тип | Описание |
---|---|---|---|
location | True |
string |
Расположение для хранения данных развертывания. |
properties | True |
Свойства развертывания. |
|
tags |
object |
Теги развертывания |
Ответы
Имя | Тип | Описание |
---|---|---|
200 OK |
ОК . Возвращает сведения о развертывании, включая состояние подготовки. |
|
201 Created |
Создано — возвращает сведения о развертывании, включая состояние подготовки. |
|
Other Status Codes |
Ответ об ошибке, описывающий причину сбоя операции. |
Безопасность
azure_auth
Поток OAuth2 в Azure Active Directory
Тип:
oauth2
Flow:
implicit
URL-адрес авторизации:
https://login.microsoftonline.com/common/oauth2/authorize
Области
Имя | Описание |
---|---|
user_impersonation | олицетворения учетной записи пользователя |
Примеры
Create deployment at management group scope.
Образец запроса
PUT https://management.azure.com/providers/Microsoft.Management/managementGroups/my-management-group-id/providers/Microsoft.Resources/deployments/my-deployment?api-version=2021-04-01
{
"location": "eastus",
"properties": {
"templateLink": {
"uri": "https://example.com/exampleTemplate.json"
},
"parameters": {},
"mode": "Incremental"
}
}
Пример ответа
{
"id": "/providers/Microsoft.Management/managementGroups/my-management-group-id/providers/Microsoft.Resources/deployments/my-deployment",
"name": "my-deployment",
"type": "Microsoft.Resources/deployments",
"location": "eastus",
"properties": {
"parameters": {},
"mode": "Incremental",
"provisioningState": "Accepted",
"timestamp": "2019-04-24T22:52:38.7895563Z",
"duration": "PT1.2970875S",
"correlationId": "00000000-0000-0000-0000-000000000000",
"providers": [
{
"namespace": "Microsoft.Authorization",
"resourceTypes": [
{
"resourceType": "policyDefinitions",
"locations": [
null
]
},
{
"resourceType": "policyAssignments",
"locations": [
null
]
}
]
},
{
"namespace": "Microsoft.Resources",
"resourceTypes": [
{
"resourceType": "deployments",
"locations": [
"eastus"
]
}
]
}
],
"dependencies": [
{
"dependsOn": [
{
"id": "/providers/Microsoft.Management/managementGroups/my-management-group-id/providers/Microsoft.Authorization/policyDefinitions/policy-definition-name",
"resourceType": "Microsoft.Authorization/policyDefinitions",
"resourceName": "policy-definition-name"
}
],
"id": "/providers/Microsoft.Management/managementGroups/my-management-group-id/providers/Microsoft.Authorization/policyAssignments/location-lock",
"resourceType": "Microsoft.Authorization/policyAssignments",
"resourceName": "location-lock"
}
]
}
}
{
"id": "/providers/Microsoft.Management/managementGroups/my-management-group-id/providers/Microsoft.Resources/deployments/my-deployment",
"name": "my-deployment",
"type": "Microsoft.Resources/deployments",
"location": "eastus",
"properties": {
"parameters": {},
"mode": "Incremental",
"provisioningState": "Accepted",
"timestamp": "2019-04-24T22:52:38.7895563Z",
"duration": "PT1.2970875S",
"correlationId": "00000000-0000-0000-0000-000000000000",
"providers": [
{
"namespace": "Microsoft.Authorization",
"resourceTypes": [
{
"resourceType": "policyDefinitions",
"locations": [
null
]
},
{
"resourceType": "policyAssignments",
"locations": [
null
]
}
]
},
{
"namespace": "Microsoft.Resources",
"resourceTypes": [
{
"resourceType": "deployments",
"locations": [
"eastus"
]
}
]
}
],
"dependencies": [
{
"dependsOn": [
{
"id": "/providers/Microsoft.Management/managementGroups/my-management-group-id/providers/Microsoft.Authorization/policyDefinitions/policy-definition-name",
"resourceType": "Microsoft.Authorization/policyDefinitions",
"resourceName": "policy-definition-name"
}
],
"id": "/providers/Microsoft.Management/managementGroups/my-management-group-id/providers/Microsoft.Authorization/policyAssignments/location-lock",
"resourceType": "Microsoft.Authorization/policyAssignments",
"resourceName": "location-lock"
}
]
}
}
Определения
Имя | Описание |
---|---|
Alias |
Тип псевдонима. |
Alias |
Тип путей для псевдонима. |
Alias |
Атрибуты маркера, на который ссылается путь псевдонима. |
Alias |
|
Alias |
Тип маркера, на который ссылается путь псевдонима. |
Alias |
Тип шаблона для пути псевдонима. |
Alias |
Тип шаблона псевдонима |
Alias |
Тип псевдонима. |
Api |
|
Basic |
Информация о зависимостях развертывания. |
Cloud |
Ответ об ошибке для запроса на управление ресурсами. |
Debug |
Параметр отладки. |
Dependency |
Информация о зависимостях развертывания. |
Deployment |
Информация о развертывании. |
Deployment |
Режим, используемый для развертывания ресурсов. Это значение может быть добавочным или завершенным. В инкрементном режиме ресурсы развертываются без удаления существующих ресурсов, не включенных в шаблон. В режиме Завершения ресурсы развертываются, а существующие ресурсы в группе ресурсов, не включенные в шаблон, удаляются. Будьте внимательны при использовании полного режима, так как вы можете непреднамеренно удалить ресурсы. |
Deployment |
Свойства развертывания. |
Deployment |
Свойства развертывания с дополнительными сведениями. |
Error |
Дополнительные сведения об ошибке управления ресурсами. |
Error |
Сообщение об ошибке |
Expression |
Указывает, вычисляются ли выражения шаблона в область родительского или вложенного шаблона. |
Expression |
Область, используемый для оценки параметров, переменных и функций во вложенном шаблоне. |
On |
Развертывание при поведении ошибки. |
On |
Развертывание при поведении ошибки с дополнительными сведениями. |
On |
Тип поведения развертывания при ошибке. Возможные значения: LastSuccessful и SpecificDeployment. |
Parameters |
Сущность, представляющая ссылку на параметры развертывания. |
Provider |
Информация о поставщике ресурсов. |
Provider |
Состояние согласия авторизации поставщика. |
Provider |
Расширенное расположение поставщика. |
Provider |
Тип ресурса, управляемый поставщиком ресурсов. |
Provisioning |
Обозначает состояние подготовки. |
Resource |
Модель идентификатора ресурса. |
Scoped |
Параметры операции развертывания. |
Template |
Сущность, представляющая ссылку на шаблон. |
Zone |
Alias
Тип псевдонима.
Имя | Тип | Описание |
---|---|---|
defaultMetadata |
Метаданные пути псевдонима по умолчанию. Применяется к пути по умолчанию и к любому пути псевдонима, который не содержит метаданных. |
|
defaultPath |
string |
Путь по умолчанию для псевдонима. |
defaultPattern |
Шаблон по умолчанию для псевдонима. |
|
name |
string |
Имя псевдонима. |
paths |
Пути для псевдонима. |
|
type |
Тип псевдонима. |
AliasPath
Тип путей для псевдонима.
Имя | Тип | Описание |
---|---|---|
apiVersions |
string[] |
Версии API. |
metadata |
Метаданные пути псевдонима. Если он отсутствует, вернитесь к метаданным псевдонима по умолчанию. |
|
path |
string |
Путь псевдонима. |
pattern |
Шаблон для пути псевдонима. |
AliasPathAttributes
Атрибуты маркера, на который ссылается путь псевдонима.
Имя | Тип | Описание |
---|---|---|
Modifiable |
string |
Маркер, на который ссылается путь псевдонима, можно изменить с помощью политик с эффектом "изменить". |
None |
string |
Маркер, на который ссылается путь псевдонима, не имеет атрибутов. |
AliasPathMetadata
Имя | Тип | Описание |
---|---|---|
attributes |
Атрибуты маркера, на который ссылается путь псевдонима. |
|
type |
Тип маркера, на который ссылается путь псевдонима. |
AliasPathTokenType
Тип маркера, на который ссылается путь псевдонима.
Имя | Тип | Описание |
---|---|---|
Any |
string |
Тип токена может быть любым. |
Array |
string |
Тип токена — array. |
Boolean |
string |
Тип токена — логический. |
Integer |
string |
Тип токена — integer. |
NotSpecified |
string |
Тип токена не указан. |
Number |
string |
Тип токена — number. |
Object |
string |
Тип токена — object. |
String |
string |
Тип токена — string. |
AliasPattern
Тип шаблона для пути псевдонима.
Имя | Тип | Описание |
---|---|---|
phrase |
string |
Фраза шаблона псевдонима. |
type |
Тип шаблона псевдонима |
|
variable |
string |
Переменная шаблона псевдонима. |
AliasPatternType
Тип шаблона псевдонима
Имя | Тип | Описание |
---|---|---|
Extract |
string |
Извлечение — это единственное допустимое значение. |
NotSpecified |
string |
NotSpecified не допускается. |
AliasType
Тип псевдонима.
Имя | Тип | Описание |
---|---|---|
Mask |
string |
Значение псевдонима — secret. |
NotSpecified |
string |
Тип псевдонима неизвестен (то же самое, что тип псевдонима не указан). |
PlainText |
string |
Значение псевдонима не является секретным. |
ApiProfile
Имя | Тип | Описание |
---|---|---|
apiVersion |
string |
Версия API. |
profileVersion |
string |
Версия профиля. |
BasicDependency
Информация о зависимостях развертывания.
Имя | Тип | Описание |
---|---|---|
id |
string |
Идентификатор зависимости. |
resourceName |
string |
Имя ресурса зависимости. |
resourceType |
string |
Тип ресурса зависимости. |
CloudError
Ответ об ошибке для запроса на управление ресурсами.
Имя | Тип | Описание |
---|---|---|
error |
Сообщение об ошибке |
DebugSetting
Параметр отладки.
Имя | Тип | Описание |
---|---|---|
detailLevel |
string |
Указывает тип сведений для записи в журнал для отладки. Допустимые значения: none, requestContent, responseContent или requestContent и responseContent разделены запятой. Значение по умолчанию — none. При установке этого значения тщательно учитывайте тип данных, которые передаются во время развертывания. При ведении журнала с информацией о запросе или ответе возможно раскрытие конфиденциальных данных, извлекаемых с помощью операций развертывания. |
Dependency
Информация о зависимостях развертывания.
Имя | Тип | Описание |
---|---|---|
dependsOn |
Список зависимостей. |
|
id |
string |
Идентификатор зависимости. |
resourceName |
string |
Имя ресурса зависимости. |
resourceType |
string |
Тип ресурса зависимости. |
DeploymentExtended
Информация о развертывании.
Имя | Тип | Описание |
---|---|---|
id |
string |
Идентификатор развертывания. |
location |
string |
расположение развертывания. |
name |
string |
Имя развертывания. |
properties |
Свойства развертывания. |
|
tags |
object |
Теги развертывания |
type |
string |
Тип развертывания. |
DeploymentMode
Режим, используемый для развертывания ресурсов. Это значение может быть добавочным или завершенным. В инкрементном режиме ресурсы развертываются без удаления существующих ресурсов, не включенных в шаблон. В режиме Завершения ресурсы развертываются, а существующие ресурсы в группе ресурсов, не включенные в шаблон, удаляются. Будьте внимательны при использовании полного режима, так как вы можете непреднамеренно удалить ресурсы.
Имя | Тип | Описание |
---|---|---|
Complete |
string |
|
Incremental |
string |
DeploymentProperties
Свойства развертывания.
Имя | Тип | Описание |
---|---|---|
debugSetting |
Параметр отладки развертывания. |
|
expressionEvaluationOptions |
Указывает, вычисляются ли выражения шаблона в область родительского или вложенного шаблона. Применимо только к вложенным шаблонам. Если значение не указано, значение по умолчанию — внешнее. |
|
mode |
Режим, используемый для развертывания ресурсов. Это значение может быть добавочным или завершенным. В инкрементном режиме ресурсы развертываются без удаления существующих ресурсов, не включенных в шаблон. В режиме Завершения ресурсы развертываются, а существующие ресурсы в группе ресурсов, не включенные в шаблон, удаляются. Будьте внимательны при использовании полного режима, так как вы можете непреднамеренно удалить ресурсы. |
|
onErrorDeployment |
Развертывание при поведении ошибки. |
|
parameters |
object |
Пары имен и значений, определяющие параметры развертывания для шаблона. Этот элемент используется, если требуется указать значения параметров непосредственно в запросе, а не ссылаться на существующий файл параметров. Используйте свойство parametersLink или свойство parameters, но не оба. Это может быть JObject или строка JSON правильного формата. |
parametersLink |
Универсальный код ресурса (URI) файла параметров. Этот элемент используется для связывания с существующим файлом параметров. Используйте свойство parametersLink или свойство parameters, но не оба. |
|
template |
object |
Содержимое шаблона. Этот элемент используется, если требуется передать синтаксис шаблона непосредственно в запросе, а не ссылку на существующий шаблон. Это может быть JObject или строка JSON правильного формата. Используйте свойство templateLink или свойство шаблона, но не оба. |
templateLink |
Универсальный код ресурса (URI) шаблона. Используйте свойство templateLink или свойство шаблона, но не оба. |
DeploymentPropertiesExtended
Свойства развертывания с дополнительными сведениями.
Имя | Тип | Описание |
---|---|---|
correlationId |
string |
Идентификатор корреляции развертывания. |
debugSetting |
Параметр отладки развертывания. |
|
dependencies |
Список зависимостей развертывания. |
|
duration |
string |
Длительность развертывания шаблона. |
error |
Сообщение об ошибке |
|
mode |
Режим развертывания. Возможные значения: Добавочный и Полный. |
|
onErrorDeployment |
Развертывание при поведении ошибки. |
|
outputResources |
Массив подготовленных ресурсов. |
|
outputs |
object |
Пары "ключ-значение", представляющие выходные данные развертывания. |
parameters |
object |
Параметры развертывания. |
parametersLink |
Универсальный код ресурса (URI), ссылающийся на параметры. |
|
providers |
Provider[] |
Список поставщиков ресурсов, необходимых для развертывания. |
provisioningState |
Обозначает состояние подготовки. |
|
templateHash |
string |
Хэш, созданный для шаблона. |
templateLink |
Универсальный код ресурса (URI), ссылающийся на шаблон. |
|
timestamp |
string |
Метка времени развертывания шаблона. |
validatedResources |
Массив проверенных ресурсов. |
ErrorAdditionalInfo
Дополнительные сведения об ошибке управления ресурсами.
Имя | Тип | Описание |
---|---|---|
info |
object |
Дополнительные сведения. |
type |
string |
Тип дополнительных сведений. |
ErrorResponse
Сообщение об ошибке
Имя | Тип | Описание |
---|---|---|
additionalInfo |
Дополнительные сведения об ошибке. |
|
code |
string |
Код ошибки. |
details |
Сведения об ошибке. |
|
message |
string |
Сообщение об ошибке. |
target |
string |
Целевой объект ошибки. |
ExpressionEvaluationOptions
Указывает, вычисляются ли выражения шаблона в область родительского или вложенного шаблона.
Имя | Тип | Описание |
---|---|---|
scope |
Область, используемый для оценки параметров, переменных и функций во вложенном шаблоне. |
ExpressionEvaluationOptionsScopeType
Область, используемый для оценки параметров, переменных и функций во вложенном шаблоне.
Имя | Тип | Описание |
---|---|---|
Inner |
string |
|
NotSpecified |
string |
|
Outer |
string |
OnErrorDeployment
Развертывание при поведении ошибки.
Имя | Тип | Описание |
---|---|---|
deploymentName |
string |
Развертывание, используемое при возникновении ошибки. |
type |
Тип поведения развертывания при ошибке. Возможные значения: LastSuccessful и SpecificDeployment. |
OnErrorDeploymentExtended
Развертывание при поведении ошибки с дополнительными сведениями.
Имя | Тип | Описание |
---|---|---|
deploymentName |
string |
Развертывание, используемое при возникновении ошибки. |
provisioningState |
string |
Состояние подготовки для развертывания при ошибке. |
type |
Тип поведения развертывания при ошибке. Возможные значения: LastSuccessful и SpecificDeployment. |
OnErrorDeploymentType
Тип поведения развертывания при ошибке. Возможные значения: LastSuccessful и SpecificDeployment.
Имя | Тип | Описание |
---|---|---|
LastSuccessful |
string |
|
SpecificDeployment |
string |
ParametersLink
Сущность, представляющая ссылку на параметры развертывания.
Имя | Тип | Описание |
---|---|---|
contentVersion |
string |
Если этот параметр включен, должен соответствовать ContentVersion в шаблоне. |
uri |
string |
Универсальный код ресурса (URI) файла параметров. |
Provider
Информация о поставщике ресурсов.
Имя | Тип | Описание |
---|---|---|
id |
string |
Идентификатор поставщика. |
namespace |
string |
Пространство имен поставщика ресурсов. |
providerAuthorizationConsentState |
Состояние согласия авторизации поставщика. |
|
registrationPolicy |
string |
Политика регистрации поставщика ресурсов. |
registrationState |
string |
Состояние регистрации поставщика ресурсов. |
resourceTypes |
Коллекция типов ресурсов поставщика. |
ProviderAuthorizationConsentState
Состояние согласия авторизации поставщика.
Имя | Тип | Описание |
---|---|---|
Consented |
string |
|
NotRequired |
string |
|
NotSpecified |
string |
|
Required |
string |
ProviderExtendedLocation
Расширенное расположение поставщика.
Имя | Тип | Описание |
---|---|---|
extendedLocations |
string[] |
Расширенные расположения для расположения Azure. |
location |
string |
Расположение Azure. |
type |
string |
Тип расширенного расположения. |
ProviderResourceType
Тип ресурса, управляемый поставщиком ресурсов.
Имя | Тип | Описание |
---|---|---|
aliases |
Alias[] |
Псевдонимы, поддерживаемые этим типом ресурсов. |
apiProfiles |
Профили API для поставщика ресурсов. |
|
apiVersions |
string[] |
Версия API. |
capabilities |
string |
Дополнительные возможности, предоставляемые этим типом ресурсов. |
defaultApiVersion |
string |
Версия API по умолчанию. |
locationMappings |
Сопоставления расположений, поддерживаемые этим типом ресурсов. |
|
locations |
string[] |
Коллекция расположений, в которых можно создать ресурс этого типа. |
properties |
object |
Свойства. |
resourceType |
string |
Тип ресурса. |
zoneMappings |
ProvisioningState
Обозначает состояние подготовки.
Имя | Тип | Описание |
---|---|---|
Accepted |
string |
|
Canceled |
string |
|
Created |
string |
|
Creating |
string |
|
Deleted |
string |
|
Deleting |
string |
|
Failed |
string |
|
NotSpecified |
string |
|
Ready |
string |
|
Running |
string |
|
Succeeded |
string |
|
Updating |
string |
ResourceReference
Модель идентификатора ресурса.
Имя | Тип | Описание |
---|---|---|
id |
string |
Полный идентификатор ресурса. |
ScopedDeployment
Параметры операции развертывания.
Имя | Тип | Описание |
---|---|---|
location |
string |
Расположение для хранения данных развертывания. |
properties |
Свойства развертывания. |
|
tags |
object |
Теги развертывания |
TemplateLink
Сущность, представляющая ссылку на шаблон.
Имя | Тип | Описание |
---|---|---|
contentVersion |
string |
Если этот параметр включен, должен соответствовать ContentVersion в шаблоне. |
id |
string |
Идентификатор ресурса спецификации шаблона. Используйте свойство id или URI, но не оба. |
queryString |
string |
Строка запроса (например, маркер SAS), используемая с URI templateLink. |
relativePath |
string |
Свойство relativePath можно использовать для развертывания связанного шаблона в расположении относительно родительского элемента. Если родительский шаблон был связан с TemplateSpec, он будет ссылаться на артефакт в TemplateSpec. Если родительский элемент был связан с URI, дочернее развертывание будет сочетанием родительских и относительных URI. |
uri |
string |
Универсальный код ресурса (URI) развертываемого шаблона. Используйте свойство URI или id, но не оба. |
ZoneMapping
Имя | Тип | Описание |
---|---|---|
location |
string |
Расположение сопоставления зон. |
zones |
string[] |