Api Version Set - Update

Aggiornamenti i dettagli dell'Api VersionSet specificati dal relativo identificatore.

PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apiVersionSets/{versionSetId}?api-version=2022-08-01

Parametri dell'URI

Nome In Necessario Tipo Descrizione
resourceGroupName
path True

string

Nome del gruppo di risorse. Per il nome non viene fatta distinzione tra maiuscole e minuscole.

serviceName
path True

string

Nome del servizio Gestione API.

Regex pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$

subscriptionId
path True

string

ID della sottoscrizione di destinazione.

versionSetId
path True

string

Identificatore del set di versioni dell'API. Deve essere univoco nell'istanza corrente del servizio Gestione API.

Regex pattern: ^[^*#&+:<>?]+$

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 set di versioni dell'API.

properties.displayName

string

Nome del set di versioni dell'API

properties.versionHeaderName

string

Nome del parametro di intestazione HTTP che indica la versione DELL'API se il controllo delle versioniScheme è impostato su header.

properties.versionQueryName

string

Nome del parametro di query che indica la versione DELL'API se il controllo delle versioniScheme è impostato su query.

properties.versioningScheme

versioningScheme

Valore che determina dove si trova l'identificatore della versione API in una richiesta HTTP.

Risposte

Nome Tipo Descrizione
200 OK

ApiVersionSetContract

Il set di versioni dell'API è stato aggiornato correttamente.

Headers

ETag: string

Other Status Codes

ErrorResponse

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

ApiManagementUpdateApiVersionSet

Sample Request

PATCH https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apiVersionSets/vs1?api-version=2022-08-01


{
  "properties": {
    "displayName": "api set 1",
    "versioningScheme": "Segment",
    "description": "Version configuration"
  }
}

Sample Response

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apiVersionSets/vs1",
  "type": "Microsoft.ApiManagement/service/api-version-sets",
  "name": "vs1",
  "properties": {
    "displayName": "api set 1",
    "versioningScheme": "Segment",
    "description": "Version configuration"
  }
}

Definizioni

Nome Descrizione
ApiVersionSetContract

Dettagli del contratto del set di versioni dell'API.

ApiVersionSetUpdateParameters

Parametri da aggiornare o creare un contratto del set di versioni dell'API.

ErrorFieldContract

Contratto campo errore.

ErrorResponse

Risposta errore.

versioningScheme

Valore che determina dove si trova l'identificatore della versione API in una richiesta HTTP.

ApiVersionSetContract

Dettagli del contratto del set di versioni dell'API.

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 set di versioni dell'API.

properties.displayName

string

Nome del set di versioni dell'API

properties.versionHeaderName

string

Nome del parametro di intestazione HTTP che indica la versione DELL'API se il controllo delle versioniScheme è impostato su header.

properties.versionQueryName

string

Nome del parametro di query che indica la versione DELL'API se il controllo delle versioniScheme è impostato su query.

properties.versioningScheme

versioningScheme

Valore che determina dove si trova l'identificatore della versione API in una richiesta HTTP.

type

string

Tipo di risorsa. Ad esempio, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

ApiVersionSetUpdateParameters

Parametri da aggiornare o creare un contratto del set di versioni dell'API.

Nome Tipo Descrizione
properties.description

string

Descrizione del set di versioni dell'API.

properties.displayName

string

Nome del set di versioni dell'API

properties.versionHeaderName

string

Nome del parametro di intestazione HTTP che indica la versione DELL'API se il controllo delle versioniScheme è impostato su header.

properties.versionQueryName

string

Nome del parametro di query che indica la versione DELL'API se il controllo delle versioniScheme è impostato su query.

properties.versioningScheme

versioningScheme

Valore che determina dove si trova l'identificatore della versione API in una richiesta HTTP.

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

ErrorFieldContract[]

Elenco di campi non validi inviati nella richiesta, in caso di errore di convalida.

error.message

string

Rappresentazione leggibile dell'errore.

versioningScheme

Valore che determina dove si trova l'identificatore della versione API in una richiesta HTTP.

Nome Tipo Descrizione
Header

string

La versione dell'API viene passata in un'intestazione HTTP.

Query

string

La versione dell'API viene passata in un parametro di query.

Segment

string

La versione dell'API viene passata in un segmento di percorso.