Share via

ClientGroupsOperations Class

  • Reference

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

EventGridManagementClient's

<xref:client_groups> attribute.

Inheritance
builtins.object
ClientGroupsOperations

Constructor

ClientGroupsOperations(*args, **kwargs)

Methods

begin_create_or_update

Create or update a client group.

Create or update a client group with the specified parameters.
begin_delete

Delete a client group.

Delete an existing client group.
get

Get a client group.

Get properties of a client group.
list_by_namespace

List all client groups under a namespace.

Get all the client groups under a namespace.

begin_create_or_update

Create or update a client group.

Create or update a client group with the specified parameters.

async 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) -> AsyncLROPoller[_models.ClientGroup]

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group within the user's subscription. Required.
namespace_name
Required
str

Name of the namespace. Required.
client_group_name
Required
str

The client group name. Required.
client_group_info
Required
ClientGroup or IO[bytes]

Client group information. Is either a ClientGroup type or a IO[bytes] type. Required.

Returns

Type Description
AsyncLROPoller[ClientGroup]

An instance of AsyncLROPoller that returns either ClientGroup or the result of cls(response)

Exceptions

Type Description
HttpResponseError

begin_delete

Delete a client group.

Delete an existing client group.

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

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group within the user's subscription. Required.
namespace_name
Required
str

Name of the namespace. Required.
client_group_name
Required
str

Name of the client group. Required.

Returns

Type Description
AsyncLROPoller[None]

An instance of AsyncLROPoller that returns either None or the result of cls(response)

Exceptions

Type Description
HttpResponseError

get

Get a client group.

Get properties of a client group.

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

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group within the user's subscription. Required.
namespace_name
Required
str

Name of the namespace. Required.
client_group_name
Required
str

Name of the client group. Required.

Returns

Type Description
ClientGroup

ClientGroup or the result of cls(response)

Exceptions

Type Description
HttpResponseError

list_by_namespace

List all client groups under a namespace.

Get all the client groups under a namespace.

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

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group within the user's subscription. Required.
namespace_name
Required
str

Name of the namespace. Required.
filter
Required
str

The query used to filter the search results using OData syntax. Filtering is permitted on the 'name' property only and with limited number of OData operations. These operations are: the 'contains' function as well as the following logical operations: not, and, or, eq (for equal), and ne (for not equal). No arithmetic operations are supported. The following is a valid filter example: $filter=contains(namE, 'PATTERN') and name ne 'PATTERN-1'. The following is not a valid filter example: $filter=location eq 'westus'. Default value is None.
top
Required
int

The number of results to return per page for the list operation. Valid range for top parameter is 1 to 100. If not specified, the default number of results to be returned is 20 items per page. Default value is None.

Returns

Type Description
AsyncItemPaged[ClientGroup]

An iterator like instance of either ClientGroup or the result of cls(response)

Exceptions

Type Description
HttpResponseError

Attributes

models 

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