Partager via


Service/groupes Microsoft.ApiManagement 2022-04-01-preview

Définition de ressource Bicep

Le type de ressource 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 des ressources

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

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

Valeurs de propriétés

service/groups

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)

Limite de caractères : 1-80

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

Doit commencer par une lettre et se terminer par un caractère alphanumérique.
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 fournies à l’opération Créer un groupe. GroupCreateParametersPropertiesOrGroupContractProper...

GroupCreateParametersPropertiesOrGroupContractProper...

Nom Description Valeur
description Description de groupe. string
displayName Nom de groupe. chaîne (obligatoire)
externalId Identificateur des groupes externes, cette propriété contient l’ID du groupe du fournisseur d’identité externe, par exemple pour Azure Active Directory aad://{tenant}.onmicrosoft.com/groups/{group object id}; sinon, la valeur est null. string
type Type du groupe. 'custom'
'externe'
'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 de 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 ressources de modèle ARM

Le type de ressource 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 des ressources

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

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

Valeurs de propriétés

service/groups

Nom Description Valeur
type Type de ressource « Microsoft.ApiManagement/service/groups »
apiVersion Version de l’API de ressource « 2022-04-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)

Limite de caractères : 1-80

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

Doit commencer par une lettre et se terminer par un caractère alphanumérique.
properties Propriétés fournies à l’opération Créer un groupe. GroupCreateParametersPropertiesOrGroupContractProper...

GroupCreateParametersPropertiesOrGroupContractProper...

Nom Description Valeur
description Description de groupe. string
displayName Nom de groupe. chaîne (obligatoire)
externalId Identificateur des groupes externes, cette propriété contient l’ID du groupe du fournisseur d’identité externe, par exemple pour Azure Active Directory aad://{tenant}.onmicrosoft.com/groups/{group object id}; sinon, la valeur est null. string
type Type du groupe. 'custom'
'externe'
'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 de 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 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 des ressources

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@2022-04-01-preview"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      description = "string"
      displayName = "string"
      externalId = "string"
      type = "string"
    }
  })
}

Valeurs de propriétés

service/groups

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

Limite de caractères : 1-80

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

Doit commencer par une lettre et se terminer par un caractère alphanumérique.
parent_id ID de la ressource qui est le parent de cette ressource. ID pour la ressource de type : service
properties Propriétés fournies à l’opération Créer un groupe. GroupCreateParametersPropertiesOrGroupContractProper...

GroupCreateParametersPropertiesOrGroupContractProper...

Nom Description Valeur
description Description de groupe. string
displayName Nom de groupe. chaîne (obligatoire)
externalId Identificateur des groupes externes, cette propriété contient l’ID du groupe du fournisseur d’identité externe, par exemple pour Azure Active Directory aad://{tenant}.onmicrosoft.com/groups/{group object id}; sinon, la valeur est null. string
type Type du groupe. « personnalisé »
« externe »
« system »