Assignments - Create Or Update

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

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

URI パラメーター

Name In Required Type Description
assignmentName
path True
  • string

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

resourceScope
path True
  • string

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

api-version
query True
  • string

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

要求本文

Name Required Type Description
identity True

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

location True
  • string

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

properties.parameters True

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

properties.resourceGroups True

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

properties.blueprintId
  • string

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

properties.description
  • string

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

properties.displayName
  • string

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

properties.locks

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

properties.scope
  • string

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

応答

Name Type Description
201 Created

作成済み -- ブループリントの割り当てを保存しました。

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 ユーザー アカウントを偽装する

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

Sample Request

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"
      }
    }
  }
}

Sample Response

{
  "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

Sample Request

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"
      }
    }
  }
}

Sample Response

{
  "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

Sample Request

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"
      }
    }
  }
}

Sample Response

{
  "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

Sample Request

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"
      }
    }
  }
}

Sample Response

{
  "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

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

Name Type Description
id
  • string

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

identity

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

location
  • string

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

name
  • string

このリソースの名前。

properties.blueprintId
  • string

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

properties.description
  • string

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

properties.displayName
  • string

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

properties.locks

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

properties.parameters

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

properties.provisioningState

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

properties.resourceGroups

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

properties.scope
  • string

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

properties.status

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

type
  • string

このリソースの種類。

AssignmentLockMode

ロック モード。

Name Type Description
AllResourcesDoNotDelete
  • string
AllResourcesReadOnly
  • string
None
  • string

AssignmentLockSettings

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

Name Type Description
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

ロック モード。

AssignmentProvisioningState

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

Name Type Description
canceled
  • string
cancelling
  • string
creating
  • string
deleting
  • string
deploying
  • string
failed
  • string
locking
  • string
succeeded
  • string
validating
  • string
waiting
  • string

AssignmentStatus

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

Name Type Description
lastModified
  • string

このブループリント定義の最終変更時刻。

managedResources
  • string[]

ブループリントの割り当てによって作成されたリソースの一覧。

timeCreated
  • string

このブループリント定義の作成時間。

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。

ManagedServiceIdentity

マネージド ID ジェネリック オブジェクト。

Name Type Description
principalId
  • string

この ID に関連付けられているプリンシパル ID をAzure Active Directoryします。

tenantId
  • string

Azure Active Directoryの ID。

type

マネージド ID の種類。

userAssignedIdentities

リソースに関連付けられているユーザー割り当てマネージド ID の一覧。 キーは、マネージド ID の Azure リソース ID です。

ManagedServiceIdentityType

マネージド ID の種類。

Name Type Description
None
  • string
SystemAssigned
  • string
UserAssigned
  • string

ParameterValue

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

Name Type Description
reference

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

value
  • object

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

ResourceGroupValue

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

Name Type Description
location
  • string

リソース グループの場所。

name
  • string

リソース グループの名前。

SecretValueReference

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

Name Type Description
keyVault

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

secretName
  • string

シークレットの名前。

secretVersion
  • string

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

UserAssignedIdentity

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

Name Type Description
clientId
  • string

この ID に関連付けられているクライアント アプリ ID。

principalId
  • string

この ID に関連付けられているプリンシパル ID をAzure Active Directoryします。