RolesOperations Class

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

CosmosdbForPostgresqlMgmtClient's

<xref:roles> attribute.

Constructor

RolesOperations(*args, **kwargs)

Methods

begin_create	Creates a new role or updates an existing role.
begin_delete	Deletes a cluster role.
get	Gets information about a cluster role.
list_by_cluster	List all the roles in a given cluster.

begin_create

Creates a new role or updates an existing role.

begin_create(resource_group_name: str, cluster_name: str, role_name: str, parameters: _models.Role, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.Role]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
cluster_name Required	str The name of the cluster. Required.
role_name Required	str The name of the cluster role. Required.
parameters Required	Role or IO The required parameters for creating or updating a role. Is either a Role type or a IO type. Required.

Keyword-Only Parameters

Name	Description
content_type	str Body Parameter content-type. Known values are: 'application/json'. Default value is None.
cls	callable A custom type or function that will be passed the direct response
continuation_token	str A continuation token to restart a poller from a saved state.
polling	bool or PollingMethod By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval	int Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

Type	Description
LROPoller[Role]	An instance of LROPoller that returns either Role or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

begin_delete

Deletes a cluster role.

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

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
cluster_name Required	str The name of the cluster. Required.
role_name Required	str The name of the cluster role. Required.

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response
continuation_token	str A continuation token to restart a poller from a saved state.
polling	bool or PollingMethod By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval	int Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

Type	Description
LROPoller[None]	An instance of LROPoller that returns either None or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

get

Gets information about a cluster role.

get(resource_group_name: str, cluster_name: str, role_name: str, **kwargs: Any) -> Role

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
cluster_name Required	str The name of the cluster. Required.
role_name Required	str The name of the cluster role. Required.

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response

Returns

Type	Description
Role	Role or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

list_by_cluster

List all the roles in a given cluster.

list_by_cluster(resource_group_name: str, cluster_name: str, **kwargs: Any) -> Iterable[Role]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
cluster_name Required	str The name of the cluster. Required.

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response

Returns

Type	Description
ItemPaged[Role]	An iterator like instance of either Role or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

Attributes

models

models = <module 'azure.mgmt.cosmosdbforpostgresql.models' from 'C:\\ToolCache\\Python\\3.11.9\\x64\\Lib\\site-packages\\py2docfx\\venv\\venv102\\Lib\\site-packages\\azure\\mgmt\\cosmosdbforpostgresql\\models\\__init__.py'>