Service/apis Microsoft.ApiManagement 2020-12-01

Article
12/20/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 - 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.ApiManagement/service/apis, ajoutez le bicep suivant à votre modèle.

resource symbolicname 'Microsoft.ApiManagement/service/apis@2020-12-01' = {
  parent: resourceSymbolicName
  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'
      }
      openid: {
        bearerTokenSendingMethods: [
          'string'
        ]
        openidProviderId: 'string'
      }
    }
    description: 'string'
    displayName: 'string'
    format: 'string'
    isCurrent: bool
    path: 'string'
    protocols: [
      'string'
    ]
    serviceUrl: 'string'
    sourceApiId: 'string'
    subscriptionKeyParameterNames: {
      header: 'string'
      query: 'string'
    }
    subscriptionRequired: bool
    type: 'string'
    value: 'string'
    wsdlSelector: {
      wsdlEndpointName: 'string'
      wsdlServiceName: 'string'
    }
  }
}

Valeurs de propriété

ApiCreateOrUpdatePropertiesOrApiContractProperties

Nom	Description	Valeur
apiRevision	Décrit la révision de l’API. Si aucune valeur n’est fournie, la révision 1 par défaut est créée	corde Contraintes: Longueur minimale = 1 Longueur maximale = 1
apiRevisionDescription	Description de la révision de l’API.	corde Contraintes: Longueur maximale =
apiType	Type d’API à créer. * `http` crée une API SOAP vers REST * `soap` crée une API directe SOAP .	'http' 'soap'
apiVersion	Indique l’identificateur de version de l’API si l’API est versionnée	corde Contraintes: Longueur maximale =
apiVersionDescription	Description de la version de l’API.	corde Contraintes: Longueur maximale =
apiVersionSet	Détails du jeu de versions	ApiVersionSetContractDetails
apiVersionSetId	Identificateur de ressource pour l’ApiVersionSet associé.	corde
authenticationSettings	Collection de paramètres d’authentification inclus dans cette API.	AuthenticationSettingsContract
description	Description de l’API. Peut inclure des balises de mise en forme HTML.	corde
displayName	Nom de l’API. Doit être de 1 à 300 caractères.	corde Contraintes: Longueur minimale = 1 Longueur maximale = 1
format	Format du contenu dans lequel l’API est importée.	'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
chemin	URL relative identifiant de manière unique cette API et tous ses chemins de ressources dans l’instance du service Gestion des API. Elle est ajoutée à l’URL de base du point de terminaison d’API spécifiée pendant la création de l’instance de service pour former une URL publique pour cette API.	corde Contraintes: Longueur maximale = (obligatoire)
protocole	Décrit les protocoles sur lesquels les opérations de cette API peuvent être appelées.	Tableau de chaînes contenant l’un des éléments suivants : 'http' 'https'
serviceUrl	URL absolue du service principal implémentant cette API. Ne peut pas comporter plus de 2 000 caractères.	corde Contraintes: Longueur maximale =
sourceApiId	Identificateur d’API de l’API source.	corde
subscriptionKeyParameterNames	Protocoles sur lesquels l’API est rendue disponible.	SubscriptionKeyParameterNamesContract
subscriptionRequired	Spécifie si un abonnement API ou Produit est requis pour accéder à l’API.	Bool
type	Type d’API.	'http' 'soap'
valeur	Valeur de contenu lors de l’importation d’une API.	corde
wsdlSelector	Critères pour limiter l’importation de WSDL à un sous-ensemble du document.	ApiCreateOrUpdatePropertiesWsdlSelector

ApiCreateOrUpdatePropertiesWsdlSelector

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

ApiVersionSetContractDetails

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

AuthenticationSettingsContract

Nom	Description	Valeur
oAuth2	Paramètres d’authentification OAuth2	OAuth2AuthenticationSettingsContract
openid	Paramètres d’authentification OpenID Connect	OpenIdAuthenticationSettingsContract

Microsoft.ApiManagement/service/apis

Nom	Description	Valeur
nom	Nom de la ressource	corde Contraintes: Longueur minimale = 1 Longueur maximale = 1 Modèle = `^[^*#&+:<>?]+$` (obligatoire)
parent	Dans Bicep, vous pouvez spécifier la ressource parente d’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
Propriétés	Création d’entités d’API de propriétés de mise à jour.	ApiCreateOrUpdatePropertiesOrApiContractProperties

OAuth2AuthenticationSettingsContract

Nom	Description	Valeur
authorizationServerId	Identificateur du serveur d’autorisation OAuth.	corde
portée	étendue des opérations.	corde

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.	corde

SubscriptionKeyParameterNamesContract

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

Définition de ressource de modèle ARM

Le type de ressource service/apis 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.ApiManagement/service/apis, ajoutez le code JSON suivant à votre modèle.

{
  "type": "Microsoft.ApiManagement/service/apis",
  "apiVersion": "2020-12-01",
  "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"
      },
      "openid": {
        "bearerTokenSendingMethods": [ "string" ],
        "openidProviderId": "string"
      }
    },
    "description": "string",
    "displayName": "string",
    "format": "string",
    "isCurrent": "bool",
    "path": "string",
    "protocols": [ "string" ],
    "serviceUrl": "string",
    "sourceApiId": "string",
    "subscriptionKeyParameterNames": {
      "header": "string",
      "query": "string"
    },
    "subscriptionRequired": "bool",
    "type": "string",
    "value": "string",
    "wsdlSelector": {
      "wsdlEndpointName": "string",
      "wsdlServiceName": "string"
    }
  }
}

Valeurs de propriété

ApiCreateOrUpdatePropertiesOrApiContractProperties

Nom	Description	Valeur
apiRevision	Décrit la révision de l’API. Si aucune valeur n’est fournie, la révision 1 par défaut est créée	corde Contraintes: Longueur minimale = 1 Longueur maximale = 1
apiRevisionDescription	Description de la révision de l’API.	corde Contraintes: Longueur maximale =
apiType	Type d’API à créer. * `http` crée une API SOAP vers REST * `soap` crée une API directe SOAP .	'http' 'soap'
apiVersion	Indique l’identificateur de version de l’API si l’API est versionnée	corde Contraintes: Longueur maximale =
apiVersionDescription	Description de la version de l’API.	corde Contraintes: Longueur maximale =
apiVersionSet	Détails du jeu de versions	ApiVersionSetContractDetails
apiVersionSetId	Identificateur de ressource pour l’ApiVersionSet associé.	corde
authenticationSettings	Collection de paramètres d’authentification inclus dans cette API.	AuthenticationSettingsContract
description	Description de l’API. Peut inclure des balises de mise en forme HTML.	corde
displayName	Nom de l’API. Doit être de 1 à 300 caractères.	corde Contraintes: Longueur minimale = 1 Longueur maximale = 1
format	Format du contenu dans lequel l’API est importée.	'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
chemin	URL relative identifiant de manière unique cette API et tous ses chemins de ressources dans l’instance du service Gestion des API. Elle est ajoutée à l’URL de base du point de terminaison d’API spécifiée pendant la création de l’instance de service pour former une URL publique pour cette API.	corde Contraintes: Longueur maximale = (obligatoire)
protocole	Décrit les protocoles sur lesquels les opérations de cette API peuvent être appelées.	Tableau de chaînes contenant l’un des éléments suivants : 'http' 'https'
serviceUrl	URL absolue du service principal implémentant cette API. Ne peut pas comporter plus de 2 000 caractères.	corde Contraintes: Longueur maximale =
sourceApiId	Identificateur d’API de l’API source.	corde
subscriptionKeyParameterNames	Protocoles sur lesquels l’API est rendue disponible.	SubscriptionKeyParameterNamesContract
subscriptionRequired	Spécifie si un abonnement API ou Produit est requis pour accéder à l’API.	Bool
type	Type d’API.	'http' 'soap'
valeur	Valeur de contenu lors de l’importation d’une API.	corde
wsdlSelector	Critères pour limiter l’importation de WSDL à un sous-ensemble du document.	ApiCreateOrUpdatePropertiesWsdlSelector

ApiCreateOrUpdatePropertiesWsdlSelector

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

ApiVersionSetContractDetails

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

AuthenticationSettingsContract

Nom	Description	Valeur
oAuth2	Paramètres d’authentification OAuth2	OAuth2AuthenticationSettingsContract
openid	Paramètres d’authentification OpenID Connect	OpenIdAuthenticationSettingsContract

Microsoft.ApiManagement/service/apis

Nom	Description	Valeur
apiVersion	Version de l’API	'2020-12-01'
nom	Nom de la ressource	corde Contraintes: Longueur minimale = 1 Longueur maximale = 1 Modèle = `^[^*#&+:<>?]+$` (obligatoire)
Propriétés	Création d’entités d’API de propriétés de mise à jour.	ApiCreateOrUpdatePropertiesOrApiContractProperties
type	Type de ressource	'Microsoft.ApiManagement/service/apis'

OAuth2AuthenticationSettingsContract

Nom	Description	Valeur
authorizationServerId	Identificateur du serveur d’autorisation OAuth.	corde
portée	étendue des opérations.	corde

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.	corde

SubscriptionKeyParameterNamesContract

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

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 de ressource

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@2020-12-01"
  name = "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"
        }
        openid = {
          bearerTokenSendingMethods = [
            "string"
          ]
          openidProviderId = "string"
        }
      }
      description = "string"
      displayName = "string"
      format = "string"
      isCurrent = bool
      path = "string"
      protocols = [
        "string"
      ]
      serviceUrl = "string"
      sourceApiId = "string"
      subscriptionKeyParameterNames = {
        header = "string"
        query = "string"
      }
      subscriptionRequired = bool
      type = "string"
      value = "string"
      wsdlSelector = {
        wsdlEndpointName = "string"
        wsdlServiceName = "string"
      }
    }
  })
}

Valeurs de propriété

ApiCreateOrUpdatePropertiesOrApiContractProperties

Nom	Description	Valeur
apiRevision	Décrit la révision de l’API. Si aucune valeur n’est fournie, la révision 1 par défaut est créée	corde Contraintes: Longueur minimale = 1 Longueur maximale = 1
apiRevisionDescription	Description de la révision de l’API.	corde Contraintes: Longueur maximale =
apiType	Type d’API à créer. * `http` crée une API SOAP vers REST * `soap` crée une API directe SOAP .	'http' 'soap'
apiVersion	Indique l’identificateur de version de l’API si l’API est versionnée	corde Contraintes: Longueur maximale =
apiVersionDescription	Description de la version de l’API.	corde Contraintes: Longueur maximale =
apiVersionSet	Détails du jeu de versions	ApiVersionSetContractDetails
apiVersionSetId	Identificateur de ressource pour l’ApiVersionSet associé.	corde
authenticationSettings	Collection de paramètres d’authentification inclus dans cette API.	AuthenticationSettingsContract
description	Description de l’API. Peut inclure des balises de mise en forme HTML.	corde
displayName	Nom de l’API. Doit être de 1 à 300 caractères.	corde Contraintes: Longueur minimale = 1 Longueur maximale = 1
format	Format du contenu dans lequel l’API est importée.	'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
chemin	URL relative identifiant de manière unique cette API et tous ses chemins de ressources dans l’instance du service Gestion des API. Elle est ajoutée à l’URL de base du point de terminaison d’API spécifiée pendant la création de l’instance de service pour former une URL publique pour cette API.	corde Contraintes: Longueur maximale = (obligatoire)
protocole	Décrit les protocoles sur lesquels les opérations de cette API peuvent être appelées.	Tableau de chaînes contenant l’un des éléments suivants : 'http' 'https'
serviceUrl	URL absolue du service principal implémentant cette API. Ne peut pas comporter plus de 2 000 caractères.	corde Contraintes: Longueur maximale =
sourceApiId	Identificateur d’API de l’API source.	corde
subscriptionKeyParameterNames	Protocoles sur lesquels l’API est rendue disponible.	SubscriptionKeyParameterNamesContract
subscriptionRequired	Spécifie si un abonnement API ou Produit est requis pour accéder à l’API.	Bool
type	Type d’API.	'http' 'soap'
valeur	Valeur de contenu lors de l’importation d’une API.	corde
wsdlSelector	Critères pour limiter l’importation de WSDL à un sous-ensemble du document.	ApiCreateOrUpdatePropertiesWsdlSelector

ApiCreateOrUpdatePropertiesWsdlSelector

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

ApiVersionSetContractDetails

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

AuthenticationSettingsContract

Nom	Description	Valeur
oAuth2	Paramètres d’authentification OAuth2	OAuth2AuthenticationSettingsContract
openid	Paramètres d’authentification OpenID Connect	OpenIdAuthenticationSettingsContract

Microsoft.ApiManagement/service/apis

Nom	Description	Valeur
nom	Nom de la ressource	corde Contraintes: Longueur minimale = 1 Longueur maximale = 1 Modèle = `^[^*#&+:<>?]+$` (obligatoire)
parent_id	ID de la ressource qui est le parent de cette ressource.	ID de ressource de type : de service
Propriétés	Création d’entités d’API de propriétés de mise à jour.	ApiCreateOrUpdatePropertiesOrApiContractProperties
type	Type de ressource	« Microsoft.ApiManagement/service/apis@2020-12-01 »

OAuth2AuthenticationSettingsContract

Nom	Description	Valeur
authorizationServerId	Identificateur du serveur d’autorisation OAuth.	corde
portée	étendue des opérations.	corde

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.	corde

SubscriptionKeyParameterNamesContract

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

Partager via

Service/apis Microsoft.ApiManagement 2020-12-01

Définition de ressource Bicep

Format de ressource

Valeurs de propriété

ApiCreateOrUpdatePropertiesOrApiContractProperties

ApiCreateOrUpdatePropertiesWsdlSelector

ApiVersionSetContractDetails

AuthenticationSettingsContract

Microsoft.ApiManagement/service/apis

OAuth2AuthenticationSettingsContract

OpenIdAuthenticationSettingsContract

SubscriptionKeyParameterNamesContract

Définition de ressource de modèle ARM

Format de ressource

Valeurs de propriété

ApiCreateOrUpdatePropertiesOrApiContractProperties

ApiCreateOrUpdatePropertiesWsdlSelector

ApiVersionSetContractDetails

AuthenticationSettingsContract

Microsoft.ApiManagement/service/apis

OAuth2AuthenticationSettingsContract

OpenIdAuthenticationSettingsContract

SubscriptionKeyParameterNamesContract

Définition de ressource Terraform (fournisseur AzAPI)

Format de ressource

Valeurs de propriété

ApiCreateOrUpdatePropertiesOrApiContractProperties

ApiCreateOrUpdatePropertiesWsdlSelector

ApiVersionSetContractDetails

AuthenticationSettingsContract

Microsoft.ApiManagement/service/apis

OAuth2AuthenticationSettingsContract

OpenIdAuthenticationSettingsContract

SubscriptionKeyParameterNamesContract

Commentaires

Ressources supplémentaires