Microsoft.Web customApis 2016-06-01
Bicep-Ressourcendefinition
Der ressourcentyp customApis kann mit Vorgängen bereitgestellt werden, die folgendes ziel haben:
- Ressourcengruppen : Siehe Ressourcengruppenbereitstellungsbefehle
Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie unter Änderungsprotokoll.
Ressourcenformat
Um eine Microsoft.Web/customApis-Ressource zu erstellen, fügen Sie der Vorlage den folgenden Bicep hinzu.
resource symbolicname 'Microsoft.Web/customApis@2016-06-01' = {
name: 'string'
location: 'string'
tags: {
tagName1: 'tagValue1'
tagName2: 'tagValue2'
}
etag: 'string'
properties: {
apiDefinitions: {
modifiedSwaggerUrl: 'string'
originalSwaggerUrl: 'string'
}
apiType: 'string'
backendService: {
serviceUrl: 'string'
}
brandColor: 'string'
capabilities: [
'string'
]
connectionParameters: {}
description: 'string'
displayName: 'string'
iconUri: 'string'
runtimeUrls: [
'string'
]
swagger: any()
wsdlDefinition: {
content: 'string'
importMethod: 'string'
service: {
endpointQualifiedNames: [
'string'
]
qualifiedName: 'string'
}
url: 'string'
content: 'string'
importMethod: 'string'
service: {
endpointQualifiedNames: [
'string'
]
qualifiedName: 'string'
}
url: 'string'
}
}
}
Eigenschaftswerte
customApis
| Name | Beschreibung | Wert |
|---|---|---|
| name | Der Ressourcenname | Zeichenfolge (erforderlich) |
| location | Ressourcenspeicherort | Zeichenfolge |
| tags | Ressourcentags | Wörterbuch der Tagnamen und -werte. Siehe Tags in Vorlagen |
| etag | Ressourcen-ETag | Zeichenfolge |
| properties | Benutzerdefinierte API-Eigenschaften | CustomApiPropertiesDefinition |
CustomApiPropertiesDefinition
| Name | Beschreibung | Wert |
|---|---|---|
| apiDefinitions | API-Definitionen | ApiResourceDefinitions |
| apiType | Der API-Typ | "NotSpecified" "Ruhe" "Seife" |
| back-EndService | Der API-Back-End-Dienst | ApiResourceBackendService |
| brandColor | Markenfarbe | Zeichenfolge |
| capabilities | Die funktionen der benutzerdefinierten API | string[] |
| connectionParameters | Verbindungsparameter | Objekt (object) |
| description | Beschreibung der benutzerdefinierten API | Zeichenfolge |
| displayName | Der Anzeigename | Zeichenfolge |
| iconUri | Der Symbol-URI | Zeichenfolge |
| runtimeUrls | Laufzeit-URLs | string[] |
| Swagger | Die JSON-Darstellung des Swaggers | Für Bicep können Sie die Funktion any() verwenden. |
| wsdlDefinition | Die WSDL-Definition | WsdlDefinition |
ApiResourceDefinitions
| Name | Beschreibung | Wert |
|---|---|---|
| modifiedSwaggerUrl | Die geänderte Swagger-URL | Zeichenfolge |
| originalSwaggerUrl | Die ursprüngliche Swagger-URL | Zeichenfolge |
ApiResourceBackendService
| Name | Beschreibung | Wert |
|---|---|---|
| serviceUrl | Die Dienst-URL | Zeichenfolge |
WsdlDefinition
| Name | Beschreibung | Wert |
|---|---|---|
| Inhalt | Der WSDL-Inhalt | Zeichenfolge |
| importMethod | Die WSDL-Importmethode | "NotSpecified" SoapPassThrough "SoapToRest" |
| Dienst | Der Dienst mit Namen und Endpunktnamen | WsdlService |
| url | Die WSDL-URL | Zeichenfolge |
| Inhalt | Der WSDL-Inhalt | Zeichenfolge |
| importMethod | Die WSDL-Importmethode | "NotSpecified" SoapPassThrough "SoapToRest" |
| Dienst | Der Dienst mit Namen und Endpunktnamen | WsdlService |
| url | Die WSDL-URL | Zeichenfolge |
WsdlService
| Name | Beschreibung | Wert |
|---|---|---|
| endpointQualifiedNames | Liste der qualifizierten Namen der Endpunkte | string[] |
| qualifiedName | Der qualifizierte Name des Diensts | Zeichenfolge (erforderlich) |
Ressourcendefinition mit einer ARM-Vorlage
Der Ressourcentyp customApis 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.Web/customApis-Ressource zu erstellen, fügen Sie der Vorlage den folgenden JSON-Code hinzu.
{
"type": "Microsoft.Web/customApis",
"apiVersion": "2016-06-01",
"name": "string",
"location": "string",
"tags": {
"tagName1": "tagValue1",
"tagName2": "tagValue2"
},
"etag": "string",
"properties": {
"apiDefinitions": {
"modifiedSwaggerUrl": "string",
"originalSwaggerUrl": "string"
},
"apiType": "string",
"backendService": {
"serviceUrl": "string"
},
"brandColor": "string",
"capabilities": [ "string" ],
"connectionParameters": {},
"description": "string",
"displayName": "string",
"iconUri": "string",
"runtimeUrls": [ "string" ],
"swagger": {},
"wsdlDefinition": {
"content": "string",
"importMethod": "string",
"service": {
"endpointQualifiedNames": [ "string" ],
"qualifiedName": "string"
},
"url": "string",
"content": "string",
"importMethod": "string",
"service": {
"endpointQualifiedNames": [ "string" ],
"qualifiedName": "string"
},
"url": "string"
}
}
}
Eigenschaftswerte
customApis
| Name | Beschreibung | Wert |
|---|---|---|
| type | Der Ressourcentyp | "Microsoft.Web/customApis" |
| apiVersion | Die Version der Ressourcen-API | '2016-06-01' |
| name | Der Ressourcenname | Zeichenfolge (erforderlich) |
| location | Ressourcenspeicherort | Zeichenfolge |
| tags | Ressourcentags | Wörterbuch der Tagnamen und -werte. Weitere Informationen finden Sie unter Tags in Vorlagen. |
| etag | Ressourcen-ETag | Zeichenfolge |
| properties | Benutzerdefinierte API-Eigenschaften | CustomApiPropertiesDefinition |
CustomApiPropertiesDefinition
| Name | Beschreibung | Wert |
|---|---|---|
| apiDefinitions | API-Definitionen | ApiResourceDefinitions |
| apiType | Der API-Typ | "NotSpecified" "Rest" "Soap" |
| back-EndService | Der API-Back-End-Dienst | ApiResourceBackendService |
| brandColor | Markenfarbe | Zeichenfolge |
| capabilities | Die benutzerdefinierten API-Funktionen | string[] |
| connectionParameters | Verbindungsparameter | Objekt (object) |
| description | Beschreibung der benutzerdefinierten API | Zeichenfolge |
| displayName | Der Anzeigename | Zeichenfolge |
| iconUri | Der Symbol-URI | Zeichenfolge |
| runtimeUrls | Laufzeit-URLs | string[] |
| Swagger | Die JSON-Darstellung des Swaggers | |
| wsdlDefinition | Die WSDL-Definition | WsdlDefinition |
ApiResourceDefinitions
| Name | Beschreibung | Wert |
|---|---|---|
| modifiedSwaggerUrl | Die geänderte Swagger-URL | Zeichenfolge |
| originalSwaggerUrl | Die ursprüngliche Swagger-URL | Zeichenfolge |
ApiResourceBackendService
| Name | Beschreibung | Wert |
|---|---|---|
| serviceUrl | Die Dienst-URL | Zeichenfolge |
WsdlDefinition
| Name | Beschreibung | Wert |
|---|---|---|
| Inhalt | Der WSDL-Inhalt | Zeichenfolge |
| importMethod | Die WSDL-Importmethode | "NotSpecified" SoapPassThrough SoapToRest |
| Dienst | Der Dienst mit Namen und Endpunktnamen | WsdlService |
| url | Die WSDL-URL | Zeichenfolge |
| Inhalt | Der WSDL-Inhalt | Zeichenfolge |
| importMethod | Die WSDL-Importmethode | "NotSpecified" SoapPassThrough SoapToRest |
| Dienst | Der Dienst mit Namen und Endpunktnamen | WsdlService |
| url | Die WSDL-URL | Zeichenfolge |
WsdlService
| Name | Beschreibung | Wert |
|---|---|---|
| endpointQualifiedNames | Liste der qualifizierten Namen der Endpunkte | string[] |
| qualifiedName | Der qualifizierte Name des Diensts | Zeichenfolge (erforderlich) |
Terraform (AzAPI-Anbieter) Ressourcendefinition
Der ressourcentyp customApis kann mit Vorgängen bereitgestellt werden, die folgendes ziel haben:
- Ressourcengruppen
Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie unter Änderungsprotokoll.
Ressourcenformat
Um eine Microsoft.Web/customApis-Ressource zu erstellen, fügen Sie Der Vorlage die folgende Terraform-Ressource hinzu.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Web/customApis@2016-06-01"
name = "string"
location = "string"
parent_id = "string"
tags = {
tagName1 = "tagValue1"
tagName2 = "tagValue2"
}
body = jsonencode({
properties = {
apiDefinitions = {
modifiedSwaggerUrl = "string"
originalSwaggerUrl = "string"
}
apiType = "string"
backendService = {
serviceUrl = "string"
}
brandColor = "string"
capabilities = [
"string"
]
connectionParameters = {}
description = "string"
displayName = "string"
iconUri = "string"
runtimeUrls = [
"string"
]
wsdlDefinition = {
content = "string"
importMethod = "string"
service = {
endpointQualifiedNames = [
"string"
]
qualifiedName = "string"
}
url = "string"
content = "string"
importMethod = "string"
service = {
endpointQualifiedNames = [
"string"
]
qualifiedName = "string"
}
url = "string"
}
}
etag = "string"
})
}
Eigenschaftswerte
customApis
| Name | Beschreibung | Wert |
|---|---|---|
| type | Ressourcentyp | "Microsoft.Web/customApis@2016-06-01" |
| name | Der Ressourcenname | Zeichenfolge (erforderlich) |
| location | Ressourcenspeicherort | Zeichenfolge |
| parent_id | Verwenden Sie zum Bereitstellen in einer Ressourcengruppe die ID dieser Ressourcengruppe. | Zeichenfolge (erforderlich) |
| tags | Ressourcentags | Wörterbuch der Tagnamen und -werte. |
| etag | Ressourcen-ETag | Zeichenfolge |
| properties | Benutzerdefinierte API-Eigenschaften | CustomApiPropertiesDefinition |
CustomApiPropertiesDefinition
| Name | Beschreibung | Wert |
|---|---|---|
| apiDefinitions | API-Definitionen | ApiResourceDefinitions |
| apiType | Der API-Typ | "NotSpecified" "Ruhe" "Seife" |
| back-EndService | Der API-Back-End-Dienst | ApiResourceBackendService |
| brandColor | Markenfarbe | Zeichenfolge |
| capabilities | Die funktionen der benutzerdefinierten API | string[] |
| connectionParameters | Verbindungsparameter | Objekt (object) |
| description | Beschreibung der benutzerdefinierten API | Zeichenfolge |
| displayName | Der Anzeigename | Zeichenfolge |
| iconUri | Der Symbol-URI | Zeichenfolge |
| runtimeUrls | Laufzeit-URLs | string[] |
| Swagger | Die JSON-Darstellung des Swaggers | |
| wsdlDefinition | Die WSDL-Definition | WsdlDefinition |
ApiResourceDefinitions
| Name | Beschreibung | Wert |
|---|---|---|
| modifiedSwaggerUrl | Die geänderte Swagger-URL | Zeichenfolge |
| originalSwaggerUrl | Die ursprüngliche Swagger-URL | Zeichenfolge |
ApiResourceBackendService
| Name | Beschreibung | Wert |
|---|---|---|
| serviceUrl | Die Dienst-URL | Zeichenfolge |
WsdlDefinition
| Name | Beschreibung | Wert |
|---|---|---|
| Inhalt | Der WSDL-Inhalt | Zeichenfolge |
| importMethod | Die WSDL-Importmethode | "NotSpecified" "SoapPassThrough" "SoapToRest" |
| Dienst | Der Dienst mit Namen und Endpunktnamen | WsdlService |
| url | Die WSDL-URL | Zeichenfolge |
| Inhalt | Der WSDL-Inhalt | Zeichenfolge |
| importMethod | Die WSDL-Importmethode | "NotSpecified" "SoapPassThrough" "SoapToRest" |
| Dienst | Der Dienst mit Namen und Endpunktnamen | WsdlService |
| url | Die WSDL-URL | Zeichenfolge |
WsdlService
| Name | Beschreibung | Wert |
|---|---|---|
| endpointQualifiedNames | Liste der qualifizierten Namen der Endpunkte | string[] |
| qualifiedName | Der qualifizierte Name des Diensts | Zeichenfolge (erforderlich) |
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