Workspace Api - Update

Usługa:: API Management

Wersja interfejsu API:: 2024-05-01

Aktualizuje określony interfejs API obszaru roboczego w wystąpieniu usługi 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 identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
apiId	path	True	string minLength: 1 maxLength: 256 pattern: ^[^*#&+:<>?]+$	Identyfikator poprawki interfejsu API. Musi być unikatowa w bieżącym wystąpieniu usługi API Management. Nieobsługiwana poprawka ma wartość ; rev=n jako sufiks, gdzie n jest numerem poprawki.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.
serviceName	path	True	string minLength: 1 maxLength: 50 pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$	Nazwa usługi API Management.
subscriptionId	path	True	string (uuid)	Identyfikator subskrypcji docelowej. Wartość musi być identyfikatorem UUID.
workspaceId	path	True	string minLength: 1 maxLength: 80 pattern: ^[^*#&+:<>?]+$	Identyfikator obszaru roboczego. Musi być unikatowa w bieżącym wystąpieniu usługi API Management.
api-version	query	True	string minLength: 1	Wersja interfejsu API do użycia dla tej operacji.

Nagłówek żądania

Nazwa	Wymagane	Typ	Opis
If-Match	True	string	Element ETag jednostki. Element ETag powinien być zgodny z bieżącym stanem jednostki z odpowiedzi nagłówka żądania GET lub powinien być * dla bezwarunkowej aktualizacji.

Treść żądania

Nazwa	Typ	Opis
properties.apiRevision	string minLength: 1 maxLength: 100	Opisuje poprawkę interfejsu API. Jeśli nie podano żadnej wartości, zostanie utworzona domyślna wersja 1
properties.apiRevisionDescription	string maxLength: 256	Opis poprawki interfejsu API.
properties.apiVersion	string maxLength: 100	Wskazuje identyfikator wersji interfejsu API, jeśli interfejs API jest w wersji
properties.apiVersionDescription	string maxLength: 256	Opis wersji interfejsu API.
properties.apiVersionSetId	string	Identyfikator zasobu powiązanego elementu ApiVersionSet.
properties.authenticationSettings	AuthenticationSettingsContract	Kolekcja ustawień uwierzytelniania uwzględnionych w tym interfejsie API.
properties.contact	ApiContactInformation	Informacje kontaktowe dotyczące interfejsu API.
properties.description	string	Opis interfejsu API. Może zawierać tagi formatowania HTML.
properties.displayName	string minLength: 1 maxLength: 300	Nazwa interfejsu API.
properties.isCurrent	boolean	Wskazuje, czy poprawka interfejsu API jest bieżącą poprawką interfejsu API.
properties.license	ApiLicenseInformation	Informacje o licencji dla interfejsu API.
properties.path	string minLength: 0 maxLength: 400	Względny adres URL jednoznacznie identyfikujący ten interfejs API i wszystkie jego ścieżki zasobów w wystąpieniu usługi API Management. Jest on dołączany do podstawowego adresu URL punktu końcowego interfejsu API określonego podczas tworzenia wystąpienia usługi w celu utworzenia publicznego adresu URL tego interfejsu API.
properties.protocols	Protocol[]	Opisuje, które protokoły mogą być wywoływane operacje w tym interfejsie API.
properties.serviceUrl	string minLength: 1 maxLength: 2000	Bezwzględny adres URL usługi zaplecza implementowania tego interfejsu API.
properties.subscriptionKeyParameterNames	SubscriptionKeyParameterNamesContract	Protokoły, za pośrednictwem których udostępniono interfejs API.
properties.subscriptionRequired	boolean	Określa, czy do uzyskiwania dostępu do interfejsu API jest wymagana subskrypcja interfejsu API lub produktu.
properties.termsOfServiceUrl	string	Adres URL warunków użytkowania usługi dla interfejsu API. MUSI być w formacie adresu URL.
properties.type	ApiType	Typ interfejsu API.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	ApiContract	Interfejs API został pomyślnie zaktualizowany. Nagłówki ETag: string
Other Status Codes	ErrorResponse	Odpowiedź na błąd opisująca, dlaczego operacja nie powiodła się.

Nazwa

Typ

Opis

200 OK

ApiContract

Interfejs API został pomyślnie zaktualizowany.

Nagłówki

ETag: string

Other Status Codes

ErrorResponse

Odpowiedź na błąd opisująca, dlaczego operacja nie powiodła się.

Zabezpieczenia

azure_auth

Przepływ protokołu OAuth2 usługi Azure Active Directory.

Typ: oauth2
Flow: implicit
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize

Zakresy

Nazwa	Opis
user_impersonation	personifikacja konta użytkownika

Przykłady

ApiManagementUpdateWorkspaceApi

Przykładowe żądanie

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

Przykładowa odpowiedź

Kod stanu:: 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
  }
}

Definicje

Nazwa	Opis
ApiContactInformation	Informacje kontaktowe interfejsu API
ApiContract	Szczegóły interfejsu API.
ApiLicenseInformation	Informacje o licencji interfejsu API
ApiType	Typ interfejsu API.
ApiUpdateContract	Szczegóły kontraktu aktualizacji interfejsu API.
ApiVersionSetContractDetails	Zestaw wersji interfejsu API zawiera wspólną konfigurację zestawu wersji interfejsu API dotyczących
AuthenticationSettingsContract	Ustawienia uwierzytelniania interfejsu API.
bearerTokenSendingMethods	Jak wysłać token do serwera.
ErrorAdditionalInfo	Dodatkowe informacje o błędzie zarządzania zasobami.
ErrorDetail	Szczegóły błędu.
ErrorResponse	Odpowiedź na błąd
OAuth2AuthenticationSettingsContract	Szczegóły ustawień uwierzytelniania OAuth2 interfejsu API.
OpenIdAuthenticationSettingsContract	Szczegóły ustawień uwierzytelniania OAuth2 interfejsu API.
Protocol	Opisuje, które protokoły mogą być wywoływane operacje w tym interfejsie API.
SubscriptionKeyParameterNamesContract	Szczegóły nazw parametrów klucza subskrypcji.
versioningScheme	Wartość określająca, gdzie identyfikator wersji interfejsu API będzie znajdować się w żądaniu HTTP.

ApiContactInformation

Objekt

Informacje kontaktowe interfejsu API

Nazwa	Typ	Opis
email	string	Adres e-mail osoby kontaktowej/organizacji. MUSI być w formacie adresu e-mail
name	string	Nazwa identyfikująca osoby kontaktowej/organizacji
url	string	Adres URL wskazujący informacje kontaktowe. MUSI być w formacie adresu URL

ApiContract

Objekt

Szczegóły interfejsu API.

Nazwa	Typ	Opis
id	string	W pełni kwalifikowany identyfikator zasobu dla zasobu. Przykład - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Nazwa zasobu
properties.apiRevision	string minLength: 1 maxLength: 100	Opisuje poprawkę interfejsu API. Jeśli nie podano żadnej wartości, zostanie utworzona domyślna wersja 1
properties.apiRevisionDescription	string maxLength: 256	Opis poprawki interfejsu API.
properties.apiVersion	string maxLength: 100	Wskazuje identyfikator wersji interfejsu API, jeśli interfejs API jest w wersji
properties.apiVersionDescription	string maxLength: 256	Opis wersji interfejsu API.
properties.apiVersionSet	ApiVersionSetContractDetails	Szczegóły zestawu wersji
properties.apiVersionSetId	string	Identyfikator zasobu powiązanego elementu ApiVersionSet.
properties.authenticationSettings	AuthenticationSettingsContract	Kolekcja ustawień uwierzytelniania uwzględnionych w tym interfejsie API.
properties.contact	ApiContactInformation	Informacje kontaktowe dotyczące interfejsu API.
properties.description	string	Opis interfejsu API. Może zawierać tagi formatowania HTML.
properties.displayName	string minLength: 1 maxLength: 300	Nazwa interfejsu API. Musi mieć długość od 1 do 300 znaków.
properties.isCurrent	boolean	Wskazuje, czy poprawka interfejsu API jest bieżącą poprawką interfejsu API.
properties.isOnline	boolean	Wskazuje, czy poprawka interfejsu API jest dostępna za pośrednictwem bramy.
properties.license	ApiLicenseInformation	Informacje o licencji dla interfejsu API.
properties.path	string minLength: 0 maxLength: 400	Względny adres URL jednoznacznie identyfikujący ten interfejs API i wszystkie jego ścieżki zasobów w wystąpieniu usługi API Management. Jest on dołączany do podstawowego adresu URL punktu końcowego interfejsu API określonego podczas tworzenia wystąpienia usługi w celu utworzenia publicznego adresu URL tego interfejsu API.
properties.protocols	Protocol[]	Opisuje, które protokoły mogą być wywoływane operacje w tym interfejsie API.
properties.provisioningState	string	Stan aprowizacji
properties.serviceUrl	string minLength: 0 maxLength: 2000	Bezwzględny adres URL usługi zaplecza implementowania tego interfejsu API. Długość nie może przekraczać 2000 znaków.
properties.sourceApiId	string	Identyfikator interfejsu API źródłowego interfejsu API.
properties.subscriptionKeyParameterNames	SubscriptionKeyParameterNamesContract	Protokoły, za pośrednictwem których udostępniono interfejs API.
properties.subscriptionRequired	boolean	Określa, czy do uzyskiwania dostępu do interfejsu API jest wymagana subskrypcja interfejsu API lub produktu.
properties.termsOfServiceUrl	string	Adres URL warunków użytkowania usługi dla interfejsu API. MUSI być w formacie adresu URL.
properties.type	ApiType	Typ interfejsu API.
type	string	Typ zasobu. Np. "Microsoft.Compute/virtualMachines" lub "Microsoft.Storage/storageAccounts"

ApiLicenseInformation

Objekt

Informacje o licencji interfejsu API

Nazwa	Typ	Opis
name	string	Nazwa licencji używana dla interfejsu API
url	string	Adres URL licencji używanej dla interfejsu API. MUSI być w formacie adresu URL

ApiType

Wyliczanie

Typ interfejsu API.

Wartość	Opis
http
soap
websocket
graphql
odata
grpc

ApiUpdateContract

Objekt

Szczegóły kontraktu aktualizacji interfejsu API.

Nazwa	Typ	Opis
properties.apiRevision	string minLength: 1 maxLength: 100	Opisuje poprawkę interfejsu API. Jeśli nie podano żadnej wartości, zostanie utworzona domyślna wersja 1
properties.apiRevisionDescription	string maxLength: 256	Opis poprawki interfejsu API.
properties.apiVersion	string maxLength: 100	Wskazuje identyfikator wersji interfejsu API, jeśli interfejs API jest w wersji
properties.apiVersionDescription	string maxLength: 256	Opis wersji interfejsu API.
properties.apiVersionSetId	string	Identyfikator zasobu powiązanego elementu ApiVersionSet.
properties.authenticationSettings	AuthenticationSettingsContract	Kolekcja ustawień uwierzytelniania uwzględnionych w tym interfejsie API.
properties.contact	ApiContactInformation	Informacje kontaktowe dotyczące interfejsu API.
properties.description	string	Opis interfejsu API. Może zawierać tagi formatowania HTML.
properties.displayName	string minLength: 1 maxLength: 300	Nazwa interfejsu API.
properties.isCurrent	boolean	Wskazuje, czy poprawka interfejsu API jest bieżącą poprawką interfejsu API.
properties.isOnline	boolean	Wskazuje, czy poprawka interfejsu API jest dostępna za pośrednictwem bramy.
properties.license	ApiLicenseInformation	Informacje o licencji dla interfejsu API.
properties.path	string minLength: 0 maxLength: 400	Względny adres URL jednoznacznie identyfikujący ten interfejs API i wszystkie jego ścieżki zasobów w wystąpieniu usługi API Management. Jest on dołączany do podstawowego adresu URL punktu końcowego interfejsu API określonego podczas tworzenia wystąpienia usługi w celu utworzenia publicznego adresu URL tego interfejsu API.
properties.protocols	Protocol[]	Opisuje, które protokoły mogą być wywoływane operacje w tym interfejsie API.
properties.serviceUrl	string minLength: 1 maxLength: 2000	Bezwzględny adres URL usługi zaplecza implementowania tego interfejsu API.
properties.subscriptionKeyParameterNames	SubscriptionKeyParameterNamesContract	Protokoły, za pośrednictwem których udostępniono interfejs API.
properties.subscriptionRequired	boolean	Określa, czy do uzyskiwania dostępu do interfejsu API jest wymagana subskrypcja interfejsu API lub produktu.
properties.termsOfServiceUrl	string	Adres URL warunków użytkowania usługi dla interfejsu API. MUSI być w formacie adresu URL.
properties.type	ApiType	Typ interfejsu API.

ApiVersionSetContractDetails

Objekt

Zestaw wersji interfejsu API zawiera wspólną konfigurację zestawu wersji interfejsu API dotyczących

Nazwa	Typ	Opis
description	string	Opis zestawu wersji interfejsu API.
id	string	Identyfikator istniejącego zestawu wersji interfejsu API. Pomiń tę wartość, aby utworzyć nowy zestaw wersji.
name	string	Wyświetlana nazwa zestawu wersji interfejsu API.
versionHeaderName	string	Nazwa parametru nagłówka HTTP wskazująca wersję interfejsu API, jeśli parametr versioningScheme jest ustawiony na `header`.
versionQueryName	string	Nazwa parametru zapytania, który wskazuje wersję interfejsu API, jeśli ustawienie versioningScheme ma wartość `query`.
versioningScheme	versioningScheme	Wartość określająca, gdzie identyfikator wersji interfejsu API będzie znajdować się w żądaniu HTTP.

AuthenticationSettingsContract

Objekt

Ustawienia uwierzytelniania interfejsu API.

Nazwa	Typ	Opis
oAuth2	OAuth2AuthenticationSettingsContract	Ustawienia uwierzytelniania OAuth2
oAuth2AuthenticationSettings	OAuth2AuthenticationSettingsContract[]	Kolekcja ustawień uwierzytelniania OAuth2 uwzględnionych w tym interfejsie API.
openid	OpenIdAuthenticationSettingsContract	Ustawienia uwierzytelniania OpenID Connect
openidAuthenticationSettings	OpenIdAuthenticationSettingsContract[]	Kolekcja ustawień uwierzytelniania programu Open ID Connect uwzględnionych w tym interfejsie API.

bearerTokenSendingMethods

Wyliczanie

Jak wysłać token do serwera.

Wartość	Opis
authorizationHeader	Token dostępu zostanie przesłany w nagłówku autoryzacji przy użyciu schematu elementu nośnego
query	Token dostępu zostanie przesłany jako parametry zapytania.

ErrorAdditionalInfo

Objekt

Dodatkowe informacje o błędzie zarządzania zasobami.

Nazwa	Typ	Opis
info	object	Dodatkowe informacje.
type	string	Dodatkowy typ informacji.

ErrorDetail

Objekt

Szczegóły błędu.

Nazwa	Typ	Opis
additionalInfo	ErrorAdditionalInfo[]	Dodatkowe informacje o błędzie.
code	string	Kod błędu.
details	ErrorDetail[]	Szczegóły błędu.
message	string	Komunikat o błędzie.
target	string	Element docelowy błędu.

ErrorResponse

Objekt

Odpowiedź na błąd

Nazwa	Typ	Opis
error	ErrorDetail	Obiekt błędu.

OAuth2AuthenticationSettingsContract

Objekt

Szczegóły ustawień uwierzytelniania OAuth2 interfejsu API.

Nazwa	Typ	Opis
authorizationServerId	string	Identyfikator serwera autoryzacji OAuth.
scope	string	zakres operacji.

OpenIdAuthenticationSettingsContract

Objekt

Szczegóły ustawień uwierzytelniania OAuth2 interfejsu API.

Nazwa	Typ	Opis
bearerTokenSendingMethods	bearerTokenSendingMethods[]	Jak wysłać token do serwera.
openidProviderId	string	Identyfikator serwera autoryzacji OAuth.

Protocol

Wyliczanie

Opisuje, które protokoły mogą być wywoływane operacje w tym interfejsie API.

Wartość	Opis
http
https
ws
wss

SubscriptionKeyParameterNamesContract

Objekt

Szczegóły nazw parametrów klucza subskrypcji.

Nazwa	Typ	Opis
header	string	Nazwa nagłówka klucza subskrypcji.
query	string	Nazwa parametru ciągu zapytania klucza subskrypcji.

versioningScheme

Wyliczanie

Wartość określająca, gdzie identyfikator wersji interfejsu API będzie znajdować się w żądaniu HTTP.

Wartość	Opis
Segment	Wersja interfejsu API jest przekazywana w segmencie ścieżki.
Query	Wersja interfejsu API jest przekazywana w parametrze zapytania.
Header	Wersja interfejsu API jest przekazywana w nagłówku HTTP.

Udostępnij za pośrednictwem

Workspace Api - Update

Parametry identyfikatora URI

Nagłówek żądania

Treść żądania

Odpowiedzi

Zabezpieczenia

azure_auth

Zakresy

Przykłady

ApiManagementUpdateWorkspaceApi

Przykładowe żądanie

Przykładowa odpowiedź

Definicje

ApiContactInformation

ApiContract

ApiLicenseInformation

ApiType

ApiUpdateContract

ApiVersionSetContractDetails

AuthenticationSettingsContract

bearerTokenSendingMethods

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

OAuth2AuthenticationSettingsContract

OpenIdAuthenticationSettingsContract

Protocol

SubscriptionKeyParameterNamesContract

versioningScheme