Service/apis Microsoft.ApiManagement

Article
01/18/2024

Définition de ressource Bicep

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

Groupes de ressources - Voir commandes de déploiement de groupe de ressources

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

Format des ressources

Pour créer une ressource Microsoft.ApiManagement/service/apis, ajoutez le Bicep suivant à votre modèle.

resource symbolicname 'Microsoft.ApiManagement/service/apis@2023-05-01-preview' = {
  name: 'string'
  parent: resourceSymbolicName
  properties: {
    apiRevision: 'string'
    apiRevisionDescription: 'string'
    apiType: 'string'
    apiVersion: 'string'
    apiVersionDescription: 'string'
    apiVersionSet: {
      description: 'string'
      id: 'string'
      name: 'string'
      versionHeaderName: 'string'
      versioningScheme: 'string'
      versionQueryName: 'string'
    }
    apiVersionSetId: 'string'
    authenticationSettings: {
      oAuth2: {
        authorizationServerId: 'string'
        scope: 'string'
      }
      oAuth2AuthenticationSettings: [
        {
          authorizationServerId: 'string'
          scope: 'string'
        }
      ]
      openid: {
        bearerTokenSendingMethods: [
          'string'
        ]
        openidProviderId: 'string'
      }
      openidAuthenticationSettings: [
        {
          bearerTokenSendingMethods: [
            'string'
          ]
          openidProviderId: 'string'
        }
      ]
    }
    contact: {
      email: 'string'
      name: 'string'
      url: 'string'
    }
    description: 'string'
    displayName: 'string'
    format: 'string'
    isCurrent: bool
    license: {
      name: 'string'
      url: 'string'
    }
    path: 'string'
    protocols: [
      'string'
    ]
    serviceUrl: 'string'
    sourceApiId: 'string'
    subscriptionKeyParameterNames: {
      header: 'string'
      query: 'string'
    }
    subscriptionRequired: bool
    termsOfServiceUrl: 'string'
    translateRequiredQueryParameters: 'string'
    type: 'string'
    value: 'string'
    wsdlSelector: {
      wsdlEndpointName: 'string'
      wsdlServiceName: 'string'
    }
  }
}

Valeurs de propriétés

service/apis

Nom	Description	Valeur
name	Nom de la ressource Découvrez comment définir des noms et des types pour des ressources enfants dans Bicep.	string (obligatoire) Limite de caractères : 1-80 Caractères valides : Caractères alphanumériques et traits d’union. Doit commencer par une lettre et se terminer par un caractère alphanumérique.
parent	Dans Bicep, vous pouvez spécifier la ressource parente pour une ressource enfant. Vous devez uniquement ajouter cette propriété lorsque la ressource enfant est déclarée en dehors de la ressource parente. Pour plus d’informations, consultez Ressource enfant en dehors de la ressource parente.	Nom symbolique de la ressource de type : service
properties	Création d’entité d’API de propriétés de mise à jour.	ApiCreateOrUpdatePropertiesOrApiContractProperties

ApiCreateOrUpdatePropertiesOrApiContractProperties

Nom	Description	Valeur
apiRevision	Décrit la révision de l’API. Si aucune valeur n’est fournie, la révision par défaut 1 est créée	string
apiRevisionDescription	Description de la révision de l’API.	string
apiType	Type d’API à créer. * `http` crée une API REST * `soap` crée une API directe SOAP * `websocket` crée l’API websocket * `graphql`crée GraphQL API. De nouveaux types peuvent être ajoutés à l’avenir.	'graphql' 'grpc' 'http' 'odata' 'soap' 'websocket'
apiVersion	Indique l’identificateur de version de l’API si l’API est avec version	string
apiVersionDescription	Description de la version de l’API.	string
apiVersionSet	Détails du jeu de versions	ApiVersionSetContractDetails
apiVersionSetId	Identificateur de ressource pour l’ApiVersionSet associé.	string
authenticationSettings	Collection de paramètres d’authentification inclus dans cette API.	AuthenticationSettingsContract
contact	Informations de contact pour l’API.	ApiContactInformation
description	Description de l’API. Peut comporter des balises de mise en forme.	string
displayName	Nom de l’API. Doit comporter entre 1 et 300 caractères.	string
format	Format du contenu dans lequel l’API est importée. De nouveaux formats pourront être ajoutés à l’avenir	'graphql-link' 'grpc' 'grpc-link' 'odata' 'odata-link' 'openapi' 'openapi+json' 'openapi+json-link' 'openapi-link' 'swagger-json' 'swagger-link-json' 'wadl-link-json' 'wadl-xml' 'wsdl' 'wsdl-link'
isCurrent	Indique si la révision de l’API est la révision actuelle de l’API.	bool
license	Informations de licence pour l’API.	ApiLicenseInformation
path	URL relative identifiant exclusivement cette API et tous les chemins d’accès à ses ressources au sein de l’instance de service Gestion des API. Elle est ajoutée à l’URL de base du point de terminaison d’API spécifiée lors de la création de l’instance de service pour former l’URL publique de cette API.	string (obligatoire)
protocols	Indique sur quels protocoles les opérations dans cette API peuvent être appelées.	Tableau de chaînes contenant l’un des éléments suivants : 'http' 'https' 'ws' 'wss'
serviceUrl	URL absolue du service principal qui implémente cette API. Ne peut pas avoir plus de 2 000 caractères.	string
sourceApiId	Identificateur d’API de l’API source.	string
subscriptionKeyParameterNames	Protocoles sur lesquels l’API est mise à disposition.	SubscriptionKeyParameterNamesContract
subscriptionRequired	Spécifie si un abonnement d’API ou de produit est requis pour accéder à l’API.	bool
termsOfServiceUrl	URL des conditions d’utilisation de l’API. DOIT être au format d’une URL.	string
translateRequiredQueryParameters	Stratégie de traduction des paramètres de requête requis en modèles. Par défaut, a la valeur « template ». Valeurs possibles : 'template', 'query'	'query' 'template'
type	Type d’API.	'graphql' 'grpc' 'http' 'odata' 'soap' 'websocket'
value	Valeur de contenu lors de l’importation d’une API.	string
wsdlSelector	Critères pour limiter l’importation de WSDL à un sous-ensemble du document.	ApiCreateOrUpdatePropertiesWsdlSelector

ApiVersionSetContractDetails

Nom	Description	Valeur
description	Description de l’ensemble de versions d’API.	string
id	Identificateur de l’ensemble de versions d’API existant. Omettez cette valeur pour créer un jeu de versions.	string
name	Nom complet de l’ensemble de versions de l’API.	string
versionHeaderName	Nom du paramètre d’en-tête HTTP qui indique la version de l’API si versioningScheme est défini sur `header`.	string
versioningScheme	Valeur qui détermine l’emplacement de l’identificateur de version de l’API dans une requête HTTP.	'En-tête' 'Query' 'Segment'
versionQueryName	Nom du paramètre de requête qui indique la version de l’API si versioningScheme a la valeur `query`.	string

AuthenticationSettingsContract

Nom	Description	Valeur
OAuth2	Paramètres d’authentification OAuth2	OAuth2AuthenticationSettingsContract
oAuth2AuthenticationSettings	Collection de paramètres d’authentification OAuth2 inclus dans cette API.	OAuth2AuthenticationSettingsContract[]
openid	Paramètres d’authentification OpenID Connect	OpenIdAuthenticationSettingsContract
openidAuthenticationSettings	Collection de paramètres d’authentification Open ID Connect inclus dans cette API.	OpenIdAuthenticationSettingsContract[]

OAuth2AuthenticationSettingsContract

Nom	Description	Valeur
authorizationServerId	Identificateur du serveur d'autorisation OAuth.	string
scope	étendue des opérations.	string

OpenIdAuthenticationSettingsContract

Nom	Description	Valeur
bearerTokenSendingMethods	Comment envoyer un jeton au serveur.	Tableau de chaînes contenant l’un des éléments suivants : 'authorizationHeader' 'query'
openidProviderId	Identificateur du serveur d'autorisation OAuth.	string

ApiContactInformation

Nom	Description	Valeur
email	Adresse e-mail de la personne/organization de contact. DOIT être au format d’une adresse e-mail	string
name	Nom d’identification de la personne/organization contact	string
url	URL pointant vers les informations de contact. DOIT être au format d’une URL	string

ApiLicenseInformation

Nom	Description	Valeur
name	Nom de licence utilisé pour l’API	string
url	URL de la licence utilisée pour l’API. DOIT être au format d’une URL	string

SubscriptionKeyParameterNamesContract

Nom	Description	Valeur
en-tête	Nom de l’en-tête de clé d’abonnement.	string
query	Nom du paramètre de chaîne de requête de clé d’abonnement.	string

ApiCreateOrUpdatePropertiesWsdlSelector

Nom	Description	Valeur
wsdlEndpointName	Nom du point de terminaison(port) à importer à partir de WSDL	string
wsdlServiceName	Nom du service à importer à partir de WSDL	string

Modèles de démarrage rapide

Les modèles de démarrage rapide suivants déploient ce type de ressource.

Modèle	Description
Créer une instance de Gestion des API et toutes les sous-ressources à l’aide d’un modèle	Ce modèle montre comment créer un service Gestion des API et configurer des sous-entités
Créer Azure Front Door devant Azure Gestion des API	Cet exemple montre comment utiliser Azure Front Door comme équilibreur de charge global devant Azure Gestion des API.

Définition de ressources de modèle ARM

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

Groupes de ressources - Voir commandes de déploiement de groupe de ressources

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

Format des ressources

Pour créer une ressource Microsoft.ApiManagement/service/apis, ajoutez le JSON suivant à votre modèle.

{
  "type": "Microsoft.ApiManagement/service/apis",
  "apiVersion": "2023-05-01-preview",
  "name": "string",
  "properties": {
    "apiRevision": "string",
    "apiRevisionDescription": "string",
    "apiType": "string",
    "apiVersion": "string",
    "apiVersionDescription": "string",
    "apiVersionSet": {
      "description": "string",
      "id": "string",
      "name": "string",
      "versionHeaderName": "string",
      "versioningScheme": "string",
      "versionQueryName": "string"
    },
    "apiVersionSetId": "string",
    "authenticationSettings": {
      "oAuth2": {
        "authorizationServerId": "string",
        "scope": "string"
      },
      "oAuth2AuthenticationSettings": [
        {
          "authorizationServerId": "string",
          "scope": "string"
        }
      ],
      "openid": {
        "bearerTokenSendingMethods": [ "string" ],
        "openidProviderId": "string"
      },
      "openidAuthenticationSettings": [
        {
          "bearerTokenSendingMethods": [ "string" ],
          "openidProviderId": "string"
        }
      ]
    },
    "contact": {
      "email": "string",
      "name": "string",
      "url": "string"
    },
    "description": "string",
    "displayName": "string",
    "format": "string",
    "isCurrent": "bool",
    "license": {
      "name": "string",
      "url": "string"
    },
    "path": "string",
    "protocols": [ "string" ],
    "serviceUrl": "string",
    "sourceApiId": "string",
    "subscriptionKeyParameterNames": {
      "header": "string",
      "query": "string"
    },
    "subscriptionRequired": "bool",
    "termsOfServiceUrl": "string",
    "translateRequiredQueryParameters": "string",
    "type": "string",
    "value": "string",
    "wsdlSelector": {
      "wsdlEndpointName": "string",
      "wsdlServiceName": "string"
    }
  }
}

Valeurs de propriétés

service/apis

Nom	Description	Valeur
type	Type de ressource	'Microsoft.ApiManagement/service/apis'
apiVersion	Version de l’API de ressource	'2023-05-01-preview'
name	Nom de la ressource Découvrez comment définir des noms et des types pour des ressources enfants dans des modèles ARM JSON.	chaîne (obligatoire) Limite de caractères : 1-80 Caractères valides : Caractères alphanumériques et traits d’union. Doit commencer par une lettre et se terminer par un caractère alphanumérique.
properties	L’entité API crée des propriétés de mise à jour.	ApiCreateOrUpdatePropertiesOrApiContractProperties

ApiCreateOrUpdatePropertiesOrApiContractProperties

Nom	Description	Valeur
apiRevision	Décrit la révision de l’API. Si aucune valeur n’est fournie, la révision par défaut 1 est créée	string
apiRevisionDescription	Description de la révision de l’API.	string
apiType	Type d’API à créer. * `http` crée une API REST * `soap` crée une API directe SOAP * `websocket` crée l’API websocket * `graphql`crée GraphQL API. De nouveaux types peuvent être ajoutés à l’avenir.	'graphql' 'grpc' 'http' 'odata' 'soap' 'websocket'
apiVersion	Indique l’identificateur de version de l’API si l’API est versionnée	string
apiVersionDescription	Description de la version de l’API.	string
apiVersionSet	Détails du jeu de versions	ApiVersionSetContractDetails
apiVersionSetId	Identificateur de ressource pour l’ApiVersionSet associé.	string
authenticationSettings	Collection des paramètres d’authentification inclus dans cette API.	AuthenticationSettingsContract
contact	Coordonnées de l’API.	ApiContactInformation
description	Description de l’API. Peut comporter des balises de mise en forme.	string
displayName	Nom de l’API. Doit contenir de 1 à 300 caractères.	string
format	Format du contenu dans lequel l’API est importée. De nouveaux formats pourront être ajoutés à l’avenir	'graphql-link' 'grpc' 'grpc-link' 'odata' 'odata-link' 'openapi' 'openapi+json' 'openapi+json-link' 'openapi-link' 'swagger-json' 'swagger-link-json' 'wadl-link-json' 'wadl-xml' 'wsdl' 'wsdl-link'
isCurrent	Indique si la révision de l’API est la révision actuelle de l’API.	bool
license	Informations de licence pour l’API.	ApiLicenseInformation
path	URL relative identifiant exclusivement cette API et tous les chemins d’accès à ses ressources au sein de l’instance de service Gestion des API. Elle est ajoutée à l’URL de base du point de terminaison d’API spécifiée lors de la création de l’instance de service pour former l’URL publique de cette API.	chaîne (obligatoire)
protocols	Indique sur quels protocoles les opérations dans cette API peuvent être appelées.	Tableau de chaînes contenant l’un des éléments suivants : 'http' 'https' 'ws' 'wss'
serviceUrl	URL absolue du service principal qui implémente cette API. Ne peut pas dépasser 2 000 caractères.	string
sourceApiId	Identificateur d’API de l’API source.	string
subscriptionKeyParameterNames	Protocoles sur lesquels l’API est mise à disposition.	SubscriptionKeyParameterNamesContract
subscriptionRequired	Spécifie si un abonnement à l’API ou au produit est requis pour accéder à l’API.	bool
termsOfServiceUrl	URL vers les conditions d’utilisation de l’API. DOIT être au format d’une URL.	string
translateRequiredQueryParameters	Stratégie de traduction des paramètres de requête requis en modèles. Par défaut, a la valeur 'template'. Valeurs possibles : 'template', 'query'	'query' 'template'
type	Type d’API.	'graphql' 'grpc' 'http' 'odata' 'soap' 'websocket'
value	Valeur de contenu lors de l’importation d’une API.	string
wsdlSelector	Critères pour limiter l’importation de WSDL dans un sous-ensemble du document.	ApiCreateOrUpdatePropertiesWsdlSelector

ApiVersionSetContractDetails

Nom	Description	Valeur
description	Description du jeu de versions d’API.	string
id	Identificateur de l’ensemble de versions d’API existant. Omettez cette valeur pour créer un jeu de versions.	string
name	Nom d’affichage du jeu de versions d’API.	string
versionHeaderName	Nom du paramètre d’en-tête HTTP qui indique la version de l’API si versioningScheme a la valeur `header`.	string
versioningScheme	Valeur qui détermine l’emplacement de l’identificateur de version de l’API dans une requête HTTP.	'En-tête' 'Query' 'Segment'
versionQueryName	Nom du paramètre de requête qui indique la version de l’API si versioningScheme est défini sur `query`.	string

AuthenticationSettingsContract

Nom	Description	Valeur
OAuth2	Paramètres d’authentification OAuth2	OAuth2AuthenticationSettingsContract
oAuth2AuthenticationSettings	Collection de paramètres d’authentification OAuth2 inclus dans cette API.	OAuth2AuthenticationSettingsContract[]
openid	Paramètres d’authentification OpenID Connect	OpenIdAuthenticationSettingsContract
openidAuthenticationSettings	Collection de paramètres d’authentification Open ID Connect inclus dans cette API.	OpenIdAuthenticationSettingsContract[]

OAuth2AuthenticationSettingsContract

Nom	Description	Valeur
authorizationServerId	Identificateur du serveur d'autorisation OAuth.	string
scope	étendue des opérations.	string

OpenIdAuthenticationSettingsContract

Nom	Description	Valeur
bearerTokenSendingMethods	Comment envoyer un jeton au serveur.	Tableau de chaînes contenant l’un des éléments suivants : 'authorizationHeader' 'query'
openidProviderId	Identificateur du serveur d'autorisation OAuth.	string

ApiContactInformation

Nom	Description	Valeur
email	Adresse e-mail de la personne/organization de contact. DOIT être au format d’une adresse e-mail	string
name	Nom d’identification de la personne/organization de contact	string
url	URL pointant vers les informations de contact. DOIT être au format d’une URL	string

ApiLicenseInformation

Nom	Description	Valeur
name	Nom de licence utilisé pour l’API	string
url	URL de la licence utilisée pour l’API. DOIT être au format d’une URL	string

SubscriptionKeyParameterNamesContract

Nom	Description	Valeur
en-tête	Nom de l’en-tête de la clé d’abonnement.	string
query	Nom du paramètre de chaîne de requête de clé d’abonnement.	string

ApiCreateOrUpdatePropertiesWsdlSelector

Nom	Description	Valeur
wsdlEndpointName	Nom du point de terminaison(port) à importer à partir de WSDL	string
wsdlServiceName	Nom du service à importer à partir de WSDL	string

Modèles de démarrage rapide

Les modèles de démarrage rapide suivants déploient ce type de ressource.

Modèle	Description
Créer une instance de Gestion des API et toutes les sous-ressources à l’aide d’un modèle	Ce modèle montre comment créer un service Gestion des API et configurer des sous-entités
Créer Azure Front Door devant Azure Gestion des API	Cet exemple montre comment utiliser Azure Front Door comme équilibreur de charge global devant Azure Gestion des API.

Définition de ressource Terraform (fournisseur AzAPI)

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

Groupes de ressources

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

Format des ressources

Pour créer une ressource Microsoft.ApiManagement/service/apis, ajoutez le Terraform suivant à votre modèle.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service/apis@2023-05-01-preview"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      apiRevision = "string"
      apiRevisionDescription = "string"
      apiType = "string"
      apiVersion = "string"
      apiVersionDescription = "string"
      apiVersionSet = {
        description = "string"
        id = "string"
        name = "string"
        versionHeaderName = "string"
        versioningScheme = "string"
        versionQueryName = "string"
      }
      apiVersionSetId = "string"
      authenticationSettings = {
        oAuth2 = {
          authorizationServerId = "string"
          scope = "string"
        }
        oAuth2AuthenticationSettings = [
          {
            authorizationServerId = "string"
            scope = "string"
          }
        ]
        openid = {
          bearerTokenSendingMethods = [
            "string"
          ]
          openidProviderId = "string"
        }
        openidAuthenticationSettings = [
          {
            bearerTokenSendingMethods = [
              "string"
            ]
            openidProviderId = "string"
          }
        ]
      }
      contact = {
        email = "string"
        name = "string"
        url = "string"
      }
      description = "string"
      displayName = "string"
      format = "string"
      isCurrent = bool
      license = {
        name = "string"
        url = "string"
      }
      path = "string"
      protocols = [
        "string"
      ]
      serviceUrl = "string"
      sourceApiId = "string"
      subscriptionKeyParameterNames = {
        header = "string"
        query = "string"
      }
      subscriptionRequired = bool
      termsOfServiceUrl = "string"
      translateRequiredQueryParameters = "string"
      type = "string"
      value = "string"
      wsdlSelector = {
        wsdlEndpointName = "string"
        wsdlServiceName = "string"
      }
    }
  })
}

Valeurs de propriétés

service/apis

Nom	Description	Valeur
type	Type de ressource	« Microsoft.ApiManagement/service/apis@2023-05-01-preview »
name	Nom de la ressource	chaîne (obligatoire) Limite de caractères : 1-80 Caractères valides : Caractères alphanumériques et traits d’union. Doit commencer par une lettre et se terminer par un caractère alphanumérique.
parent_id	ID de la ressource qui est le parent de cette ressource.	ID pour la ressource de type : service
properties	L’entité API crée des propriétés de mise à jour.	ApiCreateOrUpdatePropertiesOrApiContractProperties

ApiCreateOrUpdatePropertiesOrApiContractProperties

Nom	Description	Valeur
apiRevision	Décrit la révision de l’API. Si aucune valeur n’est fournie, la révision par défaut 1 est créée	string
apiRevisionDescription	Description de la révision de l’API.	string
apiType	Type d’API à créer. * `http` crée une API REST * `soap` crée une API directe SOAP * `websocket` crée l’API websocket * `graphql`crée GraphQL API. De nouveaux types peuvent être ajoutés à l’avenir.	« graphql » « grpc » « http » « odata » « soap » « websocket »
apiVersion	Indique l’identificateur de version de l’API si l’API est versionnée	string
apiVersionDescription	Description de la version de l’API.	string
apiVersionSet	Détails du jeu de versions	ApiVersionSetContractDetails
apiVersionSetId	Identificateur de ressource pour l’ApiVersionSet associé.	string
authenticationSettings	Collection des paramètres d’authentification inclus dans cette API.	AuthenticationSettingsContract
contact	Coordonnées de l’API.	ApiContactInformation
description	Description de l’API. Peut comporter des balises de mise en forme.	string
displayName	Nom de l’API. Doit contenir de 1 à 300 caractères.	string
format	Format du contenu dans lequel l’API est importée. De nouveaux formats pourront être ajoutés à l’avenir	« graphql-link » « grpc » « grpc-link » « odata » « odata-link » « openapi » « openapi+json » « openapi+json-link » « openapi-link » « swagger-json » « swagger-link-json » « wadl-link-json » « wadl-xml » « wsdl » « wsdl-link »
isCurrent	Indique si la révision de l’API est la révision actuelle de l’API.	bool
license	Informations de licence pour l’API.	ApiLicenseInformation
path	URL relative identifiant exclusivement cette API et tous les chemins d’accès à ses ressources au sein de l’instance de service Gestion des API. Elle est ajoutée à l’URL de base du point de terminaison d’API spécifiée lors de la création de l’instance de service pour former l’URL publique de cette API.	chaîne (obligatoire)
protocols	Indique sur quels protocoles les opérations dans cette API peuvent être appelées.	Tableau de chaînes contenant l’un des éléments suivants : « http » « https » « ws » « wss »
serviceUrl	URL absolue du service principal qui implémente cette API. Ne peut pas dépasser 2 000 caractères.	string
sourceApiId	Identificateur d’API de l’API source.	string
subscriptionKeyParameterNames	Protocoles sur lesquels l’API est mise à disposition.	SubscriptionKeyParameterNamesContract
subscriptionRequired	Spécifie si un abonnement à l’API ou au produit est requis pour accéder à l’API.	bool
termsOfServiceUrl	URL vers les conditions d’utilisation de l’API. DOIT être au format d’une URL.	string
translateRequiredQueryParameters	Stratégie de traduction des paramètres de requête requis en modèles. Par défaut, a la valeur 'template'. Valeurs possibles : 'template', 'query'	"query" « template »
type	Type d’API.	« graphql » « grpc » « http » « odata » « soap » « websocket »
value	Valeur de contenu lors de l’importation d’une API.	string
wsdlSelector	Critères pour limiter l’importation de WSDL dans un sous-ensemble du document.	ApiCreateOrUpdatePropertiesWsdlSelector

ApiVersionSetContractDetails

Nom	Description	Valeur
description	Description du jeu de versions d’API.	string
id	Identificateur de l’ensemble de versions d’API existant. Omettez cette valeur pour créer un jeu de versions.	string
name	Nom d’affichage du jeu de versions d’API.	string
versionHeaderName	Nom du paramètre d’en-tête HTTP qui indique la version de l’API si versioningScheme a la valeur `header`.	string
versioningScheme	Valeur qui détermine l’emplacement de l’identificateur de version de l’API dans une requête HTTP.	« En-tête » « Requête » « Segment »
versionQueryName	Nom du paramètre de requête qui indique la version de l’API si versioningScheme est défini sur `query`.	string

AuthenticationSettingsContract

Nom	Description	Valeur
OAuth2	Paramètres d’authentification OAuth2	OAuth2AuthenticationSettingsContract
oAuth2AuthenticationSettings	Collection de paramètres d’authentification OAuth2 inclus dans cette API.	OAuth2AuthenticationSettingsContract[]
openid	Paramètres d’authentification OpenID Connect	OpenIdAuthenticationSettingsContract
openidAuthenticationSettings	Collection de paramètres d’authentification Open ID Connect inclus dans cette API.	OpenIdAuthenticationSettingsContract[]

OAuth2AuthenticationSettingsContract

Nom	Description	Valeur
authorizationServerId	Identificateur du serveur d'autorisation OAuth.	string
scope	étendue des opérations.	string

OpenIdAuthenticationSettingsContract

Nom	Description	Valeur
bearerTokenSendingMethods	Comment envoyer un jeton au serveur.	Tableau de chaînes contenant l’un des éléments suivants : « authorizationHeader » "query"
openidProviderId	Identificateur du serveur d'autorisation OAuth.	string

ApiContactInformation

Nom	Description	Valeur
email	Adresse e-mail de la personne/organization de contact. DOIT être au format d’une adresse e-mail	string
name	Nom d’identification de la personne/organization de contact	string
url	URL pointant vers les informations de contact. DOIT être au format d’une URL	string

ApiLicenseInformation

Nom	Description	Valeur
name	Nom de licence utilisé pour l’API	string
url	URL de la licence utilisée pour l’API. DOIT être au format d’une URL	string

SubscriptionKeyParameterNamesContract

Nom	Description	Valeur
en-tête	Nom de l’en-tête de la clé d’abonnement.	string
query	Nom du paramètre de chaîne de requête de clé d’abonnement.	string

ApiCreateOrUpdatePropertiesWsdlSelector

Nom	Description	Valeur
wsdlEndpointName	Nom du point de terminaison(port) à importer à partir de WSDL	string
wsdlServiceName	Nom du service à importer à partir de WSDL	string

Partager via

Service/apis Microsoft.ApiManagement

Définition de ressource Bicep

Format des ressources

Valeurs de propriétés

service/apis

ApiCreateOrUpdatePropertiesOrApiContractProperties

ApiVersionSetContractDetails

AuthenticationSettingsContract

OAuth2AuthenticationSettingsContract

OpenIdAuthenticationSettingsContract

ApiContactInformation

ApiLicenseInformation

SubscriptionKeyParameterNamesContract

ApiCreateOrUpdatePropertiesWsdlSelector

Modèles de démarrage rapide

Définition de ressources de modèle ARM

Format des ressources

Valeurs de propriétés

service/apis

ApiCreateOrUpdatePropertiesOrApiContractProperties

ApiVersionSetContractDetails

AuthenticationSettingsContract

OAuth2AuthenticationSettingsContract

OpenIdAuthenticationSettingsContract

ApiContactInformation

ApiLicenseInformation

SubscriptionKeyParameterNamesContract

ApiCreateOrUpdatePropertiesWsdlSelector

Modèles de démarrage rapide

Définition de ressource Terraform (fournisseur AzAPI)

Format des ressources

Valeurs de propriétés

service/apis

ApiCreateOrUpdatePropertiesOrApiContractProperties

ApiVersionSetContractDetails

AuthenticationSettingsContract

OAuth2AuthenticationSettingsContract

OpenIdAuthenticationSettingsContract

ApiContactInformation

ApiLicenseInformation

SubscriptionKeyParameterNamesContract

ApiCreateOrUpdatePropertiesWsdlSelector

Commentaires

Commentaires

Ressources supplémentaires