ClientsOperations Class

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

<xref:clients> attribute.

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. The name is case insensitive. Required.
namespace_name Required	str Name of the namespace. Required.
client_name Required	str Name of the client. Required.
client_info Required	Client or <xref:JSON> or IO[bytes] Client information. Is one of the following types: Client, JSON, IO[bytes] Required.

Returns

Type	Description
AsyncLROPoller[Client]	An instance of AsyncLROPoller that returns Client. The Client is compatible with MutableMapping

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. The name is case insensitive. 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 None

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. The name is case insensitive. Required.
namespace_name Required	str Name of the namespace. Required.
client_name Required	str Name of the client. Required.

Returns

Type	Description
Client	Client. The Client is compatible with MutableMapping

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

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
namespace_name Required	str Name of the namespace. Required.

Keyword-Only Parameters

Name	Description
filter	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. Default value: None
top	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. Default value: None

Name

Description

filter

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.

Default value: None

top

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.

Default value: None

Returns

Type	Description
AsyncItemPaged[Client]	An iterator like instance of Client

Exceptions

Type	Description
HttpResponseError

Comentários

Esta página foi útil?