AccessPolicyAssignment interface

Package:

@azure/arm-rediscache

Interface representing a AccessPolicyAssignment.

Methods

beginCreateUpdate(string, string, string, RedisCacheAccessPolicyAssignment, AccessPolicyAssignmentCreateUpdateOptionalParams)	Adds the access policy assignment to the specified users
beginCreateUpdateAndWait(string, string, string, RedisCacheAccessPolicyAssignment, AccessPolicyAssignmentCreateUpdateOptionalParams)	Adds the access policy assignment to the specified users
beginDelete(string, string, string, AccessPolicyAssignmentDeleteOptionalParams)	Deletes the access policy assignment from a redis cache
beginDeleteAndWait(string, string, string, AccessPolicyAssignmentDeleteOptionalParams)	Deletes the access policy assignment from a redis cache
get(string, string, string, AccessPolicyAssignmentGetOptionalParams)	Gets the list of assignments for an access policy of a redis cache
list(string, string, AccessPolicyAssignmentListOptionalParams)	Gets the list of access policy assignments associated with this redis cache

Method Details

beginCreateUpdate(string, string, string, RedisCacheAccessPolicyAssignment, AccessPolicyAssignmentCreateUpdateOptionalParams)

Adds the access policy assignment to the specified users

function beginCreateUpdate(resourceGroupName: string, cacheName: string, accessPolicyAssignmentName: string, parameters: RedisCacheAccessPolicyAssignment, options?: AccessPolicyAssignmentCreateUpdateOptionalParams): Promise<SimplePollerLike<OperationState<RedisCacheAccessPolicyAssignment>, RedisCacheAccessPolicyAssignment>>

Parameters

resourceGroupName

string

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

cacheName

string

The name of the Redis cache.

accessPolicyAssignmentName

string

The name of the access policy assignment.

parameters

RedisCacheAccessPolicyAssignment

Parameters supplied to the Create Update Access Policy Assignment operation.

options

AccessPolicyAssignmentCreateUpdateOptionalParams

The options parameters.

Returns

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

beginCreateUpdateAndWait(string, string, string, RedisCacheAccessPolicyAssignment, AccessPolicyAssignmentCreateUpdateOptionalParams)

Adds the access policy assignment to the specified users

function beginCreateUpdateAndWait(resourceGroupName: string, cacheName: string, accessPolicyAssignmentName: string, parameters: RedisCacheAccessPolicyAssignment, options?: AccessPolicyAssignmentCreateUpdateOptionalParams): Promise<RedisCacheAccessPolicyAssignment>

Parameters

resourceGroupName

string

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

cacheName

string

The name of the Redis cache.

accessPolicyAssignmentName

string

The name of the access policy assignment.

parameters

RedisCacheAccessPolicyAssignment

Parameters supplied to the Create Update Access Policy Assignment operation.

options

AccessPolicyAssignmentCreateUpdateOptionalParams

The options parameters.

Returns

Promise<RedisCacheAccessPolicyAssignment>

beginDelete(string, string, string, AccessPolicyAssignmentDeleteOptionalParams)

Deletes the access policy assignment from a redis cache

function beginDelete(resourceGroupName: string, cacheName: string, accessPolicyAssignmentName: string, options?: AccessPolicyAssignmentDeleteOptionalParams): 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.

accessPolicyAssignmentName

string

The name of the access policy assignment.

options

AccessPolicyAssignmentDeleteOptionalParams

The options parameters.

Returns

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

beginDeleteAndWait(string, string, string, AccessPolicyAssignmentDeleteOptionalParams)

Deletes the access policy assignment from a redis cache

function beginDeleteAndWait(resourceGroupName: string, cacheName: string, accessPolicyAssignmentName: string, options?: AccessPolicyAssignmentDeleteOptionalParams): Promise<void>

Parameters

resourceGroupName

string

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

cacheName

string

The name of the Redis cache.

accessPolicyAssignmentName

string

The name of the access policy assignment.

options

AccessPolicyAssignmentDeleteOptionalParams

The options parameters.

Returns

Promise<void>

get(string, string, string, AccessPolicyAssignmentGetOptionalParams)

Gets the list of assignments for an access policy of a redis cache

function get(resourceGroupName: string, cacheName: string, accessPolicyAssignmentName: string, options?: AccessPolicyAssignmentGetOptionalParams): Promise<RedisCacheAccessPolicyAssignment>

Parameters

resourceGroupName

string

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

cacheName

string

The name of the Redis cache.

accessPolicyAssignmentName

string

The name of the access policy assignment.

options

AccessPolicyAssignmentGetOptionalParams

The options parameters.

Returns

Promise<RedisCacheAccessPolicyAssignment>

list(string, string, AccessPolicyAssignmentListOptionalParams)

Gets the list of access policy assignments associated with this redis cache

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

Parameters

resourceGroupName

string

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

cacheName

string

The name of the Redis cache.

options

AccessPolicyAssignmentListOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<RedisCacheAccessPolicyAssignment, RedisCacheAccessPolicyAssignment[], PageSettings>