次の方法で共有

Assignments - Create Or Update

サービス:
Blueprints
API バージョン:
2018-11-01-preview

ブループリントの割り当てを作成または更新します。

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

URI パラメーター

名前 / 必須 型 説明
assignmentName
 path True

string

ブループリント割り当ての名前。
resourceScope
 path True

string

リソースのスコープ。 有効なスコープは、管理グループ (形式: '/providers/Microsoft.Management/managementGroups/{managementGroup}')、サブスクリプション (形式: '/subscriptions/{subscriptionId}') です。
api-version
 query True

string

クライアント API のバージョン。

要求本文

名前 必須 型 説明
identity True

ManagedServiceIdentity

このブループリント割り当てのマネージド ID。
location True

string

このブループリント割り当ての場所。
properties.parameters True

<string,  ParameterValue>

ブループリント割り当てパラメーターの値。
properties.resourceGroups True

<string,  ResourceGroupValue>

リソース グループ プレースホルダーの名前と場所。
properties.blueprintId

string

ブループリント定義の発行済みバージョンの ID。
properties.description

string

maxLength: 500

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

string

maxLength: 256

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

AssignmentLockSettings

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

string

ブループリント割り当てのターゲット サブスクリプション スコープ (形式: '/subscriptions/{subscriptionId}')。 管理グループ レベルの割り当てには、プロパティが必要です。

応答

名前 型 説明
201 Created

Assignment

作成済み -- ブループリントの割り当てが保存されました。
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 with system-assigned managed identity at management group scope
Assignment with system-assigned managed identity at subscription scope
Assignment with user-assigned managed identity at management group scope
Assignment with user-assigned managed identity at subscription scope

Assignment with system-assigned managed identity at management group scope

要求のサンプル

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

{
  "identity": {
    "type": "SystemAssigned"
  },
  "location": "eastus",
  "properties": {
    "description": "enforce pre-defined simpleBlueprint to this XXXXXXXX subscription.",
    "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"
      }
    }
  }
}

応答のサンプル

状態コード:
201 
{
  "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": "creating",
    "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 with system-assigned managed identity at subscription scope

要求のサンプル

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

{
  "identity": {
    "type": "SystemAssigned"
  },
  "location": "eastus",
  "properties": {
    "description": "enforce pre-defined simpleBlueprint to this XXXXXXXX subscription.",
    "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"
      }
    }
  }
}

応答のサンプル

状態コード:
201 
{
  "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": "creating",
    "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 with user-assigned managed identity at management group scope

要求のサンプル

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

{
  "identity": {
    "type": "UserAssigned",
    "userAssignedIdentities": {
      "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-resource-group/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-identity": {}
    }
  },
  "location": "eastus",
  "properties": {
    "description": "enforce pre-defined simpleBlueprint to this XXXXXXXX subscription.",
    "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"
      }
    }
  }
}

応答のサンプル

状態コード:
201 
{
  "identity": {
    "type": "UserAssigned",
    "tenantId": "00000000-0000-0000-0000-000000000000",
    "userAssignedIdentities": {
      "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-resource-group/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-identity": {
        "principalId": "00000000-0000-0000-0000-000000000000",
        "clientId": "00000000-0000-0000-0000-000000000000"
      }
    }
  },
  "location": "eastus",
  "properties": {
    "description": "enforce pre-defined simpleBlueprint to this XXXXXXXX subscription.",
    "provisioningState": "creating",
    "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 with user-assigned managed identity at subscription scope

要求のサンプル

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

{
  "identity": {
    "type": "UserAssigned",
    "userAssignedIdentities": {
      "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-resource-group/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-identity": {}
    }
  },
  "location": "eastus",
  "properties": {
    "description": "enforce pre-defined simpleBlueprint to this XXXXXXXX subscription.",
    "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"
      }
    }
  }
}

応答のサンプル

状態コード:
201 
{
  "identity": {
    "type": "UserAssigned",
    "tenantId": "00000000-0000-0000-0000-000000000000",
    "userAssignedIdentities": {
      "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-resource-group/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-identity": {
        "principalId": "00000000-0000-0000-0000-000000000000",
        "clientId": "00000000-0000-0000-0000-000000000000"
      }
    }
  },
  "location": "eastus",
  "properties": {
    "description": "enforce pre-defined simpleBlueprint to this XXXXXXXX subscription.",
    "provisioningState": "creating",
    "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

ブループリントの割り当てを表します。
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

このリソースの種類。

AssignmentLockMode

列挙

ロック モード。

値 説明
None
AllResourcesReadOnly
AllResourcesDoNotDelete

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

列挙

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

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

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。