Microsoft.ApiManagement service/apis 2022-08-01
Bicep-Ressourcendefinition
Der Ressourcentyp "Service/APIs" kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:
- Ressourcengruppen – Siehe Ressourcengruppenbereitstellungsbefehle
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 Ihrer Vorlage den folgenden Bicep hinzu.
resource symbolicname 'Microsoft.ApiManagement/service/apis@2022-08-01' = {
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 Erfahren Sie, wie Sie Namen und Typen für untergeordnete Ressourcen in Bicep-festlegen. |
Zeichenfolge (erforderlich) Zeichenlimit: 1-80 Gültige Zeichen: Alphanumerische und Bindestriche. Beginnen Sie mit Buchstaben und enden Sie mit alphanumerisch. |
| Elternteil | 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 des Typs: Dienst- |
| Eigenschaften | 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. | Schnur Zwänge: Min. Länge = 1 Max. Länge = 100 |
| apiRevisionDescription | Beschreibung der API-Revision. | Schnur Zwänge: Maximale Länge = 256 |
| apiType | Typ der zu erstellenden API. * http erstellt eine REST-API * soap erstellt eine SOAP-Pass-Through-API * websocket erstellt websocket-API * graphql erstellt die GraphQL-API. |
'graphql' ' http'"Soap" 'websocket' |
| apiVersion | Gibt den Versionsbezeichner der API an, wenn die API versioniert ist. | Schnur Zwänge: Max. Länge = 100 |
| apiVersionDescription | Beschreibung der API-Version. | Schnur Zwänge: Maximale Länge = 256 |
| apiVersionSet | Versionssatzdetails | ApiVersionSetContractDetails |
| apiVersionSetId | Ein Ressourcenbezeichner für das zugehörige ApiVersionSet. | Schnur |
| authenticationSettings | Sammlung von Authentifizierungseinstellungen, die in dieser API enthalten sind. | AuthenticationSettingsContract- |
| Kontakt | Kontaktinformationen für die API. | ApiContactInformation- |
| Beschreibung | Beschreibung der API. Kann HTML-Formatierungstags enthalten. | Schnur |
| displayName | API-Name. Muss 1 bis 300 Zeichen lang sein. | Schnur Zwänge: Min. Länge = 1 Max. Länge = 300 |
| Format | Format des Inhalts, in dem die API importiert wird. | 'graphql-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 |
| Lizenz | Lizenzinformationen für die API. | ApiLicenseInformation- |
| Pfad | Relative URL identifiziert diese API und alle zugehörigen Ressourcenpfade innerhalb der API-Verwaltungsdienstinstanz eindeutig. Sie wird an die API-Endpunktbasis-URL angefügt, die während der Erstellung der Dienstinstanz angegeben wurde, um eine öffentliche URL für diese API zu bilden. | Zeichenfolge (erforderlich) Zwänge: Max. Länge = 400 |
| Protokolle | Beschreibt, welche Protokolle die Vorgänge in dieser API aufrufen können. | Zeichenfolgenarray, das eine der folgenden Elemente enthält: ' http'' https''ws' 'wss' |
| serviceUrl | Absolute URL des Back-End-Diensts, der diese API implementiert. Maximal 2000 Zeichen lang. | Schnur Zwänge: Maximale Länge = 2000 |
| sourceApiId | API-ID der Quell-API. | Schnur |
| subscriptionKeyParameterNames | Protokolle, über die API verfügbar gemacht wird. | SubscriptionKeyParameterNamesContract |
| subscriptionRequired | Gibt an, ob für den Zugriff auf die API ein API- oder Produktabonnement erforderlich ist. | Bool |
| termsOfServiceUrl | Eine URL zu den Nutzungsbedingungen für die API. MUSS im Format einer URL vorliegen. | Schnur |
| translateRequiredQueryParameters | Strategie der Übersetzung erforderlicher Abfrageparameter in Vorlagen. Standardmäßig hat der Wert 'template'. Mögliche Werte: 'template', 'query' | 'Abfrage' 'Vorlage' |
| Art | API-Typ. | 'graphql' ' http'"Soap" 'websocket' |
| Wert | Inhaltswert beim Importieren einer API. | Schnur |
| wsdlSelector | Kriterien zum Einschränken des Imports von WSDL in eine Teilmenge des Dokuments. | ApiCreateOrUpdatePropertiesWsdlSelector |
ApiVersionSetContractDetails
| Name | Beschreibung | Wert |
|---|---|---|
| Beschreibung | Beschreibung des API-Versionssatzes. | Schnur |
| id | Bezeichner für vorhandene API-Versionssatz. Lassen Sie diesen Wert aus, um einen neuen Versionssatz zu erstellen. | Schnur |
| Name | Der Anzeigename des API-Versionssatzes. | Schnur |
| versionHeaderName | Name des HTTP-Headerparameters, der die API-Version angibt, wenn versioningScheme auf headerfestgelegt ist. |
Schnur |
| versioningScheme | Ein Wert, der bestimmt, wo sich der API-Versionsbezeichner in einer HTTP-Anforderung befindet. | 'Kopfzeile' 'Abfrage' "Segment" |
| versionQueryName | Name des Abfrageparameters, der die API-Version angibt, wenn versioningScheme auf queryfestgelegt ist. |
Schnur |
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 in dieser API enthaltenen Open ID Connect-Authentifizierungseinstellungen. | OpenIdAuthenticationSettingsContract[] |
OAuth2AuthenticationSettingsContract
| Name | Beschreibung | Wert |
|---|---|---|
| authorizationServerId | OAuth-Autorisierungsserverbezeichner. | Schnur |
| Umfang | operations scope. | Schnur |
OpenIdAuthenticationSettingsContract
| Name | Beschreibung | Wert |
|---|---|---|
| bearerTokenSendingMethods | So senden Sie token an den Server. | Zeichenfolgenarray, das eine der folgenden Elemente enthält: "authorizationHeader" 'Abfrage' |
| openidProviderId | OAuth-Autorisierungsserverbezeichner. | Schnur |
ApiContactInformation
| Name | Beschreibung | Wert |
|---|---|---|
| Die E-Mail-Adresse der Kontaktperson/Organisation. MUSS im Format einer E-Mail-Adresse vorliegen | Schnur | |
| Name | Der Identifizierungsname der Kontaktperson/Organisation | Schnur |
| URL | Die URL, die auf die Kontaktinformationen verweist. MUSS im Format einer URL vorliegen | Schnur |
ApiLicenseInformation
| Name | Beschreibung | Wert |
|---|---|---|
| Name | Der für die API verwendete Lizenzname | Schnur |
| URL | Eine URL zu der lizenz, die für die API verwendet wird. MUSS im Format einer URL vorliegen | Schnur |
SubscriptionKeyParameterNamesContract
| Name | Beschreibung | Wert |
|---|---|---|
| Kopfball | Name des Abonnementschlüsselheaders. | Schnur |
| Frage | Name des Zeichenfolgenparameters der Abonnementschlüsselabfrage. | Schnur |
ApiCreateOrUpdatePropertiesWsdlSelector
| Name | Beschreibung | Wert |
|---|---|---|
| wsdlEndpointName | Name des zu importierenden Endpunkts(Port) aus WSDL | Schnur |
| wsdlServiceName | Name des Diensts, der aus WSDL importiert werden soll | Schnur |
Schnellstartvorlagen
Die folgenden Schnellstartvorlagen stellen diesen Ressourcentyp bereit.
| Schablone | Beschreibung |
|---|---|
Erstellen einer API-Verwaltungsinstanz und aller Unterressourcen mithilfe von Vorlagen
|
Diese Vorlage veranschaulicht, wie Sie einen API-Verwaltungsdienst erstellen und Unterentitäten konfigurieren. |
|
Erstellen von Azure Front Door vor der Azure API Management-
|
In diesem Beispiel wird die Verwendung von Azure Front Door als globaler Lastenausgleich vor der Azure-API-Verwaltung veranschaulicht. |
ARM-Vorlagenressourcendefinition
Der Ressourcentyp "Service/APIs" kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:
- Ressourcengruppen – Siehe Ressourcengruppenbereitstellungsbefehle
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 den folgenden JSON-Code hinzu.
{
"type": "Microsoft.ApiManagement/service/apis",
"apiVersion": "2022-08-01",
"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 |
|---|---|---|
| Art | Der Ressourcentyp | 'Microsoft.ApiManagement/service/apis' |
| apiVersion | Die Ressourcen-API-Version | '2022-08-01' |
| Name | Der Ressourcenname Erfahren Sie, wie Sie Namen und Typen für untergeordnete Ressourcen in JSON ARM-Vorlagenfestlegen. |
Zeichenfolge (erforderlich) Zeichenlimit: 1-80 Gültige Zeichen: Alphanumerische und Bindestriche. Beginnen Sie mit Buchstaben und enden Sie mit alphanumerisch. |
| Eigenschaften | 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. | Schnur Zwänge: Min. Länge = 1 Max. Länge = 100 |
| apiRevisionDescription | Beschreibung der API-Revision. | Schnur Zwänge: Maximale Länge = 256 |
| apiType | Typ der zu erstellenden API. * http erstellt eine REST-API * soap erstellt eine SOAP-Pass-Through-API * websocket erstellt websocket-API * graphql erstellt die GraphQL-API. |
'graphql' ' http'"Soap" 'websocket' |
| apiVersion | Gibt den Versionsbezeichner der API an, wenn die API versioniert ist. | Schnur Zwänge: Max. Länge = 100 |
| apiVersionDescription | Beschreibung der API-Version. | Schnur Zwänge: Maximale Länge = 256 |
| apiVersionSet | Versionssatzdetails | ApiVersionSetContractDetails |
| apiVersionSetId | Ein Ressourcenbezeichner für das zugehörige ApiVersionSet. | Schnur |
| authenticationSettings | Sammlung von Authentifizierungseinstellungen, die in dieser API enthalten sind. | AuthenticationSettingsContract- |
| Kontakt | Kontaktinformationen für die API. | ApiContactInformation- |
| Beschreibung | Beschreibung der API. Kann HTML-Formatierungstags enthalten. | Schnur |
| displayName | API-Name. Muss 1 bis 300 Zeichen lang sein. | Schnur Zwänge: Min. Länge = 1 Max. Länge = 300 |
| Format | Format des Inhalts, in dem die API importiert wird. | 'graphql-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 |
| Lizenz | Lizenzinformationen für die API. | ApiLicenseInformation- |
| Pfad | Relative URL identifiziert diese API und alle zugehörigen Ressourcenpfade innerhalb der API-Verwaltungsdienstinstanz eindeutig. Sie wird an die API-Endpunktbasis-URL angefügt, die während der Erstellung der Dienstinstanz angegeben wurde, um eine öffentliche URL für diese API zu bilden. | Zeichenfolge (erforderlich) Zwänge: Max. Länge = 400 |
| Protokolle | Beschreibt, welche Protokolle die Vorgänge in dieser API aufrufen können. | Zeichenfolgenarray, das eine der folgenden Elemente enthält: ' http'' https''ws' 'wss' |
| serviceUrl | Absolute URL des Back-End-Diensts, der diese API implementiert. Maximal 2000 Zeichen lang. | Schnur Zwänge: Maximale Länge = 2000 |
| sourceApiId | API-ID der Quell-API. | Schnur |
| subscriptionKeyParameterNames | Protokolle, über die API verfügbar gemacht wird. | SubscriptionKeyParameterNamesContract |
| subscriptionRequired | Gibt an, ob für den Zugriff auf die API ein API- oder Produktabonnement erforderlich ist. | Bool |
| termsOfServiceUrl | Eine URL zu den Nutzungsbedingungen für die API. MUSS im Format einer URL vorliegen. | Schnur |
| translateRequiredQueryParameters | Strategie der Übersetzung erforderlicher Abfrageparameter in Vorlagen. Standardmäßig hat der Wert 'template'. Mögliche Werte: 'template', 'query' | 'Abfrage' 'Vorlage' |
| Art | API-Typ. | 'graphql' ' http'"Soap" 'websocket' |
| Wert | Inhaltswert beim Importieren einer API. | Schnur |
| wsdlSelector | Kriterien zum Einschränken des Imports von WSDL in eine Teilmenge des Dokuments. | ApiCreateOrUpdatePropertiesWsdlSelector |
ApiVersionSetContractDetails
| Name | Beschreibung | Wert |
|---|---|---|
| Beschreibung | Beschreibung des API-Versionssatzes. | Schnur |
| id | Bezeichner für vorhandene API-Versionssatz. Lassen Sie diesen Wert aus, um einen neuen Versionssatz zu erstellen. | Schnur |
| Name | Der Anzeigename des API-Versionssatzes. | Schnur |
| versionHeaderName | Name des HTTP-Headerparameters, der die API-Version angibt, wenn versioningScheme auf headerfestgelegt ist. |
Schnur |
| versioningScheme | Ein Wert, der bestimmt, wo sich der API-Versionsbezeichner in einer HTTP-Anforderung befindet. | 'Kopfzeile' 'Abfrage' "Segment" |
| versionQueryName | Name des Abfrageparameters, der die API-Version angibt, wenn versioningScheme auf queryfestgelegt ist. |
Schnur |
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 in dieser API enthaltenen Open ID Connect-Authentifizierungseinstellungen. | OpenIdAuthenticationSettingsContract[] |
OAuth2AuthenticationSettingsContract
| Name | Beschreibung | Wert |
|---|---|---|
| authorizationServerId | OAuth-Autorisierungsserverbezeichner. | Schnur |
| Umfang | operations scope. | Schnur |
OpenIdAuthenticationSettingsContract
| Name | Beschreibung | Wert |
|---|---|---|
| bearerTokenSendingMethods | So senden Sie token an den Server. | Zeichenfolgenarray, das eine der folgenden Elemente enthält: "authorizationHeader" 'Abfrage' |
| openidProviderId | OAuth-Autorisierungsserverbezeichner. | Schnur |
ApiContactInformation
| Name | Beschreibung | Wert |
|---|---|---|
| Die E-Mail-Adresse der Kontaktperson/Organisation. MUSS im Format einer E-Mail-Adresse vorliegen | Schnur | |
| Name | Der Identifizierungsname der Kontaktperson/Organisation | Schnur |
| URL | Die URL, die auf die Kontaktinformationen verweist. MUSS im Format einer URL vorliegen | Schnur |
ApiLicenseInformation
| Name | Beschreibung | Wert |
|---|---|---|
| Name | Der für die API verwendete Lizenzname | Schnur |
| URL | Eine URL zu der lizenz, die für die API verwendet wird. MUSS im Format einer URL vorliegen | Schnur |
SubscriptionKeyParameterNamesContract
| Name | Beschreibung | Wert |
|---|---|---|
| Kopfball | Name des Abonnementschlüsselheaders. | Schnur |
| Frage | Name des Zeichenfolgenparameters der Abonnementschlüsselabfrage. | Schnur |
ApiCreateOrUpdatePropertiesWsdlSelector
| Name | Beschreibung | Wert |
|---|---|---|
| wsdlEndpointName | Name des zu importierenden Endpunkts(Port) aus WSDL | Schnur |
| wsdlServiceName | Name des Diensts, der aus WSDL importiert werden soll | Schnur |
Schnellstartvorlagen
Die folgenden Schnellstartvorlagen stellen diesen Ressourcentyp bereit.
| Schablone | Beschreibung |
|---|---|
|
Erstellen einer API-Verwaltungsinstanz und aller Unterressourcen mithilfe von Vorlagen
|
Diese Vorlage veranschaulicht, wie Sie einen API-Verwaltungsdienst erstellen und Unterentitäten konfigurieren. |
|
Erstellen von Azure Front Door vor der Azure API Management-
|
In diesem Beispiel wird die Verwendung von Azure Front Door als globaler Lastenausgleich vor der Azure-API-Verwaltung veranschaulicht. |
Terraform -Ressourcendefinition (AzAPI-Anbieter)
Der Ressourcentyp "Service/APIs" kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:
- 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 Ihrer Vorlage die folgende Terraform hinzu.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.ApiManagement/service/apis@2022-08-01"
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 |
|---|---|---|
| Art | Der Ressourcentyp | "Microsoft.ApiManagement/service/apis@2022-08-01" |
| Name | Der Ressourcenname | Zeichenfolge (erforderlich) Zeichenlimit: 1-80 Gültige Zeichen: Alphanumerische und Bindestriche. Beginnen Sie mit Buchstaben und enden Sie mit alphanumerisch. |
| parent_id | Die ID der Ressource, die das übergeordnete Element für diese Ressource ist. | ID für Ressource des Typs: Dienst- |
| Eigenschaften | 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. | Schnur Zwänge: Min. Länge = 1 Max. Länge = 100 |
| apiRevisionDescription | Beschreibung der API-Revision. | Schnur Zwänge: Maximale Länge = 256 |
| apiType | Typ der zu erstellenden API. * http erstellt eine REST-API * soap erstellt eine SOAP-Pass-Through-API * websocket erstellt websocket-API * graphql erstellt die GraphQL-API. |
"graphql" " http""Soap" "websocket" |
| apiVersion | Gibt den Versionsbezeichner der API an, wenn die API versioniert ist. | Schnur Zwänge: Max. Länge = 100 |
| apiVersionDescription | Beschreibung der API-Version. | Schnur Zwänge: Maximale Länge = 256 |
| apiVersionSet | Versionssatzdetails | ApiVersionSetContractDetails |
| apiVersionSetId | Ein Ressourcenbezeichner für das zugehörige ApiVersionSet. | Schnur |
| authenticationSettings | Sammlung von Authentifizierungseinstellungen, die in dieser API enthalten sind. | AuthenticationSettingsContract- |
| Kontakt | Kontaktinformationen für die API. | ApiContactInformation- |
| Beschreibung | Beschreibung der API. Kann HTML-Formatierungstags enthalten. | Schnur |
| displayName | API-Name. Muss 1 bis 300 Zeichen lang sein. | Schnur Zwänge: Min. Länge = 1 Max. Länge = 300 |
| Format | Format des Inhalts, in dem die API importiert wird. | "graphql-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 |
| Lizenz | Lizenzinformationen für die API. | ApiLicenseInformation- |
| Pfad | Relative URL identifiziert diese API und alle zugehörigen Ressourcenpfade innerhalb der API-Verwaltungsdienstinstanz eindeutig. Sie wird an die API-Endpunktbasis-URL angefügt, die während der Erstellung der Dienstinstanz angegeben wurde, um eine öffentliche URL für diese API zu bilden. | Zeichenfolge (erforderlich) Zwänge: Max. Länge = 400 |
| Protokolle | Beschreibt, welche Protokolle die Vorgänge in dieser API aufrufen können. | Zeichenfolgenarray, das eine der folgenden Elemente enthält: " http"" https""ws" "wss" |
| serviceUrl | Absolute URL des Back-End-Diensts, der diese API implementiert. Maximal 2000 Zeichen lang. | Schnur Zwänge: Maximale Länge = 2000 |
| sourceApiId | API-ID der Quell-API. | Schnur |
| subscriptionKeyParameterNames | Protokolle, über die API verfügbar gemacht wird. | SubscriptionKeyParameterNamesContract |
| subscriptionRequired | Gibt an, ob für den Zugriff auf die API ein API- oder Produktabonnement erforderlich ist. | Bool |
| termsOfServiceUrl | Eine URL zu den Nutzungsbedingungen für die API. MUSS im Format einer URL vorliegen. | Schnur |
| translateRequiredQueryParameters | Strategie der Übersetzung erforderlicher Abfrageparameter in Vorlagen. Standardmäßig hat der Wert 'template'. Mögliche Werte: 'template', 'query' | "Abfrage" "Vorlage" |
| Art | API-Typ. | "graphql" " http""Soap" "websocket" |
| Wert | Inhaltswert beim Importieren einer API. | Schnur |
| wsdlSelector | Kriterien zum Einschränken des Imports von WSDL in eine Teilmenge des Dokuments. | ApiCreateOrUpdatePropertiesWsdlSelector |
ApiVersionSetContractDetails
| Name | Beschreibung | Wert |
|---|---|---|
| Beschreibung | Beschreibung des API-Versionssatzes. | Schnur |
| id | Bezeichner für vorhandene API-Versionssatz. Lassen Sie diesen Wert aus, um einen neuen Versionssatz zu erstellen. | Schnur |
| Name | Der Anzeigename des API-Versionssatzes. | Schnur |
| versionHeaderName | Name des HTTP-Headerparameters, der die API-Version angibt, wenn versioningScheme auf headerfestgelegt ist. |
Schnur |
| versioningScheme | Ein Wert, der bestimmt, wo sich der API-Versionsbezeichner in einer HTTP-Anforderung befindet. | "Kopfzeile" "Abfrage" "Segment" |
| versionQueryName | Name des Abfrageparameters, der die API-Version angibt, wenn versioningScheme auf queryfestgelegt ist. |
Schnur |
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 in dieser API enthaltenen Open ID Connect-Authentifizierungseinstellungen. | OpenIdAuthenticationSettingsContract[] |
OAuth2AuthenticationSettingsContract
| Name | Beschreibung | Wert |
|---|---|---|
| authorizationServerId | OAuth-Autorisierungsserverbezeichner. | Schnur |
| Umfang | operations scope. | Schnur |
OpenIdAuthenticationSettingsContract
| Name | Beschreibung | Wert |
|---|---|---|
| bearerTokenSendingMethods | So senden Sie token an den Server. | Zeichenfolgenarray, das eine der folgenden Elemente enthält: "authorizationHeader" "Abfrage" |
| openidProviderId | OAuth-Autorisierungsserverbezeichner. | Schnur |
ApiContactInformation
| Name | Beschreibung | Wert |
|---|---|---|
| Die E-Mail-Adresse der Kontaktperson/Organisation. MUSS im Format einer E-Mail-Adresse vorliegen | Schnur | |
| Name | Der Identifizierungsname der Kontaktperson/Organisation | Schnur |
| URL | Die URL, die auf die Kontaktinformationen verweist. MUSS im Format einer URL vorliegen | Schnur |
ApiLicenseInformation
| Name | Beschreibung | Wert |
|---|---|---|
| Name | Der für die API verwendete Lizenzname | Schnur |
| URL | Eine URL zu der lizenz, die für die API verwendet wird. MUSS im Format einer URL vorliegen | Schnur |
SubscriptionKeyParameterNamesContract
| Name | Beschreibung | Wert |
|---|---|---|
| Kopfball | Name des Abonnementschlüsselheaders. | Schnur |
| Frage | Name des Zeichenfolgenparameters der Abonnementschlüsselabfrage. | Schnur |
ApiCreateOrUpdatePropertiesWsdlSelector
| Name | Beschreibung | Wert |
|---|---|---|
| wsdlEndpointName | Name des zu importierenden Endpunkts(Port) aus WSDL | Schnur |
| wsdlServiceName | Name des Diensts, der aus WSDL importiert werden soll | Schnur |
Feedback
Bald verfügbar: Im Laufe des Jahres 2024 werden wir GitHub-Issues stufenweise als Feedbackmechanismus für Inhalte abbauen und durch ein neues Feedbacksystem ersetzen. Weitere Informationen finden Sie unter https://aka.ms/ContentUserFeedback.
Feedback senden und anzeigen für