Artifacts - Create Or Update

Служба:
Blueprints
Версия API:
2018-11-01-preview

Создание или обновление артефакта схемы.

PUT https://management.azure.com/{resourceScope}/providers/Microsoft.Blueprint/blueprints/{blueprintName}/artifacts/{artifactName}?api-version=2018-11-01-preview

Параметры URI

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

string

Имя артефакта схемы.
blueprintName
 path True

string

Имя определения схемы.
resourceScope
 path True

string

Область ресурса. Допустимые области: группа управления (формат :/providers/Microsoft.Management/managementGroups/{managementGroup}), подписка (формат "/subscriptions/{subscriptionId}").
api-version
 query True

string

Версия КЛИЕНТСКОго API.

Текст запроса

Текст запроса может быть таким:

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

Артефакт схемы, который применяет назначение политики.
RoleAssignmentArtifact

Артефакт схемы, который применяет назначение роли.
TemplateArtifact

Артефакт схемы, который развертывает шаблон Resource Manager.

PolicyAssignmentArtifact

Артефакт схемы, который применяет назначение политики.

Имя Обязательно Тип Описание
kind True string:

policyAssignment

Указывает тип артефакта схемы.
properties.parameters True

<string,  ParameterValue>

Значения параметров для определения политики.
properties.policyDefinitionId True

string

Идентификатор ресурса Azure определения политики.
properties.dependsOn

string[]

Артефакты, которые необходимо развернуть перед указанным артефактом.
properties.description

string

maxLength: 500

В нескольких строках объясняется этот ресурс.
properties.displayName

string

maxLength: 256

Строка однострочный поясняет этот ресурс.
properties.resourceGroup

string

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

RoleAssignmentArtifact

Артефакт схемы, который применяет назначение роли.

Имя Обязательно Тип Описание
kind True string:

roleAssignment

Указывает тип артефакта схемы.
properties.principalIds True

Массив удостоверений пользователей или групп в Azure Active Directory. РольDefinition будет применяться к каждому удостоверению.
properties.roleDefinitionId True

string

Идентификатор ресурса Azure для RoleDefinition.
properties.dependsOn

string[]

Артефакты, которые необходимо развернуть перед указанным артефактом.
properties.description

string

maxLength: 500

В нескольких строках объясняется этот ресурс.
properties.displayName

string

maxLength: 256

Строка однострочный поясняет этот ресурс.
properties.resourceGroup

string

RoleAssignment будет областью для этой группы ресурсов. Если оно пустое, оно распространяется на подписку.

TemplateArtifact

Артефакт схемы, который развертывает шаблон Resource Manager.

Имя Обязательно Тип Описание
kind True string:

template

Указывает тип артефакта схемы.
properties.parameters True

<string,  ParameterValue>

Значения параметров артефакта артефакта шаблона Resource Manager.
properties.template True

object

Текст артефакта схемы шаблона Resource Manager.
properties.dependsOn

string[]

Артефакты, которые необходимо развернуть перед указанным артефактом.
properties.description

string

maxLength: 500

В нескольких строках объясняется этот ресурс.
properties.displayName

string

maxLength: 256

Строка однострочный поясняет этот ресурс.
properties.resourceGroup

string

Если применимо, имя заполнителя группы ресурсов, в которую будет развернут артефакт схемы шаблона Resource Manager.

Ответы

Имя Тип Описание
201 Created Artifact:

Создано - артефакт схемы, созданный или обновленный.
Other Status Codes

CloudError

Ответ на ошибку схемы.

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

azure_auth

Поток OAuth2 Azure Active Directory

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

Области

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

Примеры

MG-ARMTemplateArtifact
MG-PolicyAssignmentArtifact
MG-RoleAssignmentArtifact
Sub-ARMTemplateArtifact
Sub-PolicyAssignmentArtifact
Sub-RoleAssignmentArtifact

MG-ARMTemplateArtifact

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

PUT https://management.azure.com/providers/Microsoft.Management/managementGroups/ContosoOnlineGroup/providers/Microsoft.Blueprint/blueprints/simpleBlueprint/artifacts/storageTemplate?api-version=2018-11-01-preview

{
  "kind": "template",
  "properties": {
    "template": {
      "contentVersion": "1.0.0.0",
      "parameters": {
        "storageAccountType": {
          "type": "string",
          "defaultValue": "Standard_LRS",
          "allowedValues": [
            "Standard_LRS",
            "Standard_GRS",
            "Standard_ZRS",
            "Premium_LRS"
          ],
          "metadata": {
            "description": "Storage Account type"
          }
        }
      },
      "variables": {
        "storageAccountName": "[concat(uniquestring(resourceGroup().id), 'standardsa')]"
      },
      "resources": [
        {
          "type": "Microsoft.Storage/storageAccounts",
          "name": "[variables('storageAccountName')]",
          "apiVersion": "2016-01-01",
          "location": "[resourceGroup().location]",
          "sku": {
            "name": "[parameters('storageAccountType')]"
          },
          "kind": "Storage",
          "properties": {}
        }
      ],
      "outputs": {
        "storageAccountName": {
          "type": "string",
          "value": "[variables('storageAccountName')]"
        }
      }
    },
    "resourceGroup": "storageRG",
    "parameters": {
      "storageAccountType": {
        "value": "[parameters('storageAccountType')]"
      }
    }
  }
}

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

Код состояния:
201 
{
  "properties": {
    "template": {
      "contentVersion": "1.0.0.0",
      "parameters": {
        "storageAccountType": {
          "type": "string",
          "defaultValue": "Standard_LRS",
          "allowedValues": [
            "Standard_LRS",
            "Standard_GRS",
            "Standard_ZRS",
            "Premium_LRS"
          ],
          "metadata": {
            "description": "Storage Account type"
          }
        }
      },
      "variables": {
        "storageAccountName": "[concat(uniquestring(resourceGroup().id), 'standardsa')]"
      },
      "resources": [
        {
          "type": "Microsoft.Storage/storageAccounts",
          "name": "[variables('storageAccountName')]",
          "apiVersion": "2016-01-01",
          "location": "[resourceGroup().location]",
          "sku": {
            "name": "[parameters('storageAccountType')]"
          },
          "kind": "Storage",
          "properties": {}
        }
      ],
      "outputs": {
        "storageAccountName": {
          "type": "string",
          "value": "[variables('storageAccountName')]"
        }
      }
    },
    "resourceGroup": "storageRG",
    "parameters": {
      "storageAccountType": {
        "value": "[parameters('storageAccountType')]"
      }
    }
  },
  "kind": "template",
  "id": "/providers/Microsoft.Management/managementGroups/ContosoOnlineGroup/providers/Microsoft.Blueprint/blueprints/simpleBlueprint/artifacts/storageTemplate",
  "type": "Microsoft.Blueprint/blueprints/artifacts",
  "name": "storageTemplate"
}

MG-PolicyAssignmentArtifact

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

PUT https://management.azure.com/providers/Microsoft.Management/managementGroups/ContosoOnlineGroup/providers/Microsoft.Blueprint/blueprints/simpleBlueprint/artifacts/costCenterPolicy?api-version=2018-11-01-preview

{
  "properties": {
    "displayName": "force costCenter tag on all resources",
    "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/1e30110a-5ceb-460c-a204-c1c3969c6d62",
    "parameters": {
      "tagName": {
        "value": "costCenter"
      },
      "tagValue": {
        "value": "[parameter('costCenter')]"
      }
    }
  },
  "kind": "policyAssignment"
}

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

Код состояния:
201 
{
  "properties": {
    "displayName": "force costCenter tag on all resources",
    "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/1e30110a-5ceb-460c-a204-c1c3969c6d62",
    "parameters": {
      "tagName": {
        "value": "costCenter"
      },
      "tagValue": {
        "value": "[parameter('costCenter')]"
      }
    }
  },
  "kind": "policyAssignment",
  "id": "/providers/Microsoft.Management/managementGroups/ContosoOnlineGroup/providers/Microsoft.Blueprint/blueprints/simpleBlueprint/artifacts/costCenterPolicy",
  "type": "Microsoft.Blueprint/blueprints/artifacts",
  "name": "costCenterPolicy"
}

MG-RoleAssignmentArtifact

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

PUT https://management.azure.com/providers/Microsoft.Management/managementGroups/ContosoOnlineGroup/providers/Microsoft.Blueprint/blueprints/simpleBlueprint/artifacts/ownerAssignment?api-version=2018-11-01-preview

{
  "properties": {
    "displayName": "enforce owners of given subscription",
    "roleDefinitionId": "/providers/Microsoft.Authorization/roleDefinitions/acdd72a7-3385-48ef-bd42-f606fba81ae7",
    "principalIds": "[parameters('owners')]"
  },
  "kind": "roleAssignment"
}

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

Код состояния:
201 
{
  "properties": {
    "displayName": "enforce owners of given subscription",
    "roleDefinitionId": "/providers/Microsoft.Authorization/roleDefinitions/acdd72a7-3385-48ef-bd42-f606fba81ae7",
    "principalIds": "[parameters('owners')]"
  },
  "kind": "roleAssignment",
  "id": "/providers/Microsoft.Management/managementGroups/ContosoOnlineGroup/providers/Microsoft.Blueprint/blueprints/simpleBlueprint/artifacts/ownerAssignment",
  "type": "Microsoft.Blueprint/blueprints/artifacts",
  "name": "ownerAssignment"
}

Sub-ARMTemplateArtifact

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

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Blueprint/blueprints/simpleBlueprint/artifacts/storageTemplate?api-version=2018-11-01-preview

{
  "kind": "template",
  "properties": {
    "template": {
      "contentVersion": "1.0.0.0",
      "parameters": {
        "storageAccountType": {
          "type": "string",
          "defaultValue": "Standard_LRS",
          "allowedValues": [
            "Standard_LRS",
            "Standard_GRS",
            "Standard_ZRS",
            "Premium_LRS"
          ],
          "metadata": {
            "description": "Storage Account type"
          }
        }
      },
      "variables": {
        "storageAccountName": "[concat(uniquestring(resourceGroup().id), 'standardsa')]"
      },
      "resources": [
        {
          "type": "Microsoft.Storage/storageAccounts",
          "name": "[variables('storageAccountName')]",
          "apiVersion": "2016-01-01",
          "location": "[resourceGroup().location]",
          "sku": {
            "name": "[parameters('storageAccountType')]"
          },
          "kind": "Storage",
          "properties": {}
        }
      ],
      "outputs": {
        "storageAccountName": {
          "type": "string",
          "value": "[variables('storageAccountName')]"
        }
      }
    },
    "resourceGroup": "storageRG",
    "parameters": {
      "storageAccountType": {
        "value": "[parameters('storageAccountType')]"
      }
    }
  }
}

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

Код состояния:
201 
{
  "properties": {
    "template": {
      "contentVersion": "1.0.0.0",
      "parameters": {
        "storageAccountType": {
          "type": "string",
          "defaultValue": "Standard_LRS",
          "allowedValues": [
            "Standard_LRS",
            "Standard_GRS",
            "Standard_ZRS",
            "Premium_LRS"
          ],
          "metadata": {
            "description": "Storage Account type"
          }
        }
      },
      "variables": {
        "storageAccountName": "[concat(uniquestring(resourceGroup().id), 'standardsa')]"
      },
      "resources": [
        {
          "type": "Microsoft.Storage/storageAccounts",
          "name": "[variables('storageAccountName')]",
          "apiVersion": "2016-01-01",
          "location": "[resourceGroup().location]",
          "sku": {
            "name": "[parameters('storageAccountType')]"
          },
          "kind": "Storage",
          "properties": {}
        }
      ],
      "outputs": {
        "storageAccountName": {
          "type": "string",
          "value": "[variables('storageAccountName')]"
        }
      }
    },
    "resourceGroup": "storageRG",
    "parameters": {
      "storageAccountType": {
        "value": "[parameters('storageAccountType')]"
      }
    }
  },
  "kind": "template",
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Blueprint/blueprints/simpleBlueprint/artifacts/storageTemplate",
  "type": "Microsoft.Blueprint/blueprints/artifacts",
  "name": "storageTemplate"
}

Sub-PolicyAssignmentArtifact

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

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Blueprint/blueprints/simpleBlueprint/artifacts/costCenterPolicy?api-version=2018-11-01-preview

{
  "properties": {
    "displayName": "force costCenter tag on all resources",
    "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/1e30110a-5ceb-460c-a204-c1c3969c6d62",
    "parameters": {
      "tagName": {
        "value": "costCenter"
      },
      "tagValue": {
        "value": "[parameter('costCenter')]"
      }
    }
  },
  "kind": "policyAssignment"
}

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

Код состояния:
201 
{
  "properties": {
    "displayName": "force costCenter tag on all resources",
    "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/1e30110a-5ceb-460c-a204-c1c3969c6d62",
    "parameters": {
      "tagName": {
        "value": "costCenter"
      },
      "tagValue": {
        "value": "[parameter('costCenter')]"
      }
    }
  },
  "kind": "policyAssignment",
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Blueprint/blueprints/simpleBlueprint/artifacts/costCenterPolicy",
  "type": "Microsoft.Blueprint/blueprints/artifacts",
  "name": "costCenterPolicy"
}

Sub-RoleAssignmentArtifact

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

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Blueprint/blueprints/simpleBlueprint/artifacts/ownerAssignment?api-version=2018-11-01-preview

{
  "properties": {
    "displayName": "enforce owners of given subscription",
    "roleDefinitionId": "/providers/Microsoft.Authorization/roleDefinitions/acdd72a7-3385-48ef-bd42-f606fba81ae7",
    "principalIds": "[parameters('owners')]"
  },
  "kind": "roleAssignment"
}

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

Код состояния:
201 
{
  "properties": {
    "displayName": "enforce owners of given subscription",
    "roleDefinitionId": "/providers/Microsoft.Authorization/roleDefinitions/acdd72a7-3385-48ef-bd42-f606fba81ae7",
    "principalIds": "[parameters('owners')]"
  },
  "kind": "roleAssignment",
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Blueprint/blueprints/simpleBlueprint/artifacts/ownerAssignment",
  "type": "Microsoft.Blueprint/blueprints/artifacts",
  "name": "ownerAssignment"
}

Определения

Имя Описание
CloudError
ErrorAdditionalInfo

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

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

Указывает ссылку на Key Vault.
ParameterValue

Значение указанного параметра. Может быть либо значением, либо ссылкой, но не обоими.
PolicyAssignmentArtifact

Артефакт схемы, который применяет назначение политики.
RoleAssignmentArtifact

Артефакт схемы, который применяет назначение роли.
SecretValueReference

Ссылка на секрет Key Vault.
TemplateArtifact

Артефакт схемы, который развертывает шаблон Resource Manager.

CloudError

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

ErrorResponse

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

ErrorAdditionalInfo

Object

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

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

object

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

string

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

ErrorResponse

Object

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

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

ErrorAdditionalInfo[]

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

string

Код ошибки.
details

ErrorResponse[]

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

string

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

string

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

keyVaultReference

Object

Указывает ссылку на Key Vault.

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

string

Идентификатор ресурса Azure в Key Vault.

ParameterValue

Object

Значение указанного параметра. Может быть либо значением, либо ссылкой, но не обоими.

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

SecretValueReference

Значение параметра в качестве ссылочного типа.
value

object

Значение параметра. Любое допустимое значение JSON допускается, включая объекты, массивы, строки, числа и логические значения.

PolicyAssignmentArtifact

Object

Артефакт схемы, который применяет назначение политики.

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

string

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

policyAssignment

Указывает тип артефакта схемы.
name

string

Имя этого ресурса.
properties.dependsOn

string[]

Артефакты, которые необходимо развернуть перед указанным артефактом.
properties.description

string

maxLength: 500

В нескольких строках объясняется этот ресурс.
properties.displayName

string

maxLength: 256

Строка однострочный поясняет этот ресурс.
properties.parameters

<string,  ParameterValue>

Значения параметров для определения политики.
properties.policyDefinitionId

string

Идентификатор ресурса Azure определения политики.
properties.resourceGroup

string

Имя заполнителя группы ресурсов, которому будет назначена политика.
type

string

Тип этого ресурса.

RoleAssignmentArtifact

Object

Артефакт схемы, который применяет назначение роли.

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

string

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

roleAssignment

Указывает тип артефакта схемы.
name

string

Имя этого ресурса.
properties.dependsOn

string[]

Артефакты, которые необходимо развернуть перед указанным артефактом.
properties.description

string

maxLength: 500

В нескольких строках объясняется этот ресурс.
properties.displayName

string

maxLength: 256

Строка однострочный поясняет этот ресурс.
properties.principalIds

Массив удостоверений пользователей или групп в Azure Active Directory. РольDefinition будет применяться к каждому удостоверению.
properties.resourceGroup

string

RoleAssignment будет областью для этой группы ресурсов. Если оно пустое, оно распространяется на подписку.
properties.roleDefinitionId

string

Идентификатор ресурса Azure для RoleDefinition.
type

string

Тип этого ресурса.

SecretValueReference

Object

Ссылка на секрет Key Vault.

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

keyVaultReference

Указывает ссылку на определенное хранилище ключей Azure.
secretName

string

Имя секрета.
secretVersion

string

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

TemplateArtifact

Object

Артефакт схемы, который развертывает шаблон Resource Manager.

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

string

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

template

Указывает тип артефакта схемы.
name

string

Имя этого ресурса.
properties.dependsOn

string[]

Артефакты, которые необходимо развернуть перед указанным артефактом.
properties.description

string

maxLength: 500

В нескольких строках объясняется этот ресурс.
properties.displayName

string

maxLength: 256

Строка однострочный поясняет этот ресурс.
properties.parameters

<string,  ParameterValue>

Значения параметров артефакта артефакта шаблона Resource Manager.
properties.resourceGroup

string

Если применимо, имя заполнителя группы ресурсов, в которую будет развернут артефакт схемы шаблона Resource Manager.
properties.template

object

Текст артефакта схемы шаблона Resource Manager.
type

string

Тип этого ресурса.