Assignments - List

リファレンス

サービス:: Blueprints

API バージョン:: 2018-11-01-preview

サブスクリプションまたは管理グループ内のブループリントの割り当てを一覧表示します。

GET https://management.azure.com/{resourceScope}/providers/Microsoft.Blueprint/blueprintAssignments?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	AssignmentList	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	ユーザーアカウントを偽装する

例

Assignment at management group scope

Assignment at subscription scope

Assignment at management group scope

要求のサンプル

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

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/managementGroupBPAssignment/BlueprintAssignment_List.json
func ExampleAssignmentsClient_NewListPager_assignmentAtManagementGroupScope() {
	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.NewAssignmentsClient().NewListPager("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.AssignmentList = armblueprint.AssignmentList{
		// 	Value: []*armblueprint.Assignment{
		// 		{
		// 			Name: to.Ptr("assignSimpleBlueprint"),
		// 			Type: to.Ptr("Microsoft.Blueprint/Assignment"),
		// 			ID: to.Ptr("/managementGroups/ContosoOnlineGroup/providers/Microsoft.Blueprint/blueprintAssignments/assignSimpleBlueprint"),
		// 			Location: to.Ptr("eastus"),
		// 			Identity: &armblueprint.ManagedServiceIdentity{
		// 				Type: to.Ptr(armblueprint.ManagedServiceIdentityTypeSystemAssigned),
		// 				PrincipalID: to.Ptr("00000000-0000-0000-0000-000000000000"),
		// 				TenantID: to.Ptr("00000000-0000-0000-0000-000000000000"),
		// 			},
		// 			Properties: &armblueprint.AssignmentProperties{
		// 				Description: to.Ptr("enforce pre-defined simpleBlueprint to this XXXXXXXX subscription."),
		// 				BlueprintID: to.Ptr("/providers/Microsoft.Management/managementGroups/ContosoOnlineGroup/providers/Microsoft.Blueprint/blueprints/simpleBlueprint"),
		// 				Parameters: map[string]*armblueprint.ParameterValue{
		// 					"costCenter": &armblueprint.ParameterValue{
		// 						Value: "Contoso/Online/Shopping/Production",
		// 					},
		// 					"owners": &armblueprint.ParameterValue{
		// 						Value: []any{
		// 							"johnDoe@contoso.com",
		// 							"johnsteam@contoso.com",
		// 						},
		// 					},
		// 					"storageAccountType": &armblueprint.ParameterValue{
		// 						Value: "Standard_LRS",
		// 					},
		// 				},
		// 				ProvisioningState: to.Ptr(armblueprint.AssignmentProvisioningState("Succeeded")),
		// 				ResourceGroups: map[string]*armblueprint.ResourceGroupValue{
		// 					"storageRG": &armblueprint.ResourceGroupValue{
		// 						Name: to.Ptr("defaultRG"),
		// 						Location: to.Ptr("eastus"),
		// 					},
		// 				},
		// 				Scope: to.Ptr("subscriptions/00000000-0000-0000-0000-000000000000"),
		// 			},
		// 	}},
		// }
	}
}

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

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

// Generated from example definition: specification/blueprint/resource-manager/Microsoft.Blueprint/preview/2018-11-01-preview/examples/managementGroupBPAssignment/BlueprintAssignment_List.json
// this example is just showing the usage of "Assignments_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 AssignmentResource
string resourceScope = "managementGroups/ContosoOnlineGroup";
AssignmentCollection collection = client.GetAssignments(new ResourceIdentifier(resourceScope));

// invoke the operation and iterate over the result
await foreach (AssignmentResource 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
    AssignmentData 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": [
    {
      "identity": {
        "type": "SystemAssigned",
        "tenantId": "00000000-0000-0000-0000-000000000000",
        "principalId": "00000000-0000-0000-0000-000000000000"
      },
      "location": "eastus",
      "properties": {
        "description": "enforce pre-defined simpleBlueprint to this XXXXXXXX subscription.",
        "provisioningState": "failed",
        "blueprintId": "/providers/Microsoft.Management/managementGroups/ContosoOnlineGroup/providers/Microsoft.Blueprint/blueprints/simpleBlueprint",
        "scope": "subscriptions/00000000-0000-0000-0000-000000000000",
        "parameters": {
          "storageAccountType": {
            "value": "Standard_LRS"
          },
          "costCenter": {
            "value": "Contoso/Online/Shopping/Production"
          },
          "owners": {
            "value": [
              "johnDoe@contoso.com",
              "johnsteam@contoso.com"
            ]
          }
        },
        "resourceGroups": {
          "storageRG": {
            "name": "defaultRG",
            "location": "eastus"
          }
        }
      },
      "id": "/managementGroups/ContosoOnlineGroup/providers/Microsoft.Blueprint/blueprintAssignments/assignSimpleBlueprint",
      "type": "Microsoft.Blueprint/Assignment",
      "name": "assignSimpleBlueprint"
    }
  ]
}

Assignment at subscription scope

要求のサンプル

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

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/subscriptionBPAssignment/BlueprintAssignment_List.json
func ExampleAssignmentsClient_NewListPager_assignmentAtSubscriptionScope() {
	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.NewAssignmentsClient().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.AssignmentList = armblueprint.AssignmentList{
		// 	Value: []*armblueprint.Assignment{
		// 		{
		// 			Name: to.Ptr("assignSimpleBlueprint"),
		// 			Type: to.Ptr("Microsoft.Blueprint/Assignment"),
		// 			ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Blueprint/blueprintAssignments/assignSimpleBlueprint"),
		// 			Location: to.Ptr("eastus"),
		// 			Identity: &armblueprint.ManagedServiceIdentity{
		// 				Type: to.Ptr(armblueprint.ManagedServiceIdentityTypeSystemAssigned),
		// 				PrincipalID: to.Ptr("00000000-0000-0000-0000-000000000000"),
		// 				TenantID: to.Ptr("00000000-0000-0000-0000-000000000000"),
		// 			},
		// 			Properties: &armblueprint.AssignmentProperties{
		// 				Description: to.Ptr("enforce pre-defined simpleBlueprint to this XXXXXXXX subscription."),
		// 				BlueprintID: to.Ptr("/providers/Microsoft.Management/managementGroups/ContosoOnlineGroup/providers/Microsoft.Blueprint/blueprints/simpleBlueprint"),
		// 				Parameters: map[string]*armblueprint.ParameterValue{
		// 					"costCenter": &armblueprint.ParameterValue{
		// 						Value: "Contoso/Online/Shopping/Production",
		// 					},
		// 					"owners": &armblueprint.ParameterValue{
		// 						Value: []any{
		// 							"johnDoe@contoso.com",
		// 							"johnsteam@contoso.com",
		// 						},
		// 					},
		// 					"storageAccountType": &armblueprint.ParameterValue{
		// 						Value: "Standard_LRS",
		// 					},
		// 				},
		// 				ProvisioningState: to.Ptr(armblueprint.AssignmentProvisioningState("Succeeded")),
		// 				ResourceGroups: map[string]*armblueprint.ResourceGroupValue{
		// 					"storageRG": &armblueprint.ResourceGroupValue{
		// 						Name: to.Ptr("defaultRG"),
		// 						Location: to.Ptr("eastus"),
		// 					},
		// 				},
		// 			},
		// 	}},
		// }
	}
}

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

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

// Generated from example definition: specification/blueprint/resource-manager/Microsoft.Blueprint/preview/2018-11-01-preview/examples/subscriptionBPAssignment/BlueprintAssignment_List.json
// this example is just showing the usage of "Assignments_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 AssignmentResource
string resourceScope = "subscriptions/00000000-0000-0000-0000-000000000000";
AssignmentCollection collection = client.GetAssignments(new ResourceIdentifier(resourceScope));

// invoke the operation and iterate over the result
await foreach (AssignmentResource 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
    AssignmentData 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": [
    {
      "identity": {
        "type": "SystemAssigned",
        "tenantId": "00000000-0000-0000-0000-000000000000",
        "principalId": "00000000-0000-0000-0000-000000000000"
      },
      "location": "eastus",
      "properties": {
        "description": "enforce pre-defined simpleBlueprint to this XXXXXXXX subscription.",
        "provisioningState": "failed",
        "blueprintId": "/providers/Microsoft.Management/managementGroups/ContosoOnlineGroup/providers/Microsoft.Blueprint/blueprints/simpleBlueprint",
        "parameters": {
          "storageAccountType": {
            "value": "Standard_LRS"
          },
          "costCenter": {
            "value": "Contoso/Online/Shopping/Production"
          },
          "owners": {
            "value": [
              "johnDoe@contoso.com",
              "johnsteam@contoso.com"
            ]
          }
        },
        "resourceGroups": {
          "storageRG": {
            "name": "defaultRG",
            "location": "eastus"
          }
        }
      },
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Blueprint/blueprintAssignments/assignSimpleBlueprint",
      "type": "Microsoft.Blueprint/Assignment",
      "name": "assignSimpleBlueprint"
    }
  ]
}

定義

名前	説明
Assignment	ブループリントの割り当てを表します。
AssignmentList	ブループリントの割り当ての一覧
AssignmentLockMode	ロックモード。
AssignmentLockSettings	ブループリント割り当てによってデプロイされたリソースをロックする方法を定義します。
AssignmentProvisioningState	ブループリント割り当ての状態。
AssignmentStatus	ブループリント割り当ての状態。このフィールドは読み取り時です。
CloudError
ErrorAdditionalInfo	リソース管理エラーの追加情報。
ErrorResponse	エラー応答
keyVaultReference	Key Vault へのリンクを指定します。
ManagedServiceIdentity	マネージド ID 汎用オブジェクト。
ManagedServiceIdentityType	マネージド ID の種類。
ParameterValue	指定したパラメーターの値。 'value' または 'reference' のいずれかを指定できますが、両方を指定することはできません。
ResourceGroupValue	Azure リソースグループを表します。
SecretValueReference	Key Vault シークレットへの参照。
UserAssignedIdentity	ユーザー割り当てマネージド ID。

Assignment

Object

ブループリントの割り当てを表します。

名前	型	説明
id	string	Azure 上の任意のリソースを検索するために使用される文字列 ID。
identity	ManagedServiceIdentity	このブループリント割り当てのマネージド ID。
location	string	このブループリント割り当ての場所。
name	string	このリソースの名前。
properties.blueprintId	string	ブループリント定義の発行済みバージョンの ID。
properties.description	string maxLength: 500	複数行でこのリソースについて説明します。
properties.displayName	string maxLength: 256	このリソースを説明する 1 行の文字列。
properties.locks	AssignmentLockSettings	ブループリント割り当てによってデプロイされたリソースをロックする方法を定義します。
properties.parameters	<string, ParameterValue>	ブループリント割り当てパラメーターの値。
properties.provisioningState	AssignmentProvisioningState	ブループリント割り当ての状態。
properties.resourceGroups	<string, ResourceGroupValue>	リソースグループプレースホルダーの名前と場所。
properties.scope	string	ブループリント割り当てのターゲットサブスクリプションスコープ (形式: '/subscriptions/{subscriptionId}')。管理グループレベルの割り当てには、プロパティが必要です。
properties.status	AssignmentStatus	ブループリント割り当ての状態。このフィールドは読み取り時です。
type	string	このリソースの種類。

AssignmentList

Object

ブループリントの割り当ての一覧

名前	型	説明
nextLink	string	結果の次のページにリンクします。
value	Assignment[]	ブループリントの割り当ての一覧。

AssignmentLockMode

列挙

ロックモード。

値	説明
AllResourcesDoNotDelete
AllResourcesReadOnly
None

AssignmentLockSettings

Object

ブループリント割り当てによってデプロイされたリソースをロックする方法を定義します。

名前	型	説明
excludedActions	string[]	ブループリントロックから除外される管理操作の一覧。最大 200 個のアクションが許可されます。ロックモードが 'AllResourcesReadOnly' に設定されている場合、'excludedActions'、'*/read'、'Microsoft.Network/virtualNetworks/subnets/join/action'、および 'Microsoft.Authorization/locks/delete' に次のアクションが自動的に追加されます。ロックモードが 'AllResourcesDoNotDelete' に設定されている場合、次のアクションが自動的に 'excludedActions' に追加されます: 'Microsoft.Authorization/locks/delete'。重複するアクションは削除されます。
excludedPrincipals	string[]	ブループリントロックから除外された AAD プリンシパルの一覧。最大 5 つのプリンシパルが許可されます。
mode	AssignmentLockMode	ロックモード。

AssignmentProvisioningState

列挙

ブループリント割り当ての状態。

値	説明
canceled
cancelling
creating
deleting
deploying
failed
locking
succeeded
validating
waiting

AssignmentStatus

Object

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

名前	型	説明
lastModified	string (date-time)	このブループリント定義の最終変更時刻。
managedResources	string[]	ブループリント割り当てによって作成されたリソースの一覧。
timeCreated	string (date-time)	このブループリント定義の作成時間。

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	エラーターゲット。

keyVaultReference

Object

Key Vault へのリンクを指定します。

名前	型	説明
id	string	Key Vault の Azure リソース ID。

ManagedServiceIdentity

Object

マネージド ID 汎用オブジェクト。

名前	型	説明
principalId	string	この ID に関連付けられている Azure Active Directory プリンシパル ID。
tenantId	string	Azure Active Directory の ID。
type	ManagedServiceIdentityType	マネージド ID の種類。
userAssignedIdentities	<string, UserAssignedIdentity>	リソースに関連付けられているユーザー割り当てマネージド ID の一覧。キーは、マネージド ID の Azure リソース ID です。

ManagedServiceIdentityType

列挙

マネージド ID の種類。

値	説明
None
SystemAssigned
UserAssigned

ParameterValue

Object

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

名前	型	説明
reference	SecretValueReference	参照型としてのパラメーター値。
value	object	パラメーター値。オブジェクト、配列、文字列、数値、ブール値など、有効な JSON 値を指定できます。

ResourceGroupValue

Object

Azure リソースグループを表します。

名前	型	説明
location	string	リソースグループの場所。
name	string minLength: 1 maxLength: 90	リソースグループの名前。

SecretValueReference

Object

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

名前	型	説明
keyVault	keyVaultReference	特定の Azure Key Vault への参照を指定します。
secretName	string	シークレットの名前。
secretVersion	string	使用するシークレットのバージョン。空白のままにすると、最新バージョンのシークレットが使用されます。

UserAssignedIdentity

Object

ユーザー割り当てマネージド ID。

名前	型	説明
clientId	string	この ID に関連付けられているクライアントアプリ ID。
principalId	string	この ID に関連付けられている Azure Active Directory プリンシパル ID。

次の方法で共有

Assignments - List

URI パラメーター

応答

セキュリティ

azure_auth

スコープ

例

Assignment at management group scope

要求のサンプル

応答のサンプル

Assignment at subscription scope

要求のサンプル

応答のサンプル

定義

Assignment

AssignmentList

AssignmentLockMode

AssignmentLockSettings

AssignmentProvisioningState

AssignmentStatus

CloudError

ErrorAdditionalInfo

ErrorResponse

keyVaultReference

ManagedServiceIdentity

ManagedServiceIdentityType

ParameterValue

ResourceGroupValue

SecretValueReference

UserAssignedIdentity