Partager via

Service Microsoft.ApiManagement/apiVersionSets 2021-08-01

  • Article

Définition de ressource Bicep

Le type de ressource service/apiVersionSets 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/apiVersionSets, ajoutez le bicep suivant à votre modèle.

resource symbolicname 'Microsoft.ApiManagement/service/apiVersionSets@2021-08-01' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    description: 'string'
    displayName: 'string'
    versionHeaderName: 'string'
    versioningScheme: 'string'
    versionQueryName: 'string'
  }
}

Valeurs de propriété

ApiVersionSetContractProperties

Nom Description Valeur
description Description du jeu de versions d’API. corde
displayName Nom du jeu de versions d’API corde

Contraintes:
Longueur minimale = 1
Longueur maximale = 1 (obligatoire)
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

Contraintes:
Longueur minimale = 1
Longueur maximale = 1
versioningScheme Valeur qui détermine l’emplacement de l’identificateur de version de l’API dans une requête HTTP. 'Header'
'Query'
'Segment' (obligatoire)
versionQueryName Nom du paramètre de requête qui indique la version de l’API si versioningScheme a la valeur query. corde

Contraintes:
Longueur minimale = 1
Longueur maximale = 1

Microsoft.ApiManagement/service/apiVersionSets

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 Propriétés du contrat API VersionSet. ApiVersionSetContractProperties

Définition de ressource de modèle ARM

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

{
  "type": "Microsoft.ApiManagement/service/apiVersionSets",
  "apiVersion": "2021-08-01",
  "name": "string",
  "properties": {
    "description": "string",
    "displayName": "string",
    "versionHeaderName": "string",
    "versioningScheme": "string",
    "versionQueryName": "string"
  }
}

Valeurs de propriété

ApiVersionSetContractProperties

Nom Description Valeur
description Description du jeu de versions d’API. corde
displayName Nom du jeu de versions d’API corde

Contraintes:
Longueur minimale = 1
Longueur maximale = 1 (obligatoire)
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

Contraintes:
Longueur minimale = 1
Longueur maximale = 1
versioningScheme Valeur qui détermine l’emplacement de l’identificateur de version de l’API dans une requête HTTP. 'Header'
'Query'
'Segment' (obligatoire)
versionQueryName Nom du paramètre de requête qui indique la version de l’API si versioningScheme a la valeur query. corde

Contraintes:
Longueur minimale = 1
Longueur maximale = 1

Microsoft.ApiManagement/service/apiVersionSets

Nom Description Valeur
apiVersion Version de l’API '2021-08-01'
nom Nom de la ressource corde

Contraintes:
Longueur minimale = 1
Longueur maximale = 1
Modèle = ^[^*#&+:<>?]+$ (obligatoire)
Propriétés Propriétés du contrat API VersionSet. ApiVersionSetContractProperties
type Type de ressource 'Microsoft.ApiManagement/service/apiVersionSets'

Définition de ressource Terraform (fournisseur AzAPI)

Le type de ressource service/apiVersionSets 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/apiVersionSets, ajoutez la terraform suivante à votre modèle.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service/apiVersionSets@2021-08-01"
  name = "string"
  body = jsonencode({
    properties = {
      description = "string"
      displayName = "string"
      versionHeaderName = "string"
      versioningScheme = "string"
      versionQueryName = "string"
    }
  })
}

Valeurs de propriété

ApiVersionSetContractProperties

Nom Description Valeur
description Description du jeu de versions d’API. corde
displayName Nom du jeu de versions d’API corde

Contraintes:
Longueur minimale = 1
Longueur maximale = 1 (obligatoire)
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

Contraintes:
Longueur minimale = 1
Longueur maximale = 1
versioningScheme Valeur qui détermine l’emplacement de l’identificateur de version de l’API dans une requête HTTP. 'Header'
'Query'
'Segment' (obligatoire)
versionQueryName Nom du paramètre de requête qui indique la version de l’API si versioningScheme a la valeur query. corde

Contraintes:
Longueur minimale = 1
Longueur maximale = 1

Microsoft.ApiManagement/service/apiVersionSets

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 Propriétés du contrat API VersionSet. ApiVersionSetContractProperties
type Type de ressource « Microsoft.ApiManagement/service/apiVersionSets@2021-08-01 »