Microsoft.ApiManagement service/apis 2016-07-07
- 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@2016-07-07' = {
parent: resourceSymbolicName
authenticationSettings: {
oAuth2: {
authorizationServerId: 'string'
scope: 'string'
}
}
description: 'string'
name: 'string'
path: 'string'
protocols: [
'string'
]
serviceUrl: 'string'
subscriptionKeyParameterNames: {
header: 'string'
query: 'string'
}
}
Eigenschaftswerte
AuthenticationSettingsContract
| Name | Beschreibung | Wert |
|---|---|---|
| oAuth2 | Details zu den OAuth2-Authentifizierungseinstellungen der API. | OAuth2AuthenticationSettingsContract |
Microsoft.ApiManagement/service/apis
| Name | Beschreibung | Wert |
|---|---|---|
| authenticationSettings | Sammlung von Authentifizierungseinstellungen, die in dieser API enthalten sind. | AuthenticationSettingsContract- |
| Beschreibung | Beschreibung der API. Kann HTML-Formatierungstags enthalten. | Schnur |
| 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- |
| 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" (erforderlich) |
| serviceUrl | Absolute URL des Back-End-Diensts, der diese API implementiert. | Schnur Zwänge: Min. Länge = 1 Max. Länge = 1 (erforderlich) |
| subscriptionKeyParameterNames | Protokolle, über die API verfügbar gemacht wird. | SubscriptionKeyParameterNamesContract |
OAuth2AuthenticationSettingsContract
| Name | Beschreibung | Wert |
|---|---|---|
| authorizationServerId | OAuth-Autorisierungsserverbezeichner. | Schnur |
| Umfang | operations scope. | 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": "2016-07-07",
"name": "string",
"authenticationSettings": {
"oAuth2": {
"authorizationServerId": "string",
"scope": "string"
}
},
"description": "string",
"path": "string",
"protocols": [ "string" ],
"serviceUrl": "string",
"subscriptionKeyParameterNames": {
"header": "string",
"query": "string"
}
}
Eigenschaftswerte
AuthenticationSettingsContract
| Name | Beschreibung | Wert |
|---|---|---|
| oAuth2 | Details zu den OAuth2-Authentifizierungseinstellungen der API. | OAuth2AuthenticationSettingsContract |
Microsoft.ApiManagement/service/apis
| Name | Beschreibung | Wert |
|---|---|---|
| apiVersion | Die API-Version | '2016-07-07' |
| authenticationSettings | Sammlung von Authentifizierungseinstellungen, die in dieser API enthalten sind. | AuthenticationSettingsContract- |
| Beschreibung | Beschreibung der API. Kann HTML-Formatierungstags enthalten. | Schnur |
| Name | Der Ressourcenname | Schnur Zwänge: Min. Länge = 1 Max. Länge = 1 Pattern = ^[^*#&+:<>?]+$ (erforderlich) |
| 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" (erforderlich) |
| serviceUrl | Absolute URL des Back-End-Diensts, der diese API implementiert. | Schnur Zwänge: Min. Länge = 1 Max. Länge = 1 (erforderlich) |
| subscriptionKeyParameterNames | Protokolle, über die API verfügbar gemacht wird. | SubscriptionKeyParameterNamesContract |
| Art | Der Ressourcentyp | 'Microsoft.ApiManagement/service/apis' |
OAuth2AuthenticationSettingsContract
| Name | Beschreibung | Wert |
|---|---|---|
| authorizationServerId | OAuth-Autorisierungsserverbezeichner. | Schnur |
| Umfang | operations scope. | 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@2016-07-07"
name = "string"
authenticationSettings = {
oAuth2 = {
authorizationServerId = "string"
scope = "string"
}
}
description = "string"
path = "string"
protocols = [
"string"
]
serviceUrl = "string"
subscriptionKeyParameterNames = {
header = "string"
query = "string"
}
}
Eigenschaftswerte
AuthenticationSettingsContract
| Name | Beschreibung | Wert |
|---|---|---|
| oAuth2 | Details zu den OAuth2-Authentifizierungseinstellungen der API. | OAuth2AuthenticationSettingsContract |
Microsoft.ApiManagement/service/apis
| Name | Beschreibung | Wert |
|---|---|---|
| authenticationSettings | Sammlung von Authentifizierungseinstellungen, die in dieser API enthalten sind. | AuthenticationSettingsContract- |
| Beschreibung | Beschreibung der API. Kann HTML-Formatierungstags enthalten. | Schnur |
| 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- |
| 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" (erforderlich) |
| serviceUrl | Absolute URL des Back-End-Diensts, der diese API implementiert. | Schnur Zwänge: Min. Länge = 1 Max. Länge = 1 (erforderlich) |
| subscriptionKeyParameterNames | Protokolle, über die API verfügbar gemacht wird. | SubscriptionKeyParameterNamesContract |
| Art | Der Ressourcentyp | "Microsoft.ApiManagement/service/apis@2016-07-07" |
OAuth2AuthenticationSettingsContract
| Name | Beschreibung | Wert |
|---|---|---|
| authorizationServerId | OAuth-Autorisierungsserverbezeichner. | Schnur |
| Umfang | operations scope. | Schnur |
SubscriptionKeyParameterNamesContract
| Name | Beschreibung | Wert |
|---|---|---|
| Kopfball | Name des Abonnementschlüsselheaders. | Schnur |
| Frage | Name des Zeichenfolgenparameters der Abonnementschlüsselabfrage. | Schnur |