Group - Get

Hiermee haalt u de details van de groep die is opgegeven door de id.

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

URI-parameters

Name In Required Type Description
groupId
path True
  • string

Groeps-id. Moet uniek zijn in het huidige API Management service-exemplaar.

resourceGroupName
path True
  • string

De naam van de resourcegroep.

serviceName
path True
  • string

De naam van de API Management service.

Regex pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$

subscriptionId
path True
  • string

Abonnementsreferenties die een uniek Microsoft Azure identificeren. De abonnements-id maakt deel uit van de URI voor elke serviceoproep.

api-version
query True
  • string

Versie van de API die moet worden gebruikt met de clientaanvraag.

Antwoorden

Name Type Description
200 OK

De antwoord-body bevat de opgegeven groepsentiteit.

Headers

  • ETag: string
Other Status Codes

Foutbericht waarin wordt beschreven waarom de bewerking is mislukt.

Beveiliging

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation uw gebruikersaccount imiteren

Voorbeelden

ApiManagementGetGroup

Sample Request

GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/groups/59306a29e4bbd510dc24e5f9?api-version=2020-12-01

Sample Response

{
  "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"
  }
}

Definities

ErrorFieldContract

Foutveldcontract.

ErrorResponse

Foutbericht.

GroupContract

Contractdetails.

GroupType

Groepstype.

ErrorFieldContract

Foutveldcontract.

Name Type Description
code
  • string

Foutcode op eigenschapsniveau.

message
  • string

Door mensen leesbare weergave van fout op eigenschapsniveau.

target
  • string

Eigenschapsnaam.

ErrorResponse

Foutbericht.

Name Type Description
error.code
  • string

Door de service gedefinieerde foutcode. Deze code fungeert als een substatus voor de HTTP-foutcode die is opgegeven in het antwoord.

error.details

De lijst met ongeldige velden die in de aanvraag worden weergegeven, in het geval van een validatiefout.

error.message
  • string

Door mensen leesbare weergave van de fout.

GroupContract

Contractdetails.

Name Type Description
id
  • string

Resource-id.

name
  • string

Resourcenaam.

properties.builtIn
  • boolean

waar als de groep een van de drie systeemgroepen is (beheerders, ontwikkelaars of gasten); anders false.

properties.description
  • string

Groepsbeschrijving. Kan HTML-opmaaktags bevatten.

properties.displayName
  • string

Groepsnaam.

properties.externalId
  • string

Voor externe groepen bevat deze eigenschap de id van de groep van de externe id-provider, bijvoorbeeld voor Azure Active Directory ; anders is de waarde aad://<tenant>.onmicrosoft.com/groups/<group object id> null.

properties.type

Groepstype.

type
  • string

Resourcetype voor API Management resource.

GroupType

Groepstype.

Name Type Description
custom
  • string
external
  • string
system
  • string