Udostępnij za pośrednictwem


Workspace Api - Update

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=2023-09-01-preview

Parametry identyfikatora URI

Nazwa W Wymagane Typ Opis
apiId
path True

string

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.

Wzorzec wyrażenia regularnego: ^[^*#&+:<>?]+$

resourceGroupName
path True

string

Nazwa grupy zasobów. W nazwie jest uwzględniana wielkość liter.

serviceName
path True

string

Nazwa usługi API Management.

Wzorzec wyrażenia regularnego: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$

subscriptionId
path True

string

uuid

Identyfikator subskrypcji docelowej. Wartość musi być identyfikatorem UUID.

workspaceId
path True

string

Identyfikator obszaru roboczego. Musi być unikatowa w bieżącym wystąpieniu usługi API Management.

Wzorzec wyrażenia regularnego: ^[^*#&+:<>?]+$

api-version
query True

string

Wersja interfejsu API do użycia dla tej operacji.

Nagłówek żądania

Nazwa Wymagane Typ Opis
If-Match True

string

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

Opisuje poprawkę interfejsu API. Jeśli nie zostanie podana żadna wartość, zostanie utworzona domyślna wersja 1

properties.apiRevisionDescription

string

Opis poprawki interfejsu API.

properties.apiVersion

string

Wskazuje identyfikator wersji interfejsu API, jeśli interfejs API jest w wersji

properties.apiVersionDescription

string

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

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

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 dla tego interfejsu API.

properties.protocols

Protocol[]

Opisuje, na których protokołach można wywołać operacje w tym interfejsie API.

properties.serviceUrl

string

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 interfejs API lub subskrypcja produktu jest wymagana do uzyskiwania dostępu do interfejsu API.

properties.termsOfServiceUrl

string

Adres URL warunków użytkowania 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ę.

Zabezpieczenia

azure_auth

Przepływ 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

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=2023-09-01-preview


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

Przykładowa odpowiedź

{
  "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 typową 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, na których protokołach można wywołać 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

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

Szczegóły interfejsu API.

Nazwa Typ Opis
id

string

W pełni kwalifikowany identyfikator zasobu dla zasobu. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

name

string

Nazwa zasobu

properties.apiRevision

string

Opisuje poprawkę interfejsu API. Jeśli nie zostanie podana żadna wartość, zostanie utworzona domyślna wersja 1

properties.apiRevisionDescription

string

Opis poprawki interfejsu API.

properties.apiVersion

string

Wskazuje identyfikator wersji interfejsu API, jeśli interfejs API jest w wersji

properties.apiVersionDescription

string

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

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

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 dla tego interfejsu API.

properties.protocols

Protocol[]

Opisuje, na których protokołach można wywołać operacje w tym interfejsie API.

properties.provisioningState

string

Stan aprowizacji

properties.serviceUrl

string

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.

properties.subscriptionKeyParameterNames

SubscriptionKeyParameterNamesContract

Protokoły, za pośrednictwem których udostępniono interfejs API.

properties.subscriptionRequired

boolean

Określa, czy interfejs API lub subskrypcja produktu jest wymagana do uzyskiwania dostępu do interfejsu API.

properties.termsOfServiceUrl

string

Adres URL warunków użytkowania 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

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

Typ interfejsu API.

Nazwa Typ Opis
graphql

string

grpc

string

http

string

odata

string

soap

string

websocket

string

ApiUpdateContract

Szczegóły kontraktu aktualizacji interfejsu API.

Nazwa Typ Opis
properties.apiRevision

string

Opisuje poprawkę interfejsu API. Jeśli nie zostanie podana żadna wartość, zostanie utworzona domyślna wersja 1

properties.apiRevisionDescription

string

Opis poprawki interfejsu API.

properties.apiVersion

string

Wskazuje identyfikator wersji interfejsu API, jeśli interfejs API jest w wersji

properties.apiVersionDescription

string

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

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

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 dla tego interfejsu API.

properties.protocols

Protocol[]

Opisuje, na których protokołach można wywołać operacje w tym interfejsie API.

properties.serviceUrl

string

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 interfejs API lub subskrypcja produktu jest wymagana do uzyskiwania dostępu do interfejsu API.

properties.termsOfServiceUrl

string

Adres URL warunków użytkowania interfejsu API. MUSI być w formacie adresu URL.

properties.type

ApiType

Typ interfejsu API.

ApiVersionSetContractDetails

Zestaw wersji interfejsu API zawiera typową 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 parametr versioningScheme jest ustawiony na query.

versioningScheme

versioningScheme

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

AuthenticationSettingsContract

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

Jak wysłać token do serwera.

Nazwa Typ Opis
authorizationHeader

string

Token dostępu zostanie przesłany w nagłówku autoryzacji przy użyciu schematu elementu nośnego

query

string

Token dostępu zostanie przesłany jako parametry zapytania.

ErrorAdditionalInfo

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

Nazwa Typ Opis
info

object

Dodatkowe informacje.

type

string

Dodatkowy typ informacji.

ErrorDetail

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

Odpowiedź na błąd

Nazwa Typ Opis
error

ErrorDetail

Obiekt error.

OAuth2AuthenticationSettingsContract

Szczegóły ustawień uwierzytelniania OAuth2 interfejsu API.

Nazwa Typ Opis
authorizationServerId

string

Identyfikator serwera autoryzacji OAuth.

scope

string

zakres operacji.

OpenIdAuthenticationSettingsContract

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

Opisuje, na których protokołach można wywołać operacje w tym interfejsie API.

Nazwa Typ Opis
http

string

https

string

ws

string

wss

string

SubscriptionKeyParameterNamesContract

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

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

Nazwa Typ Opis
Header

string

Wersja interfejsu API jest przekazywana w nagłówku HTTP.

Query

string

Wersja interfejsu API jest przekazywana w parametrze zapytania.

Segment

string

Wersja interfejsu API jest przekazywana w segmencie ścieżki.