Tenant Access - Update
Aggiornare i dettagli delle informazioni di accesso al tenant.
PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/tenant/{accessName}?api-version=2022-08-01
Parametri dell'URI
Nome | In | Necessario | Tipo | Descrizione |
---|---|---|---|---|
access
|
path | True |
Identificatore della configurazione di Access. |
|
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 Gestione API. Regex pattern: |
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 | True |
string |
ETag dell'entità. ETag deve corrispondere allo stato dell'entità corrente dalla risposta di intestazione della richiesta GET oppure deve essere * per l'aggiornamento incondizionato. |
Corpo della richiesta
Nome | Tipo | Descrizione |
---|---|---|
properties.enabled |
boolean |
Determina se l'accesso diretto è abilitato. |
Risposte
Nome | Tipo | Descrizione |
---|---|---|
200 OK |
Le informazioni di accesso al tenant sono state aggiornate correttamente. Headers ETag: string |
|
Other Status Codes |
Risposta di errore che descrive perché l'operazione non è riuscita. |
Sicurezza
azure_auth
Flusso OAuth2 di Azure Active Directory.
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Nome | Descrizione |
---|---|
user_impersonation | rappresentare l'account utente |
Esempio
ApiManagementUpdateTenantAccess
Sample Request
PATCH https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/access?api-version=2022-08-01
{
"properties": {
"enabled": true
}
}
Sample Response
{
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/access",
"type": "Microsoft.ApiManagement/service/tenant",
"name": "access",
"properties": {
"enabled": true
}
}
Definizioni
Nome | Descrizione |
---|---|
Access |
Identificatore della configurazione di Access. |
Access |
Impostazioni tenant. |
Access |
Parametri di aggiornamento delle informazioni di accesso al tenant. |
Error |
Contratto campo errore. |
Error |
Risposta errore. |
AccessIdName
Identificatore della configurazione di Access.
Nome | Tipo | Descrizione |
---|---|---|
access |
string |
|
gitAccess |
string |
AccessInformationContract
Impostazioni tenant.
Nome | Tipo | Descrizione |
---|---|---|
id |
string |
ID di risorsa completo per la risorsa. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
name |
string |
nome della risorsa. |
properties.enabled |
boolean |
Determina se l'accesso diretto è abilitato. |
properties.id |
string |
Tipo di informazioni di accesso ('access' o 'gitAccess') |
properties.principalId |
string |
Identificatore dell'entità (utente). |
type |
string |
Tipo di risorsa. Ad esempio, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts" |
AccessInformationUpdateParameters
Parametri di aggiornamento delle informazioni di accesso al tenant.
Nome | Tipo | Descrizione |
---|---|---|
properties.enabled |
boolean |
Determina se l'accesso diretto è abilitato. |
ErrorFieldContract
Contratto campo 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. |