Dela via


Group - Get

Hämtar information om den grupp som anges av dess identifierare.

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

URI-parametrar

Name I Obligatorisk Typ Description
groupId
path True

string

minLength: 1
maxLength: 256

Gruppidentifierare. Måste vara unikt i den aktuella API Management-tjänstinstansen.

resourceGroupName
path True

string

minLength: 1
maxLength: 90

Namnet på resursgruppen. Namnet är skiftlägesokänsligt.

serviceName
path True

string

minLength: 1
maxLength: 50
pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$

Namnet på API Management-tjänsten.

subscriptionId
path True

string (uuid)

ID för målprenumerationen. Värdet måste vara ett UUID.

api-version
query True

string

minLength: 1

DEN API-version som ska användas för den här åtgärden.

Svar

Name Typ Description
200 OK

GroupContract

Svarstexten innehåller den angivna gruppentiteten.

Sidhuvuden

ETag: string

Other Status Codes

ErrorResponse

Felsvar som beskriver varför åtgärden misslyckades.

Säkerhet

azure_auth

Azure Active Directory OAuth2 Flow.

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize

Omfattningar

Name Description
user_impersonation personifiera ditt användarkonto

Exempel

ApiManagementGetGroup

Exempelbegäran

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/groups/59306a29e4bbd510dc24e5f9?api-version=2024-05-01

Exempelsvar

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/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"
  }
}

Definitioner

Name Description
ErrorAdditionalInfo

Ytterligare information om resurshanteringsfelet.

ErrorDetail

Felinformationen.

ErrorResponse

Felsvar

GroupContract

Kontraktsinformation.

GroupType

Grupptyp.

ErrorAdditionalInfo

Ytterligare information om resurshanteringsfelet.

Name Typ Description
info

object

Ytterligare information.

type

string

Ytterligare informationstyp.

ErrorDetail

Felinformationen.

Name Typ Description
additionalInfo

ErrorAdditionalInfo[]

Ytterligare information om felet.

code

string

Felkoden.

details

ErrorDetail[]

Felinformationen.

message

string

Felmeddelandet.

target

string

Felmålet.

ErrorResponse

Felsvar

Name Typ Description
error

ErrorDetail

Felobjektet.

GroupContract

Kontraktsinformation.

Name Typ Description
id

string

Fullständigt kvalificerat resurs-ID för resursen. Ex – /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

name

string

Namnet på resursen

properties.builtIn

boolean

sant om gruppen är en av de tre systemgrupperna (administratörer, utvecklare eller gäster); annars falskt.

properties.description

string

maxLength: 1000

Gruppbeskrivning. Kan innehålla HTML-formateringstaggar.

properties.displayName

string

minLength: 1
maxLength: 300

Gruppnamn.

properties.externalId

string

För externa grupper innehåller den här egenskapen id:t för gruppen från den externa identitetsprovidern, t.ex. för Azure Active Directory aad://<tenant>.onmicrosoft.com/groups/<group object id>; annars är värdet null.

properties.type

GroupType

Grupptyp.

type

string

Resurstypen. Till exempel "Microsoft.Compute/virtualMachines" eller "Microsoft.Storage/storageAccounts"

GroupType

Grupptyp.

Värde Description
custom
external
system