Share via

ClientsOperations Class

  • Reference

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

EventGridManagementClient's

<xref:clients> attribute.

Inheritance
builtins.object
ClientsOperations

Constructor

ClientsOperations(*args, **kwargs)

Methods

begin_create_or_update

Create or update a client.

Create or update a client with the specified parameters.
begin_delete

Delete a client.

Delete an existing client.
get

Get a client.

Get properties of a client.
list_by_namespace

List all permission bindings under a namespace.

Get all the permission bindings under a namespace.

begin_create_or_update

Create or update a client.

Create or update a client with the specified parameters.

async begin_create_or_update(resource_group_name: str, namespace_name: str, client_name: str, client_info: _models.Client, *, content_type: str = 'application/json', **kwargs: Any) -> AsyncLROPoller[_models.Client]

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_name
Required
str

The client name. Required.
client_info
Required
Client or IO[bytes]

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

Returns

Type Description
AsyncLROPoller[Client]

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

Exceptions

Type Description
HttpResponseError

begin_delete

Delete a client.

Delete an existing client.

async begin_delete(resource_group_name: str, namespace_name: str, client_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_name
Required
str

Name of the client. 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.

Get properties of a client.

async get(resource_group_name: str, namespace_name: str, client_name: str, **kwargs: Any) -> Client

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_name
Required
str

Name of the client. Required.

Returns

Type Description
Client

Client or the result of cls(response)

Exceptions

Type Description
HttpResponseError

list_by_namespace

List all permission bindings under a namespace.

Get all the permission bindings under a namespace.

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

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[Client]

An iterator like instance of either Client 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'>