AccessPolicy interface

Package:

@azure/arm-rediscache

Interface representing a AccessPolicy.

Methods

beginCreateUpdate(string, string, string, RedisCacheAccessPolicy, AccessPolicyCreateUpdateOptionalParams)	Adds an access policy to the redis cache
beginCreateUpdateAndWait(string, string, string, RedisCacheAccessPolicy, AccessPolicyCreateUpdateOptionalParams)	Adds an access policy to the redis cache
beginDelete(string, string, string, AccessPolicyDeleteOptionalParams)	Deletes the access policy from a redis cache
beginDeleteAndWait(string, string, string, AccessPolicyDeleteOptionalParams)	Deletes the access policy from a redis cache
get(string, string, string, AccessPolicyGetOptionalParams)	Gets the detailed information about an access policy of a redis cache
list(string, string, AccessPolicyListOptionalParams)	Gets the list of access policies associated with this redis cache

Method Details

beginCreateUpdate(string, string, string, RedisCacheAccessPolicy, AccessPolicyCreateUpdateOptionalParams)

Adds an access policy to the redis cache

function beginCreateUpdate(resourceGroupName: string, cacheName: string, accessPolicyName: string, parameters: RedisCacheAccessPolicy, options?: AccessPolicyCreateUpdateOptionalParams): Promise<SimplePollerLike<OperationState<RedisCacheAccessPolicy>, RedisCacheAccessPolicy>>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

cacheName

string

The name of the Redis cache.

accessPolicyName

string

The name of the access policy that is being added to the Redis cache.

parameters

RedisCacheAccessPolicy

Parameters supplied to the Create Update Access Policy operation.

options

AccessPolicyCreateUpdateOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<RedisCacheAccessPolicy>, RedisCacheAccessPolicy>>

beginCreateUpdateAndWait(string, string, string, RedisCacheAccessPolicy, AccessPolicyCreateUpdateOptionalParams)

Adds an access policy to the redis cache

function beginCreateUpdateAndWait(resourceGroupName: string, cacheName: string, accessPolicyName: string, parameters: RedisCacheAccessPolicy, options?: AccessPolicyCreateUpdateOptionalParams): Promise<RedisCacheAccessPolicy>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

cacheName

string

The name of the Redis cache.

accessPolicyName

string

The name of the access policy that is being added to the Redis cache.

parameters

RedisCacheAccessPolicy

Parameters supplied to the Create Update Access Policy operation.

options

AccessPolicyCreateUpdateOptionalParams

The options parameters.

Returns

Promise<RedisCacheAccessPolicy>

beginDelete(string, string, string, AccessPolicyDeleteOptionalParams)

Deletes the access policy from a redis cache

function beginDelete(resourceGroupName: string, cacheName: string, accessPolicyName: string, options?: AccessPolicyDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

cacheName

string

The name of the Redis cache.

accessPolicyName

string

The name of the access policy that is being added to the Redis cache.

options

AccessPolicyDeleteOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>

beginDeleteAndWait(string, string, string, AccessPolicyDeleteOptionalParams)

Deletes the access policy from a redis cache

function beginDeleteAndWait(resourceGroupName: string, cacheName: string, accessPolicyName: string, options?: AccessPolicyDeleteOptionalParams): Promise<void>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

cacheName

string

The name of the Redis cache.

accessPolicyName

string

The name of the access policy that is being added to the Redis cache.

options

AccessPolicyDeleteOptionalParams

The options parameters.

Returns

Promise<void>

get(string, string, string, AccessPolicyGetOptionalParams)

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

function get(resourceGroupName: string, cacheName: string, accessPolicyName: string, options?: AccessPolicyGetOptionalParams): Promise<RedisCacheAccessPolicy>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

cacheName

string

The name of the Redis cache.

accessPolicyName

string

The name of the access policy that is being added to the Redis cache.

options

AccessPolicyGetOptionalParams

The options parameters.

Returns

Promise<RedisCacheAccessPolicy>

list(string, string, AccessPolicyListOptionalParams)

Gets the list of access policies associated with this redis cache

function list(resourceGroupName: string, cacheName: string, options?: AccessPolicyListOptionalParams): PagedAsyncIterableIterator<RedisCacheAccessPolicy, RedisCacheAccessPolicy[], PageSettings>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

cacheName

string

The name of the Redis cache.

options

AccessPolicyListOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<RedisCacheAccessPolicy, RedisCacheAccessPolicy[], PageSettings>