Compartilhar via

ScopeMapsOperations Class

  • Reference

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

ContainerRegistryManagementClient's

<xref:scope_maps> attribute.

Inheritance
builtins.object
ScopeMapsOperations

Constructor

ScopeMapsOperations(*args, **kwargs)

Methods

begin_create

Creates a scope map for a container registry with the specified parameters.
begin_delete

Deletes a scope map from a container registry.
begin_update

Updates a scope map with the specified parameters.
get

Gets the properties of the specified scope map.
list

Lists all the scope maps for the specified container registry.

begin_create

Creates a scope map for a container registry with the specified parameters.

async begin_create(resource_group_name: str, registry_name: str, scope_map_name: str, scope_map_create_parameters: _models.ScopeMap, *, content_type: str = 'application/json', **kwargs: Any) -> AsyncLROPoller[_models.ScopeMap]

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.
scope_map_name
Required
str

The name of the scope map. Required.
scope_map_create_parameters
Required
ScopeMap or IO

The parameters for creating a scope map. Is either a ScopeMap 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 AsyncPollingMethod

By default, your polling method will be AsyncARMPolling. 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
AsyncLROPoller[ScopeMap]

An instance of AsyncLROPoller that returns either ScopeMap or the result of cls(response)

Exceptions

Type Description
HttpResponseError

begin_delete

Deletes a scope map from a container registry.

async begin_delete(resource_group_name: str, registry_name: str, scope_map_name: str, **kwargs: Any) -> AsyncLROPoller[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.
scope_map_name
Required
str

The name of the scope map. 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 AsyncPollingMethod

By default, your polling method will be AsyncARMPolling. 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
AsyncLROPoller[None]

An instance of AsyncLROPoller that returns either None or the result of cls(response)

Exceptions

Type Description
HttpResponseError

begin_update

Updates a scope map with the specified parameters.

async begin_update(resource_group_name: str, registry_name: str, scope_map_name: str, scope_map_update_parameters: _models.ScopeMapUpdateParameters, *, content_type: str = 'application/json', **kwargs: Any) -> AsyncLROPoller[_models.ScopeMap]

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.
scope_map_name
Required
str

The name of the scope map. Required.
scope_map_update_parameters
Required
ScopeMapUpdateParameters or IO

The parameters for updating a scope map. Is either a ScopeMapUpdateParameters 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 AsyncPollingMethod

By default, your polling method will be AsyncARMPolling. 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
AsyncLROPoller[ScopeMap]

An instance of AsyncLROPoller that returns either ScopeMap or the result of cls(response)

Exceptions

Type Description
HttpResponseError

get

Gets the properties of the specified scope map.

async get(resource_group_name: str, registry_name: str, scope_map_name: str, **kwargs: Any) -> ScopeMap

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.
scope_map_name
Required
str

The name of the scope map. Required.

Keyword-Only Parameters

Name Description
cls
callable

A custom type or function that will be passed the direct response

Returns

Type Description
ScopeMap

ScopeMap or the result of cls(response)

Exceptions

Type Description
HttpResponseError

list

Lists all the scope maps for the specified container registry.

list(resource_group_name: str, registry_name: str, **kwargs: Any) -> AsyncIterable[ScopeMap]

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
AsyncItemPaged[ScopeMap]

An iterator like instance of either ScopeMap or the result of cls(response)

Exceptions

Type Description
HttpResponseError

Attributes

models 

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