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

OK -- 発行されたブループリント定義のバージョンの成果物が取得されました。

Other Status Codes

ブループリントのエラー応答。

セキュリティ

azure_auth

OAuth2 FlowをAzure Active Directoryする

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

指定したパラメーターの値。 'value' または 'reference' を指定できますが、両方を指定することはできません。

PolicyAssignmentArtifact

ポリシー割り当てを適用するブループリント 成果物。

RoleAssignmentArtifact

ロールの割り当てを適用するブループリント 成果物。

SecretValueReference

Key Vault シークレットへの参照。

TemplateArtifact

Resource Manager テンプレートをデプロイするブループリント アーティファクト。

ArtifactList

ブループリント成果物の一覧。

Name Type Description
nextLink
  • string

結果の次のページにリンクします。

value Artifact[]:

ブループリント成果物の一覧。

CloudError

Name Type Description
error

エラー応答
失敗した操作のエラーの詳細を返す、すべての Azure Resource Manager API に対する一般的なエラー応答。 (これは、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

Key Vaultの Azure リソース ID。

ParameterValue

指定したパラメーターの値。 'value' または 'reference' を指定できますが、両方を指定することはできません。

Name Type Description
reference

参照型としてのパラメーター値。

value
  • object

パラメーター値。 オブジェクト、配列、文字列、数値、ブール値など、有効な JSON 値はすべて使用できます。

PolicyAssignmentArtifact

ポリシー割り当てを適用するブループリント 成果物。

Name Type Description
id
  • string

Azure 上の任意のリソースを検索するために使用される文字列 ID。

kind string:
  • policyAssignment

ブループリント 成果物の種類を指定します。

name
  • string

このリソースの名前。

properties.dependsOn
  • string[]

Artifacts指定した成果物の前にデプロイする必要があります。

properties.description
  • string

複数行でこのリソースについて説明します。

properties.displayName
  • string

このリソースを説明する 1 行の文字列。

properties.parameters

ポリシー定義のパラメーター値。

properties.policyDefinitionId
  • string

ポリシー定義の Azure リソース ID。

properties.resourceGroup
  • string

ポリシーが割り当てられるリソース グループ プレースホルダーの名前。

type
  • string

このリソースの種類。

RoleAssignmentArtifact

ロールの割り当てを適用するブループリント 成果物。

Name Type Description
id
  • string

Azure 上の任意のリソースを検索するために使用される文字列 ID。

kind string:
  • roleAssignment

ブループリント 成果物の種類を指定します。

name
  • string

このリソースの名前。

properties.dependsOn
  • string[]

Artifacts指定した成果物の前にデプロイする必要があります。

properties.description
  • string

複数行でこのリソースについて説明します。

properties.displayName
  • string

このリソースを説明する 1 行の文字列。

properties.principalIds

Azure Active Directory内のユーザー ID またはグループ ID の配列。 roleDefinition は各 ID に適用されます。

properties.resourceGroup
  • string

RoleAssignment は、この resourceGroup のスコープになります。 空の場合は、サブスクリプションにスコープが設定されます。

properties.roleDefinitionId
  • string

RoleDefinition の Azure リソース ID。

type
  • string

このリソースの種類。

SecretValueReference

Key Vault シークレットへの参照。

Name Type Description
keyVault

特定の Azure Key Vaultへの参照を指定します。

secretName
  • string

シークレットの名前。

secretVersion
  • string

使用するシークレットのバージョン。 空白のままにすると、シークレットの最新バージョンが使用されます。

TemplateArtifact

Resource Manager テンプレートをデプロイするブループリント アーティファクト。

Name Type Description
id
  • string

Azure 上の任意のリソースを検索するために使用される文字列 ID。

kind string:
  • template

ブループリント 成果物の種類を指定します。

name
  • string

このリソースの名前。

properties.dependsOn
  • string[]

Artifacts指定した成果物の前にデプロイする必要があります。

properties.description
  • string

複数行でこのリソースについて説明します。

properties.displayName
  • string

このリソースを説明する 1 行の文字列。

properties.parameters

テンプレート ブループリント成果物パラメーター値をResource Managerします。

properties.resourceGroup
  • string

該当する場合は、Resource Manager テンプレート ブループリント成果物のデプロイ先となるリソース グループ プレースホルダーの名前。

properties.template
  • object

Resource Manager テンプレート ブループリントアーティファクト本文。

type
  • string

このリソースの種類。