Microsoft.ApiManagement service/apis 2023-03-01-preview

Artikel
01/18/2024

Bicep-Ressourcendefinition

Der Ressourcentyp service/apis kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:

Ressourcengruppen – Siehe Bereitstellungsbefehle für Ressourcengruppen

Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie im Änderungsprotokoll.

Ressourcenformat

Um eine Microsoft.ApiManagement/service/apis-Ressource zu erstellen, fügen Sie ihrer Vorlage den folgenden Bicep hinzu.

resource symbolicname 'Microsoft.ApiManagement/service/apis@2023-03-01-preview' = {
  name: 'string'
  parent: resourceSymbolicName
  properties: {
    apiRevision: 'string'
    apiRevisionDescription: 'string'
    apiType: 'string'
    apiVersion: 'string'
    apiVersionDescription: 'string'
    apiVersionSet: {
      description: 'string'
      id: 'string'
      name: 'string'
      versionHeaderName: 'string'
      versioningScheme: 'string'
      versionQueryName: 'string'
    }
    apiVersionSetId: 'string'
    authenticationSettings: {
      oAuth2: {
        authorizationServerId: 'string'
        scope: 'string'
      }
      oAuth2AuthenticationSettings: [
        {
          authorizationServerId: 'string'
          scope: 'string'
        }
      ]
      openid: {
        bearerTokenSendingMethods: [
          'string'
        ]
        openidProviderId: 'string'
      }
      openidAuthenticationSettings: [
        {
          bearerTokenSendingMethods: [
            'string'
          ]
          openidProviderId: 'string'
        }
      ]
    }
    contact: {
      email: 'string'
      name: 'string'
      url: 'string'
    }
    description: 'string'
    displayName: 'string'
    format: 'string'
    isCurrent: bool
    license: {
      name: 'string'
      url: 'string'
    }
    path: 'string'
    protocols: [
      'string'
    ]
    serviceUrl: 'string'
    sourceApiId: 'string'
    subscriptionKeyParameterNames: {
      header: 'string'
      query: 'string'
    }
    subscriptionRequired: bool
    termsOfServiceUrl: 'string'
    translateRequiredQueryParameters: 'string'
    type: 'string'
    value: 'string'
    wsdlSelector: {
      wsdlEndpointName: 'string'
      wsdlServiceName: 'string'
    }
  }
}

Eigenschaftswerte

service/apis

Name	BESCHREIBUNG	Wert
name	Der Ressourcenname Weitere Informationen finden Sie unter Festlegen von Namen und Typen für untergeordnete Ressourcen in Bicep.	Zeichenfolge (erforderlich) Zeichenlimit: 1-80 Gültige Zeichen: Alphanumerische Zeichen und Bindestriche. Muss mit einem Buchstaben beginnen und mit einem alphanumerischen Zeichen enden.
parent	In Bicep können Sie die übergeordnete Ressource für eine untergeordnete Ressource angeben. Sie müssen diese Eigenschaft nur hinzufügen, wenn die untergeordnete Ressource außerhalb der übergeordneten Ressource deklariert wird. Weitere Informationen finden Sie unter Untergeordnete Ressource außerhalb der übergeordneten Ressource.	Symbolischer Name für Ressource vom Typ: Dienst
properties	Api-Entitätserstellung von Updateeigenschaften.	ApiCreateOrUpdatePropertiesOrApiContractProperties

ApiCreateOrUpdatePropertiesOrApiContractProperties

Name	BESCHREIBUNG	Wert
apiRevision	Beschreibt die Revision der API. Wenn kein Wert angegeben wird, wird die Standardrevision 1 erstellt.	Zeichenfolge
apiRevisionDescription	Beschreibung der API-Revision.	Zeichenfolge
apiType	Typ der zu erstellenden API. * `http` erstellt eine REST-API * `soap` erstellt eine SOAP-Passthrough-API * `websocket` erstellt websocket-API * `graphql`erstellt GraphQL-API. In Zukunft können neue Typen hinzugefügt werden.	'graphql' "http" "odata" "Seife" "websocket"
apiVersion	Gibt den Versionsbezeichner der API an, wenn die API versioniert ist.	Zeichenfolge
apiVersionDescription	Beschreibung der API-Version.	Zeichenfolge
apiVersionSet	Versionssatzdetails	ApiVersionSetContractDetails
apiVersionSetId	Ein Ressourcenbezeichner für das zugehörige ApiVersionSet.	Zeichenfolge
authenticationSettings	Sammlung von Authentifizierungseinstellungen, die in dieser API enthalten sind.	AuthenticationSettingsContract
contact	Kontaktinformationen für die API.	ApiContactInformation
description	Beschreibung der API. Kann HTML-Formatierungstags umfassen.	Zeichenfolge
displayName	API-Name. Muss 1 bis 300 Zeichen lang sein.	Zeichenfolge
format	Format des Inhalts, in den die API importiert wird. Neue Formate können in Zukunft hinzugefügt werden	'graphql-link' "odata" 'odata-link' "openapi" "openapi+json" "openapi+json-link" 'openapi-link' 'swagger-json' 'swagger-link-json' 'wadl-link-json' 'wadl-xml' 'wsdl' 'wsdl-link'
isCurrent	Gibt an, ob die API-Revision die aktuelle API-Revision ist.	bool
license	Lizenzinformationen für die API.	ApiLicenseInformation
path	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.	Zeichenfolge (erforderlich)
protocols	Beschreibt, über welche Protokolle die Vorgänge in dieser API aufgerufen werden können.	Zeichenfolgenarray, das eines der folgenden Elemente enthält: "http" "https" "ws" 'wss'
serviceUrl	Absolute URL des Back-End-Diensts, der diese API implementiert. Darf nicht mehr als 2.000 Zeichen lang sein.	Zeichenfolge
sourceApiId	API-Bezeichner der Quell-API.	Zeichenfolge
subscriptionKeyParameterNames	Protokolle, über die die API verfügbar gemacht wird.	SubscriptionKeyParameterNamesContract
subscriptionRequired	Gibt an, ob ein API- oder Produktabonnement für den Zugriff auf die API erforderlich ist.	bool
termsOfServiceUrl	Eine URL zu den Nutzungsbedingungen für die API. MUSS im Format einer URL vorliegen.	Zeichenfolge
translateRequiredQueryParameters	Strategie der Übersetzung erforderlicher Abfrageparameter in Vorlagenparameter. Hat standardmäßig den Wert "template". Mögliche Werte: "template", "query"	"Abfrage" "Vorlage"
Typ	Art der API.	'graphql' "http" "odata" "Seife" "websocket"
value	Inhaltswert beim Importieren einer API.	Zeichenfolge
wsdlSelector	Kriterien zum Einschränken des WSDL-Imports auf eine Teilmenge des Dokuments.	ApiCreateOrUpdatePropertiesWsdlSelector

ApiVersionSetContractDetails

Name	BESCHREIBUNG	Wert
description	Beschreibung des API-Versionssatzes.	Zeichenfolge
id	Bezeichner für den vorhandenen API-Versionssatz. Lassen Sie diesen Wert aus, um einen neuen Versionssatz zu erstellen.	Zeichenfolge
name	Der Anzeigename des API-Versionssatzes.	Zeichenfolge
versionHeaderName	Name des HTTP-Headerparameters, der die API-Version angibt, wenn versioningScheme auf `header`festgelegt ist.	Zeichenfolge
versionsverwaltungScheme	Ein -Wert, der bestimmt, wo sich der API-Versionsbezeichner in einer HTTP-Anforderung befindet.	"Header" "Abfrage" "Segment"
versionQueryName	Name des Abfrageparameters, der die API-Version angibt, wenn versioningScheme auf `query`festgelegt ist.	Zeichenfolge

AuthenticationSettingsContract

Name	BESCHREIBUNG	Wert
oAuth2	OAuth2-Authentifizierungseinstellungen	OAuth2AuthenticationSettingsContract
oAuth2AuthenticationSettings	Sammlung der OAuth2-Authentifizierungseinstellungen, die in dieser API enthalten sind.	OAuth2AuthenticationSettingsContract[]
openid	OpenID Connect-Authentifizierungseinstellungen	OpenIdAuthenticationSettingsContract
openidAuthenticationSettings	Sammlung der Open ID Connect-Authentifizierungseinstellungen, die in dieser API enthalten sind.	OpenIdAuthenticationSettingsContract[]

OAuth2AuthenticationSettingsContract

Name	BESCHREIBUNG	Wert
authorizationServerId	Bezeichner (ID) des OAuth-Autorisierungsservers.	Zeichenfolge
scope	Operations-Bereich.	Zeichenfolge

OpenIdAuthenticationSettingsContract

Name	BESCHREIBUNG	Wert
bearerTokenSendingMethods	So senden Sie ein Token an den Server.	Zeichenfolgenarray, das eines der folgenden Elemente enthält: "authorizationHeader" "Abfrage"
openidProviderId	Bezeichner (ID) des OAuth-Autorisierungsservers.	Zeichenfolge

ApiContactInformation

Name	BESCHREIBUNG	Wert
email	Die E-Mail-Adresse der Kontaktperson/organization. MUSS im Format einer E-Mail-Adresse vorliegen.	Zeichenfolge
name	Der identifizierende Name der Kontaktperson/organization	Zeichenfolge
url	Die URL, die auf die Kontaktinformationen verweist. MUSS im Format einer URL vorliegen.	Zeichenfolge

ApiLicenseInformation

Name	BESCHREIBUNG	Wert
name	Der für die API verwendete Lizenzname.	Zeichenfolge
url	Eine URL zur Lizenz, die für die API verwendet wird. MUSS im Format einer URL vorliegen.	Zeichenfolge

SubscriptionKeyParameterNamesContract

Name	BESCHREIBUNG	Wert
header	Name des Abonnementschlüsselheaders.	Zeichenfolge
Abfrage	Name der Abonnementschlüsselabfragezeichenfolge.	Zeichenfolge

ApiCreateOrUpdatePropertiesWsdlSelector

Name	BESCHREIBUNG	Wert
wsdlEndpointName	Name des Endpunkts (Port), der aus WSDL importiert werden soll	Zeichenfolge
wsdlServiceName	Name des Diensts, der aus WSDL importiert werden soll	Zeichenfolge

Schnellstartvorlagen

In den folgenden Schnellstartvorlagen wird dieser Ressourcentyp bereitgestellt.

Vorlage	BESCHREIBUNG
Erstellen einer API Management-Instanz und aller Unterressourcen mithilfe einer Vorlage	Diese Vorlage veranschaulicht, wie Sie einen API Management-Dienst erstellen und Untergeordnetetitäten konfigurieren.
Erstellen von Azure Front Door vor Azure API Management	In diesem Beispiel wird veranschaulicht, wie Sie Azure Front Door als globalen Lastenausgleich vor Azure API Management verwenden.

Ressourcendefinition mit einer ARM-Vorlage

Der Ressourcentyp service/apis kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:

Ressourcengruppen – Siehe Bereitstellungsbefehle für Ressourcengruppen

Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie im Änderungsprotokoll.

Ressourcenformat

Um eine Microsoft.ApiManagement/service/apis-Ressource zu erstellen, fügen Sie der Vorlage den folgenden JSON-Code hinzu.

{
  "type": "Microsoft.ApiManagement/service/apis",
  "apiVersion": "2023-03-01-preview",
  "name": "string",
  "properties": {
    "apiRevision": "string",
    "apiRevisionDescription": "string",
    "apiType": "string",
    "apiVersion": "string",
    "apiVersionDescription": "string",
    "apiVersionSet": {
      "description": "string",
      "id": "string",
      "name": "string",
      "versionHeaderName": "string",
      "versioningScheme": "string",
      "versionQueryName": "string"
    },
    "apiVersionSetId": "string",
    "authenticationSettings": {
      "oAuth2": {
        "authorizationServerId": "string",
        "scope": "string"
      },
      "oAuth2AuthenticationSettings": [
        {
          "authorizationServerId": "string",
          "scope": "string"
        }
      ],
      "openid": {
        "bearerTokenSendingMethods": [ "string" ],
        "openidProviderId": "string"
      },
      "openidAuthenticationSettings": [
        {
          "bearerTokenSendingMethods": [ "string" ],
          "openidProviderId": "string"
        }
      ]
    },
    "contact": {
      "email": "string",
      "name": "string",
      "url": "string"
    },
    "description": "string",
    "displayName": "string",
    "format": "string",
    "isCurrent": "bool",
    "license": {
      "name": "string",
      "url": "string"
    },
    "path": "string",
    "protocols": [ "string" ],
    "serviceUrl": "string",
    "sourceApiId": "string",
    "subscriptionKeyParameterNames": {
      "header": "string",
      "query": "string"
    },
    "subscriptionRequired": "bool",
    "termsOfServiceUrl": "string",
    "translateRequiredQueryParameters": "string",
    "type": "string",
    "value": "string",
    "wsdlSelector": {
      "wsdlEndpointName": "string",
      "wsdlServiceName": "string"
    }
  }
}

Eigenschaftswerte

service/apis

Name	BESCHREIBUNG	Wert
type	Der Ressourcentyp	"Microsoft.ApiManagement/service/apis"
apiVersion	Die Version der Ressourcen-API	"2023-03-01-preview"
name	Der Ressourcenname Weitere Informationen finden Sie unter Festlegen von Namen und Typen für untergeordnete Ressourcen in JSON-ARM-Vorlagen.	Zeichenfolge (erforderlich) Zeichenlimit: 1-80 Gültige Zeichen: Alphanumerische Zeichen und Bindestriche. Muss mit einem Buchstaben beginnen und mit einem alphanumerischen Zeichen enden.
properties	Erstellen von API-Entitäten von Updateeigenschaften.	ApiCreateOrUpdatePropertiesOrApiContractProperties

ApiCreateOrUpdatePropertiesOrApiContractProperties

Name	BESCHREIBUNG	Wert
apiRevision	Beschreibt die Überarbeitung der API. Wenn kein Wert angegeben wird, wird die Standardrevision 1 erstellt.	Zeichenfolge
apiRevisionDescription	Beschreibung der API-Revision.	Zeichenfolge
apiType	Typ der zu erstellenden API. * `http` erstellt eine REST-API * `soap` erstellt eine SOAP-Passthrough-API * `websocket` Erstellt websocket-API * `graphql`erstellt GraphQL-API. In Zukunft können neue Typen hinzugefügt werden.	'graphql' "http" 'odata' "Seife" Websocket
apiVersion	Gibt den Versionsbezeichner der API an, wenn die API versioniert ist.	Zeichenfolge
apiVersionDescription	Beschreibung der API-Version.	Zeichenfolge
apiVersionSet	Versionssatzdetails	ApiVersionSetContractDetails
apiVersionSetId	Ein Ressourcenbezeichner für das zugehörige ApiVersionSet.	Zeichenfolge
authenticationSettings	Sammlung von Authentifizierungseinstellungen, die in dieser API enthalten sind.	AuthenticationSettingsContract
contact	Kontaktinformationen für die API.	ApiContactInformation
description	Beschreibung der API. Kann HTML-Formatierungstags umfassen.	Zeichenfolge
displayName	API-Name. Muss 1 bis 300 Zeichen lang sein.	Zeichenfolge
format	Format des Inhalts, in den die API importiert wird. Neue Formate können in Zukunft hinzugefügt werden	'graphql-link' 'odata' 'odata-link' "openapi" "openapi+json" "openapi+json-link" "openapi-link" 'swagger-json' 'swagger-link-json' 'wadl-link-json' 'wadl-xml' 'wsdl' 'wsdl-link'
isCurrent	Gibt an, ob die API-Revision die aktuelle API-Revision ist.	bool
license	Lizenzinformationen für die API.	ApiLicenseInformation
path	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.	Zeichenfolge (erforderlich)
protocols	Beschreibt, über welche Protokolle die Vorgänge in dieser API aufgerufen werden können.	Zeichenfolgenarray, das folgendes enthält: "http" "https" "ws" 'wss'
serviceUrl	Absolute URL des Back-End-Diensts, der diese API implementiert. Darf nicht mehr als 2000 Zeichen lang sein.	Zeichenfolge
sourceApiId	API-Bezeichner der Quell-API.	Zeichenfolge
subscriptionKeyParameterNames	Protokolle, für die die API verfügbar gemacht wird.	SubscriptionKeyParameterNamesContract
subscriptionRequired	Gibt an, ob ein API- oder Produktabonnement für den Zugriff auf die API erforderlich ist.	bool
termsOfServiceUrl	Eine URL zu den Nutzungsbedingungen für die API. MUSS im Format einer URL vorliegen.	Zeichenfolge
translateRequiredQueryParameters	Strategie der Übersetzung erforderlicher Abfrageparameter in Vorlagenparameter. Standardmäßig hat der Wert "template". Mögliche Werte: "template", "query"	"Abfrage" "Vorlage"
Typ	Art der API.	'graphql' "http" 'odata' "Seife" Websocket
value	Inhaltswert beim Importieren einer API.	Zeichenfolge
wsdlSelector	Kriterien, um den Import von WSDL auf eine Teilmenge des Dokuments zu beschränken.	ApiCreateOrUpdatePropertiesWsdlSelector

ApiVersionSetContractDetails

Name	BESCHREIBUNG	Wert
description	Beschreibung des API-Versionssatzes.	Zeichenfolge
id	Bezeichner für vorhandene API-Versionssätze. Lassen Sie diesen Wert weg, um einen neuen Versionssatz zu erstellen.	Zeichenfolge
name	Der Anzeigename des API-Versionssatzes.	Zeichenfolge
versionHeaderName	Name des HTTP-Headerparameters, der die API-Version angibt, wenn versioningScheme auf `header`festgelegt ist.	Zeichenfolge
versionsverwaltungScheme	Ein Wert, der bestimmt, wo sich der API-Versionsbezeichner in einer HTTP-Anforderung befindet.	"Header" "Abfrage" "Segment"
versionQueryName	Name des Abfrageparameters, der die API-Version angibt, wenn versioningScheme auf `query`festgelegt ist.	Zeichenfolge

AuthenticationSettingsContract

Name	BESCHREIBUNG	Wert
oAuth2	OAuth2-Authentifizierungseinstellungen	OAuth2AuthenticationSettingsContract
oAuth2AuthenticationSettings	Sammlung von OAuth2-Authentifizierungseinstellungen, die in dieser API enthalten sind.	OAuth2AuthenticationSettingsContract[]
openid	OpenID Connect-Authentifizierungseinstellungen	OpenIdAuthenticationSettingsContract
openidAuthenticationSettings	Sammlung von Open ID Connect-Authentifizierungseinstellungen, die in dieser API enthalten sind.	OpenIdAuthenticationSettingsContract[]

OAuth2AuthenticationSettingsContract

Name	BESCHREIBUNG	Wert
authorizationServerId	Bezeichner (ID) des OAuth-Autorisierungsservers.	Zeichenfolge
scope	Operations-Bereich.	Zeichenfolge

OpenIdAuthenticationSettingsContract

Name	BESCHREIBUNG	Wert
bearerTokenSendingMethods	So senden Sie ein Token an den Server.	Zeichenfolgenarray, das folgendes enthält: 'authorizationHeader' "Abfrage"
openidProviderId	Bezeichner (ID) des OAuth-Autorisierungsservers.	Zeichenfolge

ApiContactInformation

Name	BESCHREIBUNG	Wert
email	Die E-Mail-Adresse des Ansprechpartners/organization. MUSS im Format einer E-Mail-Adresse vorliegen	Zeichenfolge
name	Der identifizierende Name der Kontaktperson/organization	Zeichenfolge
url	Die URL, die auf die Kontaktinformationen verweist. MUSS im Format einer URL vorliegen	Zeichenfolge

ApiLicenseInformation

Name	BESCHREIBUNG	Wert
name	Der für die API verwendete Lizenzname	Zeichenfolge
url	Eine URL für die Lizenz, die für die API verwendet wird. MUSS im Format einer URL vorliegen	Zeichenfolge

SubscriptionKeyParameterNamesContract

Name	BESCHREIBUNG	Wert
header	Name des Abonnementschlüsselheaders.	Zeichenfolge
Abfrage	Name des Abonnementschlüsselabfragezeichenfolgenparameters.	Zeichenfolge

ApiCreateOrUpdatePropertiesWsdlSelector

Name	BESCHREIBUNG	Wert
wsdlEndpointName	Name des Endpunkts (Port), der aus WSDL importiert werden soll	Zeichenfolge
wsdlServiceName	Name des Diensts, der aus WSDL importiert werden soll	Zeichenfolge

Schnellstartvorlagen

Diesen Ressourcentyp werden in den folgenden Schnellstartvorlagen bereitgestellt.

Vorlage	BESCHREIBUNG
Erstellen einer API Management-Instanz und aller Unterressourcen mithilfe einer Vorlage	Diese Vorlage veranschaulicht, wie Sie einen API Management Dienst erstellen und Unterentitäten konfigurieren.
Erstellen von Azure Front Door vor Azure API Management	In diesem Beispiel wird veranschaulicht, wie Sie Azure Front Door als globalen Lastenausgleich vor Azure API Management verwenden.

Terraform (AzAPI-Anbieter) Ressourcendefinition

Der Ressourcentyp dienst/apis kann mit Vorgängen bereitgestellt werden, die Folgendes zum Ziel haben:

Ressourcengruppen

Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie unter Änderungsprotokoll.

Ressourcenformat

Um eine Microsoft.ApiManagement/service/apis-Ressource zu erstellen, fügen Sie Der Vorlage die folgende Terraform-Ressource hinzu.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service/apis@2023-03-01-preview"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      apiRevision = "string"
      apiRevisionDescription = "string"
      apiType = "string"
      apiVersion = "string"
      apiVersionDescription = "string"
      apiVersionSet = {
        description = "string"
        id = "string"
        name = "string"
        versionHeaderName = "string"
        versioningScheme = "string"
        versionQueryName = "string"
      }
      apiVersionSetId = "string"
      authenticationSettings = {
        oAuth2 = {
          authorizationServerId = "string"
          scope = "string"
        }
        oAuth2AuthenticationSettings = [
          {
            authorizationServerId = "string"
            scope = "string"
          }
        ]
        openid = {
          bearerTokenSendingMethods = [
            "string"
          ]
          openidProviderId = "string"
        }
        openidAuthenticationSettings = [
          {
            bearerTokenSendingMethods = [
              "string"
            ]
            openidProviderId = "string"
          }
        ]
      }
      contact = {
        email = "string"
        name = "string"
        url = "string"
      }
      description = "string"
      displayName = "string"
      format = "string"
      isCurrent = bool
      license = {
        name = "string"
        url = "string"
      }
      path = "string"
      protocols = [
        "string"
      ]
      serviceUrl = "string"
      sourceApiId = "string"
      subscriptionKeyParameterNames = {
        header = "string"
        query = "string"
      }
      subscriptionRequired = bool
      termsOfServiceUrl = "string"
      translateRequiredQueryParameters = "string"
      type = "string"
      value = "string"
      wsdlSelector = {
        wsdlEndpointName = "string"
        wsdlServiceName = "string"
      }
    }
  })
}

Eigenschaftswerte

service/apis

Name	BESCHREIBUNG	Wert
type	Ressourcentyp	"Microsoft.ApiManagement/service/apis@2023-03-01-preview"
name	Der Ressourcenname	Zeichenfolge (erforderlich) Zeichenlimit: 1-80 Gültige Zeichen: Alphanumerische Zeichen und Bindestriche. Muss mit einem Buchstaben beginnen und mit einem alphanumerischen Zeichen enden.
parent_id	Die ID der Ressource, die die übergeordnete Ressource für diese Ressource ist.	ID für Ressource vom Typ: Dienst
properties	Erstellen von API-Entitäten von Updateeigenschaften.	ApiCreateOrUpdatePropertiesOrApiContractProperties

ApiCreateOrUpdatePropertiesOrApiContractProperties

Name	BESCHREIBUNG	Wert
apiRevision	Beschreibt die Überarbeitung der API. Wenn kein Wert angegeben wird, wird die Standardrevision 1 erstellt.	Zeichenfolge
apiRevisionDescription	Beschreibung der API-Revision.	Zeichenfolge
apiType	Typ der zu erstellenden API. * `http` erstellt eine REST-API * `soap` erstellt eine SOAP-Passthrough-API * `websocket` Erstellt websocket-API * `graphql`erstellt GraphQL-API. In Zukunft können neue Typen hinzugefügt werden.	"graphql" "http" "odata" "Seife" "Websocket"
apiVersion	Gibt den Versionsbezeichner der API an, wenn die API versioniert ist.	Zeichenfolge
apiVersionDescription	Beschreibung der API-Version.	Zeichenfolge
apiVersionSet	Versionssatzdetails	ApiVersionSetContractDetails
apiVersionSetId	Ein Ressourcenbezeichner für das zugehörige ApiVersionSet.	Zeichenfolge
authenticationSettings	Sammlung von Authentifizierungseinstellungen, die in dieser API enthalten sind.	AuthenticationSettingsContract
contact	Kontaktinformationen für die API.	ApiContactInformation
description	Beschreibung der API. Kann HTML-Formatierungstags umfassen.	Zeichenfolge
displayName	API-Name. Muss 1 bis 300 Zeichen lang sein.	Zeichenfolge
format	Format des Inhalts, in den die API importiert wird. Neue Formate können in Zukunft hinzugefügt werden	"graphql-link" "odata" "odata-link" "openapi" "openapi+json" "openapi+json-link" "openapi-link" "swagger-json" "swagger-link-json" "wadl-link-json" "wadl-xml" "wsdl" "wsdl-link"
isCurrent	Gibt an, ob die API-Revision die aktuelle API-Revision ist.	bool
license	Lizenzinformationen für die API.	ApiLicenseInformation
path	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.	Zeichenfolge (erforderlich)
protocols	Beschreibt, über welche Protokolle die Vorgänge in dieser API aufgerufen werden können.	Zeichenfolgenarray, das folgendes enthält: "http" "https" "ws" "wss"
serviceUrl	Absolute URL des Back-End-Diensts, der diese API implementiert. Darf nicht mehr als 2000 Zeichen lang sein.	Zeichenfolge
sourceApiId	API-Bezeichner der Quell-API.	Zeichenfolge
subscriptionKeyParameterNames	Protokolle, für die die API verfügbar gemacht wird.	SubscriptionKeyParameterNamesContract
subscriptionRequired	Gibt an, ob ein API- oder Produktabonnement für den Zugriff auf die API erforderlich ist.	bool
termsOfServiceUrl	Eine URL zu den Nutzungsbedingungen für die API. MUSS im Format einer URL vorliegen.	Zeichenfolge
translateRequiredQueryParameters	Strategie der Übersetzung erforderlicher Abfrageparameter in Vorlagenparameter. Standardmäßig hat der Wert "template". Mögliche Werte: "template", "query"	„query“ "Vorlage"
Typ	Art der API.	"graphql" "http" "odata" "Seife" "Websocket"
value	Inhaltswert beim Importieren einer API.	Zeichenfolge
wsdlSelector	Kriterien, um den Import von WSDL auf eine Teilmenge des Dokuments zu beschränken.	ApiCreateOrUpdatePropertiesWsdlSelector

ApiVersionSetContractDetails

Name	BESCHREIBUNG	Wert
description	Beschreibung des API-Versionssatzes.	Zeichenfolge
id	Bezeichner für vorhandene API-Versionssätze. Lassen Sie diesen Wert weg, um einen neuen Versionssatz zu erstellen.	Zeichenfolge
name	Der Anzeigename des API-Versionssatzes.	Zeichenfolge
versionHeaderName	Name des HTTP-Headerparameters, der die API-Version angibt, wenn versioningScheme auf `header`festgelegt ist.	Zeichenfolge
versionsverwaltungScheme	Ein -Wert, der bestimmt, wo sich der API-Versionsbezeichner in einer HTTP-Anforderung befindet.	„Header“ "Abfrage" "Segment"
versionQueryName	Name des Abfrageparameters, der die API-Version angibt, wenn versioningScheme auf `query`festgelegt ist.	Zeichenfolge

AuthenticationSettingsContract

Name	BESCHREIBUNG	Wert
oAuth2	OAuth2-Authentifizierungseinstellungen	OAuth2AuthenticationSettingsContract
oAuth2AuthenticationSettings	Sammlung der OAuth2-Authentifizierungseinstellungen, die in dieser API enthalten sind.	OAuth2AuthenticationSettingsContract[]
openid	OpenID Connect-Authentifizierungseinstellungen	OpenIdAuthenticationSettingsContract
openidAuthenticationSettings	Sammlung der Open ID Connect-Authentifizierungseinstellungen, die in dieser API enthalten sind.	OpenIdAuthenticationSettingsContract[]

OAuth2AuthenticationSettingsContract

Name	BESCHREIBUNG	Wert
authorizationServerId	Bezeichner (ID) des OAuth-Autorisierungsservers.	Zeichenfolge
scope	Operations-Bereich.	Zeichenfolge

OpenIdAuthenticationSettingsContract

Name	BESCHREIBUNG	Wert
bearerTokenSendingMethods	So senden Sie ein Token an den Server.	Zeichenfolgenarray, das eines der folgenden Elemente enthält: "authorizationHeader" „query“
openidProviderId	Bezeichner (ID) des OAuth-Autorisierungsservers.	Zeichenfolge

ApiContactInformation

Name	BESCHREIBUNG	Wert
email	Die E-Mail-Adresse der Kontaktperson/organization. MUSS im Format einer E-Mail-Adresse vorliegen.	Zeichenfolge
name	Der identifizierende Name der Kontaktperson/organization	Zeichenfolge
url	Die URL, die auf die Kontaktinformationen verweist. MUSS im Format einer URL vorliegen.	Zeichenfolge

ApiLicenseInformation

Name	BESCHREIBUNG	Wert
name	Der für die API verwendete Lizenzname.	Zeichenfolge
url	Eine URL zur Lizenz, die für die API verwendet wird. MUSS im Format einer URL vorliegen.	Zeichenfolge

SubscriptionKeyParameterNamesContract

Name	BESCHREIBUNG	Wert
header	Name des Abonnementschlüsselheaders.	Zeichenfolge
Abfrage	Name der Abonnementschlüsselabfragezeichenfolge.	Zeichenfolge

ApiCreateOrUpdatePropertiesWsdlSelector

Name	BESCHREIBUNG	Wert
wsdlEndpointName	Name des Endpunkts (Port), der aus WSDL importiert werden soll	Zeichenfolge
wsdlServiceName	Name des Diensts, der aus WSDL importiert werden soll	Zeichenfolge

Share via

Microsoft.ApiManagement service/apis 2023-03-01-preview

Bicep-Ressourcendefinition

Ressourcenformat

Eigenschaftswerte

service/apis

ApiCreateOrUpdatePropertiesOrApiContractProperties

ApiVersionSetContractDetails

AuthenticationSettingsContract

OAuth2AuthenticationSettingsContract

OpenIdAuthenticationSettingsContract

ApiContactInformation

ApiLicenseInformation

SubscriptionKeyParameterNamesContract

ApiCreateOrUpdatePropertiesWsdlSelector

Schnellstartvorlagen

Ressourcendefinition mit einer ARM-Vorlage

Ressourcenformat

Eigenschaftswerte

service/apis

ApiCreateOrUpdatePropertiesOrApiContractProperties

ApiVersionSetContractDetails

AuthenticationSettingsContract

OAuth2AuthenticationSettingsContract

OpenIdAuthenticationSettingsContract

ApiContactInformation

ApiLicenseInformation

SubscriptionKeyParameterNamesContract

ApiCreateOrUpdatePropertiesWsdlSelector

Schnellstartvorlagen

Terraform (AzAPI-Anbieter) Ressourcendefinition

Ressourcenformat

Eigenschaftswerte

service/apis

ApiCreateOrUpdatePropertiesOrApiContractProperties

ApiVersionSetContractDetails

AuthenticationSettingsContract

OAuth2AuthenticationSettingsContract

OpenIdAuthenticationSettingsContract

ApiContactInformation

ApiLicenseInformation

SubscriptionKeyParameterNamesContract

ApiCreateOrUpdatePropertiesWsdlSelector

Zusätzliche Ressourcen