Published Artifacts - List

Вывод списка артефактов для версии опубликованного определения схемы.

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

Параметры URI

Name In Required Type Description
blueprintName
path True
  • string

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

resourceScope
path True
  • string

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

versionId
path True
  • string

Версия опубликованного определения схемы.

api-version
query True
  • string

Версия API клиента.

Ответы

Name Type Description
200 OK

ОК — артефакты версии опубликованного определения схемы, полученной.

Other Status Codes

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

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

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation олицетворения учетной записи пользователя

Примеры

MG-ArtifactList
Sub-ArtifactList

MG-ArtifactList

Sample Request

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

Sample Response

{
  "value": [
    {
      "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/versions/V2/artifacts/ownerAssignment",
      "type": "Microsoft.Blueprint/blueprints/versions/artifacts",
      "name": "ownerAssignment"
    },
    {
      "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/versions/V2/artifacts/costCenterPolicy",
      "type": "Microsoft.Blueprint/blueprints/versions/artifacts",
      "name": "costCenterPolicy"
    },
    {
      "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/versions/V2/artifacts/storageTemplate",
      "type": "Microsoft.Blueprint/blueprints/versions/artifacts",
      "name": "storageTemplate"
    }
  ]
}

Sub-ArtifactList

Sample Request

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

Sample Response

{
  "value": [
    {
      "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/versions/V2/artifacts/ownerAssignment",
      "type": "Microsoft.Blueprint/blueprints/versions/artifacts",
      "name": "ownerAssignment"
    },
    {
      "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/versions/V2/artifacts/costCenterPolicy",
      "type": "Microsoft.Blueprint/blueprints/versions/artifacts",
      "name": "costCenterPolicy"
    },
    {
      "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/versions/V2/artifacts/storageTemplate",
      "type": "Microsoft.Blueprint/blueprints/versions/artifacts",
      "name": "storageTemplate"
    }
  ]
}

Определения

ArtifactList

Список артефактов схемы.

CloudError
ErrorAdditionalInfo

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

ErrorResponse

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

keyVaultReference

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

ParameterValue

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

PolicyAssignmentArtifact

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

RoleAssignmentArtifact

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

SecretValueReference

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

TemplateArtifact

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

ArtifactList

Список артефактов схемы.

Name Type Description
nextLink
  • string

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

value Artifact[]:

Список артефактов схемы.

CloudError

Name Type Description
error

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

ErrorAdditionalInfo

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

Name Type Description
info
  • object

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

type
  • string

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

ErrorResponse

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

Name Type Description
additionalInfo

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

code
  • string

Код ошибки.

details

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

message
  • string

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

target
  • string

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

keyVaultReference

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

Name Type Description
id
  • string

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

ParameterValue

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

Name Type Description
reference

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

value
  • object

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

PolicyAssignmentArtifact

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

Name Type Description
id
  • string

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

kind string:
  • policyAssignment

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

name
  • string

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

properties.dependsOn
  • string[]

Artifacts, которые необходимо развернуть до указанного артефакта.

properties.description
  • string

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

properties.displayName
  • string

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

properties.parameters

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

properties.policyDefinitionId
  • string

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

properties.resourceGroup
  • string

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

type
  • string

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

RoleAssignmentArtifact

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

Name Type Description
id
  • string

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

kind string:
  • roleAssignment

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

name
  • string

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

properties.dependsOn
  • string[]

Artifacts, которые необходимо развернуть до указанного артефакта.

properties.description
  • string

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

properties.displayName
  • string

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

properties.principalIds

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

properties.resourceGroup
  • string

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

properties.roleDefinitionId
  • string

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

type
  • string

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

SecretValueReference

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

Name Type Description
keyVault

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

secretName
  • string

Имя секрета.

secretVersion
  • string

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

TemplateArtifact

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

Name Type Description
id
  • string

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

kind string:
  • template

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

name
  • string

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

properties.dependsOn
  • string[]

Artifacts, которые необходимо развернуть до указанного артефакта.

properties.description
  • string

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

properties.displayName
  • string

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

properties.parameters

Resource Manager значения параметров артефакта схемы шаблона.

properties.resourceGroup
  • string

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

properties.template
  • object

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

type
  • string

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