Api Version Set - Update

Dienst:

API Management

API-Version:

2024-05-01

Aktualisiert die Details des durch den Bezeichner angegebenen API-Versionssets.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Der Name der Ressourcengruppe. Bei dem Namen wird die Groß-/Kleinschreibung nicht beachtet.
serviceName	path	True	string minLength: 1 maxLength: 50 pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$	Der Name des API-Verwaltungsdiensts.
subscriptionId	path	True	string (uuid)	Die ID des Zielabonnements. Der Wert muss eine UUID sein.
versionSetId	path	True	string minLength: 1 maxLength: 80 pattern: ^[^*#&+:<>?]+$	API-Versionssatzbezeichner. Muss in der aktuellen API-Verwaltungsdienstinstanz eindeutig sein.
api-version	query	True	string minLength: 1	Die API-Version, die für diesen Vorgang verwendet werden soll.

Anforderungsheader

Name	Erforderlich	Typ	Beschreibung
If-Match	True	string	ETag der Entität. ETag sollte mit dem aktuellen Entitätsstatus aus der Headerantwort der GET-Anforderung übereinstimmen, oder es sollte * für bedingungslose Aktualisierung sein.

Anforderungstext

Name	Typ	Beschreibung
properties.description	string	Beschreibung des API-Versionssatzes.
properties.displayName	string minLength: 1 maxLength: 100	Name des API-Versionssatzes
properties.versionHeaderName	string minLength: 1 maxLength: 100	Name des HTTP-Headerparameters, der die API-Version angibt, wenn versioningScheme auf headerfestgelegt ist.
properties.versionQueryName	string minLength: 1 maxLength: 100	Name des Abfrageparameters, der die API-Version angibt, wenn versioningScheme auf queryfestgelegt ist.
properties.versioningScheme	versioningScheme	Ein Wert, der bestimmt, wo sich der API-Versionsbezeichner in einer HTTP-Anforderung befindet.

Antworten

Name	Typ	Beschreibung
200 OK	ApiVersionSetContract	Api-Versionssatz wurde erfolgreich aktualisiert. Header ETag: string
Other Status Codes	ErrorResponse	Fehlerantwort, die beschreibt, warum der Vorgang fehlgeschlagen ist.

Sicherheit

azure_auth

Azure Active Directory OAuth2-Fluss.

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel ihres Benutzerkontos

Beispiele

ApiManagementUpdateApiVersionSet

Beispielanforderung

HTTP

PATCH https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apiVersionSets/vs1?api-version=2024-05-01


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

Beispiel für eine Antwort

Statuscode:

200

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/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"
  }
}

Definitionen

Name	Beschreibung
ApiVersionSetContract	Details zum API-Versionssatz-Vertrag.
ApiVersionSetUpdateParameters	Parameter zum Aktualisieren oder Erstellen eines API-Versionssatzvertrags.
ErrorAdditionalInfo	Der Ressourcenverwaltungsfehler zusätzliche Informationen.
ErrorDetail	Das Fehlerdetails.
ErrorResponse	Fehlerantwort
versioningScheme	Ein Wert, der bestimmt, wo sich der API-Versionsbezeichner in einer HTTP-Anforderung befindet.

ApiVersionSetContract

Objekt

Details zum API-Versionssatz-Vertrag.

Name	Typ	Beschreibung
id	string	Vollqualifizierte Ressourcen-ID für die Ressource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Der Name der Ressource
properties.description	string	Beschreibung des API-Versionssatzes.
properties.displayName	string minLength: 1 maxLength: 100	Name des API-Versionssatzes
properties.versionHeaderName	string minLength: 1 maxLength: 100	Name des HTTP-Headerparameters, der die API-Version angibt, wenn versioningScheme auf headerfestgelegt ist.
properties.versionQueryName	string minLength: 1 maxLength: 100	Name des Abfrageparameters, der die API-Version angibt, wenn versioningScheme auf queryfestgelegt ist.
properties.versioningScheme	versioningScheme	Ein Wert, der bestimmt, wo sich der API-Versionsbezeichner in einer HTTP-Anforderung befindet.
type	string	Der Typ der Ressource. Z. B. "Microsoft.Compute/virtualMachines" oder "Microsoft.Storage/storageAccounts"

ApiVersionSetUpdateParameters

Objekt

Parameter zum Aktualisieren oder Erstellen eines API-Versionssatzvertrags.

Name	Typ	Beschreibung
properties.description	string	Beschreibung des API-Versionssatzes.
properties.displayName	string minLength: 1 maxLength: 100	Name des API-Versionssatzes
properties.versionHeaderName	string minLength: 1 maxLength: 100	Name des HTTP-Headerparameters, der die API-Version angibt, wenn versioningScheme auf headerfestgelegt ist.
properties.versionQueryName	string minLength: 1 maxLength: 100	Name des Abfrageparameters, der die API-Version angibt, wenn versioningScheme auf queryfestgelegt ist.
properties.versioningScheme	versioningScheme	Ein Wert, der bestimmt, wo sich der API-Versionsbezeichner in einer HTTP-Anforderung befindet.

ErrorAdditionalInfo

Objekt

Der Ressourcenverwaltungsfehler zusätzliche Informationen.

Name	Typ	Beschreibung
info	object	Die zusätzlichen Informationen.
type	string	Der zusätzliche Informationstyp.

ErrorDetail

Objekt

Das Fehlerdetails.

Name	Typ	Beschreibung
additionalInfo	ErrorAdditionalInfo[]	Die zusätzlichen Informationen des Fehlers.
code	string	Der Fehlercode.
details	ErrorDetail[]	Die Fehlerdetails.
message	string	Die Fehlermeldung.
target	string	Das Fehlerziel.

ErrorResponse

Objekt

Fehlerantwort

Name	Typ	Beschreibung
error	ErrorDetail	Das Fehlerobjekt.

versioningScheme

Enumeration

Ein Wert, der bestimmt, wo sich der API-Versionsbezeichner in einer HTTP-Anforderung befindet.

Wert	Beschreibung
Header	Die API-Version wird in einem HTTP-Header übergeben.
Query	Die API-Version wird in einem Abfrageparameter übergeben.
Segment	Die API-Version wird in einem Pfadsegment übergeben.