Microsoft.Web/customApis

Bicep-erőforrásdefiníció

A customApis erőforrástípus üzembe helyezhető a célműveletekkel:

Erőforráscsoportok – Lásd erőforráscsoport üzembe helyezési parancsaival

Az egyes API-verziók módosított tulajdonságainak listáját a változásnaplócímű témakörben találja.

Erőforrás formátuma

Microsoft.Web/customApis erőforrás létrehozásához adja hozzá a következő Bicep-et a sablonhoz.

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(Azure.Bicep.Types.Concrete.AnyType)
              uiDefinition: any(Azure.Bicep.Types.Concrete.AnyType)
              value: 'string'
            }
          }
          identityProvider: 'string'
          properties: any(Azure.Bicep.Types.Concrete.AnyType)
          redirectUrl: 'string'
          scopes: [
            'string'
          ]
        }
        type: 'string'
      }
    }
    description: 'string'
    displayName: 'string'
    iconUri: 'string'
    runtimeUrls: [
      'string'
    ]
    swagger: any(Azure.Bicep.Types.Concrete.AnyType)
    wsdlDefinition: {
      content: 'string'
      importMethod: 'string'
      service: {
        endpointQualifiedNames: [
          'string'
        ]
        qualifiedName: 'string'
      }
      url: 'string'
    }
  }
  tags: {
    {customized property}: 'string'
  }
}

Tulajdonságértékek

ApiOAuthSettings

Név	Leírás	Érték
clientId	Erőforrás-szolgáltató ügyfélazonosítója	húr
clientSecret	Az OAuth-hoz szükséges ügyfélkód	húr
customParameters	Az OAuth paraméterkulcs a paraméter neve	ApiOAuthSettingsCustomParameters
identityProvider	Identitásszolgáltató	húr
kellékek	Csak olvasási tulajdonságok ehhez az oauth beállításhoz.	bármely
redirectUrl	URL-cím	húr
Hatókörök	OAuth-hatókörök	sztring[]

ApiOAuthSettingsCustomParameters

Név	Leírás	Érték

ApiOAuthSettingsParameter

Név	Leírás	Érték
beállítások	A paraméterhez elérhető beállítások	bármely
uiDefinition	A felhasználói felület definíciói kultúránként, ahogy a hívó megadhatja a kultúrát	bármely
érték	A beállítás értéke	húr

ApiResourceBackendService

Név	Leírás	Érték
serviceUrl	A szolgáltatás URL-címe	húr

ApiResourceDefinitions

Név	Leírás	Érték
modifiedSwaggerUrl	A módosított swagger URL-cím	húr
originalSwaggerUrl	Az eredeti swagger URL-cím	húr

ConnectionParameter

Név	Leírás	Érték
oAuthSettings	OAuth-beállítások a kapcsolatszolgáltatóhoz	ApiOAuthSettings
típus	A paraméter típusa	"tömb" "bool" "kapcsolat" 'int' "oauthSetting" "objektum" "secureobject" "securestring" "sztring"

CustomApiPropertiesDefinition

Név	Leírás	Érték
apiDefinitions	API-definíciók	ApiResourceDefinitions
apiType	Az API típusa	"Nincs meghatározva" "Rest" "Szappan"
backendService	Az API háttérszolgáltatása	ApiResourceBackendService
brandColor	Márka színe	húr
Képességek	Az egyéni API-képességek	sztring[]
connectionParameters	Kapcsolati paraméterek	CustomApiPropertiesDefinitionConnectionParameters
leírás	Az egyéni API leírása	húr
displayName	A megjelenítendő név	húr
iconUri	Az ikon URI-ja	húr
runtimeUrls	Futtatókörnyezeti URL-címek	sztring[]
henceg	A swagger JSON-ábrázolása	bármely
wsdlDefinition	A WSDL definíciója	WsdlDefinition

CustomApiPropertiesDefinitionConnectionParameters

Név	Leírás	Érték

Név	Leírás	Érték
etag	Erőforráscímke	húr
hely	Erőforrás helye	húr
név	Az erőforrás neve	sztring (kötelező)
kellékek	Egyéni API-tulajdonságok	CustomApiPropertiesDefinition
Címkék	Erőforráscímkék	Címkenevek és -értékek szótára. sablonok címkéinek megtekintése

TagsDictionary

Név	Leírás	Érték

WsdlDefinition

Név	Leírás	Érték
tartalom	A WSDL-tartalom	húr
importMethod	A WSDL importálási módszere	"Nincs meghatározva" "SoapPassThrough" "SoapToRest"
szolgáltatás	A szolgáltatás névvel és végpontnevekkel	WsdlService
URL-cím	A WSDL URL-címe	húr

WsdlService

Név	Leírás	Érték
endpointQualifiedNames	A végpontok minősített neveinek listája	sztring[]
qualifiedName	A szolgáltatás minősített neve	sztring (kötelező)

ARM-sablon erőforrásdefiníciója