Workspace Api - Update

Tjänst:: API Management

API-version:: 2024-05-01

Uppdaterar det angivna API:et för arbetsytan i en API Management-tjänstinstans.

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
apiId	path	True	string minLength: 1 maxLength: 256 pattern: ^[^*#&+:<>?]+$	API-revisionsidentifierare. Måste vara unikt i den aktuella API Management-tjänstinstansen. Icke-aktuell revision har ; rev=n som ett suffix där n är revisionsnumret.
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.
workspaceId	path	True	string minLength: 1 maxLength: 80 pattern: ^[^*#&+:<>?]+$	Arbetsyteidentifierare. 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.apiRevision	string minLength: 1 maxLength: 100	Beskriver revisionen av API:et. Om inget värde anges skapas standardrevision 1
properties.apiRevisionDescription	string maxLength: 256	Beskrivning av API-revisionen.
properties.apiVersion	string maxLength: 100	Anger versionsidentifieraren för API:et om API:et är versionshanterat
properties.apiVersionDescription	string maxLength: 256	Beskrivning av API-versionen.
properties.apiVersionSetId	string	En resursidentifierare för den relaterade ApiVersionSet.
properties.authenticationSettings	AuthenticationSettingsContract	Samling autentiseringsinställningar som ingår i det här API:et.
properties.contact	ApiContactInformation	Kontaktuppgifter för API:et.
properties.description	string	Beskrivning av API:et. Kan innehålla HTML-formateringstaggar.
properties.displayName	string minLength: 1 maxLength: 300	API-namn.
properties.isCurrent	boolean	Anger om API-revisionen är aktuell api-revision.
properties.license	ApiLicenseInformation	Licensinformation för API:et.
properties.path	string minLength: 0 maxLength: 400	Relativ URL som unikt identifierar det här API:et och alla dess resurssökvägar i API Management-tjänstinstansen. Den läggs till i den API-slutpunktsbas-URL som angavs när tjänstinstansen skapades för att skapa en offentlig URL för det här API:et.
properties.protocols	Protocol[]	Beskriver vilka protokoll som åtgärderna i det här API:et kan anropas för.
properties.serviceUrl	string minLength: 1 maxLength: 2000	Absolut URL för serverdelstjänsten som implementerar det här API:et.
properties.subscriptionKeyParameterNames	SubscriptionKeyParameterNamesContract	Protokoll som API:et görs tillgängligt för.
properties.subscriptionRequired	boolean	Anger om ett API eller en produktprenumeration krävs för åtkomst till API:et.
properties.termsOfServiceUrl	string	En URL till användningsvillkoren för API:et. MÅSTE vara i formatet för en URL.
properties.type	ApiType	Typ av API.

Svar

Name	Typ	Description
200 OK	ApiContract	API:et har uppdaterats. Sidhuvuden ETag: string
Other Status Codes	ErrorResponse	Felsvar som beskriver varför åtgärden misslyckades.

Name

Typ

Description

200 OK

ApiContract

API:et 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-flöde.

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

Omfattningar

Name	Description
user_impersonation	personifiera ditt användarkonto

Exempel

ApiManagementUpdateWorkspaceApi

Exempelbegäran

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

Exempelsvar

Statuskod:: 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
  }
}

Definitioner

Name	Description
ApiContactInformation	API-kontaktinformation
ApiContract	API-information.
ApiLicenseInformation	API-licensinformation
ApiType	Typ av API.
ApiUpdateContract	Information om API-uppdateringskontrakt.
ApiVersionSetContractDetails	En API-versionsuppsättning innehåller den vanliga konfigurationen för en uppsättning API-versioner relaterade
AuthenticationSettingsContract	Inställningar för API-autentisering.
bearerTokenSendingMethods	Så här skickar du token till servern.
ErrorAdditionalInfo	Ytterligare information om resurshanteringsfelet.
ErrorDetail	Felinformationen.
ErrorResponse	Felsvar
OAuth2AuthenticationSettingsContract	Information om API OAuth2-autentiseringsinställningar.
OpenIdAuthenticationSettingsContract	Information om API OAuth2-autentiseringsinställningar.
Protocol	Beskriver vilka protokoll som åtgärderna i det här API:et kan anropas för.
SubscriptionKeyParameterNamesContract	Information om namn på prenumerationsnyckelparameter.
versioningScheme	Ett värde som avgör var API-versionsidentifieraren ska finnas i en HTTP-begäran.

ApiContactInformation

Objekt

API-kontaktinformation

Name	Typ	Description
email	string	Kontaktpersonens/organisationens e-postadress. MÅSTE vara i formatet för en e-postadress
name	string	Det identifierande namnet på kontaktpersonen/organisationen
url	string	URL:en som pekar på kontaktinformationen. MÅSTE vara i formatet för en URL

ApiContract

Objekt

API-information.

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.apiRevision	string minLength: 1 maxLength: 100	Beskriver revisionen av API:et. Om inget värde anges skapas standardrevision 1
properties.apiRevisionDescription	string maxLength: 256	Beskrivning av API-revisionen.
properties.apiVersion	string maxLength: 100	Anger versionsidentifieraren för API:et om API:et är versionshanterat
properties.apiVersionDescription	string maxLength: 256	Beskrivning av API-versionen.
properties.apiVersionSet	ApiVersionSetContractDetails	Information om versionsuppsättning
properties.apiVersionSetId	string	En resursidentifierare för den relaterade ApiVersionSet.
properties.authenticationSettings	AuthenticationSettingsContract	Samling autentiseringsinställningar som ingår i det här API:et.
properties.contact	ApiContactInformation	Kontaktuppgifter för API:et.
properties.description	string	Beskrivning av API:et. Kan innehålla HTML-formateringstaggar.
properties.displayName	string minLength: 1 maxLength: 300	API-namn. Måste vara mellan 1 och 300 tecken långt.
properties.isCurrent	boolean	Anger om API-revisionen är aktuell api-revision.
properties.isOnline	boolean	Anger om API-revisionen är tillgänglig via gatewayen.
properties.license	ApiLicenseInformation	Licensinformation för API:et.
properties.path	string minLength: 0 maxLength: 400	Relativ URL som unikt identifierar det här API:et och alla dess resurssökvägar i API Management-tjänstinstansen. Den läggs till i den API-slutpunktsbas-URL som angavs när tjänstinstansen skapades för att skapa en offentlig URL för det här API:et.
properties.protocols	Protocol[]	Beskriver vilka protokoll som åtgärderna i det här API:et kan anropas för.
properties.provisioningState	string	Etableringstillståndet
properties.serviceUrl	string minLength: 0 maxLength: 2000	Absolut URL för serverdelstjänsten som implementerar det här API:et. Får inte vara längre än 2 000 tecken.
properties.sourceApiId	string	API-identifierare för käll-API:et.
properties.subscriptionKeyParameterNames	SubscriptionKeyParameterNamesContract	Protokoll som API:et görs tillgängligt för.
properties.subscriptionRequired	boolean	Anger om ett API eller en produktprenumeration krävs för åtkomst till API:et.
properties.termsOfServiceUrl	string	En URL till användningsvillkoren för API:et. MÅSTE vara i formatet för en URL.
properties.type	ApiType	Typ av API.
type	string	Resurstypen. Till exempel "Microsoft.Compute/virtualMachines" eller "Microsoft.Storage/storageAccounts"

ApiLicenseInformation

Objekt

API-licensinformation

Name	Typ	Description
name	string	Licensnamnet som används för API:et
url	string	En URL till den licens som används för API:et. MÅSTE vara i formatet för en URL

ApiType

Uppräkning

Typ av API.

Värde	Description
http
soap
websocket
graphql
odata
grpc

ApiUpdateContract

Objekt

Information om API-uppdateringskontrakt.

Name	Typ	Description
properties.apiRevision	string minLength: 1 maxLength: 100	Beskriver revisionen av API:et. Om inget värde anges skapas standardrevision 1
properties.apiRevisionDescription	string maxLength: 256	Beskrivning av API-revisionen.
properties.apiVersion	string maxLength: 100	Anger versionsidentifieraren för API:et om API:et är versionshanterat
properties.apiVersionDescription	string maxLength: 256	Beskrivning av API-versionen.
properties.apiVersionSetId	string	En resursidentifierare för den relaterade ApiVersionSet.
properties.authenticationSettings	AuthenticationSettingsContract	Samling autentiseringsinställningar som ingår i det här API:et.
properties.contact	ApiContactInformation	Kontaktuppgifter för API:et.
properties.description	string	Beskrivning av API:et. Kan innehålla HTML-formateringstaggar.
properties.displayName	string minLength: 1 maxLength: 300	API-namn.
properties.isCurrent	boolean	Anger om API-revisionen är aktuell api-revision.
properties.isOnline	boolean	Anger om API-revisionen är tillgänglig via gatewayen.
properties.license	ApiLicenseInformation	Licensinformation för API:et.
properties.path	string minLength: 0 maxLength: 400	Relativ URL som unikt identifierar det här API:et och alla dess resurssökvägar i API Management-tjänstinstansen. Den läggs till i den API-slutpunktsbas-URL som angavs när tjänstinstansen skapades för att skapa en offentlig URL för det här API:et.
properties.protocols	Protocol[]	Beskriver vilka protokoll som åtgärderna i det här API:et kan anropas för.
properties.serviceUrl	string minLength: 1 maxLength: 2000	Absolut URL för serverdelstjänsten som implementerar det här API:et.
properties.subscriptionKeyParameterNames	SubscriptionKeyParameterNamesContract	Protokoll som API:et görs tillgängligt för.
properties.subscriptionRequired	boolean	Anger om ett API eller en produktprenumeration krävs för åtkomst till API:et.
properties.termsOfServiceUrl	string	En URL till användningsvillkoren för API:et. MÅSTE vara i formatet för en URL.
properties.type	ApiType	Typ av API.

ApiVersionSetContractDetails

Objekt

En API-versionsuppsättning innehåller den vanliga konfigurationen för en uppsättning API-versioner relaterade

Name	Typ	Description
description	string	Beskrivning av API-versionsuppsättning.
id	string	Identifierare för befintlig API-versionsuppsättning. Utelämna det här värdet för att skapa en ny versionsuppsättning.
name	string	Visningsnamnet för API-versionsuppsättningen.
versionHeaderName	string	Namnet på HTTP-huvudparametern som anger API-versionen om versionshanteringScheme är inställt på `header`.
versionQueryName	string	Namnet på frågeparametern som anger API-versionen om versionshanteringScheme är inställt på `query`.
versioningScheme	versioningScheme	Ett värde som avgör var API-versionsidentifieraren ska finnas i en HTTP-begäran.

AuthenticationSettingsContract

Objekt

Inställningar för API-autentisering.

Name	Typ	Description
oAuth2	OAuth2AuthenticationSettingsContract	Autentiseringsinställningar för OAuth2
oAuth2AuthenticationSettings	OAuth2AuthenticationSettingsContract[]	Samling OAuth2-autentiseringsinställningar som ingår i det här API:et.
openid	OpenIdAuthenticationSettingsContract	Inställningar för OpenID Connect-autentisering
openidAuthenticationSettings	OpenIdAuthenticationSettingsContract[]	Samling autentiseringsinställningar för Open ID Connect som ingår i det här API:et.

bearerTokenSendingMethods

Uppräkning

Så här skickar du token till servern.

Värde	Description
authorizationHeader	Åtkomsttoken överförs i auktoriseringshuvudet med hjälp av Bearer-schemat
query	Åtkomsttoken överförs som frågeparametrar.

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.

OAuth2AuthenticationSettingsContract

Objekt

Information om API OAuth2-autentiseringsinställningar.

Name	Typ	Description
authorizationServerId	string	OAuth-auktoriseringsserveridentifierare.
scope	string	driftsomfång.

OpenIdAuthenticationSettingsContract

Objekt

Information om API OAuth2-autentiseringsinställningar.

Name	Typ	Description
bearerTokenSendingMethods	bearerTokenSendingMethods[]	Så här skickar du token till servern.
openidProviderId	string	OAuth-auktoriseringsserveridentifierare.

Protocol

Uppräkning

Beskriver vilka protokoll som åtgärderna i det här API:et kan anropas för.

Värde	Description
http
https
ws
wss

SubscriptionKeyParameterNamesContract

Objekt

Information om namn på prenumerationsnyckelparameter.

Name	Typ	Description
header	string	Namn på prenumerationsnyckelhuvud.
query	string	Parameternamn för frågesträng för prenumerationsnyckel.

versioningScheme

Uppräkning

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

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

Dela via

Workspace Api - Update

URI-parametrar

Begärandehuvud

Begärandetext

Svar

Säkerhet

azure_auth

Omfattningar

Exempel

ApiManagementUpdateWorkspaceApi

Exempelbegäran

Exempelsvar

Definitioner

ApiContactInformation

ApiContract

ApiLicenseInformation

ApiType

ApiUpdateContract

ApiVersionSetContractDetails

AuthenticationSettingsContract

bearerTokenSendingMethods

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

OAuth2AuthenticationSettingsContract

OpenIdAuthenticationSettingsContract

Protocol

SubscriptionKeyParameterNamesContract

versioningScheme