Group - Get
Obtient les détails du groupe spécifié par son identificateur.
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/groups/{groupId}?api-version=2021-08-01
Paramètres URI
Nom | Dans | Obligatoire | Type | Description |
---|---|---|---|---|
group
|
path | True |
string |
Identificateur de groupe. Doit être unique dans le instance de service Gestion des API actuel. |
resource
|
path | True |
string |
Nom du groupe de ressources. |
service
|
path | True |
string |
Nom du service Gestion des API. Modèle d’expression régulière: |
subscription
|
path | True |
string |
Informations d’identification d’abonnement qui identifient de manière unique l’abonnement Microsoft Azure. L’ID d’abonnement fait partie de l’URI pour chaque appel de service. |
api-version
|
query | True |
string |
Version de l’API à utiliser avec la demande cliente. |
Réponses
Nom | Type | Description |
---|---|---|
200 OK |
Le corps de la réponse contient l’entité Group spécifiée. En-têtes ETag: string |
|
Other Status Codes |
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
ApiManagementGetGroup
Exemple de requête
Exemple de réponse
{
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/groups/59306a29e4bbd510dc24e5f9",
"type": "Microsoft.ApiManagement/service/groups",
"name": "59306a29e4bbd510dc24e5f9",
"properties": {
"displayName": "AwesomeGroup (samiraad.onmicrosoft.com)",
"description": "awesome group of people",
"builtIn": false,
"type": "external",
"externalId": "aad://samiraad.onmicrosoft.com/groups/3773adf4-032e-4d25-9988-eaff9ca72eca"
}
}
Définitions
Nom | Description |
---|---|
Error |
Contrat champ d’erreur. |
Error |
Réponse d’erreur. |
Group |
Détails du contrat. |
Group |
Type du groupe. |
ErrorFieldContract
Contrat 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 de la propriété. |
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 |
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 du fournisseur d’identité externe, par exemple pour Azure Active Directory |
properties.type |
Type du groupe. |
|
type |
string |
Type de la ressource. Par exemple, « Microsoft.Compute/virtualMachines » ou « Microsoft.Storage/storageAccounts » |
GroupType
Type du groupe.
Nom | Type | Description |
---|---|---|
custom |
string |
|
external |
string |
|
system |
string |