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 參數

名稱	位於	必要	類型	Description
assignmentName	path	True	string	藍圖指派的名稱。
resourceScope	path	True	string	資源的範圍。有效範圍包括：管理群組（格式：'/providers/Microsoft.Management/managementGroups/{managementGroup}'）、訂用帳戶（格式：'/subscriptions/{subscriptionId}'）。
api-version	query	True	string	用戶端 API 版本。

要求本文

名稱	必要	類型	Description
identity	True	ManagedServiceIdentity	此藍圖指派的受控識別。
location	True	string	此藍圖指派的位置。
properties.parameters	True	<string, ParameterValue>	藍圖指派參數值。
properties.resourceGroups	True	<string, ResourceGroupValue>	資源群組佔位元的名稱和位置。
properties.blueprintId		string	藍圖定義的已發佈版本的標識碼。
properties.description		string maxLength: 500	多行說明此資源。
properties.displayName		string maxLength: 256	單行字串說明此資源。
properties.locks		AssignmentLockSettings	定義藍圖指派所部署的資源鎖定方式。
properties.scope		string	藍圖指派的目標訂用帳戶範圍（格式：』/subscriptions/{subscriptionId}'）。針對管理群組層級指派，需要屬性。

回應

名稱	類型	Description
201 Created	Assignment	已建立 -- 已儲存藍圖指派。
Other Status Codes	CloudError	藍圖錯誤回應。

安全性

azure_auth

Azure Active Directory OAuth2 流

類型: oauth2
Flow: implicit
授權 URL: https://login.microsoftonline.com/common/oauth2/authorize

範圍

名稱	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

範例要求

HTTP

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

範例要求

HTTP

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

範例要求

HTTP

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

範例要求

HTTP

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

定義

名稱	Description
Assignment	表示藍圖指派。
AssignmentLockMode	鎖定模式。
AssignmentLockSettings	定義藍圖指派所部署的資源鎖定方式。
AssignmentProvisioningState	藍圖指派的狀態。
AssignmentStatus	藍圖指派的狀態。此欄位是唯讀的。
CloudError
ErrorAdditionalInfo	資源管理錯誤其他資訊。
ErrorResponse	錯誤回應
keyVaultReference	指定 Key Vault 的連結。
ManagedServiceIdentity	受控識別泛型物件。
ManagedServiceIdentityType	受控識別的類型。
ParameterValue	指定參數的值。可以是 'value' 或 'reference'，但不能同時是兩者。
ResourceGroupValue	代表 Azure 資源群組。
SecretValueReference	Key Vault 秘密的參考。
UserAssignedIdentity	使用者指派的受控識別。

Assignment

Object

表示藍圖指派。

名稱	類型	Description
id	string	用來尋找 Azure 上任何資源的字串標識碼。
identity	ManagedServiceIdentity	此藍圖指派的受控識別。
location	string	此藍圖指派的位置。
name	string	此資源的名稱。
properties.blueprintId	string	藍圖定義的已發佈版本的標識碼。
properties.description	string maxLength: 500	多行說明此資源。
properties.displayName	string maxLength: 256	單行字串說明此資源。
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

列舉型別

鎖定模式。

值	Description
None
AllResourcesReadOnly
AllResourcesDoNotDelete

AssignmentLockSettings

Object

定義藍圖指派所部署的資源鎖定方式。

名稱	類型	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	AssignmentLockMode	鎖定模式。

AssignmentProvisioningState

列舉型別

藍圖指派的狀態。

值	Description
creating
validating
waiting
deploying
cancelling
locking
succeeded
failed
canceled
deleting

AssignmentStatus

Object

藍圖指派的狀態。此欄位是唯讀的。

名稱	類型	Description
lastModified	string (date-time)	此藍圖定義的上次修改時間。
managedResources	string[]	藍圖指派所建立的資源清單。
timeCreated	string (date-time)	此藍圖定義的建立時間。

CloudError

Object

名稱	類型	Description
error	ErrorResponse	錯誤回應所有 Azure Resource Manager API 的常見錯誤回應，以傳回失敗作業的錯誤詳細數據。（這也遵循 OData 錯誤回應格式。）

ErrorAdditionalInfo

Object

資源管理錯誤其他資訊。

名稱	類型	Description
info	object	其他資訊。
type	string	其他信息類型。

ErrorResponse

Object

錯誤回應

名稱	類型	Description
additionalInfo	ErrorAdditionalInfo[]	錯誤其他資訊。
code	string	錯誤碼。
details	ErrorResponse[]	錯誤詳細數據。
message	string	錯誤訊息。
target	string	錯誤目標。

keyVaultReference

Object

指定 Key Vault 的連結。

名稱	類型	Description
id	string	Key Vault 的 Azure 資源識別碼。

ManagedServiceIdentity

Object

受控識別泛型物件。

名稱	類型	Description
principalId	string	與此身分識別相關聯的 Azure Active Directory 主體標識符。
tenantId	string	Azure Active Directory 的標識碼。
type	ManagedServiceIdentityType	受控識別的類型。
userAssignedIdentities	<string, UserAssignedIdentity>	與資源相關聯的使用者指派受控識別清單。密鑰是受控識別的 Azure 資源識別碼。

ManagedServiceIdentityType

列舉型別

受控識別的類型。

值	Description
None
SystemAssigned
UserAssigned

ParameterValue

Object

指定參數的值。可以是 'value' 或 'reference'，但不能同時是兩者。

名稱	類型	Description
reference	SecretValueReference	參數值做為參考型別。
value	object	參數值。允許任何有效的 JSON 值，包括對象、數位、字串、數位和布爾值。

ResourceGroupValue

Object

代表 Azure 資源群組。

名稱	類型	Description
location	string	資源群組的位置。
name	string minLength: 1 maxLength: 90	資源群組的名稱。

SecretValueReference

Object

Key Vault 秘密的參考。

名稱	類型	Description
keyVault	keyVaultReference	指定指定 Azure Key Vault 的參考。
secretName	string	秘密的名稱。
secretVersion	string	要使用的秘密版本。如果保留空白，則會使用最新版本的秘密。

UserAssignedIdentity

Object

使用者指派的受控識別。

名稱	類型	Description
clientId	string	與此身分識別相關聯的用戶端應用程式標識碼。
principalId	string	與此身分識別相關聯的 Azure Active Directory 主體標識符。

共用方式為

Assignments - Create Or Update

URI 參數

要求本文

回應

安全性

azure_auth

範圍

範例

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

AssignmentLockMode

AssignmentLockSettings

AssignmentProvisioningState

AssignmentStatus

CloudError

ErrorAdditionalInfo

ErrorResponse

keyVaultReference

ManagedServiceIdentity

ManagedServiceIdentityType

ParameterValue

ResourceGroupValue

SecretValueReference

UserAssignedIdentity