Notitie
Voor toegang tot deze pagina is autorisatie vereist. U kunt proberen u aan te melden of de directory te wijzigen.
Voor toegang tot deze pagina is autorisatie vereist. U kunt proberen de mappen te wijzigen.
Bicep-resourcedefinitie
Het resourcetype customApis kan worden geïmplementeerd met bewerkingen die zijn gericht op:
- Resourcegroepen - Zie opdrachten voor de implementatie van resourcegroepen
Zie logboek wijzigenvoor een lijst met gewijzigde eigenschappen in elke API-versie.
Resource-indeling
Als u een Microsoft.Web/customApis-resource wilt maken, voegt u de volgende Bicep toe aan uw sjabloon.
resource symbolicname 'Microsoft.Web/customApis@2016-06-01' = {
etag: 'string'
location: 'string'
name: 'string'
properties: {
apiDefinitions: {
modifiedSwaggerUrl: 'string'
originalSwaggerUrl: 'string'
}
apiType: 'string'
backendService: {
serviceUrl: 'string'
}
brandColor: 'string'
capabilities: [
'string'
]
connectionParameters: {
{customized property}: {
oAuthSettings: {
clientId: 'string'
clientSecret: 'string'
customParameters: {
{customized property}: {
options: any(...)
uiDefinition: any(...)
value: 'string'
}
}
identityProvider: 'string'
properties: any(...)
redirectUrl: 'string'
scopes: [
'string'
]
}
type: 'string'
}
}
description: 'string'
displayName: 'string'
iconUri: 'string'
runtimeUrls: [
'string'
]
swagger: any(...)
wsdlDefinition: {
content: 'string'
importMethod: 'string'
service: {
endpointQualifiedNames: [
'string'
]
qualifiedName: 'string'
}
url: 'string'
}
}
tags: {
{customized property}: 'string'
}
}
Eigenschapswaarden
Microsoft.Web/customApis
| Naam | Beschrijving | Waarde |
|---|---|---|
| etag | Resource-ETag | snaar |
| plaats | Resourcelocatie | snaar |
| naam | De resourcenaam | tekenreeks (vereist) |
| Eigenschappen | Aangepaste API-eigenschappen | CustomApiPropertiesDefinition- |
| Tags | Resourcetags | Woordenlijst met tagnamen en -waarden. Zie Tags in sjablonen |
ApiOAuthInstellingen
| Naam | Beschrijving | Waarde |
|---|---|---|
| cliënt-ID | Client-id van resourceprovider | snaar |
| cliëntgeheim | Clientgeheim nodig voor OAuth | snaar |
| aangepaste parameters | OAuth-parameterssleutel is de naam van de parameter | ApiOAuthSettingsCustomParameters |
| identiteitsprovider | Id-provider | snaar |
| Eigenschappen | Alleen-lezeneigenschappen voor deze oauth-instelling. | enig |
| redirectUrl | URL | snaar |
| Scopes | OAuth-bereiken | tekenreeks[] |
ApiOAuthSettingsCustomParameters
| Naam | Beschrijving | Waarde |
|---|
ApiOAuthSettingsParameter
| Naam | Beschrijving | Waarde |
|---|---|---|
| Opties | Beschikbare opties voor deze parameter | enig |
| uiDefinition | UI-definities per cultuur als aanroeper kan de cultuur opgeven | enig |
| waarde | Waarde van de instelling | snaar |
ApiResourceBackendService
| Naam | Beschrijving | Waarde |
|---|---|---|
| serviceUrl | De service-URL | snaar |
ApiResourceDefinitions
| Naam | Beschrijving | Waarde |
|---|---|---|
| gewijzigdSwaggerUrl | De gewijzigde swagger-URL | snaar |
| originele SwaggerUrl | De oorspronkelijke swagger-URL | snaar |
Verbinding Parameter
| Naam | Beschrijving | Waarde |
|---|---|---|
| oAuthInstellingen | OAuth-instellingen voor de verbindingsprovider | ApiOAuthSettings- |
| soort | Type van de parameter | 'matrix' 'bool' 'verbinding' "int" 'oauthInstelling' 'Voorwerp' 'Beveiligd object' 'Veilige string' 'tekenreeks' |
CustomApiPropertiesDefinition
| Naam | Beschrijving | Waarde |
|---|---|---|
| apiDefinities | API-definities | ApiResourceDefinitions- |
| apiType | Het API-type | 'Niet opgegeven' 'Rust' 'Zeep' |
| backend-service | De API-back-endservice | ApiResourceBackendService |
| merkKleur | Merkkleur | snaar |
| Mogelijkheden | De aangepaste API-mogelijkheden | tekenreeks[] |
| verbinding Parameters | Verbindingsparameters | CustomApiPropertiesDefinitionConnectionParameters |
| beschrijving | De beschrijving van de aangepaste API | snaar |
| weergaveNaam | De weergavenaam | snaar |
| iconUri | De pictogram-URI | snaar |
| runtimeUrls | Runtime-URL's | tekenreeks[] |
| Branie | De JSON-weergave van de swagger | enig |
| wsdlDefinitie | De WSDL-definitie | WsdlDefinition- |
CustomApiPropertiesDefinitionConnectionParameters
| Naam | Beschrijving | Waarde |
|---|
Tagwoordenboek
| Naam | Beschrijving | Waarde |
|---|
WsdlDefinitie
| Naam | Beschrijving | Waarde |
|---|---|---|
| tevreden | De WSDL-inhoud | snaar |
| importMethode | De WSDL-importmethode | 'Niet opgegeven' 'ZeepDoorlaat' 'ZeepNaarRust' |
| dienst | De service met naam- en eindpuntnamen | Wsdl-service |
| URL | De WSDL-URL | snaar |
Wsdl-service
| Naam | Beschrijving | Waarde |
|---|---|---|
| eindpuntGekwalificeerde namen | Lijst met gekwalificeerde namen van de eindpunten | tekenreeks[] |
| gekwalificeerd Naam | De gekwalificeerde naam van de service | tekenreeks (vereist) |
Resourcedefinitie van ARM-sjabloon
Het resourcetype customApis kan worden geïmplementeerd met bewerkingen die zijn gericht op:
- Resourcegroepen - Zie opdrachten voor de implementatie van resourcegroepen
Zie logboek wijzigenvoor een lijst met gewijzigde eigenschappen in elke API-versie.
Resource-indeling
Als u een Microsoft.Web/customApis-resource wilt maken, voegt u de volgende JSON toe aan uw sjabloon.
{
"type": "Microsoft.Web/customApis",
"apiVersion": "2016-06-01",
"name": "string",
"etag": "string",
"location": "string",
"properties": {
"apiDefinitions": {
"modifiedSwaggerUrl": "string",
"originalSwaggerUrl": "string"
},
"apiType": "string",
"backendService": {
"serviceUrl": "string"
},
"brandColor": "string",
"capabilities": [ "string" ],
"connectionParameters": {
"{customized property}": {
"oAuthSettings": {
"clientId": "string",
"clientSecret": "string",
"customParameters": {
"{customized property}": {
"options": {},
"uiDefinition": {},
"value": "string"
}
},
"identityProvider": "string",
"properties": {},
"redirectUrl": "string",
"scopes": [ "string" ]
},
"type": "string"
}
},
"description": "string",
"displayName": "string",
"iconUri": "string",
"runtimeUrls": [ "string" ],
"swagger": {},
"wsdlDefinition": {
"content": "string",
"importMethod": "string",
"service": {
"endpointQualifiedNames": [ "string" ],
"qualifiedName": "string"
},
"url": "string"
}
},
"tags": {
"{customized property}": "string"
}
}
Eigenschapswaarden
Microsoft.Web/customApis
| Naam | Beschrijving | Waarde |
|---|---|---|
| apiVersion | De API-versie | '2016-06-01' |
| etag | Resource-ETag | snaar |
| plaats | Resourcelocatie | snaar |
| naam | De resourcenaam | tekenreeks (vereist) |
| Eigenschappen | Aangepaste API-eigenschappen | CustomApiPropertiesDefinition- |
| Tags | Resourcetags | Woordenlijst met tagnamen en -waarden. Zie Tags in sjablonen |
| soort | Het resourcetype | 'Microsoft.Web/customApis' |
ApiOAuthInstellingen
| Naam | Beschrijving | Waarde |
|---|---|---|
| cliënt-ID | Client-id van resourceprovider | snaar |
| cliëntgeheim | Clientgeheim nodig voor OAuth | snaar |
| aangepaste parameters | OAuth-parameterssleutel is de naam van de parameter | ApiOAuthSettingsCustomParameters |
| identiteitsprovider | Id-provider | snaar |
| Eigenschappen | Alleen-lezeneigenschappen voor deze oauth-instelling. | enig |
| redirectUrl | URL | snaar |
| Scopes | OAuth-bereiken | tekenreeks[] |
ApiOAuthSettingsCustomParameters
| Naam | Beschrijving | Waarde |
|---|
ApiOAuthSettingsParameter
| Naam | Beschrijving | Waarde |
|---|---|---|
| Opties | Beschikbare opties voor deze parameter | enig |
| uiDefinition | UI-definities per cultuur als aanroeper kan de cultuur opgeven | enig |
| waarde | Waarde van de instelling | snaar |
ApiResourceBackendService
| Naam | Beschrijving | Waarde |
|---|---|---|
| serviceUrl | De service-URL | snaar |
ApiResourceDefinitions
| Naam | Beschrijving | Waarde |
|---|---|---|
| gewijzigdSwaggerUrl | De gewijzigde swagger-URL | snaar |
| originele SwaggerUrl | De oorspronkelijke swagger-URL | snaar |
Verbinding Parameter
| Naam | Beschrijving | Waarde |
|---|---|---|
| oAuthInstellingen | OAuth-instellingen voor de verbindingsprovider | ApiOAuthSettings- |
| soort | Type van de parameter | 'matrix' 'bool' 'verbinding' "int" 'oauthInstelling' 'Voorwerp' 'Beveiligd object' 'Veilige string' 'tekenreeks' |
CustomApiPropertiesDefinition
| Naam | Beschrijving | Waarde |
|---|---|---|
| apiDefinities | API-definities | ApiResourceDefinitions- |
| apiType | Het API-type | 'Niet opgegeven' 'Rust' 'Zeep' |
| backend-service | De API-back-endservice | ApiResourceBackendService |
| merkKleur | Merkkleur | snaar |
| Mogelijkheden | De aangepaste API-mogelijkheden | tekenreeks[] |
| verbinding Parameters | Verbindingsparameters | CustomApiPropertiesDefinitionConnectionParameters |
| beschrijving | De beschrijving van de aangepaste API | snaar |
| weergaveNaam | De weergavenaam | snaar |
| iconUri | De pictogram-URI | snaar |
| runtimeUrls | Runtime-URL's | tekenreeks[] |
| Branie | De JSON-weergave van de swagger | enig |
| wsdlDefinitie | De WSDL-definitie | WsdlDefinition- |
CustomApiPropertiesDefinitionConnectionParameters
| Naam | Beschrijving | Waarde |
|---|
Tagwoordenboek
| Naam | Beschrijving | Waarde |
|---|
WsdlDefinitie
| Naam | Beschrijving | Waarde |
|---|---|---|
| tevreden | De WSDL-inhoud | snaar |
| importMethode | De WSDL-importmethode | 'Niet opgegeven' 'ZeepDoorlaat' 'ZeepNaarRust' |
| dienst | De service met naam- en eindpuntnamen | Wsdl-service |
| URL | De WSDL-URL | snaar |
Wsdl-service
| Naam | Beschrijving | Waarde |
|---|---|---|
| eindpuntGekwalificeerde namen | Lijst met gekwalificeerde namen van de eindpunten | tekenreeks[] |
| gekwalificeerd Naam | De gekwalificeerde naam van de service | tekenreeks (vereist) |
Gebruiksvoorbeelden
Resourcedefinitie van Terraform (AzAPI-provider)
Het resourcetype customApis kan worden geïmplementeerd met bewerkingen die zijn gericht op:
- Resourcegroepen
Zie logboek wijzigenvoor een lijst met gewijzigde eigenschappen in elke API-versie.
Resource-indeling
Als u een Microsoft.Web/customApis-resource wilt maken, voegt u de volgende Terraform toe aan uw sjabloon.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Web/customApis@2016-06-01"
name = "string"
parent_id = "string"
location = "string"
tags = {
{customized property} = "string"
}
body = {
etag = "string"
properties = {
apiDefinitions = {
modifiedSwaggerUrl = "string"
originalSwaggerUrl = "string"
}
apiType = "string"
backendService = {
serviceUrl = "string"
}
brandColor = "string"
capabilities = [
"string"
]
connectionParameters = {
{customized property} = {
oAuthSettings = {
clientId = "string"
clientSecret = "string"
customParameters = {
{customized property} = {
options = ?
uiDefinition = ?
value = "string"
}
}
identityProvider = "string"
properties = ?
redirectUrl = "string"
scopes = [
"string"
]
}
type = "string"
}
}
description = "string"
displayName = "string"
iconUri = "string"
runtimeUrls = [
"string"
]
swagger = ?
wsdlDefinition = {
content = "string"
importMethod = "string"
service = {
endpointQualifiedNames = [
"string"
]
qualifiedName = "string"
}
url = "string"
}
}
}
}
Eigenschapswaarden
Microsoft.Web/customApis
| Naam | Beschrijving | Waarde |
|---|---|---|
| etag | Resource-ETag | snaar |
| plaats | Resourcelocatie | snaar |
| naam | De resourcenaam | tekenreeks (vereist) |
| Eigenschappen | Aangepaste API-eigenschappen | CustomApiPropertiesDefinition- |
| Tags | Resourcetags | Woordenlijst met tagnamen en -waarden. |
| soort | Het resourcetype | "Microsoft.Web/customApis@2016-06-01" |
ApiOAuthInstellingen
| Naam | Beschrijving | Waarde |
|---|---|---|
| cliënt-ID | Client-id van resourceprovider | snaar |
| cliëntgeheim | Clientgeheim nodig voor OAuth | snaar |
| aangepaste parameters | OAuth-parameterssleutel is de naam van de parameter | ApiOAuthSettingsCustomParameters |
| identiteitsprovider | Id-provider | snaar |
| Eigenschappen | Alleen-lezeneigenschappen voor deze oauth-instelling. | enig |
| redirectUrl | URL | snaar |
| Scopes | OAuth-bereiken | tekenreeks[] |
ApiOAuthSettingsCustomParameters
| Naam | Beschrijving | Waarde |
|---|
ApiOAuthSettingsParameter
| Naam | Beschrijving | Waarde |
|---|---|---|
| Opties | Beschikbare opties voor deze parameter | enig |
| uiDefinition | UI-definities per cultuur als aanroeper kan de cultuur opgeven | enig |
| waarde | Waarde van de instelling | snaar |
ApiResourceBackendService
| Naam | Beschrijving | Waarde |
|---|---|---|
| serviceUrl | De service-URL | snaar |
ApiResourceDefinitions
| Naam | Beschrijving | Waarde |
|---|---|---|
| gewijzigdSwaggerUrl | De gewijzigde swagger-URL | snaar |
| originele SwaggerUrl | De oorspronkelijke swagger-URL | snaar |
Verbinding Parameter
| Naam | Beschrijving | Waarde |
|---|---|---|
| oAuthInstellingen | OAuth-instellingen voor de verbindingsprovider | ApiOAuthSettings- |
| soort | Type van de parameter | 'matrix' 'bool' 'verbinding' "int" 'oauthInstelling' 'Voorwerp' 'Beveiligd object' 'Veilige string' 'tekenreeks' |
CustomApiPropertiesDefinition
| Naam | Beschrijving | Waarde |
|---|---|---|
| apiDefinities | API-definities | ApiResourceDefinitions- |
| apiType | Het API-type | 'Niet opgegeven' 'Rust' 'Zeep' |
| backend-service | De API-back-endservice | ApiResourceBackendService |
| merkKleur | Merkkleur | snaar |
| Mogelijkheden | De aangepaste API-mogelijkheden | tekenreeks[] |
| verbinding Parameters | Verbindingsparameters | CustomApiPropertiesDefinitionConnectionParameters |
| beschrijving | De beschrijving van de aangepaste API | snaar |
| weergaveNaam | De weergavenaam | snaar |
| iconUri | De pictogram-URI | snaar |
| runtimeUrls | Runtime-URL's | tekenreeks[] |
| Branie | De JSON-weergave van de swagger | enig |
| wsdlDefinitie | De WSDL-definitie | WsdlDefinition- |
CustomApiPropertiesDefinitionConnectionParameters
| Naam | Beschrijving | Waarde |
|---|
Tagwoordenboek
| Naam | Beschrijving | Waarde |
|---|
WsdlDefinitie
| Naam | Beschrijving | Waarde |
|---|---|---|
| tevreden | De WSDL-inhoud | snaar |
| importMethode | De WSDL-importmethode | 'Niet opgegeven' 'ZeepDoorlaat' 'ZeepNaarRust' |
| dienst | De service met naam- en eindpuntnamen | Wsdl-service |
| URL | De WSDL-URL | snaar |
Wsdl-service
| Naam | Beschrijving | Waarde |
|---|---|---|
| eindpuntGekwalificeerde namen | Lijst met gekwalificeerde namen van de eindpunten | tekenreeks[] |
| gekwalificeerd Naam | De gekwalificeerde naam van de service | tekenreeks (vereist) |