Microsoft. Web customApis

Definizione di risorsa Bicep

Il tipo di risorsa customApis può essere distribuito con operazioni destinate a:

  • gruppi di risorse - Vedere i comandi di distribuzione del gruppo di risorse

Per un elenco delle proprietà modificate in ogni versione dell'API, vedere log delle modifiche.

Formato risorsa

Per creare una risorsa Microsoft.Web/customApis, aggiungere il bicep seguente al modello.

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'
  }
}

Valori delle proprietà

Microsoft.Web/customApis

Nome Descrizione Valore
etag ETag risorsa corda
ubicazione Percorso risorsa corda
nome Nome della risorsa stringa (obbligatorio)
proprietà Proprietà dell'API personalizzate customApiPropertiesDefinition
Tag Tag delle risorse Dizionario di nomi e valori di tag. Vedere tag nei modelli

ApiOAuthSettings

Nome Descrizione Valore
ID cliente ID client del provider di risorse corda
clientSecret Segreto client necessario per OAuth corda
customParameters La chiave dei parametri OAuth è il nome del parametro ApiOAuthSettingsCustomParameters
Fornitore di identità Provider di identità corda
proprietà Proprietà di sola lettura per questa impostazione oauth. qualunque
redirectUrl URL corda
Ambiti Ambiti OAuth stringa[]

ApiOAuthSettingsCustomParameters

Nome Descrizione Valore

ApiOAuthSettingsParameter

Nome Descrizione Valore
Opzioni Opzioni disponibili per questo parametro qualunque
uiDefinizione Le definizioni dell'interfaccia utente per impostazioni cultura come chiamante possono specificare le impostazioni cultura qualunque
valore Valore dell'impostazione corda

ApiResourceBackendService

Nome Descrizione Valore
serviceUrl URL del servizio corda

ApiResourceDefinitions

Nome Descrizione Valore
modifiedSwaggerUrl URL swagger modificato corda
originalSwaggerUrl URL di swagger originale corda

Parametro di connessione

Nome Descrizione Valore
oAuthImpostazioni Impostazioni OAuth per il provider di connessione ApiOAuthSettings
digitare Tipo del parametro 'Schieramento'
'bool'
'connessione'
'int'
'oauthSetting'
'oggetto'
'oggetto sicuro'
'corda sicura'
'string'

CustomApiPropertiesDefinition

Nome Descrizione Valore
apiDefinitions Definizioni API ApiResourceDefinitions
apiType Tipo di API 'Non specificato'
'Riposo'
'Sapone'
servizio di backend Servizio back-end dell'API ApiResourceBackendService
marcaColore Colore del marchio corda
Funzionalità Funzionalità dell'API personalizzata stringa[]
connectionParameters Parametri di connessione customApiPropertiesDefinitionConnectionParameters
descrizione Descrizione dell'API personalizzata corda
nome visualizzato Nome visualizzato corda
iconUri URI icona corda
runtimeUrls URL di runtime stringa[]
spavalderia Rappresentazione JSON di swagger qualunque
wsdlDefinizione Definizione WSDL WsdlDefinition

CustomApiPropertiesDefinitionConnectionParameters

Nome Descrizione Valore

Dizionario dei Tag

Nome Descrizione Valore

WsdlDefinition

Nome Descrizione Valore
contenuto Contenuto WSDL corda
Metodo di importazione Metodo di importazione WSDL 'Non specificato'
'SoapPassThrough'
'SaponeToRest'
servizio Servizio con nomi di nome ed endpoint WsdlService
URL L'URL WSDL corda

WsdlService

Nome Descrizione Valore
endpointQualifiedNames Elenco dei nomi qualificati degli endpoint stringa[]
nome qualificato Nome completo del servizio stringa (obbligatorio)

Definizione di risorsa del modello di Resource Manager

Il tipo di risorsa customApis può essere distribuito con operazioni destinate a:

Esempi di utilizzo

Formato risorsa

Per creare una risorsa Microsoft.Web/customApis, aggiungere il codice JSON seguente al modello.

{
  "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"
  }
}

Valori delle proprietà

Microsoft.Web/customApis

Nome Descrizione Valore
versione dell'API Versione dell'API '2016-06-01'
etag ETag risorsa corda
ubicazione Percorso risorsa corda
nome Nome della risorsa stringa (obbligatorio)
proprietà Proprietà dell'API personalizzate customApiPropertiesDefinition
Tag Tag delle risorse Dizionario di nomi e valori di tag. Vedere tag nei modelli
digitare Tipo di risorsa 'Microsoft.Web/customApis'

ApiOAuthSettings

Nome Descrizione Valore
ID cliente ID client del provider di risorse corda
clientSecret Segreto client necessario per OAuth corda
customParameters La chiave dei parametri OAuth è il nome del parametro ApiOAuthSettingsCustomParameters
Fornitore di identità Provider di identità corda
proprietà Proprietà di sola lettura per questa impostazione oauth. qualunque
redirectUrl URL corda
Ambiti Ambiti OAuth stringa[]

ApiOAuthSettingsCustomParameters

Nome Descrizione Valore

ApiOAuthSettingsParameter

Nome Descrizione Valore
Opzioni Opzioni disponibili per questo parametro qualunque
uiDefinizione Le definizioni dell'interfaccia utente per impostazioni cultura come chiamante possono specificare le impostazioni cultura qualunque
valore Valore dell'impostazione corda

ApiResourceBackendService

Nome Descrizione Valore
serviceUrl URL del servizio corda

ApiResourceDefinitions

Nome Descrizione Valore
modifiedSwaggerUrl URL swagger modificato corda
originalSwaggerUrl URL di swagger originale corda

Parametro di connessione

Nome Descrizione Valore
oAuthImpostazioni Impostazioni OAuth per il provider di connessione ApiOAuthSettings
digitare Tipo del parametro 'Schieramento'
'bool'
'connessione'
'int'
'oauthSetting'
'oggetto'
'oggetto sicuro'
'corda sicura'
'string'

CustomApiPropertiesDefinition

Nome Descrizione Valore
apiDefinitions Definizioni API ApiResourceDefinitions
apiType Tipo di API 'Non specificato'
'Riposo'
'Sapone'
servizio di backend Servizio back-end dell'API ApiResourceBackendService
marcaColore Colore del marchio corda
Funzionalità Funzionalità dell'API personalizzata stringa[]
connectionParameters Parametri di connessione customApiPropertiesDefinitionConnectionParameters
descrizione Descrizione dell'API personalizzata corda
nome visualizzato Nome visualizzato corda
iconUri URI icona corda
runtimeUrls URL di runtime stringa[]
spavalderia Rappresentazione JSON di swagger qualunque
wsdlDefinizione Definizione WSDL WsdlDefinition

CustomApiPropertiesDefinitionConnectionParameters

Nome Descrizione Valore

Dizionario dei Tag

Nome Descrizione Valore

WsdlDefinition

Nome Descrizione Valore
contenuto Contenuto WSDL corda
Metodo di importazione Metodo di importazione WSDL 'Non specificato'
'SoapPassThrough'
'SaponeToRest'
servizio Servizio con nomi di nome ed endpoint WsdlService
URL L'URL WSDL corda

WsdlService

Nome Descrizione Valore
endpointQualifiedNames Elenco dei nomi qualificati degli endpoint stringa[]
nome qualificato Nome completo del servizio stringa (obbligatorio)

Definizione di risorsa Terraform (provider AzAPI)

Il tipo di risorsa customApis può essere distribuito con operazioni destinate a:

  • Gruppi di risorse Per un elenco delle proprietà modificate in ogni versione dell'API, vedi il registro modifiche.

Formato risorsa

Per creare una risorsa Microsoft.Web/customApis, aggiungere il comando Terraform seguente al modello.

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"
      }
    }
  }
}

Valori delle proprietà

Microsoft.Web/customApis

Nome Descrizione Valore
etag ETag risorsa corda
ubicazione Percorso risorsa corda
nome Nome della risorsa stringa (obbligatorio)
proprietà Proprietà dell'API personalizzate customApiPropertiesDefinition
Tag Tag delle risorse Dizionario di nomi e valori di tag.
digitare Tipo di risorsa "Microsoft.Web/customApis@2016-06-01"

ApiOAuthSettings

Nome Descrizione Valore
ID cliente ID client del provider di risorse corda
clientSecret Segreto client necessario per OAuth corda
customParameters La chiave dei parametri OAuth è il nome del parametro ApiOAuthSettingsCustomParameters
Fornitore di identità Provider di identità corda
proprietà Proprietà di sola lettura per questa impostazione oauth. qualunque
redirectUrl URL corda
Ambiti Ambiti OAuth stringa[]

ApiOAuthSettingsCustomParameters

Nome Descrizione Valore

ApiOAuthSettingsParameter

Nome Descrizione Valore
Opzioni Opzioni disponibili per questo parametro qualunque
uiDefinizione Le definizioni dell'interfaccia utente per impostazioni cultura come chiamante possono specificare le impostazioni cultura qualunque
valore Valore dell'impostazione corda

ApiResourceBackendService

Nome Descrizione Valore
serviceUrl URL del servizio corda

ApiResourceDefinitions

Nome Descrizione Valore
modifiedSwaggerUrl URL swagger modificato corda
originalSwaggerUrl URL di swagger originale corda

Parametro di connessione

Nome Descrizione Valore
oAuthImpostazioni Impostazioni OAuth per il provider di connessione ApiOAuthSettings
digitare Tipo del parametro 'Schieramento'
'bool'
'connessione'
'int'
'oauthSetting'
'oggetto'
'oggetto sicuro'
'corda sicura'
'string'

CustomApiPropertiesDefinition

Nome Descrizione Valore
apiDefinitions Definizioni API ApiResourceDefinitions
apiType Tipo di API 'Non specificato'
'Riposo'
'Sapone'
servizio di backend Servizio back-end dell'API ApiResourceBackendService
marcaColore Colore del marchio corda
Funzionalità Funzionalità dell'API personalizzata stringa[]
connectionParameters Parametri di connessione customApiPropertiesDefinitionConnectionParameters
descrizione Descrizione dell'API personalizzata corda
nome visualizzato Nome visualizzato corda
iconUri URI icona corda
runtimeUrls URL di runtime stringa[]
spavalderia Rappresentazione JSON di swagger qualunque
wsdlDefinizione Definizione WSDL WsdlDefinition

CustomApiPropertiesDefinitionConnectionParameters

Nome Descrizione Valore

Dizionario dei Tag

Nome Descrizione Valore

WsdlDefinition

Nome Descrizione Valore
contenuto Contenuto WSDL corda
Metodo di importazione Metodo di importazione WSDL 'Non specificato'
'SoapPassThrough'
'SaponeToRest'
servizio Servizio con nomi di nome ed endpoint WsdlService
URL L'URL WSDL corda

WsdlService

Nome Descrizione Valore
endpointQualifiedNames Elenco dei nomi qualificati degli endpoint stringa[]
nome qualificato Nome completo del servizio stringa (obbligatorio)
  • Ultimo aggiornamento: