Blueprints - List

サービス:

Blueprints

API バージョン:

2018-11-01-preview

ブループリント定義を一覧表示します。

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

URI パラメーター

名前	/	必須	型	説明
resourceScope	path	True	string	リソースのスコープ。 有効なスコープは、管理グループ (形式: '/providers/Microsoft.Management/managementGroups/{managementGroup}')、サブスクリプション (形式: '/subscriptions/{subscriptionId}') です。
api-version	query	True	string	クライアント API のバージョン。

応答

名前	型	説明
200 OK	BlueprintList	OK -- ブループリント定義の一覧を取得しました。
Other Status Codes	CloudError	ブループリントエラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/authorize

スコープ

名前	説明
user_impersonation	ユーザー アカウントを偽装する

例

ManagementGroupBlueprint

SubscriptionBlueprint

ManagementGroupBlueprint

要求のサンプル

HTTP

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

Go

package armblueprint_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/blueprint/armblueprint"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/f790e624d0d080b89d962a3bd19c65bc6a6b2f5e/specification/blueprint/resource-manager/Microsoft.Blueprint/preview/2018-11-01-preview/examples/managementGroupBPDef/Blueprint_List.json
func ExampleBlueprintsClient_NewListPager_managementGroupBlueprint() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armblueprint.NewClientFactory(cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewBlueprintsClient().NewListPager("providers/Microsoft.Management/managementGroups/ContosoOnlineGroup", nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.List = armblueprint.List{
		// 	Value: []*armblueprint.Blueprint{
		// 		{
		// 			Name: to.Ptr("simpleBlueprint"),
		// 			Type: to.Ptr("Microsoft.Blueprint/blueprints"),
		// 			ID: to.Ptr("/providers/Microsoft.Management/managementGroups/ContosoOnlineGroup/providers/Microsoft.Blueprint/blueprints/simpleBlueprint"),
		// 			Properties: &armblueprint.Properties{
		// 				Description: to.Ptr("blueprint contains all artifact kinds {'template', 'rbac', 'policy'}"),
		// 				Parameters: map[string]*armblueprint.ParameterDefinition{
		// 					"costCenter": &armblueprint.ParameterDefinition{
		// 						Type: to.Ptr(armblueprint.TemplateParameterTypeString),
		// 						Metadata: &armblueprint.ParameterDefinitionMetadata{
		// 							DisplayName: to.Ptr("force cost center tag for all resources under given subscription."),
		// 						},
		// 					},
		// 					"owners": &armblueprint.ParameterDefinition{
		// 						Type: to.Ptr(armblueprint.TemplateParameterTypeArray),
		// 						Metadata: &armblueprint.ParameterDefinitionMetadata{
		// 							DisplayName: to.Ptr("assign owners to subscription along with blueprint assignment."),
		// 						},
		// 					},
		// 					"storageAccountType": &armblueprint.ParameterDefinition{
		// 						Type: to.Ptr(armblueprint.TemplateParameterTypeString),
		// 						Metadata: &armblueprint.ParameterDefinitionMetadata{
		// 							DisplayName: to.Ptr("storage account type."),
		// 						},
		// 					},
		// 				},
		// 				ResourceGroups: map[string]*armblueprint.ResourceGroupDefinition{
		// 					"storageRG": &armblueprint.ResourceGroupDefinition{
		// 						Metadata: &armblueprint.ParameterDefinitionMetadata{
		// 							Description: to.Ptr("Contains storageAccounts that collect all shoebox logs."),
		// 							DisplayName: to.Ptr("storage resource group"),
		// 						},
		// 					},
		// 				},
		// 				TargetScope: to.Ptr(armblueprint.BlueprintTargetScopeSubscription),
		// 			},
		// 	}},
		// }
	}
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

dotnet

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Blueprint.Models;
using Azure.ResourceManager.Blueprint;

// Generated from example definition: specification/blueprint/resource-manager/Microsoft.Blueprint/preview/2018-11-01-preview/examples/managementGroupBPDef/Blueprint_List.json
// this example is just showing the usage of "Blueprints_List" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// get the collection of this BlueprintResource
string resourceScope = "providers/Microsoft.Management/managementGroups/ContosoOnlineGroup";
BlueprintCollection collection = client.GetBlueprints(new ResourceIdentifier(resourceScope));

// invoke the operation and iterate over the result
await foreach (BlueprintResource item in collection.GetAllAsync())
{
    // the variable item is a resource, you could call other operations on this instance as well
    // but just for demo, we get its data from this resource instance
    BlueprintData resourceData = item.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

Console.WriteLine("Succeeded");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

応答のサンプル

状態コード:

200

{
  "value": [
    {
      "properties": {
        "description": "blueprint contains all artifact kinds {'template', 'rbac', 'policy'}",
        "parameters": {
          "storageAccountType": {
            "type": "string",
            "metadata": {
              "displayName": "storage account type."
            }
          },
          "costCenter": {
            "type": "string",
            "metadata": {
              "displayName": "force cost center tag for all resources under given subscription."
            }
          },
          "owners": {
            "type": "array",
            "metadata": {
              "displayName": "assign owners to subscription along with blueprint assignment."
            }
          }
        },
        "resourceGroups": {
          "storageRG": {
            "metadata": {
              "displayName": "storage resource group",
              "description": "Contains storageAccounts that collect all shoebox logs."
            }
          }
        },
        "targetScope": "subscription",
        "status": null
      },
      "id": "/providers/Microsoft.Management/managementGroups/ContosoOnlineGroup/providers/Microsoft.Blueprint/blueprints/simpleBlueprint",
      "type": "Microsoft.Blueprint/blueprints",
      "name": "simpleBlueprint"
    }
  ]
}

SubscriptionBlueprint

要求のサンプル

HTTP

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

Go

package armblueprint_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/blueprint/armblueprint"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/f790e624d0d080b89d962a3bd19c65bc6a6b2f5e/specification/blueprint/resource-manager/Microsoft.Blueprint/preview/2018-11-01-preview/examples/subscriptionBPDef/Blueprint_List.json
func ExampleBlueprintsClient_NewListPager_subscriptionBlueprint() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armblueprint.NewClientFactory(cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewBlueprintsClient().NewListPager("subscriptions/00000000-0000-0000-0000-000000000000", nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.List = armblueprint.List{
		// 	Value: []*armblueprint.Blueprint{
		// 		{
		// 			Name: to.Ptr("simpleBlueprint"),
		// 			Type: to.Ptr("Microsoft.Blueprint/blueprints"),
		// 			ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Blueprint/blueprints/simpleBlueprint"),
		// 			Properties: &armblueprint.Properties{
		// 				Description: to.Ptr("blueprint contains all artifact kinds {'template', 'rbac', 'policy'}"),
		// 				Parameters: map[string]*armblueprint.ParameterDefinition{
		// 					"costCenter": &armblueprint.ParameterDefinition{
		// 						Type: to.Ptr(armblueprint.TemplateParameterTypeString),
		// 						Metadata: &armblueprint.ParameterDefinitionMetadata{
		// 							DisplayName: to.Ptr("force cost center tag for all resources under given subscription."),
		// 						},
		// 					},
		// 					"owners": &armblueprint.ParameterDefinition{
		// 						Type: to.Ptr(armblueprint.TemplateParameterTypeArray),
		// 						Metadata: &armblueprint.ParameterDefinitionMetadata{
		// 							DisplayName: to.Ptr("assign owners to subscription along with blueprint assignment."),
		// 						},
		// 					},
		// 					"storageAccountType": &armblueprint.ParameterDefinition{
		// 						Type: to.Ptr(armblueprint.TemplateParameterTypeString),
		// 						Metadata: &armblueprint.ParameterDefinitionMetadata{
		// 							DisplayName: to.Ptr("storage account type."),
		// 						},
		// 					},
		// 				},
		// 				ResourceGroups: map[string]*armblueprint.ResourceGroupDefinition{
		// 					"storageRG": &armblueprint.ResourceGroupDefinition{
		// 						Metadata: &armblueprint.ParameterDefinitionMetadata{
		// 							Description: to.Ptr("Contains storageAccounts that collect all shoebox logs."),
		// 							DisplayName: to.Ptr("storage resource group"),
		// 						},
		// 					},
		// 				},
		// 				TargetScope: to.Ptr(armblueprint.BlueprintTargetScopeSubscription),
		// 			},
		// 	}},
		// }
	}
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

dotnet

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Blueprint.Models;
using Azure.ResourceManager.Blueprint;

// Generated from example definition: specification/blueprint/resource-manager/Microsoft.Blueprint/preview/2018-11-01-preview/examples/subscriptionBPDef/Blueprint_List.json
// this example is just showing the usage of "Blueprints_List" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// get the collection of this BlueprintResource
string resourceScope = "subscriptions/00000000-0000-0000-0000-000000000000";
BlueprintCollection collection = client.GetBlueprints(new ResourceIdentifier(resourceScope));

// invoke the operation and iterate over the result
await foreach (BlueprintResource item in collection.GetAllAsync())
{
    // the variable item is a resource, you could call other operations on this instance as well
    // but just for demo, we get its data from this resource instance
    BlueprintData resourceData = item.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

Console.WriteLine("Succeeded");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

応答のサンプル

状態コード:

200

{
  "value": [
    {
      "properties": {
        "description": "blueprint contains all artifact kinds {'template', 'rbac', 'policy'}",
        "parameters": {
          "storageAccountType": {
            "type": "string",
            "metadata": {
              "displayName": "storage account type."
            }
          },
          "costCenter": {
            "type": "string",
            "metadata": {
              "displayName": "force cost center tag for all resources under given subscription."
            }
          },
          "owners": {
            "type": "array",
            "metadata": {
              "displayName": "assign owners to subscription along with blueprint assignment."
            }
          }
        },
        "resourceGroups": {
          "storageRG": {
            "metadata": {
              "displayName": "storage resource group",
              "description": "Contains storageAccounts that collect all shoebox logs."
            }
          }
        },
        "targetScope": "subscription",
        "status": null
      },
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Blueprint/blueprints/simpleBlueprint",
      "type": "Microsoft.Blueprint/blueprints",
      "name": "simpleBlueprint"
    }
  ]
}

定義

名前	説明
Blueprint	ブループリント定義を表します。
BlueprintList	BlueprintList
BlueprintStatus	ブループリントの状態。 このフィールドは読み取り時です。
BlueprintTargetScope	このブループリント定義を割り当てることができるスコープ。
CloudError
ErrorAdditionalInfo	リソース管理エラーの追加情報。
ErrorResponse	エラー応答
ParameterDefinition	制約とメタデータを使用してパラメーターを表します。
ResourceGroupDefinition	ブループリント定義内の Azure リソース グループを表します。
TemplateParameterType	Resource Manager テンプレート パラメーターに使用できるデータ型。

Blueprint

Object

ブループリント定義を表します。

名前	型	説明
description	string maxLength: 500	複数行でこのリソースについて説明します。
displayName	string maxLength: 256	このリソースを説明する 1 行の文字列。
id	string	Azure 上の任意のリソースを検索するために使用される文字列 ID。
name	string	このリソースの名前。
properties.layout	object	UI リファレンスのブループリント定義のレイアウト ビュー。
properties.parameters	<string,  ParameterDefinition>	このブループリント定義に必要なパラメーター。
properties.resourceGroups	<string,  ResourceGroupDefinition>	このブループリント定義で定義されているリソース グループ プレースホルダー。
properties.status	BlueprintStatus	ブループリントの状態。 このフィールドは読み取り時です。
properties.targetScope	BlueprintTargetScope	このブループリント定義を割り当てることができるスコープ。
properties.versions	object	このブループリント定義の発行済みバージョン。
type	string	このリソースの種類。

BlueprintList

Object

BlueprintList

名前	型	説明
nextLink	string	結果の次のページにリンクします。
value	Blueprint[]	ブループリント定義の一覧。

BlueprintStatus

Object

ブループリントの状態。 このフィールドは読み取り時です。

名前	型	説明
lastModified	string (date-time)	このブループリント定義の最終変更時刻。
timeCreated	string (date-time)	このブループリント定義の作成時間。

BlueprintTargetScope

列挙

このブループリント定義を割り当てることができるスコープ。

値	説明
managementGroup	ブループリントは、ブループリントの割り当て中に管理グループを対象とします。 これは将来使用するために予約されています。
subscription	ブループリントは、ブループリントの割り当て中にサブスクリプションを対象とします。

CloudError

Object

名前	型	説明
error	ErrorResponse	エラー応答 失敗した操作のエラーの詳細を返す、すべての Azure Resource Manager API の一般的なエラー応答。 (これは、OData エラー応答形式にも従います)。

ErrorAdditionalInfo

Object

リソース管理エラーの追加情報。

名前	型	説明
info	object	追加情報。
type	string	追加情報の種類。

ErrorResponse

Object

エラー応答

名前	型	説明
additionalInfo	ErrorAdditionalInfo[]	エラーの追加情報。
code	string	エラー コード。
details	ErrorResponse[]	エラーの詳細。
message	string	エラー メッセージ。
target	string	エラーターゲット。

ParameterDefinition

Object

制約とメタデータを使用してパラメーターを表します。

名前	型	説明
allowedValues	AllowedValues[]	このパラメーターに使用できる値の配列。
defaultValue		このパラメーターの既定値。
metadata.description	string maxLength: 500	このパラメーター/resourceGroup の説明。
metadata.displayName	string maxLength: 256	このパラメーター/resourceGroup の DisplayName。
metadata.strongType	string maxLength: 64	ブループリントの割り当て中に豊富なエクスペリエンスをレンダリングする UI 用の StrongType。 サポートされている厳密な種類は、resourceType、principalId、および場所です。
type	TemplateParameterType	Resource Manager テンプレート パラメーターに使用できるデータ型。

ResourceGroupDefinition

Object

ブループリント定義内の Azure リソース グループを表します。

名前	型	説明
dependsOn	string[]	このリソース グループの前にデプロイする必要がある成果物。
location	string	この resourceGroup の場所。 ブループリントの割り当て中にリソース グループの場所を指定する場合は、空のままにします。
metadata.description	string maxLength: 500	このパラメーター/resourceGroup の説明。
metadata.displayName	string maxLength: 256	このパラメーター/resourceGroup の DisplayName。
metadata.strongType	string maxLength: 64	ブループリントの割り当て中に豊富なエクスペリエンスをレンダリングする UI 用の StrongType。 サポートされている厳密な種類は、resourceType、principalId、および場所です。
name	string	この resourceGroup の名前。 ブループリントの割り当て中にリソース グループ名を指定する場合は、空のままにします。
tags	object	このリソース グループに割り当てられるタグ。

TemplateParameterType

列挙

Resource Manager テンプレート パラメーターに使用できるデータ型。

値	説明
array
bool
int
object
secureObject
secureString
string