Gateway - Update
Aggiornamenti i dettagli del gateway specificati dall'identificatore.
PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/gateways/{gatewayId}?api-version=2022-08-01
Parametri dell'URI
Nome | In | Necessario | Tipo | Descrizione |
---|---|---|---|---|
gateway
|
path | True |
string |
Identificatore di entità gateway. Deve essere univoco nell'istanza corrente del servizio Gestione API. Non deve avere valore 'managed' |
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.description |
string |
Descrizione del gateway |
properties.locationData |
Percorso del gateway. |
Risposte
Nome | Tipo | Descrizione |
---|---|---|
200 OK |
I dettagli del gateway sono stati aggiornati 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
ApiManagementUpdateGateway
Sample Request
PATCH https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/gateways/gw1?api-version=2022-08-01
{
"properties": {
"description": "my gateway 1",
"locationData": {
"name": "my location"
}
}
}
Sample Response
{
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/gateways/gw1",
"type": "Microsoft.ApiManagement/service/gateways",
"name": "a1",
"properties": {
"description": "my gateway 1",
"locationData": {
"name": "my location"
}
}
}
Definizioni
Nome | Descrizione |
---|---|
Error |
Contratto campo errore. |
Error |
Risposta errore. |
Gateway |
Dettagli del gateway. |
Resource |
Proprietà dei dati del percorso delle risorse. |
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. |
GatewayContract
Dettagli del gateway.
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.description |
string |
Descrizione del gateway |
properties.locationData |
Percorso del gateway. |
|
type |
string |
Tipo di risorsa. Ad esempio, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts" |
ResourceLocationDataContract
Proprietà dei dati del percorso delle risorse.
Nome | Tipo | Descrizione |
---|---|---|
city |
string |
Città o località in cui si trova la risorsa. |
countryOrRegion |
string |
Paese o area geografica in cui si trova la risorsa. |
district |
string |
Distretto, stato o provincia in cui si trova la risorsa. |
name |
string |
Nome canonico per la posizione geografica o fisica. |