Group - Create Or Update
Crea o Aggiornamenti un gruppo.
PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/groups/{groupId}?api-version=2022-08-01
Parametri dell'URI
Nome | In | Necessario | Tipo | Descrizione |
---|---|---|---|---|
group
|
path | True |
string |
Identificatore del gruppo. Deve essere univoco nell'istanza corrente del servizio di Gestione API. |
resource
|
path | True |
string |
Nome del gruppo di risorse. Per il nome non viene fatta distinzione tra maiuscole e minuscole. |
service
|
path | True |
string |
Nome del servizio di Gestione API. Criterio di espressione regolare: |
subscription
|
path | True |
string |
ID della sottoscrizione di destinazione. |
api-version
|
query | True |
string |
Versione dell'API da usare per questa operazione. |
Intestazione della richiesta
Nome | Necessario | Tipo | Descrizione |
---|---|---|---|
If-Match |
string |
ETag dell'entità. Non obbligatorio durante la creazione di un'entità, ma necessario durante l'aggiornamento di un'entità. |
Corpo della richiesta
Nome | Necessario | Tipo | Descrizione |
---|---|---|---|
properties.displayName | True |
string |
Nome del gruppo. |
properties.description |
string |
Descrizione del gruppo. |
|
properties.externalId |
string |
Identificatore dei gruppi esterni, questa proprietà contiene l'ID del gruppo dal provider di identità esterno, ad esempio per Azure Active Directory |
|
properties.type |
Tipo di gruppo. |
Risposte
Nome | Tipo | Descrizione |
---|---|---|
200 OK |
Il gruppo esiste già. Intestazioni ETag: string |
|
201 Created |
Il gruppo è stato creato correttamente. Intestazioni ETag: string |
|
Other Status Codes |
Risposta di errore che descrive il motivo per cui l'operazione non è riuscita. |
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
Api |
Api |
ApiManagementCreateGroup
Esempio di richiesta
Risposta di esempio
{
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/groups/tempgroup",
"type": "Microsoft.ApiManagement/service/groups",
"name": "tempgroup",
"properties": {
"displayName": "temp group",
"type": "custom"
}
}
{
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/groups/tempgroup",
"type": "Microsoft.ApiManagement/service/groups",
"name": "tempgroup",
"properties": {
"displayName": "temp group",
"type": "custom"
}
}
ApiManagementCreateGroupExternal
Esempio di richiesta
PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/groups/aadGroup?api-version=2022-08-01
{
"properties": {
"displayName": "NewGroup (samiraad.onmicrosoft.com)",
"description": "new group to test",
"type": "external",
"externalId": "aad://samiraad.onmicrosoft.com/groups/83cf2753-5831-4675-bc0e-2f8dc067c58d"
}
}
Risposta di esempio
{
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/groups/aadGroup",
"type": "Microsoft.ApiManagement/service/groups",
"name": "aadGroup",
"properties": {
"displayName": "NewGroup (samiraad.onmicrosoft.com)",
"description": "new group to test",
"type": "external",
"externalId": "aad://samiraad.onmicrosoft.com/groups/83cf2753-5831-4675-bc0e-2f8dc067c58d"
}
}
{
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/groups/aadGroup",
"type": "Microsoft.ApiManagement/service/groups",
"name": "aadGroup",
"properties": {
"displayName": "NewGroup (samiraad.onmicrosoft.com)",
"description": "new group to test",
"type": "external",
"externalId": "aad://samiraad.onmicrosoft.com/groups/83cf2753-5831-4675-bc0e-2f8dc067c58d"
}
}
Definizioni
Nome | Descrizione |
---|---|
Error |
Contratto campo di errore. |
Error |
Risposta errore. |
Group |
Dettagli del contratto. |
Group |
Parametri forniti all'operazione Crea gruppo. |
Group |
Tipo di gruppo. |
ErrorFieldContract
Contratto campo di errore.
Nome | Tipo | Descrizione |
---|---|---|
code |
string |
Codice di errore a livello di proprietà. |
message |
string |
Rappresentazione leggibile dell'errore a livello di proprietà. |
target |
string |
Nome della proprietà. |
ErrorResponse
Risposta errore.
Nome | Tipo | Descrizione |
---|---|---|
error.code |
string |
Codice di errore definito dal servizio. Questo codice svolge la funzione di stato secondario per il codice di errore HTTP specificato nella risposta. |
error.details |
Elenco di campi non validi inviati nella richiesta, in caso di errore di convalida. |
|
error.message |
string |
Rappresentazione leggibile dell'errore. |
GroupContract
Dettagli del contratto.
Nome | Tipo | Descrizione |
---|---|---|
id |
string |
ID di risorsa completo per la risorsa. Ad esempio - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
name |
string |
nome della risorsa. |
properties.builtIn |
boolean |
true se il gruppo è uno dei tre gruppi di sistema (Amministratori, Sviluppatori o Guest); in caso contrario false. |
properties.description |
string |
Descrizione del gruppo. Può contenere tag di formattazione HTML. |
properties.displayName |
string |
Nome del gruppo. |
properties.externalId |
string |
Per i gruppi esterni, questa proprietà contiene l'ID del gruppo dal provider di identità esterno, ad esempio per Azure Active Directory |
properties.type |
Tipo di gruppo. |
|
type |
string |
Tipo di risorsa. Ad esempio, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts" |
GroupCreateParameters
Parametri forniti all'operazione Crea gruppo.
Nome | Tipo | Descrizione |
---|---|---|
properties.description |
string |
Descrizione del gruppo. |
properties.displayName |
string |
Nome del gruppo. |
properties.externalId |
string |
Identificatore dei gruppi esterni, questa proprietà contiene l'ID del gruppo dal provider di identità esterno, ad esempio per Azure Active Directory |
properties.type |
Tipo di gruppo. |
GroupType
Tipo di gruppo.
Nome | Tipo | Descrizione |
---|---|---|
custom |
string |
|
external |
string |
|
system |
string |