Api Version Set - Update

Tjänst:

API Management

API-version:

2024-05-01

Uppdaterar informationen om API VersionSet som anges av dess identifierare.

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Namnet på resursgruppen. Namnet är skiftlägesokänsligt.
serviceName	path	True	string minLength: 1 maxLength: 50 pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$	Namnet på API Management-tjänsten.
subscriptionId	path	True	string (uuid)	ID för målprenumerationen. Värdet måste vara ett UUID.
versionSetId	path	True	string minLength: 1 maxLength: 80 pattern: ^[^*#&+:<>?]+$	Api-versionsuppsättningsidentifierare. Måste vara unikt i den aktuella API Management-tjänstinstansen.
api-version	query	True	string minLength: 1	DEN API-version som ska användas för den här åtgärden.

Begärandehuvud

Name	Obligatorisk	Typ	Description
If-Match	True	string	ETag för entiteten. ETag ska matcha det aktuella entitetstillståndet från huvudsvaret för GET-begäran, eller så bör det vara * för ovillkorlig uppdatering.

Begärandetext

Name	Typ	Description
properties.description	string	Beskrivning av API-versionsuppsättning.
properties.displayName	string minLength: 1 maxLength: 100	Namn på API-versionsuppsättning
properties.versionHeaderName	string minLength: 1 maxLength: 100	Namnet på HTTP-huvudparametern som anger API-versionen om versionshanteringScheme är inställt på header.
properties.versionQueryName	string minLength: 1 maxLength: 100	Namnet på frågeparametern som anger API-versionen om versionshanteringScheme är inställt på query.
properties.versioningScheme	versioningScheme	Ett värde som avgör var API-versionsidentifieraren ska finnas i en HTTP-begäran.

Svar

Name	Typ	Description
200 OK	ApiVersionSetContract	Api-versionsuppsättningen har uppdaterats. Sidhuvuden ETag: string
Other Status Codes	ErrorResponse	Felsvar som beskriver varför åtgärden misslyckades.

Säkerhet

azure_auth

Azure Active Directory OAuth2 Flow.

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize

Omfattningar

Name	Description
user_impersonation	personifiera ditt användarkonto

Exempel

ApiManagementUpdateApiVersionSet

Exempelbegäran

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"
  }
}

Exempelsvar

Statuskod:

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"
  }
}

Definitioner

Name	Description
ApiVersionSetContract	Information om API-versionsuppsättningskontrakt.
ApiVersionSetUpdateParameters	Parametrar för att uppdatera eller skapa ett API-versionsuppsättningskontrakt.
ErrorAdditionalInfo	Ytterligare information om resurshanteringsfelet.
ErrorDetail	Felinformationen.
ErrorResponse	Felsvar
versioningScheme	Ett värde som avgör var API-versionsidentifieraren ska finnas i en HTTP-begäran.

ApiVersionSetContract

Objekt

Information om API-versionsuppsättningskontrakt.

Name	Typ	Description
id	string	Fullständigt kvalificerat resurs-ID för resursen. Ex – /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Namnet på resursen
properties.description	string	Beskrivning av API-versionsuppsättning.
properties.displayName	string minLength: 1 maxLength: 100	Namn på API-versionsuppsättning
properties.versionHeaderName	string minLength: 1 maxLength: 100	Namnet på HTTP-huvudparametern som anger API-versionen om versionshanteringScheme är inställt på header.
properties.versionQueryName	string minLength: 1 maxLength: 100	Namnet på frågeparametern som anger API-versionen om versionshanteringScheme är inställt på query.
properties.versioningScheme	versioningScheme	Ett värde som avgör var API-versionsidentifieraren ska finnas i en HTTP-begäran.
type	string	Resurstypen. Till exempel "Microsoft.Compute/virtualMachines" eller "Microsoft.Storage/storageAccounts"

ApiVersionSetUpdateParameters

Objekt

Parametrar för att uppdatera eller skapa ett API-versionsuppsättningskontrakt.

Name	Typ	Description
properties.description	string	Beskrivning av API-versionsuppsättning.
properties.displayName	string minLength: 1 maxLength: 100	Namn på API-versionsuppsättning
properties.versionHeaderName	string minLength: 1 maxLength: 100	Namnet på HTTP-huvudparametern som anger API-versionen om versionshanteringScheme är inställt på header.
properties.versionQueryName	string minLength: 1 maxLength: 100	Namnet på frågeparametern som anger API-versionen om versionshanteringScheme är inställt på query.
properties.versioningScheme	versioningScheme	Ett värde som avgör var API-versionsidentifieraren ska finnas i en HTTP-begäran.

ErrorAdditionalInfo

Objekt

Ytterligare information om resurshanteringsfelet.

Name	Typ	Description
info	object	Ytterligare information.
type	string	Ytterligare informationstyp.

ErrorDetail

Objekt

Felinformationen.

Name	Typ	Description
additionalInfo	ErrorAdditionalInfo[]	Ytterligare information om felet.
code	string	Felkoden.
details	ErrorDetail[]	Felinformationen.
message	string	Felmeddelandet.
target	string	Felmålet.

ErrorResponse

Objekt

Felsvar

Name	Typ	Description
error	ErrorDetail	Felobjektet.

versioningScheme

Uppräkning

Ett värde som avgör var API-versionsidentifieraren ska finnas i en HTTP-begäran.

Värde	Description
Header	API-versionen skickas i ett HTTP-huvud.
Query	API-versionen skickas i en frågeparameter.
Segment	API-versionen skickas i ett sökvägssegment.