Freigeben über


Workspace Api - Update

Aktualisiert die angegebene API des Arbeitsbereichs in einer API Management-Dienstinstanz.

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

URI-Parameter

Name In Erforderlich Typ Beschreibung
apiId
path True

string

API-Revisionsbezeichner. Muss in der aktuellen API Management-Dienstinstanz eindeutig sein. Die nicht aktuelle Revision hat ; rev=n als Suffix, wobei n die Revisionsnummer ist.

RegEx-Muster: ^[^*#&+:<>?]+$

resourceGroupName
path True

string

Der Name der Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet.

serviceName
path True

string

Der Name des API Management-Diensts.

RegEx-Muster: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$

subscriptionId
path True

string

uuid

Hierbei handelt es sich um die ID des Zielabonnements. Der Wert muss eine UUID sein.

workspaceId
path True

string

Arbeitsbereichsbezeichner. Muss in der aktuellen API Management-Dienstinstanz eindeutig sein.

RegEx-Muster: ^[^*#&+:<>?]+$

api-version
query True

string

Hierbei handelt es sich um die für diesen Vorgang zu verwendende API-Version.

Anforderungsheader

Name Erforderlich Typ Beschreibung
If-Match True

string

ETag der Entität. ETag sollte mit dem aktuellen Entitätsstatus aus der Headerantwort der GET-Anforderung übereinstimmen, oder es sollte * für die bedingungslose Aktualisierung sein.

Anforderungstext

Name Typ Beschreibung
properties.apiRevision

string

Beschreibt die Revision der API. Wenn kein Wert angegeben wird, wird die Standardrevision 1 erstellt.

properties.apiRevisionDescription

string

Beschreibung der API-Revision.

properties.apiVersion

string

Gibt den Versionsbezeichner der API an, wenn die API versioniert ist.

properties.apiVersionDescription

string

Beschreibung der API-Version.

properties.apiVersionSetId

string

Ein Ressourcenbezeichner für das zugehörige ApiVersionSet.

properties.authenticationSettings

AuthenticationSettingsContract

Sammlung von Authentifizierungseinstellungen, die in dieser API enthalten sind.

properties.contact

ApiContactInformation

Kontaktinformationen für die API.

properties.description

string

Beschreibung der API. Kann HTML-Formatierungstags umfassen.

properties.displayName

string

API-Name.

properties.isCurrent

boolean

Gibt an, ob die API-Revision die aktuelle API-Revision ist.

properties.license

ApiLicenseInformation

Lizenzinformationen für die API.

properties.path

string

Relative URL, die diese API und all ihre Ressourcenpfade in der Instanz des API Management-Diensts eindeutig identifiziert. Sie wird an die Basis-URL des API-Endpunkts angehängt, die während der Dienstinstanzerstellung angegeben wurde, um eine öffentliche URL für diese API zu erstellen.

properties.protocols

Protocol[]

Beschreibt, über welche Protokolle die Vorgänge in dieser API aufgerufen werden können.

properties.serviceUrl

string

Absolute URL des Back-End-Diensts, der diese API implementiert.

properties.subscriptionKeyParameterNames

SubscriptionKeyParameterNamesContract

Protokolle, über die die API verfügbar gemacht wird.

properties.subscriptionRequired

boolean

Gibt an, ob ein API- oder Produktabonnement für den Zugriff auf die API erforderlich ist.

properties.termsOfServiceUrl

string

Eine URL zu den Nutzungsbedingungen für die API. MUSS im Format einer URL vorliegen.

properties.type

ApiType

Art der API.

Antworten

Name Typ Beschreibung
200 OK

ApiContract

Die API wurde erfolgreich aktualisiert.

Header

ETag: string

Other Status Codes

ErrorResponse

Fehlerantwort mit Beschreibung des Grunds für den Fehler.

Sicherheit

azure_auth

Azure Active Directory OAuth2-Flow.

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name Beschreibung
user_impersonation Identitätswechsel Ihres Benutzerkontos

Beispiele

ApiManagementUpdateWorkspaceApi

Beispielanforderung

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

Beispiel für eine Antwort

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

Definitionen

Name Beschreibung
ApiContactInformation

API-Kontaktinformationen

ApiContract

API-Details.

ApiLicenseInformation

API-Lizenzinformationen

ApiType

Art der API.

ApiUpdateContract

Api-Updatevertragsdetails.

ApiVersionSetContractDetails

Ein API-Versionssatz enthält die allgemeine Konfiguration für eine Reihe von API-Versionen, die sich auf

AuthenticationSettingsContract

API-Authentifizierungseinstellungen.

bearerTokenSendingMethods

So senden Sie ein Token an den Server.

ErrorAdditionalInfo

Zusätzliche Informationen zum Ressourcenverwaltungsfehler.

ErrorDetail

Die Fehlerdetails.

ErrorResponse

Fehlerantwort

OAuth2AuthenticationSettingsContract

Details zu API OAuth2-Authentifizierungseinstellungen.

OpenIdAuthenticationSettingsContract

Details zu API OAuth2-Authentifizierungseinstellungen.

Protocol

Beschreibt, über welche Protokolle die Vorgänge in dieser API aufgerufen werden können.

SubscriptionKeyParameterNamesContract

Details zu Abonnementschlüsselparametern.

versioningScheme

Ein -Wert, der bestimmt, wo sich der API-Versionsbezeichner in einer HTTP-Anforderung befindet.

ApiContactInformation

API-Kontaktinformationen

Name Typ Beschreibung
email

string

Die E-Mail-Adresse der Kontaktperson/Organisation. MUSS im Format einer E-Mail-Adresse vorliegen

name

string

Der identifizierende Name der Kontaktperson/Organisation

url

string

Die URL, die auf die Kontaktinformationen verweist. MUSS im Format einer URL vorliegen

ApiContract

API-Details.

Name Typ Beschreibung
id

string

Vollqualifizierte Ressourcen-ID für die Ressource. Beispiel: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

name

string

Der Name der Ressource

properties.apiRevision

string

Beschreibt die Überarbeitung der API. Wenn kein Wert angegeben wird, wird die Standardrevision 1 erstellt.

properties.apiRevisionDescription

string

Beschreibung der API-Revision.

properties.apiVersion

string

Gibt den Versionsbezeichner der API an, wenn die API versioniert ist.

properties.apiVersionDescription

string

Beschreibung der API-Version.

properties.apiVersionSet

ApiVersionSetContractDetails

Versionssatzdetails

properties.apiVersionSetId

string

Ein Ressourcenbezeichner für das zugehörige ApiVersionSet.

properties.authenticationSettings

AuthenticationSettingsContract

Sammlung von Authentifizierungseinstellungen, die in dieser API enthalten sind.

properties.contact

ApiContactInformation

Kontaktinformationen für die API.

properties.description

string

Beschreibung der API. Kann HTML-Formatierungstags umfassen.

properties.displayName

string

API-Name. Muss 1 bis 300 Zeichen lang sein.

properties.isCurrent

boolean

Gibt an, ob die API-Revision die aktuelle API-Revision ist.

properties.isOnline

boolean

Gibt an, ob auf die API-Revision über das Gateway zugegriffen werden kann.

properties.license

ApiLicenseInformation

Lizenzinformationen für die API.

properties.path

string

Relative URL, die diese API und all ihre Ressourcenpfade in der Instanz des API Management-Diensts eindeutig identifiziert. Sie wird an die Basis-URL des API-Endpunkts angehängt, die während der Dienstinstanzerstellung angegeben wurde, um eine öffentliche URL für diese API zu erstellen.

properties.protocols

Protocol[]

Beschreibt, über welche Protokolle die Vorgänge in dieser API aufgerufen werden können.

properties.provisioningState

string

Der Bereitstellungsstatus

properties.serviceUrl

string

Absolute URL des Back-End-Diensts, der diese API implementiert. Darf nicht mehr als 2000 Zeichen lang sein.

properties.sourceApiId

string

API-Bezeichner der Quell-API.

properties.subscriptionKeyParameterNames

SubscriptionKeyParameterNamesContract

Protokolle, für die die API verfügbar gemacht wird.

properties.subscriptionRequired

boolean

Gibt an, ob ein API- oder Produktabonnement für den Zugriff auf die API erforderlich ist.

properties.termsOfServiceUrl

string

Eine URL zu den Nutzungsbedingungen für die API. MUSS im Format einer URL vorliegen.

properties.type

ApiType

Art der API.

type

string

Der Typ der Ressource. Z. B. "Microsoft.Compute/virtualMachines" oder "Microsoft.Storage/storageAccounts"

ApiLicenseInformation

API-Lizenzinformationen

Name Typ Beschreibung
name

string

Der für die API verwendete Lizenzname

url

string

Eine URL für die Lizenz, die für die API verwendet wird. MUSS im Format einer URL vorliegen

ApiType

Art der API.

Name Typ Beschreibung
graphql

string

grpc

string

http

string

odata

string

soap

string

websocket

string

ApiUpdateContract

Api-Updatevertragsdetails.

Name Typ Beschreibung
properties.apiRevision

string

Beschreibt die Überarbeitung der API. Wenn kein Wert angegeben wird, wird die Standardrevision 1 erstellt.

properties.apiRevisionDescription

string

Beschreibung der API-Revision.

properties.apiVersion

string

Gibt den Versionsbezeichner der API an, wenn die API versioniert ist.

properties.apiVersionDescription

string

Beschreibung der API-Version.

properties.apiVersionSetId

string

Ein Ressourcenbezeichner für das zugehörige ApiVersionSet.

properties.authenticationSettings

AuthenticationSettingsContract

Sammlung von Authentifizierungseinstellungen, die in dieser API enthalten sind.

properties.contact

ApiContactInformation

Kontaktinformationen für die API.

properties.description

string

Beschreibung der API. Kann HTML-Formatierungstags umfassen.

properties.displayName

string

API-Name.

properties.isCurrent

boolean

Gibt an, ob die API-Revision die aktuelle API-Revision ist.

properties.isOnline

boolean

Gibt an, ob auf die API-Revision über das Gateway zugegriffen werden kann.

properties.license

ApiLicenseInformation

Lizenzinformationen für die API.

properties.path

string

Relative URL, die diese API und all ihre Ressourcenpfade in der Instanz des API Management-Diensts eindeutig identifiziert. Sie wird an die Basis-URL des API-Endpunkts angehängt, die während der Dienstinstanzerstellung angegeben wurde, um eine öffentliche URL für diese API zu erstellen.

properties.protocols

Protocol[]

Beschreibt, über welche Protokolle die Vorgänge in dieser API aufgerufen werden können.

properties.serviceUrl

string

Absolute URL des Back-End-Diensts, der diese API implementiert.

properties.subscriptionKeyParameterNames

SubscriptionKeyParameterNamesContract

Protokolle, für die die API verfügbar gemacht wird.

properties.subscriptionRequired

boolean

Gibt an, ob ein API- oder Produktabonnement für den Zugriff auf die API erforderlich ist.

properties.termsOfServiceUrl

string

Eine URL zu den Nutzungsbedingungen für die API. MUSS im Format einer URL vorliegen.

properties.type

ApiType

Art der API.

ApiVersionSetContractDetails

Ein API-Versionssatz enthält die allgemeine Konfiguration für eine Reihe von API-Versionen, die sich auf

Name Typ Beschreibung
description

string

Beschreibung des API-Versionssatzes.

id

string

Bezeichner für vorhandene API-Versionssätze. Lassen Sie diesen Wert weg, um einen neuen Versionssatz zu erstellen.

name

string

Der Anzeigename des API-Versionssatzes.

versionHeaderName

string

Name des HTTP-Headerparameters, der die API-Version angibt, wenn versioningScheme auf headerfestgelegt ist.

versionQueryName

string

Name des Abfrageparameters, der die API-Version angibt, wenn versioningScheme auf queryfestgelegt ist.

versioningScheme

versioningScheme

Ein Wert, der bestimmt, wo sich der API-Versionsbezeichner in einer HTTP-Anforderung befindet.

AuthenticationSettingsContract

API-Authentifizierungseinstellungen.

Name Typ Beschreibung
oAuth2

OAuth2AuthenticationSettingsContract

OAuth2-Authentifizierungseinstellungen

oAuth2AuthenticationSettings

OAuth2AuthenticationSettingsContract[]

Sammlung von OAuth2-Authentifizierungseinstellungen, die in dieser API enthalten sind.

openid

OpenIdAuthenticationSettingsContract

OpenID Connect-Authentifizierungseinstellungen

openidAuthenticationSettings

OpenIdAuthenticationSettingsContract[]

Sammlung von Open ID Connect-Authentifizierungseinstellungen, die in dieser API enthalten sind.

bearerTokenSendingMethods

So senden Sie ein Token an den Server.

Name Typ Beschreibung
authorizationHeader

string

Das Zugriffstoken wird im Autorisierungsheader mithilfe des Bearerschemas übertragen.

query

string

Das Zugriffstoken wird als Abfrageparameter übertragen.

ErrorAdditionalInfo

Zusätzliche Informationen zum Ressourcenverwaltungsfehler.

Name Typ Beschreibung
info

object

Zusätzliche Informationen.

type

string

Typ der zusätzlichen Informationen.

ErrorDetail

Die Fehlerdetails.

Name Typ Beschreibung
additionalInfo

ErrorAdditionalInfo[]

Die zusätzlichen Fehlerinformationen.

code

string

Der Fehlercode.

details

ErrorDetail[]

Die Fehlerdetails.

message

string

Die Fehlermeldung.

target

string

Das Fehlerziel.

ErrorResponse

Fehlerantwort

Name Typ Beschreibung
error

ErrorDetail

Das Fehlerobjekt.

OAuth2AuthenticationSettingsContract

Details zu API OAuth2-Authentifizierungseinstellungen.

Name Typ Beschreibung
authorizationServerId

string

Bezeichner (ID) des OAuth-Autorisierungsservers.

scope

string

Operations-Bereich.

OpenIdAuthenticationSettingsContract

Details zu API OAuth2-Authentifizierungseinstellungen.

Name Typ Beschreibung
bearerTokenSendingMethods

bearerTokenSendingMethods[]

So senden Sie ein Token an den Server.

openidProviderId

string

Bezeichner (ID) des OAuth-Autorisierungsservers.

Protocol

Beschreibt, über welche Protokolle die Vorgänge in dieser API aufgerufen werden können.

Name Typ Beschreibung
http

string

https

string

ws

string

wss

string

SubscriptionKeyParameterNamesContract

Details zu Abonnementschlüsselparametern.

Name Typ Beschreibung
header

string

Name des Abonnementschlüsselheaders.

query

string

Name des Abonnementschlüsselabfragezeichenfolgenparameters.

versioningScheme

Ein -Wert, der bestimmt, wo sich der API-Versionsbezeichner in einer HTTP-Anforderung befindet.

Name Typ Beschreibung
Header

string

Die API-Version wird in einem HTTP-Header übergeben.

Query

string

Die API-Version wird in einem Abfrageparameter übergeben.

Segment

string

Die API-Version wird in einem Pfadsegment übergeben.