Assignments - Create Or Update

Layanan:

Blueprints

Versi API:

2018-11-01-preview

Membuat atau memperbarui penetapan cetak biru.

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

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
assignmentName	path	True	string	Nama penetapan cetak biru.
resourceScope	path	True	string	Cakupan sumber daya. Cakupan yang valid adalah: grup manajemen (format: '/providers/Microsoft.Management/managementGroups/{managementGroup}'), langganan (format: '/subscriptions/{subscriptionId}').
api-version	query	True	string	Versi API Klien.

Isi Permintaan

Nama	Diperlukan	Jenis	Deskripsi
identity	True	ManagedServiceIdentity	Identitas terkelola untuk penetapan cetak biru ini.
location	True	string	Lokasi penetapan cetak biru ini.
properties.parameters	True	<string,  ParameterValue>	Nilai parameter penetapan cetak biru.
properties.resourceGroups	True	<string,  ResourceGroupValue>	Nama dan lokasi tempat penampung grup sumber daya.
properties.blueprintId		string	ID dari versi definisi cetak biru yang diterbitkan.
properties.description		string maxLength: 500	Multibaris menjelaskan sumber daya ini.
properties.displayName		string maxLength: 256	String satu baris menjelaskan sumber daya ini.
properties.locks		AssignmentLockSettings	Menentukan bagaimana sumber daya yang disebarkan oleh penetapan cetak biru dikunci.
properties.scope		string	Cakupan langganan target dari penetapan cetak biru (format: '/subscriptions/{subscriptionId}'). Untuk penetapan tingkat grup manajemen, properti diperlukan.

Respons

Nama	Jenis	Deskripsi
201 Created	Assignment	Dibuat -- penetapan cetak biru disimpan.
Other Status Codes	CloudError	Respons kesalahan cetak biru.

Keamanan

azure_auth

Alur OAuth2 Azure Active Directory

Jenis: oauth2
Alur: implicit
URL Otorisasi: https://login.microsoftonline.com/common/oauth2/authorize

Cakupan

Nama	Deskripsi
user_impersonation	meniru akun pengguna Anda

Contoh

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

Permintaan sampel

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

Respon sampel

Kode status:

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

Permintaan sampel

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

Respon sampel

Kode status:

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

Permintaan sampel

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

Respon sampel

Kode status:

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

Permintaan sampel

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

Respon sampel

Kode status:

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

Definisi

Nama	Deskripsi
Assignment	Mewakili penetapan cetak biru.
AssignmentLockMode	Mode kunci.
AssignmentLockSettings	Menentukan bagaimana sumber daya yang disebarkan oleh penetapan cetak biru dikunci.
AssignmentProvisioningState	Status penetapan cetak biru.
AssignmentStatus	Status penetapan cetak biru. Bidang ini adalah readonly.
CloudError
ErrorAdditionalInfo	Info tambahan kesalahan manajemen sumber daya.
ErrorResponse	Respons Kesalahan
keyVaultReference	Menentukan tautan ke Key Vault.
ManagedServiceIdentity	Objek generik identitas terkelola.
ManagedServiceIdentityType	Jenis identitas terkelola.
ParameterValue	Nilai untuk parameter yang ditentukan. Dapat berupa 'nilai' atau 'referensi' tetapi tidak keduanya.
ResourceGroupValue	Mewakili grup sumber daya Azure.
SecretValueReference	Referensi ke rahasia Key Vault.
UserAssignedIdentity	Identitas terkelola yang ditetapkan pengguna.

Assignment

Objek

Mewakili penetapan cetak biru.

Nama	Jenis	Deskripsi
id	string	Id String yang digunakan untuk menemukan sumber daya apa pun di Azure.
identity	ManagedServiceIdentity	Identitas terkelola untuk penetapan cetak biru ini.
location	string	Lokasi penetapan cetak biru ini.
name	string	Nama sumber daya ini.
properties.blueprintId	string	ID dari versi definisi cetak biru yang diterbitkan.
properties.description	string maxLength: 500	Multibaris menjelaskan sumber daya ini.
properties.displayName	string maxLength: 256	String satu baris menjelaskan sumber daya ini.
properties.locks	AssignmentLockSettings	Menentukan bagaimana sumber daya yang disebarkan oleh penetapan cetak biru dikunci.
properties.parameters	<string,  ParameterValue>	Nilai parameter penetapan cetak biru.
properties.provisioningState	AssignmentProvisioningState	Status penetapan cetak biru.
properties.resourceGroups	<string,  ResourceGroupValue>	Nama dan lokasi tempat penampung grup sumber daya.
properties.scope	string	Cakupan langganan target dari penetapan cetak biru (format: '/subscriptions/{subscriptionId}'). Untuk penetapan tingkat grup manajemen, properti diperlukan.
properties.status	AssignmentStatus	Status penetapan cetak biru. Bidang ini adalah readonly.
type	string	Jenis sumber daya ini.

AssignmentLockMode

Enumeration

Mode kunci.

Nilai	Deskripsi
None
AllResourcesReadOnly
AllResourcesDoNotDelete

AssignmentLockSettings

Objek

Menentukan bagaimana sumber daya yang disebarkan oleh penetapan cetak biru dikunci.

Nama	Jenis	Deskripsi
excludedActions	string[]	Daftar operasi manajemen yang dikecualikan dari kunci cetak biru. Hingga 200 tindakan diizinkan. Jika mode kunci diatur ke 'AllResourcesReadOnly', maka tindakan berikut secara otomatis ditambahkan ke 'excludedActions': '*/read', 'Microsoft.Network/virtualNetworks/subnets/join/action' dan 'Microsoft.Authorization/locks/delete'. Jika mode kunci diatur ke 'AllResourcesDoNotDelete', maka tindakan berikut secara otomatis ditambahkan ke 'excludedActions': 'Microsoft.Authorization/locks/delete'. Tindakan duplikat akan dihapus.
excludedPrincipals	string[]	Daftar prinsipal AAD yang dikecualikan dari kunci cetak biru. Hingga 5 prinsipal diizinkan.
mode	AssignmentLockMode	Mode kunci.

AssignmentProvisioningState

Enumeration

Status penetapan cetak biru.

Nilai	Deskripsi
creating
validating
waiting
deploying
cancelling
locking
succeeded
failed
canceled
deleting

AssignmentStatus

Objek

Status penetapan cetak biru. Bidang ini adalah readonly.

Nama	Jenis	Deskripsi
lastModified	string (date-time)	Waktu terakhir yang dimodifikasi dari definisi cetak biru ini.
managedResources	string[]	Daftar sumber daya yang dibuat oleh penetapan cetak biru.
timeCreated	string (date-time)	Waktu pembuatan definisi cetak biru ini.

CloudError

Objek

Nama	Jenis	Deskripsi
error	ErrorResponse	Respons Kesalahan Respons kesalahan umum untuk semua API Azure Resource Manager untuk mengembalikan detail kesalahan untuk operasi yang gagal. (Ini juga mengikuti format respons kesalahan OData.)

ErrorAdditionalInfo

Objek

Info tambahan kesalahan manajemen sumber daya.

Nama	Jenis	Deskripsi
info	object	Info tambahan.
type	string	Jenis info tambahan.

ErrorResponse

Objek

Respons Kesalahan

Nama	Jenis	Deskripsi
additionalInfo	ErrorAdditionalInfo[]	Info tambahan kesalahan.
code	string	Kode kesalahan.
details	ErrorResponse[]	Detail kesalahan.
message	string	Pesan kesalahan.
target	string	Target kesalahan.

keyVaultReference

Objek

Menentukan tautan ke Key Vault.

Nama	Jenis	Deskripsi
id	string	ID sumber daya Azure dari Key Vault.

ManagedServiceIdentity

Objek

Objek generik identitas terkelola.

Nama	Jenis	Deskripsi
principalId	string	ID utama Azure Active Directory yang terkait dengan Identitas ini.
tenantId	string	ID of the Azure Active Directory.
type	ManagedServiceIdentityType	Jenis identitas terkelola.
userAssignedIdentities	<string,  UserAssignedIdentity>	Daftar identitas terkelola yang ditetapkan pengguna yang terkait dengan sumber daya. Kuncinya adalah Id sumber daya Azure dari identitas terkelola.

ManagedServiceIdentityType

Enumeration

Jenis identitas terkelola.

Nilai	Deskripsi
None
SystemAssigned
UserAssigned

ParameterValue

Objek

Nilai untuk parameter yang ditentukan. Dapat berupa 'nilai' atau 'referensi' tetapi tidak keduanya.

Nama	Jenis	Deskripsi
reference	SecretValueReference	Nilai parameter sebagai jenis referensi.
value	object	Nilai parameter. Setiap nilai JSON yang valid diizinkan termasuk objek, array, string, angka, dan boolean.

ResourceGroupValue

Objek

Mewakili grup sumber daya Azure.

Nama	Jenis	Deskripsi
location	string	Lokasi grup sumber daya.
name	string minLength: 1 maxLength: 90	Nama grup sumber daya.

SecretValueReference

Objek

Referensi ke rahasia Key Vault.

Nama	Jenis	Deskripsi
keyVault	keyVaultReference	Menentukan referensi ke Azure Key Vault tertentu.
secretName	string	Nama rahasia.
secretVersion	string	Versi rahasia yang akan digunakan. Jika dibiarkan kosong, versi terbaru rahasia akan digunakan.

UserAssignedIdentity

Objek

Identitas terkelola yang ditetapkan pengguna.

Nama	Jenis	Deskripsi
clientId	string	Id Aplikasi Klien yang terkait dengan identitas ini.
principalId	string	ID utama Azure Active Directory yang terkait dengan Identitas ini.