Microsoft.Web/customApis

Définition de ressource Bicep

Le type de ressource customApis peut être déployé avec des opérations qui ciblent :

groupes de ressources - Consultez commandes de déploiement de groupes de ressources

Pour obtenir la liste des propriétés modifiées dans chaque version de l’API, consultez journal des modifications.

Format de ressource

Pour créer une ressource Microsoft.Web/customApis, ajoutez le bicep suivant à votre modèle.

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

Valeurs de propriété

ApiOAuthSettings

Nom	Description	Valeur
clientId	ID client du fournisseur de ressources	corde
clientSecret	Clé secrète client nécessaire pour OAuth	corde
customParameters	La clé de paramètres OAuth est le nom du paramètre	ApiOAuthSettingsCustomParameters
identityProvider	Fournisseur d’identité	corde
Propriétés	Lire uniquement les propriétés de ce paramètre oauth.	quelconque
redirectUrl	URL	corde
Étendues	Étendues OAuth	string[]

ApiOAuthSettingsCustomParameters

Nom	Description	Valeur

ApiOAuthSettingsParameter

Nom	Description	Valeur
Options	Options disponibles pour ce paramètre	quelconque
uiDefinition	Les définitions d’interface utilisateur par culture en tant qu’appelant peuvent spécifier la culture	quelconque
valeur	Valeur du paramètre	corde

ApiResourceBackendService

Nom	Description	Valeur
serviceUrl	URL du service	corde

ApiResourceDefinitions

Nom	Description	Valeur
modifiedSwaggerUrl	URL swagger modifiée	corde
originalSwaggerUrl	URL swagger d’origine	corde

ConnectionParameter

Nom	Description	Valeur
oAuthSettings	Paramètres OAuth pour le fournisseur de connexions	ApiOAuthSettings
type	Type du paramètre	'array' 'bool' 'connexion' 'int' 'oauthSetting' 'object' 'secureobject' 'securestring' 'string'

CustomApiPropertiesDefinition

Nom	Description	Valeur
apiDefinitions	Définitions d’API	ApiResourceDefinitions
apiType	Type d’API	'NotSpecified' 'Rest' 'Soap'
backendService	Service principal d’API	ApiResourceBackendService
brandColor	Couleur de la marque	corde
Capacités	Fonctionnalités d’API personnalisées	string[]
connectionParameters	Paramètres de connexion	CustomApiPropertiesDefinitionConnectionParameters
description	Description de l’API personnalisée	corde
displayName	Nom complet	corde
iconUri	URI d’icône	corde
runtimeUrls	URL du runtime	string[]
fanfaronner	Représentation JSON du swagger	quelconque
wsdlDefinition	Définition WSDL	WsdlDefinition

CustomApiPropertiesDefinitionConnectionParameters

Nom	Description	Valeur

Nom	Description	Valeur
etag	ETag de ressource	corde
emplacement	Emplacement des ressources	corde
nom	Nom de la ressource	chaîne (obligatoire)
Propriétés	Propriétés d’API personnalisées	CustomApiPropertiesDefinition
étiquettes	Balises de ressource	Dictionnaire de noms et de valeurs d’étiquettes. Consultez les balises dans les modèles

TagsDictionary

Nom	Description	Valeur

WsdlDefinition

Nom	Description	Valeur
contenu	Contenu WSDL	corde
importMethod	Méthode d’importation WSDL	'NotSpecified' 'SoapPassThrough' 'SoapToRest'
service	Service avec des noms de nom et de point de terminaison	WsdlService
URL	The WSDL URL	corde

WsdlService

Nom	Description	Valeur
endpointQualifiedNames	Liste des noms qualifiés des points de terminaison	string[]
qualifiedName	Nom qualifié du service	chaîne (obligatoire)

Définition de ressource de modèle ARM