Microsoft.ApiManagement service/apis 2021-08-01
- neueste
- 2024-06-01-Preview-
- 2024-05-01
- 2023-09-01-Preview-
- 2023-05-01-Preview-
- 2023-03-01-Preview-
- 2022-09-01-Preview-
- 2022-08-01
- 2022-04-01-Vorschau-
- 2021-12-01-Preview-
- 2021-08-01
- 2021-04-01-preview
- 2021-01-01-Preview-
- 2020-12-01
- 2020-06-01-Preview-
- 2019-12-01
- 2019-12-01-Preview-
- 2019-01-01
- 2018-06-01-Preview-
- 2018-01-01
- 2017-03-01
- 2016-10-10
- 2016-07-07
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@2021-08-01' = {
parent: resourceSymbolicName
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'
}
openid: {
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'
type: 'string'
value: 'string'
wsdlSelector: {
wsdlEndpointName: 'string'
wsdlServiceName: 'string'
}
}
}
Eigenschaftswerte
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 |
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 = 1 |
apiRevisionDescription | Beschreibung der API-Revision. | Schnur Zwänge: Max. Länge = |
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 = |
apiVersionDescription | Beschreibung der API-Version. | Schnur Zwänge: Max. Länge = |
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 = 1 |
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. | Schnur Zwänge: Max. Länge = (erforderlich) |
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: Max. Länge = |
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 |
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 |
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 |
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 |
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 header festgelegt 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 query festgelegt ist. |
Schnur |
AuthenticationSettingsContract
Name | Beschreibung | Wert |
---|---|---|
oAuth2 | OAuth2-Authentifizierungseinstellungen | OAuth2AuthenticationSettingsContract |
openid | OpenID Connect-Authentifizierungseinstellungen | OpenIdAuthenticationSettingsContract- |
Microsoft.ApiManagement/service/apis
Name | Beschreibung | Wert |
---|---|---|
Name | Der Ressourcenname | Schnur Zwänge: Min. Länge = 1 Max. Länge = 1 Pattern = ^[^*#&+:<>?]+$ (erforderlich) |
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 |
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 |
SubscriptionKeyParameterNamesContract
Name | Beschreibung | Wert |
---|---|---|
Kopfball | Name des Abonnementschlüsselheaders. | Schnur |
Frage | Name des Zeichenfolgenparameters der Abonnementschlüsselabfrage. | Schnur |
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": "2021-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"
},
"openid": {
"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",
"type": "string",
"value": "string",
"wsdlSelector": {
"wsdlEndpointName": "string",
"wsdlServiceName": "string"
}
}
}
Eigenschaftswerte
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 |
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 = 1 |
apiRevisionDescription | Beschreibung der API-Revision. | Schnur Zwänge: Max. Länge = |
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 = |
apiVersionDescription | Beschreibung der API-Version. | Schnur Zwänge: Max. Länge = |
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 = 1 |
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. | Schnur Zwänge: Max. Länge = (erforderlich) |
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: Max. Länge = |
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 |
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 |
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 |
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 |
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 header festgelegt 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 query festgelegt ist. |
Schnur |
AuthenticationSettingsContract
Name | Beschreibung | Wert |
---|---|---|
oAuth2 | OAuth2-Authentifizierungseinstellungen | OAuth2AuthenticationSettingsContract |
openid | OpenID Connect-Authentifizierungseinstellungen | OpenIdAuthenticationSettingsContract- |
Microsoft.ApiManagement/service/apis
Name | Beschreibung | Wert |
---|---|---|
apiVersion | Die API-Version | '2021-08-01' |
Name | Der Ressourcenname | Schnur Zwänge: Min. Länge = 1 Max. Länge = 1 Pattern = ^[^*#&+:<>?]+$ (erforderlich) |
Eigenschaften | Api-Entitätserstellung von Updateeigenschaften. | ApiCreateOrUpdatePropertiesOrApiContractProperties |
Art | Der Ressourcentyp | 'Microsoft.ApiManagement/service/apis' |
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 |
SubscriptionKeyParameterNamesContract
Name | Beschreibung | Wert |
---|---|---|
Kopfball | Name des Abonnementschlüsselheaders. | Schnur |
Frage | Name des Zeichenfolgenparameters der Abonnementschlüsselabfrage. | Schnur |
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@2021-08-01"
name = "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"
}
openid = {
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"
type = "string"
value = "string"
wsdlSelector = {
wsdlEndpointName = "string"
wsdlServiceName = "string"
}
}
})
}
Eigenschaftswerte
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 |
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 = 1 |
apiRevisionDescription | Beschreibung der API-Revision. | Schnur Zwänge: Max. Länge = |
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 = |
apiVersionDescription | Beschreibung der API-Version. | Schnur Zwänge: Max. Länge = |
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 = 1 |
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. | Schnur Zwänge: Max. Länge = (erforderlich) |
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: Max. Länge = |
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 |
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 |
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 |
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 |
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 header festgelegt 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 query festgelegt ist. |
Schnur |
AuthenticationSettingsContract
Name | Beschreibung | Wert |
---|---|---|
oAuth2 | OAuth2-Authentifizierungseinstellungen | OAuth2AuthenticationSettingsContract |
openid | OpenID Connect-Authentifizierungseinstellungen | OpenIdAuthenticationSettingsContract- |
Microsoft.ApiManagement/service/apis
Name | Beschreibung | Wert |
---|---|---|
Name | Der Ressourcenname | Schnur Zwänge: Min. Länge = 1 Max. Länge = 1 Pattern = ^[^*#&+:<>?]+$ (erforderlich) |
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 |
Art | Der Ressourcentyp | "Microsoft.ApiManagement/service/apis@2021-08-01" |
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 |
SubscriptionKeyParameterNamesContract
Name | Beschreibung | Wert |
---|---|---|
Kopfball | Name des Abonnementschlüsselheaders. | Schnur |
Frage | Name des Zeichenfolgenparameters der Abonnementschlüsselabfrage. | Schnur |