AccessPolicyOperations Class

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

RedisManagementClient's

<xref:access_policy> attribute.

Inheritance

builtins.object

AccessPolicyOperations

Constructor

AccessPolicyOperations(*args, **kwargs)

Methods

begin_create_update	Adds an access policy to the redis cache.
begin_delete	Deletes the access policy from a redis cache.
get	Gets the detailed information about an access policy of a redis cache.
list	Gets the list of access policies associated with this redis cache.

begin_create_update

Adds an access policy to the redis cache.

async begin_create_update(resource_group_name: str, cache_name: str, access_policy_name: str, parameters: _models.RedisCacheAccessPolicy, *, content_type: str = 'application/json', **kwargs: Any) -> AsyncLROPoller[_models.RedisCacheAccessPolicy]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
cache_name Required	str The name of the Redis cache. Required.
access_policy_name Required	str The name of the access policy that is being added to the Redis cache. Required.
parameters Required	RedisCacheAccessPolicy or IO[bytes] Parameters supplied to the Create Update Access Policy operation. Is either a RedisCacheAccessPolicy type or a IO[bytes] type. Required.

Returns

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

Exceptions

Type	Description
HttpResponseError

begin_delete

Deletes the access policy from a redis cache.

async begin_delete(resource_group_name: str, cache_name: str, access_policy_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.
cache_name Required	str The name of the Redis cache. Required.
access_policy_name Required	str The name of the access policy that is being added to the Redis cache. 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

Gets the detailed information about an access policy of a redis cache.

async get(resource_group_name: str, cache_name: str, access_policy_name: str, **kwargs: Any) -> RedisCacheAccessPolicy

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
cache_name Required	str The name of the Redis cache. Required.
access_policy_name Required	str The name of the access policy that is being added to the Redis cache. Required.

Returns

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

Exceptions

Type	Description
HttpResponseError

list

Gets the list of access policies associated with this redis cache.

list(resource_group_name: str, cache_name: str, **kwargs: Any) -> AsyncIterable[RedisCacheAccessPolicy]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
cache_name Required	str The name of the Redis cache. Required.

Returns

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

Exceptions

Type	Description
HttpResponseError

Attributes

models

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