Api Version Set - Create Or Update

Služba:

API Management

Verze rozhraní API:

2024-05-01

Vytvoří nebo aktualizuje sadu verzí rozhraní API.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Název skupiny prostředků. Název nerozlišuje malá a velká písmena.
serviceName	path	True	string minLength: 1 maxLength: 50 pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$	Název služby API Management.
subscriptionId	path	True	string (uuid)	ID cílového předplatného. Hodnota musí být UUID.
versionSetId	path	True	string minLength: 1 maxLength: 80 pattern: ^[^*#&+:<>?]+$	Identifikátor sady verzí rozhraní API. V aktuální instanci služby API Management musí být jedinečné.
api-version	query	True	string minLength: 1	Verze rozhraní API, která se má použít pro tuto operaci.

Hlavička požadavku

Name	Vyžadováno	Typ	Description
If-Match		string	ETag of the Entity. Při vytváření entity se nevyžaduje, ale vyžaduje se při aktualizaci entity.

Text požadavku

Name	Vyžadováno	Typ	Description
properties.displayName	True	string minLength: 1 maxLength: 100	Název sady verzí rozhraní API
properties.versioningScheme	True	versioningScheme	Hodnota, která určuje, kde se bude identifikátor verze rozhraní API nacházet v požadavku HTTP.
properties.description		string	Popis sady verzí rozhraní API
properties.versionHeaderName		string minLength: 1 maxLength: 100	Název parametru hlavičky HTTP, který označuje verzi rozhraní API, pokud je vlastnost versioningScheme nastavená na header.
properties.versionQueryName		string minLength: 1 maxLength: 100	Název parametru dotazu, který označuje verzi rozhraní API, pokud je správa verzí nastavena na query.

Odpovědi

Name	Typ	Description
200 OK	ApiVersionSetContract	Sada verzí rozhraní API byla úspěšně aktualizována. Hlavičky ETag: string
201 Created	ApiVersionSetContract	Sada verzí rozhraní API byla úspěšně vytvořena. Hlavičky ETag: string
Other Status Codes	ErrorResponse	Chybová odpověď popisující, proč operace selhala.

Zabezpečení

azure_auth

Tok OAuth2 v Azure Active Directory

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize

Rozsahy

Name	Description
user_impersonation	zosobnění uživatelského účtu

Příklady

ApiManagementCreateApiVersionSet

Ukázkový požadavek

HTTP

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

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

Ukázková odpověď

Stavový kód:

200

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

Stavový kód:

201

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

Definice

Name	Description
ApiVersionSetContract	Podrobnosti kontraktu sady verzí rozhraní API
ErrorAdditionalInfo	Další informace o chybě správy prostředků
ErrorDetail	Podrobnosti o chybě.
ErrorResponse	Chybová odpověď
versioningScheme	Hodnota, která určuje, kde se bude identifikátor verze rozhraní API nacházet v požadavku HTTP.

ApiVersionSetContract

Objekt

Podrobnosti kontraktu sady verzí rozhraní API

Name	Typ	Description
id	string	Plně kvalifikované ID prostředku pro prostředek. Příklad : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Název prostředku
properties.description	string	Popis sady verzí rozhraní API
properties.displayName	string minLength: 1 maxLength: 100	Název sady verzí rozhraní API
properties.versionHeaderName	string minLength: 1 maxLength: 100	Název parametru hlavičky HTTP, který označuje verzi rozhraní API, pokud je vlastnost versioningScheme nastavená na header.
properties.versionQueryName	string minLength: 1 maxLength: 100	Název parametru dotazu, který označuje verzi rozhraní API, pokud je správa verzí nastavena na query.
properties.versioningScheme	versioningScheme	Hodnota, která určuje, kde se bude identifikátor verze rozhraní API nacházet v požadavku HTTP.
type	string	Typ prostředku. Například Microsoft.Compute/virtualMachines nebo Microsoft.Storage/storageAccounts

ErrorAdditionalInfo

Objekt

Další informace o chybě správy prostředků

Name	Typ	Description
info	object	Další informace.
type	string	Další typ informací.

ErrorDetail

Objekt

Podrobnosti o chybě.

Name	Typ	Description
additionalInfo	ErrorAdditionalInfo[]	Další informace o chybě.
code	string	Kód chyby.
details	ErrorDetail[]	Podrobnosti o chybě.
message	string	Chybová zpráva.
target	string	Cíl chyby.

ErrorResponse

Objekt

Chybová odpověď

Name	Typ	Description
error	ErrorDetail	Objekt chyby.

versioningScheme

Výčet

Hodnota, která určuje, kde se bude identifikátor verze rozhraní API nacházet v požadavku HTTP.

Hodnota	Description
Header	Verze rozhraní API se předává v hlavičce HTTP.
Query	Verze rozhraní API se předává v parametru dotazu.
Segment	Verze rozhraní API se předává v segmentu cesty.