Assignments - Create Or Update
Creare o aggiornare un'assegnazione di progetto.
PUT https://management.azure.com/{resourceScope}/providers/Microsoft.Blueprint/blueprintAssignments/{assignmentName}?api-version=2018-11-01-preview
Parametri dell'URI
Nome | In | Necessario | Tipo | Descrizione |
---|---|---|---|---|
assignment
|
path | True |
string |
Nome dell'assegnazione del progetto. |
resource
|
path | True |
string |
Ambito della risorsa. Gli ambiti validi sono: gruppo di gestione (formato: '/providers/Microsoft.Management/managementGroups/{managementGroup}'), sottoscrizione (formato: '/subscriptions/{subscriptionId}'). |
api-version
|
query | True |
string |
Versione dell'API client. |
Corpo della richiesta
Nome | Necessario | Tipo | Descrizione |
---|---|---|---|
identity | True |
Identità gestita per questa assegnazione di progetto. |
|
location | True |
string |
Posizione dell'assegnazione del progetto. |
properties.parameters | True |
<string,
Parameter |
Valori dei parametri di assegnazione del progetto. |
properties.resourceGroups | True |
<string,
Resource |
Nomi e posizioni dei segnaposto del gruppo di risorse. |
properties.blueprintId |
string |
ID della versione pubblicata di una definizione di progetto. |
|
properties.description |
string maxLength: 500 |
Spiegare in più righe questa risorsa. |
|
properties.displayName |
string maxLength: 256 |
La stringa di una riga spiega questa risorsa. |
|
properties.locks |
Definisce la modalità di blocco delle risorse distribuite da un'assegnazione di progetto. |
||
properties.scope |
string |
Ambito della sottoscrizione di destinazione dell'assegnazione del progetto (formato: '/subscriptions/{subscriptionId}'). Per le assegnazioni a livello di gruppo di gestione, la proprietà è obbligatoria. |
Risposte
Nome | Tipo | Descrizione |
---|---|---|
201 Created |
Creato: l'assegnazione del progetto è stata salvata. |
|
Other Status Codes |
Risposta di errore di Blueprints. |
Sicurezza
azure_auth
Flusso OAuth2 di Azure Active Directory
Tipo:
oauth2
Flow:
implicit
URL di autorizzazione:
https://login.microsoftonline.com/common/oauth2/authorize
Ambiti
Nome | Descrizione |
---|---|
user_impersonation | rappresentare l'account utente |
Esempio
Assignment with system-assigned managed identity at management group scope
Esempio di richiesta
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"
}
}
}
}
Risposta di esempio
{
"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
Esempio di richiesta
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"
}
}
}
}
Risposta di esempio
{
"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
Esempio di richiesta
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"
}
}
}
}
Risposta di esempio
{
"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
Esempio di richiesta
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"
}
}
}
}
Risposta di esempio
{
"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"
}
Definizioni
Nome | Descrizione |
---|---|
Assignment |
Rappresenta un'assegnazione di progetto. |
Assignment |
Modalità di blocco. |
Assignment |
Definisce la modalità di blocco delle risorse distribuite da un'assegnazione di progetto. |
Assignment |
Stato dell'assegnazione del progetto. |
Assignment |
Stato di un'assegnazione di progetto. Questo campo è di sola lettura. |
Cloud |
|
Error |
Informazioni aggiuntive sull'errore di gestione delle risorse. |
Error |
Risposta errore |
key |
Specifica il collegamento a un insieme di credenziali delle chiavi. |
Managed |
Oggetto generico identità gestita. |
Managed |
Tipo dell'identità gestita. |
Parameter |
Valore per il parametro specificato. Può essere "value" o "reference", ma non entrambi. |
Resource |
Rappresenta un gruppo di risorse di Azure. |
Secret |
Riferimento a un segreto di Key Vault. |
User |
Identità gestita assegnata dall'utente. |
Assignment
Rappresenta un'assegnazione di progetto.
Nome | Tipo | Descrizione |
---|---|---|
id |
string |
ID stringa usato per individuare qualsiasi risorsa in Azure. |
identity |
Identità gestita per questa assegnazione di progetto. |
|
location |
string |
Posizione dell'assegnazione del progetto. |
name |
string |
Nome della risorsa. |
properties.blueprintId |
string |
ID della versione pubblicata di una definizione di progetto. |
properties.description |
string maxLength: 500 |
Spiegare in più righe questa risorsa. |
properties.displayName |
string maxLength: 256 |
La stringa di una riga spiega questa risorsa. |
properties.locks |
Definisce la modalità di blocco delle risorse distribuite da un'assegnazione di progetto. |
|
properties.parameters |
<string,
Parameter |
Valori dei parametri di assegnazione del progetto. |
properties.provisioningState |
Stato dell'assegnazione del progetto. |
|
properties.resourceGroups |
<string,
Resource |
Nomi e posizioni dei segnaposto del gruppo di risorse. |
properties.scope |
string |
Ambito della sottoscrizione di destinazione dell'assegnazione del progetto (formato: '/subscriptions/{subscriptionId}'). Per le assegnazioni a livello di gruppo di gestione, la proprietà è obbligatoria. |
properties.status |
Stato dell'assegnazione del progetto. Questo campo è di sola lettura. |
|
type |
string |
Tipo di questa risorsa. |
AssignmentLockMode
Modalità di blocco.
Valore | Descrizione |
---|---|
AllResourcesDoNotDelete | |
AllResourcesReadOnly | |
None |
AssignmentLockSettings
Definisce la modalità di blocco delle risorse distribuite da un'assegnazione di progetto.
Nome | Tipo | Descrizione |
---|---|---|
excludedActions |
string[] |
Elenco delle operazioni di gestione escluse dai blocchi del progetto. Sono consentite fino a 200 azioni. Se la modalità di blocco è impostata su 'AllResourcesReadOnly', le azioni seguenti vengono aggiunte automaticamente a 'excludedActions': '*/read', 'Microsoft.Network/virtualNetworks/subnets/join/action' e 'Microsoft.Authorization/locks/delete'. Se la modalità di blocco è impostata su 'AllResourcesDoNotDelete', le azioni seguenti vengono aggiunte automaticamente a 'excludedActions': 'Microsoft.Authorization/locks/delete'. Le azioni duplicate verranno rimosse. |
excludedPrincipals |
string[] |
Elenco delle entità AAD escluse dai blocchi del progetto. Sono consentite fino a 5 entità. |
mode |
Modalità di blocco. |
AssignmentProvisioningState
Stato dell'assegnazione del progetto.
Valore | Descrizione |
---|---|
canceled | |
cancelling | |
creating | |
deleting | |
deploying | |
failed | |
locking | |
succeeded | |
validating | |
waiting |
AssignmentStatus
Stato di un'assegnazione di progetto. Questo campo è di sola lettura.
Nome | Tipo | Descrizione |
---|---|---|
lastModified |
string (date-time) |
Ora dell'ultima modifica della definizione del progetto. |
managedResources |
string[] |
Elenco delle risorse create dall'assegnazione del progetto. |
timeCreated |
string (date-time) |
Ora di creazione della definizione del progetto. |
CloudError
Nome | Tipo | Descrizione |
---|---|---|
error |
Risposta errore |
ErrorAdditionalInfo
Informazioni aggiuntive sull'errore di gestione delle risorse.
Nome | Tipo | Descrizione |
---|---|---|
info |
object |
Informazioni aggiuntive. |
type |
string |
Tipo di informazioni aggiuntive. |
ErrorResponse
Risposta errore
Nome | Tipo | Descrizione |
---|---|---|
additionalInfo |
Informazioni aggiuntive sull'errore. |
|
code |
string |
Codice di errore. |
details |
Dettagli dell'errore. |
|
message |
string |
Messaggio di errore. |
target |
string |
Destinazione dell'errore. |
keyVaultReference
Specifica il collegamento a un insieme di credenziali delle chiavi.
Nome | Tipo | Descrizione |
---|---|---|
id |
string |
ID risorsa di Azure dell'insieme di credenziali delle chiavi. |
ManagedServiceIdentity
Oggetto generico identità gestita.
Nome | Tipo | Descrizione |
---|---|---|
principalId |
string |
ID entità di Azure Active Directory associato a questa identità. |
tenantId |
string |
ID di Azure Active Directory. |
type |
Tipo dell'identità gestita. |
|
userAssignedIdentities |
<string,
User |
Elenco di identità gestite assegnate dall'utente associate alla risorsa. La chiave è l'ID risorsa di Azure dell'identità gestita. |
ManagedServiceIdentityType
Tipo dell'identità gestita.
Valore | Descrizione |
---|---|
None | |
SystemAssigned | |
UserAssigned |
ParameterValue
Valore per il parametro specificato. Può essere "value" o "reference", ma non entrambi.
Nome | Tipo | Descrizione |
---|---|---|
reference |
Valore del parametro come tipo riferimento. |
|
value |
object |
Valore del parametro. Qualsiasi valore JSON valido è consentito, inclusi oggetti, matrici, stringhe, numeri e valori booleani. |
ResourceGroupValue
Rappresenta un gruppo di risorse di Azure.
Nome | Tipo | Descrizione |
---|---|---|
location |
string |
Posizione del gruppo di risorse. |
name |
string minLength: 1maxLength: 90 |
Nome del gruppo di risorse. |
SecretValueReference
Riferimento a un segreto di Key Vault.
Nome | Tipo | Descrizione |
---|---|---|
keyVault |
Specifica il riferimento a un determinato insieme di credenziali delle chiavi di Azure. |
|
secretName |
string |
Nome del segreto. |
secretVersion |
string |
Versione del segreto da usare. Se lasciato vuoto, viene usata la versione più recente del segreto. |
UserAssignedIdentity
Identità gestita assegnata dall'utente.
Nome | Tipo | Descrizione |
---|---|---|
clientId |
string |
ID app client associato a questa identità. |
principalId |
string |
ID entità di Azure Active Directory associato a questa identità. |