Partager via

Service Microsoft.ApiManagement/apis 2016-07-07

  • Article

Définition de ressource Bicep

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

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@2016-07-07' = {
  parent: resourceSymbolicName
  authenticationSettings: {
    oAuth2: {
      authorizationServerId: 'string'
      scope: 'string'
    }
  }
  description: 'string'
  name: 'string'
  path: 'string'
  protocols: [
    'string'
  ]
  serviceUrl: 'string'
  subscriptionKeyParameterNames: {
    header: 'string'
    query: 'string'
  }
}

Valeurs de propriété

AuthenticationSettingsContract

Nom Description Valeur
oAuth2 Détails des paramètres d’authentification OAuth2 de l’API. OAuth2AuthenticationSettingsContract

Microsoft.ApiManagement/service/apis

Nom Description Valeur
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
nom Nom de la ressource corde

Contraintes:
Longueur minimale = 1
Longueur maximale = 256
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
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 = 400 (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' (obligatoire)
serviceUrl URL absolue du service principal implémentant cette API. corde

Contraintes:
Longueur minimale = 1
Longueur maximale = 2000 (obligatoire)
subscriptionKeyParameterNames Protocoles sur lesquels l’API est rendue disponible. SubscriptionKeyParameterNamesContract

OAuth2AuthenticationSettingsContract

Nom Description Valeur
authorizationServerId Identificateur du serveur d’autorisation OAuth. corde
portée étendue des opérations. 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 :

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": "2016-07-07",
  "name": "string",
  "authenticationSettings": {
    "oAuth2": {
      "authorizationServerId": "string",
      "scope": "string"
    }
  },
  "description": "string",
  "path": "string",
  "protocols": [ "string" ],
  "serviceUrl": "string",
  "subscriptionKeyParameterNames": {
    "header": "string",
    "query": "string"
  }
}

Valeurs de propriété

AuthenticationSettingsContract

Nom Description Valeur
oAuth2 Détails des paramètres d’authentification OAuth2 de l’API. OAuth2AuthenticationSettingsContract

Microsoft.ApiManagement/service/apis

Nom Description Valeur
apiVersion Version de l’API '2016-07-07'
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
nom Nom de la ressource corde

Contraintes:
Longueur minimale = 1
Longueur maximale = 256
Modèle = ^[^*#&+:<>?]+$ (obligatoire)
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 = 400 (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' (obligatoire)
serviceUrl URL absolue du service principal implémentant cette API. corde

Contraintes:
Longueur minimale = 1
Longueur maximale = 2000 (obligatoire)
subscriptionKeyParameterNames Protocoles sur lesquels l’API est rendue disponible. SubscriptionKeyParameterNamesContract
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

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

Exemples d’utilisation

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@2016-07-07"
  name = "string"
  authenticationSettings = {
    oAuth2 = {
      authorizationServerId = "string"
      scope = "string"
    }
  }
  description = "string"
  path = "string"
  protocols = [
    "string"
  ]
  serviceUrl = "string"
  subscriptionKeyParameterNames = {
    header = "string"
    query = "string"
  }
}

Valeurs de propriété

AuthenticationSettingsContract

Nom Description Valeur
oAuth2 Détails des paramètres d’authentification OAuth2 de l’API. OAuth2AuthenticationSettingsContract

Microsoft.ApiManagement/service/apis

Nom Description Valeur
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
nom Nom de la ressource corde

Contraintes:
Longueur minimale = 1
Longueur maximale = 256
Modèle = ^[^*#&+:<>?]+$ (obligatoire)
parent_id ID de la ressource qui est le parent de cette ressource. ID de ressource de type : de service
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 = 400 (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' (obligatoire)
serviceUrl URL absolue du service principal implémentant cette API. corde

Contraintes:
Longueur minimale = 1
Longueur maximale = 2000 (obligatoire)
subscriptionKeyParameterNames Protocoles sur lesquels l’API est rendue disponible. SubscriptionKeyParameterNamesContract
type Type de ressource « Microsoft.ApiManagement/service/apis@2016-07-07 »

OAuth2AuthenticationSettingsContract

Nom Description Valeur
authorizationServerId Identificateur du serveur d’autorisation OAuth. corde
portée étendue des opérations. 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