Share via


CacheRules interface

Interface representing a CacheRules.

Methods

beginCreate(string, string, string, CacheRule, CacheRulesCreateOptionalParams)

Creates a cache rule for a container registry with the specified parameters.

beginCreateAndWait(string, string, string, CacheRule, CacheRulesCreateOptionalParams)

Creates a cache rule for a container registry with the specified parameters.

beginDelete(string, string, string, CacheRulesDeleteOptionalParams)

Deletes a cache rule resource from a container registry.

beginDeleteAndWait(string, string, string, CacheRulesDeleteOptionalParams)

Deletes a cache rule resource from a container registry.

beginUpdate(string, string, string, CacheRuleUpdateParameters, CacheRulesUpdateOptionalParams)

Updates a cache rule for a container registry with the specified parameters.

beginUpdateAndWait(string, string, string, CacheRuleUpdateParameters, CacheRulesUpdateOptionalParams)

Updates a cache rule for a container registry with the specified parameters.

get(string, string, string, CacheRulesGetOptionalParams)

Gets the properties of the specified cache rule resource.

list(string, string, CacheRulesListOptionalParams)

Lists all cache rule resources for the specified container registry.

Method Details

beginCreate(string, string, string, CacheRule, CacheRulesCreateOptionalParams)

Creates a cache rule for a container registry with the specified parameters.

function beginCreate(resourceGroupName: string, registryName: string, cacheRuleName: string, cacheRuleCreateParameters: CacheRule, options?: CacheRulesCreateOptionalParams): Promise<SimplePollerLike<OperationState<CacheRule>, CacheRule>>

Parameters

resourceGroupName

string

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

registryName

string

The name of the container registry.

cacheRuleName

string

The name of the cache rule.

cacheRuleCreateParameters
CacheRule

The parameters for creating a cache rule.

options
CacheRulesCreateOptionalParams

The options parameters.

Returns

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

beginCreateAndWait(string, string, string, CacheRule, CacheRulesCreateOptionalParams)

Creates a cache rule for a container registry with the specified parameters.

function beginCreateAndWait(resourceGroupName: string, registryName: string, cacheRuleName: string, cacheRuleCreateParameters: CacheRule, options?: CacheRulesCreateOptionalParams): Promise<CacheRule>

Parameters

resourceGroupName

string

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

registryName

string

The name of the container registry.

cacheRuleName

string

The name of the cache rule.

cacheRuleCreateParameters
CacheRule

The parameters for creating a cache rule.

options
CacheRulesCreateOptionalParams

The options parameters.

Returns

Promise<CacheRule>

beginDelete(string, string, string, CacheRulesDeleteOptionalParams)

Deletes a cache rule resource from a container registry.

function beginDelete(resourceGroupName: string, registryName: string, cacheRuleName: string, options?: CacheRulesDeleteOptionalParams): Promise<SimplePollerLike<OperationState<CacheRulesDeleteHeaders>, CacheRulesDeleteHeaders>>

Parameters

resourceGroupName

string

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

registryName

string

The name of the container registry.

cacheRuleName

string

The name of the cache rule.

options
CacheRulesDeleteOptionalParams

The options parameters.

Returns

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

beginDeleteAndWait(string, string, string, CacheRulesDeleteOptionalParams)

Deletes a cache rule resource from a container registry.

function beginDeleteAndWait(resourceGroupName: string, registryName: string, cacheRuleName: string, options?: CacheRulesDeleteOptionalParams): Promise<CacheRulesDeleteHeaders>

Parameters

resourceGroupName

string

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

registryName

string

The name of the container registry.

cacheRuleName

string

The name of the cache rule.

options
CacheRulesDeleteOptionalParams

The options parameters.

Returns

beginUpdate(string, string, string, CacheRuleUpdateParameters, CacheRulesUpdateOptionalParams)

Updates a cache rule for a container registry with the specified parameters.

function beginUpdate(resourceGroupName: string, registryName: string, cacheRuleName: string, cacheRuleUpdateParameters: CacheRuleUpdateParameters, options?: CacheRulesUpdateOptionalParams): Promise<SimplePollerLike<OperationState<CacheRule>, CacheRule>>

Parameters

resourceGroupName

string

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

registryName

string

The name of the container registry.

cacheRuleName

string

The name of the cache rule.

cacheRuleUpdateParameters
CacheRuleUpdateParameters

The parameters for updating a cache rule.

options
CacheRulesUpdateOptionalParams

The options parameters.

Returns

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

beginUpdateAndWait(string, string, string, CacheRuleUpdateParameters, CacheRulesUpdateOptionalParams)

Updates a cache rule for a container registry with the specified parameters.

function beginUpdateAndWait(resourceGroupName: string, registryName: string, cacheRuleName: string, cacheRuleUpdateParameters: CacheRuleUpdateParameters, options?: CacheRulesUpdateOptionalParams): Promise<CacheRule>

Parameters

resourceGroupName

string

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

registryName

string

The name of the container registry.

cacheRuleName

string

The name of the cache rule.

cacheRuleUpdateParameters
CacheRuleUpdateParameters

The parameters for updating a cache rule.

options
CacheRulesUpdateOptionalParams

The options parameters.

Returns

Promise<CacheRule>

get(string, string, string, CacheRulesGetOptionalParams)

Gets the properties of the specified cache rule resource.

function get(resourceGroupName: string, registryName: string, cacheRuleName: string, options?: CacheRulesGetOptionalParams): Promise<CacheRule>

Parameters

resourceGroupName

string

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

registryName

string

The name of the container registry.

cacheRuleName

string

The name of the cache rule.

options
CacheRulesGetOptionalParams

The options parameters.

Returns

Promise<CacheRule>

list(string, string, CacheRulesListOptionalParams)

Lists all cache rule resources for the specified container registry.

function list(resourceGroupName: string, registryName: string, options?: CacheRulesListOptionalParams): PagedAsyncIterableIterator<CacheRule, CacheRule[], PageSettings>

Parameters

resourceGroupName

string

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

registryName

string

The name of the container registry.

options
CacheRulesListOptionalParams

The options parameters.

Returns