CacheRulesOperations Class

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

<xref:azure.mgmt.containerregistry.v2023_06_06_preview.ContainerRegistryManagementClient>'s

<xref:cache_rules> attribute.

Inheritance

builtins.object

CacheRulesOperations

Constructor

CacheRulesOperations(*args, **kwargs)

Methods

begin_create	Creates a cache rule for a container registry with the specified parameters.
begin_delete	Deletes a cache rule resource from a container registry.
begin_update	Updates a cache rule for a container registry with the specified parameters.
get	Gets the properties of the specified cache rule resource.
list	Lists all cache rule resources for the specified container registry.

begin_create

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

begin_create(resource_group_name: str, registry_name: str, cache_rule_name: str, cache_rule_create_parameters: _models.CacheRule, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.CacheRule]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
registry_name Required	str The name of the container registry. Required.
cache_rule_name Required	str The name of the cache rule. Required.
cache_rule_create_parameters Required	<xref:azure.mgmt.containerregistry.v2023_06_06_preview.models.CacheRule> or IO The parameters for creating a cache rule. Is either a CacheRule type or a IO type. Required.

Keyword-Only Parameters

Name	Description
content_type	str Body Parameter content-type. Known values are: 'application/json'. Default value is None.
cls	callable A custom type or function that will be passed the direct response
continuation_token	str A continuation token to restart a poller from a saved state.
polling	bool or PollingMethod By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval	int Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Exceptions

Type	Description
HttpResponseError

begin_delete

Deletes a cache rule resource from a container registry.

begin_delete(resource_group_name: str, registry_name: str, cache_rule_name: str, **kwargs: Any) -> LROPoller[None]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
registry_name Required	str The name of the container registry. Required.
cache_rule_name Required	str The name of the cache rule. Required.

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response
continuation_token	str A continuation token to restart a poller from a saved state.
polling	bool or PollingMethod By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval	int Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Exceptions

Type	Description
HttpResponseError

begin_update

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

begin_update(resource_group_name: str, registry_name: str, cache_rule_name: str, cache_rule_update_parameters: _models.CacheRuleUpdateParameters, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.CacheRule]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
registry_name Required	str The name of the container registry. Required.
cache_rule_name Required	str The name of the cache rule. Required.
cache_rule_update_parameters Required	<xref:azure.mgmt.containerregistry.v2023_06_06_preview.models.CacheRuleUpdateParameters> or IO The parameters for updating a cache rule. Is either a CacheRuleUpdateParameters type or a IO type. Required.

Keyword-Only Parameters

Name	Description
content_type	str Body Parameter content-type. Known values are: 'application/json'. Default value is None.
cls	callable A custom type or function that will be passed the direct response
continuation_token	str A continuation token to restart a poller from a saved state.
polling	bool or PollingMethod By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval	int Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Exceptions

Type	Description
HttpResponseError

get

Gets the properties of the specified cache rule resource.

get(resource_group_name: str, registry_name: str, cache_rule_name: str, **kwargs: Any) -> CacheRule

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
registry_name Required	str The name of the container registry. Required.
cache_rule_name Required	str The name of the cache rule. Required.

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response

Returns

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

Exceptions

Type	Description
HttpResponseError

list

Lists all cache rule resources for the specified container registry.

list(resource_group_name: str, registry_name: str, **kwargs: Any) -> Iterable[CacheRule]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
registry_name Required	str The name of the container registry. Required.

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response

Returns

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

Exceptions

Type	Description
HttpResponseError

Attributes

models

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