Package version:

Interface representing a CacheRules.

interface CacheRules {
    beginCreate(resourceGroupName: string, registryName: string, cacheRuleName: string, cacheRuleCreateParameters: CacheRule, options?: CacheRulesCreateOptionalParams): Promise<SimplePollerLike<OperationState<CacheRule>, CacheRule>>;
    beginCreateAndWait(resourceGroupName: string, registryName: string, cacheRuleName: string, cacheRuleCreateParameters: CacheRule, options?: CacheRulesCreateOptionalParams): Promise<CacheRule>;
    beginDelete(resourceGroupName: string, registryName: string, cacheRuleName: string, options?: CacheRulesDeleteOptionalParams): Promise<SimplePollerLike<OperationState<CacheRulesDeleteHeaders>, CacheRulesDeleteHeaders>>;
    beginDeleteAndWait(resourceGroupName: string, registryName: string, cacheRuleName: string, options?: CacheRulesDeleteOptionalParams): Promise<CacheRulesDeleteHeaders>;
    beginUpdate(resourceGroupName: string, registryName: string, cacheRuleName: string, cacheRuleUpdateParameters: CacheRuleUpdateParameters, options?: CacheRulesUpdateOptionalParams): Promise<SimplePollerLike<OperationState<CacheRule>, CacheRule>>;
    beginUpdateAndWait(resourceGroupName: string, registryName: string, cacheRuleName: string, cacheRuleUpdateParameters: CacheRuleUpdateParameters, options?: CacheRulesUpdateOptionalParams): Promise<CacheRule>;
    get(resourceGroupName: string, registryName: string, cacheRuleName: string, options?: CacheRulesGetOptionalParams): Promise<CacheRule>;
    list(resourceGroupName: string, registryName: string, options?: CacheRulesListOptionalParams): PagedAsyncIterableIterator<CacheRule>;
}

Methods

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

    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.

    • Optionaloptions: CacheRulesCreateOptionalParams

      The options parameters.

    Returns Promise<SimplePollerLike<OperationState<CacheRule>, CacheRule>>

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

    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.

    • Optionaloptions: CacheRulesCreateOptionalParams

      The options parameters.

    Returns Promise<CacheRule>

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

    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.

    • Optionaloptions: CacheRulesUpdateOptionalParams

      The options parameters.

    Returns Promise<SimplePollerLike<OperationState<CacheRule>, CacheRule>>

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

    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.

    • Optionaloptions: CacheRulesUpdateOptionalParams

      The options parameters.

    Returns Promise<CacheRule>

  • Gets the properties of the specified cache rule resource.

    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.

    • Optionaloptions: CacheRulesGetOptionalParams

      The options parameters.

    Returns Promise<CacheRule>

  • Lists all cache rule resources for the specified container registry.

    Parameters

    • resourceGroupName: string

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

    • registryName: string

      The name of the container registry.

    • Optionaloptions: CacheRulesListOptionalParams

      The options parameters.

    Returns PagedAsyncIterableIterator<CacheRule>