Service Microsoft.ApiManagement/apiVersionSets 2023-03-01-preview

• La plus récente
• 2023-05-01-preview
• Préversion du 01/03/2023
• 2022-09-01-preview
• 2022-08-01
• 2022-04-01-preview
• 2021-12-01-preview
• 2021-08-01
• 2021-04-01-preview

Définition de ressource Bicep

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

• Groupes de ressources - Voir 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 des ressources

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

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

Valeurs de propriétés

service/apiVersionSets

Nom	Description	Valeur
name	Nom de la ressource Découvrez comment définir des noms et des types pour des ressources enfants dans Bicep.	chaîne (obligatoire)
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	Propriétés du contrat API VersionSet.	ApiVersionSetContractProperties

ApiVersionSetContractProperties

Nom	Description	Valeur
description	Description du jeu de versions d’API.	string
displayName	Nom du jeu de versions d’API	chaîne (obligatoire)
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' (obligatoire)
versionQueryName	Nom du paramètre de requête qui indique la version de l’API si versioningScheme est défini sur query.	string

Définition de ressources de modèle ARM

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

• Groupes de ressources - Voir 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 des ressources

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

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

Valeurs de propriétés

service/apiVersionSets

Nom	Description	Valeur
type	Type de ressource	« Microsoft.ApiManagement/service/apiVersionSets »
apiVersion	Version de l’API de ressource	« 2023-03-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)
properties	Propriétés du contrat API VersionSet.	ApiVersionSetContractProperties

ApiVersionSetContractProperties

Nom	Description	Valeur
description	Description du jeu de versions d’API.	string
displayName	Nom du jeu de versions d’API	chaîne (obligatoire)
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' (obligatoire)
versionQueryName	Nom du paramètre de requête qui indique la version de l’API si versioningScheme a la valeur query.	string

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 d’API, consultez journal des modifications.

Format des ressources

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

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

Valeurs de propriétés

service/apiVersionSets

Nom	Description	Valeur
type	Type de ressource	« Microsoft.ApiManagement/service/apiVersionSets@2023-03-01-preview »
name	Nom de la ressource	string (obligatoire)
parent_id	ID de la ressource qui est le parent de cette ressource.	ID de ressource de type : service
properties	Propriétés du contrat API VersionSet.	ApiVersionSetContractProperties

ApiVersionSetContractProperties

Nom	Description	Valeur
description	Description de l’ensemble de versions d’API.	string
displayName	Nom de l’ensemble de versions d’API	string (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.	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 » (obligatoire)
versionQueryName	Nom du paramètre de requête qui indique la version de l’API si versioningScheme a la valeur query.	string