Dela via


Client Groups - Get

Hämta en klientgrupp.
Hämta egenskaper för en klientgrupp.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/namespaces/{namespaceName}/clientGroups/{clientGroupName}?api-version=2024-06-01-preview

URI-parametrar

Name I Obligatorisk Typ Description
clientGroupName
path True

string

Namnet på klientgruppen.

Reguljärt uttrycksmönster: ^[a-zA-Z0-9-]*$

namespaceName
path True

string

Namn på namnområdet.

Reguljärt uttrycksmönster: ^[a-zA-Z0-9-]*$

resourceGroupName
path True

string

Namnet på resursgruppen i användarens prenumeration.

subscriptionId
path True

string

Prenumerationsautentiseringsuppgifter som unikt identifierar en Microsoft Azure-prenumeration. Prenumerations-ID:t utgör en del av URI:n för varje tjänstanrop.

api-version
query True

string

Version av API:et som ska användas med klientbegäran.

Svar

Name Typ Description
200 OK

ClientGroup

OK

Other Status Codes

ErrorResponse

Felsvaret returnerades om begäran misslyckades.

Exempel

ClientGroups_Get

Exempelbegäran

GET https://management.azure.com/subscriptions/8f6b6269-84f2-4d09-9e31-1127efcd1e40/resourceGroups/examplerg/providers/Microsoft.EventGrid/namespaces/exampleNamespaceName1/clientGroups/exampleClientGroupName1?api-version=2024-06-01-preview

Exempelsvar

{
  "properties": {
    "description": "This is a test client group",
    "query": "attributes.b IN ['a', 'b', 'c']"
  },
  "id": "/subscriptions/8f6b6269-84f2-4d09-9e31-1127efcd1e40/resourceGroups/examplerg/providers/Microsoft.EventGrid/namespaces/exampleNamespaceName1/clientGroups/exampleClientGroupName1",
  "name": "exampleClientGroupName1",
  "type": "Microsoft.EventGrid/namespaces/clientGroups"
}

Definitioner

Name Description
ClientGroup

Resursen Klientgrupp.

ClientGroupProvisioningState

Etableringstillstånd för ClientGroup-resursen.

createdByType

Den typ av identitet som skapade resursen.

ErrorAdditionalInfo

Ytterligare information om resurshanteringsfelet.

ErrorDetail

Felinformationen.

ErrorResponse

Felsvar

systemData

Metadata som rör skapande och senaste ändring av resursen.

ClientGroup

Resursen Klientgrupp.

Name Typ Description
id

string

Fullständigt kvalificerad identifierare för resursen.

name

string

Namn på resursen.

properties.description

string

Beskrivning av klientgruppsresursen.

properties.provisioningState

ClientGroupProvisioningState

Etableringstillstånd för ClientGroup-resursen.

properties.query

string

Grupperingsfrågan för klienterna. Exempel: attributes.keyName IN ['a', 'b', 'c'].

systemData

systemData

Systemmetadata som relaterar till ClientGroup-resursen.

type

string

Resurstyp.

ClientGroupProvisioningState

Etableringstillstånd för ClientGroup-resursen.

Name Typ Description
Canceled

string

Creating

string

Deleted

string

Deleting

string

Failed

string

Succeeded

string

Updating

string

createdByType

Den typ av identitet som skapade resursen.

Name Typ Description
Application

string

Key

string

ManagedIdentity

string

User

string

ErrorAdditionalInfo

Ytterligare information om resurshanteringsfelet.

Name Typ Description
info

object

Ytterligare information.

type

string

Den ytterligare informationstypen.

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.

systemData

Metadata som rör skapande och senaste ändring av resursen.

Name Typ Description
createdAt

string

Tidsstämpeln för resursskapande (UTC).

createdBy

string

Identiteten som skapade resursen.

createdByType

createdByType

Den typ av identitet som skapade resursen.

lastModifiedAt

string

Tidsstämpeln för resursens senaste ändring (UTC)

lastModifiedBy

string

Identiteten som senast ändrade resursen.

lastModifiedByType

createdByType

Den typ av identitet som senast ändrade resursen.