Workspace Api - Update

Služba:: API Management

Verze rozhraní API:: 2024-05-01

Aktualizuje zadané rozhraní API pracovního prostoru v instanci služby API Management.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
apiId	path	True	string minLength: 1 maxLength: 256 pattern: ^[^*#&+:<>?]+$	Identifikátor revize rozhraní API. V aktuální instanci služby API Management musí být jedinečné. Revize, která není aktuální, má ; rev=n jako přípona, kde n je číslo revize.
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.
workspaceId	path	True	string minLength: 1 maxLength: 80 pattern: ^[^*#&+:<>?]+$	Identifikátor pracovního prostoru 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	True	string	ETag of the Entity. Značka ETag by měla odpovídat aktuálnímu stavu entity z odpovědi hlavičky požadavku GET, nebo by měla být * pro nepodmíněnou aktualizaci.

Text požadavku

Name	Typ	Description
properties.apiRevision	string minLength: 1 maxLength: 100	Popisuje revizi rozhraní API. Pokud není zadána žádná hodnota, vytvoří se výchozí revize 1.
properties.apiRevisionDescription	string maxLength: 256	Popis revize rozhraní API
properties.apiVersion	string maxLength: 100	Označuje identifikátor verze rozhraní API, pokud je rozhraní API s verzí.
properties.apiVersionDescription	string maxLength: 256	Popis verze rozhraní API
properties.apiVersionSetId	string	Identifikátor prostředku pro související sadu ApiVersionSet.
properties.authenticationSettings	AuthenticationSettingsContract	Kolekce nastavení ověřování, která jsou součástí tohoto rozhraní API.
properties.contact	ApiContactInformation	Kontaktní informace pro rozhraní API
properties.description	string	Popis rozhraní API Může obsahovat značky formátování HTML.
properties.displayName	string minLength: 1 maxLength: 300	Název rozhraní API
properties.isCurrent	boolean	Označuje, jestli je revize rozhraní API aktuální revizí rozhraní API.
properties.license	ApiLicenseInformation	Informace o licenci pro rozhraní API
properties.path	string minLength: 0 maxLength: 400	Relativní adresa URL jednoznačně identifikuje toto rozhraní API a všechny jeho cesty k prostředkům v rámci instance služby API Management. Připojí se k základní adrese URL koncového bodu rozhraní API zadané během vytváření instance služby a vytvoří veřejnou adresu URL pro toto rozhraní API.
properties.protocols	Protocol[]	Popisuje, na kterých protokolech lze vyvolat operace v tomto rozhraní API.
properties.serviceUrl	string minLength: 1 maxLength: 2000	Absolutní adresa URL back-endové služby, která toto rozhraní API implementuje.
properties.subscriptionKeyParameterNames	SubscriptionKeyParameterNamesContract	Protokoly, u kterých je rozhraní API dostupné.
properties.subscriptionRequired	boolean	Určuje, jestli se pro přístup k rozhraní API vyžaduje předplatné rozhraní API nebo produktu.
properties.termsOfServiceUrl	string	Adresa URL podmínek služby pro rozhraní API. Musí být ve formátu adresy URL.
properties.type	ApiType	Typ rozhraní API

Odpovědi

Name	Typ	Description
200 OK	ApiContract	Rozhraní API bylo úspěšně aktualizováno. Hlavičky ETag: string
Other Status Codes	ErrorResponse	Chybová odpověď popisující, proč operace selhala.

Name

Typ

Description

200 OK

ApiContract

Rozhraní API bylo úspěšně aktualizováno.

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

ApiManagementUpdateWorkspaceApi

Ukázkový požadavek

HTTP

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


{
  "properties": {
    "displayName": "Echo API New",
    "serviceUrl": "http://echoapi.cloudapp.net/api2",
    "path": "newecho"
  }
}

Ukázková odpověď

Stavový kód:: 200

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/echo-api",
  "type": "Microsoft.ApiManagement/service/workspaces/pis",
  "name": "echo-api",
  "properties": {
    "displayName": "Echo API New",
    "apiRevision": "1",
    "serviceUrl": "http://echoapi.cloudapp.net/api2",
    "path": "newecho",
    "protocols": [
      "https"
    ],
    "subscriptionKeyParameterNames": {
      "header": "Ocp-Apim-Subscription-Key",
      "query": "subscription-key"
    },
    "isCurrent": true,
    "isOnline": true
  }
}

Definice

Name	Description
ApiContactInformation	Kontaktní informace rozhraní API
ApiContract	Podrobnosti rozhraní API
ApiLicenseInformation	Informace o licencích rozhraní API
ApiType	Typ rozhraní API
ApiUpdateContract	Podrobnosti kontraktu aktualizace rozhraní API
ApiVersionSetContractDetails	Sada verzí rozhraní API obsahuje společnou konfiguraci pro sadu verzí rozhraní API souvisejících
AuthenticationSettingsContract	Nastavení ověřování rozhraní API
bearerTokenSendingMethods	Postup odeslání tokenu na server
ErrorAdditionalInfo	Další informace o chybě správy prostředků
ErrorDetail	Podrobnosti o chybě.
ErrorResponse	Chybová odpověď
OAuth2AuthenticationSettingsContract	Podrobnosti o nastavení ověřování OAuth2 rozhraní API
OpenIdAuthenticationSettingsContract	Podrobnosti o nastavení ověřování OAuth2 rozhraní API
Protocol	Popisuje, na kterých protokolech lze vyvolat operace v tomto rozhraní API.
SubscriptionKeyParameterNamesContract	Podrobnosti o názvech parametrů klíče předplatného
versioningScheme	Hodnota, která určuje, kde se bude identifikátor verze rozhraní API nacházet v požadavku HTTP.

ApiContactInformation

Objekt

Kontaktní informace rozhraní API

Name	Typ	Description
email	string	E-mailová adresa kontaktní osoby nebo organizace Musí být ve formátu e-mailové adresy.
name	string	Identifikační jméno kontaktní osoby nebo organizace
url	string	Adresa URL odkazující na kontaktní údaje. Musí být ve formátu adresy URL.

ApiContract

Objekt

Podrobnosti 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.apiRevision	string minLength: 1 maxLength: 100	Popisuje revizi rozhraní API. Pokud není zadána žádná hodnota, vytvoří se výchozí revize 1.
properties.apiRevisionDescription	string maxLength: 256	Popis revize rozhraní API
properties.apiVersion	string maxLength: 100	Označuje identifikátor verze rozhraní API, pokud je rozhraní API s verzí.
properties.apiVersionDescription	string maxLength: 256	Popis verze rozhraní API
properties.apiVersionSet	ApiVersionSetContractDetails	Podrobnosti o sadě verzí
properties.apiVersionSetId	string	Identifikátor prostředku pro související sadu ApiVersionSet.
properties.authenticationSettings	AuthenticationSettingsContract	Kolekce nastavení ověřování, která jsou součástí tohoto rozhraní API.
properties.contact	ApiContactInformation	Kontaktní informace pro rozhraní API
properties.description	string	Popis rozhraní API Může obsahovat značky formátování HTML.
properties.displayName	string minLength: 1 maxLength: 300	Název rozhraní API Musí mít délku 1 až 300 znaků.
properties.isCurrent	boolean	Označuje, jestli je revize rozhraní API aktuální revizí rozhraní API.
properties.isOnline	boolean	Označuje, jestli je revize rozhraní API přístupná přes bránu.
properties.license	ApiLicenseInformation	Informace o licenci pro rozhraní API
properties.path	string minLength: 0 maxLength: 400	Relativní adresa URL jednoznačně identifikuje toto rozhraní API a všechny jeho cesty k prostředkům v rámci instance služby API Management. Připojí se k základní adrese URL koncového bodu rozhraní API zadané během vytváření instance služby a vytvoří veřejnou adresu URL pro toto rozhraní API.
properties.protocols	Protocol[]	Popisuje, na kterých protokolech lze vyvolat operace v tomto rozhraní API.
properties.provisioningState	string	Stav zřizování
properties.serviceUrl	string minLength: 0 maxLength: 2000	Absolutní adresa URL back-endové služby, která toto rozhraní API implementuje. Nesmí být delší než 2 000 znaků.
properties.sourceApiId	string	Identifikátor rozhraní API zdrojového rozhraní API.
properties.subscriptionKeyParameterNames	SubscriptionKeyParameterNamesContract	Protokoly, u kterých je rozhraní API dostupné.
properties.subscriptionRequired	boolean	Určuje, jestli se pro přístup k rozhraní API vyžaduje předplatné rozhraní API nebo produktu.
properties.termsOfServiceUrl	string	Adresa URL podmínek služby pro rozhraní API. Musí být ve formátu adresy URL.
properties.type	ApiType	Typ rozhraní API
type	string	Typ prostředku. Například Microsoft.Compute/virtualMachines nebo Microsoft.Storage/storageAccounts

ApiLicenseInformation

Objekt

Informace o licencích rozhraní API

Name	Typ	Description
name	string	Název licence použitý pro rozhraní API
url	string	Adresa URL licence použité pro rozhraní API. Musí být ve formátu adresy URL.

ApiType

Výčet

Typ rozhraní API

Hodnota	Description
http
soap
websocket
graphql
odata
grpc

ApiUpdateContract

Objekt

Podrobnosti kontraktu aktualizace rozhraní API

Name	Typ	Description
properties.apiRevision	string minLength: 1 maxLength: 100	Popisuje revizi rozhraní API. Pokud není zadána žádná hodnota, vytvoří se výchozí revize 1.
properties.apiRevisionDescription	string maxLength: 256	Popis revize rozhraní API
properties.apiVersion	string maxLength: 100	Označuje identifikátor verze rozhraní API, pokud je rozhraní API s verzí.
properties.apiVersionDescription	string maxLength: 256	Popis verze rozhraní API
properties.apiVersionSetId	string	Identifikátor prostředku pro související sadu ApiVersionSet.
properties.authenticationSettings	AuthenticationSettingsContract	Kolekce nastavení ověřování, která jsou součástí tohoto rozhraní API.
properties.contact	ApiContactInformation	Kontaktní informace pro rozhraní API
properties.description	string	Popis rozhraní API Může obsahovat značky formátování HTML.
properties.displayName	string minLength: 1 maxLength: 300	Název rozhraní API
properties.isCurrent	boolean	Označuje, jestli je revize rozhraní API aktuální revizí rozhraní API.
properties.isOnline	boolean	Označuje, jestli je revize rozhraní API přístupná přes bránu.
properties.license	ApiLicenseInformation	Informace o licenci pro rozhraní API
properties.path	string minLength: 0 maxLength: 400	Relativní adresa URL jednoznačně identifikuje toto rozhraní API a všechny jeho cesty k prostředkům v rámci instance služby API Management. Připojí se k základní adrese URL koncového bodu rozhraní API zadané během vytváření instance služby a vytvoří veřejnou adresu URL pro toto rozhraní API.
properties.protocols	Protocol[]	Popisuje, na kterých protokolech lze vyvolat operace v tomto rozhraní API.
properties.serviceUrl	string minLength: 1 maxLength: 2000	Absolutní adresa URL back-endové služby, která toto rozhraní API implementuje.
properties.subscriptionKeyParameterNames	SubscriptionKeyParameterNamesContract	Protokoly, u kterých je rozhraní API dostupné.
properties.subscriptionRequired	boolean	Určuje, jestli se pro přístup k rozhraní API vyžaduje předplatné rozhraní API nebo produktu.
properties.termsOfServiceUrl	string	Adresa URL podmínek služby pro rozhraní API. Musí být ve formátu adresy URL.
properties.type	ApiType	Typ rozhraní API

ApiVersionSetContractDetails

Objekt

Sada verzí rozhraní API obsahuje společnou konfiguraci pro sadu verzí rozhraní API souvisejících

Name	Typ	Description
description	string	Popis sady verzí rozhraní API
id	string	Identifikátor existující sady verzí rozhraní API Tuto hodnotu vynecháte, pokud chcete vytvořit novou sadu verzí.
name	string	Zobrazovaný název sady verzí rozhraní API
versionHeaderName	string	Název parametru hlavičky HTTP, který označuje verzi rozhraní API, pokud je vlastnost versioningScheme nastavená na `header`.
versionQueryName	string	Název parametru dotazu, který označuje verzi rozhraní API, pokud je správa verzí nastavena na `query`.
versioningScheme	versioningScheme	Hodnota, která určuje, kde se bude identifikátor verze rozhraní API nacházet v požadavku HTTP.

AuthenticationSettingsContract

Objekt

Nastavení ověřování rozhraní API

Name	Typ	Description
oAuth2	OAuth2AuthenticationSettingsContract	Nastavení ověřování OAuth2
oAuth2AuthenticationSettings	OAuth2AuthenticationSettingsContract[]	Kolekce nastavení ověřování OAuth2, která jsou součástí tohoto rozhraní API.
openid	OpenIdAuthenticationSettingsContract	Nastavení ověřování OpenID Connect
openidAuthenticationSettings	OpenIdAuthenticationSettingsContract[]	Kolekce nastavení ověřování Open ID Connect, která jsou součástí tohoto rozhraní API.

bearerTokenSendingMethods

Výčet

Postup odeslání tokenu na server

Hodnota	Description
authorizationHeader	Přístupový token se bude přenášet v autorizační hlavičce pomocí nosného schématu.
query	Přístupový token se přenese jako parametry dotazu.

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.

OAuth2AuthenticationSettingsContract

Objekt

Podrobnosti o nastavení ověřování OAuth2 rozhraní API

Name	Typ	Description
authorizationServerId	string	Identifikátor autorizačního serveru OAuth.
scope	string	rozsah operací.

OpenIdAuthenticationSettingsContract

Objekt

Podrobnosti o nastavení ověřování OAuth2 rozhraní API

Name	Typ	Description
bearerTokenSendingMethods	bearerTokenSendingMethods[]	Postup odeslání tokenu na server
openidProviderId	string	Identifikátor autorizačního serveru OAuth.

Protocol

Výčet

Popisuje, na kterých protokolech lze vyvolat operace v tomto rozhraní API.

Hodnota	Description
http
https
ws
wss

SubscriptionKeyParameterNamesContract

Objekt

Podrobnosti o názvech parametrů klíče předplatného

Name	Typ	Description
header	string	Název hlavičky klíče předplatného
query	string	Název parametru řetězce dotazu klíče předplatného

versioningScheme

Výčet

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

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

Sdílet prostřednictvím

Workspace Api - Update

Parametry identifikátoru URI

Hlavička požadavku

Text požadavku

Odpovědi

Zabezpečení

azure_auth

Rozsahy

Příklady

ApiManagementUpdateWorkspaceApi

Ukázkový požadavek

Ukázková odpověď

Definice

ApiContactInformation

ApiContract

ApiLicenseInformation

ApiType

ApiUpdateContract

ApiVersionSetContractDetails

AuthenticationSettingsContract

bearerTokenSendingMethods

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

OAuth2AuthenticationSettingsContract

OpenIdAuthenticationSettingsContract

Protocol

SubscriptionKeyParameterNamesContract

versioningScheme