Partager via


Group - Create Or Update

Crée ou met à jour un groupe.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/groups/{groupId}?api-version=2022-08-01

Paramètres URI

Nom Dans Obligatoire Type Description
groupId
path True

string

Identificateur de groupe. Doit être unique dans le instance de service Gestion des API actuel.

resourceGroupName
path True

string

Nom du groupe de ressources. Le nom ne respecte pas la casse.

serviceName
path True

string

Nom du service Gestion des API.

Modèle d’expression régulière: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$

subscriptionId
path True

string

ID de l’abonnement cible.

api-version
query True

string

Version de l’API à utiliser pour cette opération.

En-tête de la demande

Nom Obligatoire Type Description
If-Match

string

ETag de l’entité. Non obligatoire lors de la création d’une entité, mais obligatoire lors de la mise à jour d’une entité.

Corps de la demande

Nom Obligatoire Type Description
properties.displayName True

string

Nom de groupe.

properties.description

string

Description de groupe.

properties.externalId

string

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.

properties.type

GroupType

Type du groupe.

Réponses

Nom Type Description
200 OK

GroupContract

Le groupe existe déjà.

En-têtes

ETag: string

201 Created

GroupContract

Le groupe a été créé avec succès.

En-têtes

ETag: string

Other Status Codes

ErrorResponse

Réponse d’erreur décrivant la raison de l’échec de l’opération.

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory.

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

Nom Description
user_impersonation Emprunter l’identité de votre compte d’utilisateur

Exemples

ApiManagementCreateGroup
ApiManagementCreateGroupExternal

ApiManagementCreateGroup

Exemple de requête

PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/groups/tempgroup?api-version=2022-08-01

{
  "properties": {
    "displayName": "temp group"
  }
}

Exemple de réponse

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/groups/tempgroup",
  "type": "Microsoft.ApiManagement/service/groups",
  "name": "tempgroup",
  "properties": {
    "displayName": "temp group",
    "type": "custom"
  }
}
{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/groups/tempgroup",
  "type": "Microsoft.ApiManagement/service/groups",
  "name": "tempgroup",
  "properties": {
    "displayName": "temp group",
    "type": "custom"
  }
}

ApiManagementCreateGroupExternal

Exemple de requête

PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/groups/aadGroup?api-version=2022-08-01

{
  "properties": {
    "displayName": "NewGroup (samiraad.onmicrosoft.com)",
    "description": "new group to test",
    "type": "external",
    "externalId": "aad://samiraad.onmicrosoft.com/groups/83cf2753-5831-4675-bc0e-2f8dc067c58d"
  }
}

Exemple de réponse

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/groups/aadGroup",
  "type": "Microsoft.ApiManagement/service/groups",
  "name": "aadGroup",
  "properties": {
    "displayName": "NewGroup (samiraad.onmicrosoft.com)",
    "description": "new group to test",
    "type": "external",
    "externalId": "aad://samiraad.onmicrosoft.com/groups/83cf2753-5831-4675-bc0e-2f8dc067c58d"
  }
}
{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/groups/aadGroup",
  "type": "Microsoft.ApiManagement/service/groups",
  "name": "aadGroup",
  "properties": {
    "displayName": "NewGroup (samiraad.onmicrosoft.com)",
    "description": "new group to test",
    "type": "external",
    "externalId": "aad://samiraad.onmicrosoft.com/groups/83cf2753-5831-4675-bc0e-2f8dc067c58d"
  }
}

Définitions

Nom Description
ErrorFieldContract

Contrat de champ d’erreur.

ErrorResponse

Réponse d’erreur.

GroupContract

Détails du contrat.

GroupCreateParameters

Paramètres fournis à l’opération Créer un groupe.

GroupType

Type du groupe.

ErrorFieldContract

Contrat de champ d’erreur.

Nom Type Description
code

string

Code d'erreur de niveau propriété.

message

string

Représentation lisible par l’homme de l’erreur au niveau des propriétés.

target

string

Nom de propriété.

ErrorResponse

Réponse d’erreur.

Nom Type Description
error.code

string

Code d'erreur défini par le service. Ce code sert de sous-état pour le code d'erreur HTTP spécifié dans la réponse.

error.details

ErrorFieldContract[]

Liste des champs non valides envoyés dans la demande, en cas d’erreur de validation.

error.message

string

Représentation contrôlable de visu de l’erreur.

GroupContract

Détails du contrat.

Nom Type Description
id

string

ID de ressource complet pour la ressource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

name

string

nom de la ressource.

properties.builtIn

boolean

true si le groupe est l’un des trois groupes système (Administrateurs, Développeurs ou Invités) ; sinon, false.

properties.description

string

Description de groupe. Peut contenir des balises au format HTML.

properties.displayName

string

Nom de groupe.

properties.externalId

string

Pour les 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.

properties.type

GroupType

Type du groupe.

type

string

Type de la ressource. Par exemple, « Microsoft.Compute/virtualMachines » ou « Microsoft.Storage/storageAccounts »

GroupCreateParameters

Paramètres fournis à l’opération Créer un groupe.

Nom Type Description
properties.description

string

Description de groupe.

properties.displayName

string

Nom de groupe.

properties.externalId

string

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.

properties.type

GroupType

Type du groupe.

GroupType

Type du groupe.

Nom Type Description
custom

string

external

string

system

string