Dela via


ClientGroupsOperations Klass

Varning

Instansiera INTE den här klassen direkt.

I stället bör du komma åt följande åtgärder via

EventGridManagementClient's

<xref:client_groups> Attributet.

Arv
builtins.object
ClientGroupsOperations

Konstruktor

ClientGroupsOperations(*args, **kwargs)

Metoder

begin_create_or_update

Skapa eller uppdatera en klientgrupp.

Skapa eller uppdatera en klientgrupp med de angivna parametrarna.

begin_delete

Ta bort en klientgrupp.

Ta bort en befintlig klientgrupp.

get

Hämta en klientgrupp.

Hämta egenskaper för en klientgrupp.

list_by_namespace

Visa en lista över alla klientgrupper under ett namnområde.

Hämta alla klientgrupper under ett namnområde.

begin_create_or_update

Skapa eller uppdatera en klientgrupp.

Skapa eller uppdatera en klientgrupp med de angivna parametrarna.

begin_create_or_update(resource_group_name: str, namespace_name: str, client_group_name: str, client_group_info: _models.ClientGroup, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.ClientGroup]

Parametrar

resource_group_name
str
Obligatorisk

Namnet på resursgruppen i användarens prenumeration. Krävs.

namespace_name
str
Obligatorisk

Namn på namnområdet. Krävs.

client_group_name
str
Obligatorisk

Klientgruppens namn. Krävs.

client_group_info
ClientGroup eller IO
Obligatorisk

Information om klientgrupp. Är antingen en ClientGroup-typ eller en I/O-typ. Krävs.

content_type
str

Innehållstyp för brödtextparameter. Kända värden är: "application/json". Standardvärdet är Ingen.

cls
callable

En anpassad typ eller funktion som skickas direktsvaret

continuation_token
str

En fortsättningstoken för att starta om en poller från ett sparat tillstånd.

polling
bool eller PollingMethod

Som standard är avsökningsmetoden ARMPolling. Skicka in Falskt för att den här åtgärden inte ska avsöka eller skicka in ditt eget initierade avsökningsobjekt för en personlig avsökningsstrategi.

polling_interval
int

Standardväntetid mellan två omröstningar för LRO-åtgärder om det inte finns någon Retry-After huvud.

Returer

En instans av LROPoller som returnerar antingen ClientGroup eller resultatet av cls(response)

Returtyp

Undantag

begin_delete

Ta bort en klientgrupp.

Ta bort en befintlig klientgrupp.

begin_delete(resource_group_name: str, namespace_name: str, client_group_name: str, **kwargs: Any) -> LROPoller[None]

Parametrar

resource_group_name
str
Obligatorisk

Namnet på resursgruppen i användarens prenumeration. Krävs.

namespace_name
str
Obligatorisk

Namn på namnområdet. Krävs.

client_group_name
str
Obligatorisk

Namnet på klientgruppen. Krävs.

cls
callable

En anpassad typ eller funktion som skickas direktsvaret

continuation_token
str

En fortsättningstoken för att starta om en poller från ett sparat tillstånd.

polling
bool eller PollingMethod

Som standard är avsökningsmetoden ARMPolling. Skicka in Falskt för att den här åtgärden inte ska avsöka eller skicka in ditt eget initierade avsökningsobjekt för en personlig avsökningsstrategi.

polling_interval
int

Standardväntetid mellan två omröstningar för LRO-åtgärder om det inte finns någon Retry-After huvud.

Returer

En instans av LROPoller som returnerar antingen None eller resultatet av cls(response)

Returtyp

Undantag

get

Hämta en klientgrupp.

Hämta egenskaper för en klientgrupp.

get(resource_group_name: str, namespace_name: str, client_group_name: str, **kwargs: Any) -> ClientGroup

Parametrar

resource_group_name
str
Obligatorisk

Namnet på resursgruppen i användarens prenumeration. Krävs.

namespace_name
str
Obligatorisk

Namn på namnområdet. Krävs.

client_group_name
str
Obligatorisk

Namnet på klientgruppen. Krävs.

cls
callable

En anpassad typ eller funktion som skickas direktsvaret

Returer

ClientGroup eller resultatet av cls(response)

Returtyp

Undantag

list_by_namespace

Visa en lista över alla klientgrupper under ett namnområde.

Hämta alla klientgrupper under ett namnområde.

list_by_namespace(resource_group_name: str, namespace_name: str, filter: str | None = None, top: int | None = None, **kwargs: Any) -> Iterable[ClientGroup]

Parametrar

resource_group_name
str
Obligatorisk

Namnet på resursgruppen i användarens prenumeration. Krävs.

namespace_name
str
Obligatorisk

Namn på namnområdet. Krävs.

filter
str
Obligatorisk

Frågan som används för att filtrera sökresultaten med OData-syntax. Filtrering tillåts endast för egenskapen "name" och med ett begränsat antal OData-åtgärder. Dessa åtgärder är: funktionen "contains" samt följande logiska åtgärder: inte, och eller eq (för lika med) och ne (för inte lika med). Inga aritmetiska åtgärder stöds. Följande är ett giltigt filterexempel: $filter=contains(namE, 'PATTERN') och name ne 'PATTERN-1'. Följande är inte ett giltigt filterexempel: $filter=location eq 'westus'. Standardvärdet är Ingen.

top
int
Obligatorisk

Antalet resultat som ska returneras per sida för liståtgärden. Giltigt intervall för den översta parametern är 1 till 100. Om inget anges är standardantalet resultat som ska returneras 20 objekt per sida. Standardvärdet är Ingen.

cls
callable

En anpassad typ eller funktion som skickas direktsvaret

Returer

En iterator som en instans av antingen ClientGroup eller resultatet av cls(response)

Returtyp

Undantag

Attribut

models

models = <module 'azure.mgmt.eventgrid.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.7\\x64\\Lib\\site-packages\\azure\\mgmt\\eventgrid\\models\\__init__.py'>