Partager via

Service/groupes Microsoft.ApiManagement

  • Article

Définition de ressource Bicep

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

resource symbolicname 'Microsoft.ApiManagement/service/groups@2023-09-01-preview' = {
  name: 'string'
  parent: resourceSymbolicName
  properties: {
    description: 'string'
    displayName: 'string'
    externalId: 'string'
    type: 'string'
  }
}

Valeurs de propriété

service/groupes

Nom Description Valeur
nom Nom de la ressource

Découvrez comment définir des noms et des types pour les ressources enfants dans Bicep.		 chaîne (obligatoire)

Limite de caractères : 1 à 80

Caractères valides :
Alphanumériques et traits d’union.

Commencez par la lettre et terminez par alphanumérique.
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 fournies pour l’opération Créer un groupe. GroupCreateParametersPropertiesOrGroupContractProper...

GroupCreateParametersPropertiesOrGroupContractProper...

Nom Description Valeur
description Description du groupe. corde
displayName Nom du groupe. chaîne (obligatoire)

Contraintes:
Longueur minimale = 1
Longueur maximale = 300
externalId Identificateur des groupes externes, cette propriété contient l’ID du groupe à partir du fournisseur d’identité externe, par exemple pour Azure Active Directory aad://{tenant}.onmicrosoft.com/groups/{group object id}; sinon, la valeur est Null. corde
type Type de groupe. 'custom'
'external'
'system'

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 Gestion des API et toutes les sous-ressources à l’aide d’un modèle

Déployer sur Azure 		Ce modèle montre comment créer un service Gestion des API et configurer des sous-entités

Définition de ressource de modèle ARM

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

{
  "type": "Microsoft.ApiManagement/service/groups",
  "apiVersion": "2023-09-01-preview",
  "name": "string",
  "properties": {
    "description": "string",
    "displayName": "string",
    "externalId": "string",
    "type": "string"
  }
}

Valeurs de propriété

service/groupes

Nom Description Valeur
type Type de ressource 'Microsoft.ApiManagement/service/groups'
apiVersion Version de l’API de ressource '2023-09-01-preview'
nom Nom de la ressource

Découvrez comment définir des noms et des types pour les ressources enfants dans modèles ARM JSON.		 chaîne (obligatoire)

Limite de caractères : 1 à 80

Caractères valides :
Alphanumériques et traits d’union.

Commencez par la lettre et terminez par alphanumérique.
Propriétés Propriétés fournies pour l’opération Créer un groupe. GroupCreateParametersPropertiesOrGroupContractProper...

GroupCreateParametersPropertiesOrGroupContractProper...

Nom Description Valeur
description Description du groupe. corde
displayName Nom du groupe. chaîne (obligatoire)

Contraintes:
Longueur minimale = 1
Longueur maximale = 300
externalId Identificateur des groupes externes, cette propriété contient l’ID du groupe à partir du fournisseur d’identité externe, par exemple pour Azure Active Directory aad://{tenant}.onmicrosoft.com/groups/{group object id}; sinon, la valeur est Null. corde
type Type de groupe. 'custom'
'external'
'system'

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 Gestion des API et toutes les sous-ressources à l’aide d’un modèle

Déployer sur Azure 		Ce modèle montre comment créer un service Gestion des API et configurer des sous-entités

Définition de ressource Terraform (fournisseur AzAPI)

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service/groups@2023-09-01-preview"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      description = "string"
      displayName = "string"
      externalId = "string"
      type = "string"
    }
  })
}

Valeurs de propriété

service/groupes

Nom Description Valeur
type Type de ressource « Microsoft.ApiManagement/service/groups@2023-09-01-preview »
nom Nom de la ressource chaîne (obligatoire)

Limite de caractères : 1 à 80

Caractères valides :
Alphanumériques et traits d’union.

Commencez par la lettre et terminez par alphanumérique.
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 fournies pour l’opération Créer un groupe. GroupCreateParametersPropertiesOrGroupContractProper...

GroupCreateParametersPropertiesOrGroupContractProper...

Nom Description Valeur
description Description du groupe. corde
displayName Nom du groupe. chaîne (obligatoire)

Contraintes:
Longueur minimale = 1
Longueur maximale = 300
externalId Identificateur des groupes externes, cette propriété contient l’ID du groupe à partir du fournisseur d’identité externe, par exemple pour Azure Active Directory aad://{tenant}.onmicrosoft.com/groups/{group object id}; sinon, la valeur est Null. corde
type Type de groupe. « personnalisé »
« externe »
« system »