Share via

EncryptionScopesOperations Class

  • Reference

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

StorageManagementClient's

<xref:encryption_scopes> attribute.

Inheritance
builtins.object
EncryptionScopesOperations

Constructor

EncryptionScopesOperations(*args, **kwargs)

Methods

get

Returns the properties for the specified encryption scope.
list

Lists all the encryption scopes available under the specified storage account.
patch

Update encryption scope properties as specified in the request body. Update fails if the specified encryption scope does not already exist.
put

Synchronously creates or updates an encryption scope under the specified storage account. If an encryption scope is already created and a subsequent request is issued with different properties, the encryption scope properties will be updated per the specified request.

get

Returns the properties for the specified encryption scope.

get(resource_group_name: str, account_name: str, encryption_scope_name: str, **kwargs: Any) -> EncryptionScope

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group within the user's subscription. The name is case insensitive. Required.
account_name
Required
str

The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only. Required.
encryption_scope_name
Required
str

The name of the encryption scope within the specified storage account. Encryption scope names must be between 3 and 63 characters in length and use numbers, lower-case letters and dash (-) only. Every dash (-) character must be immediately preceded and followed by a letter or number. Required.

Returns

Type Description
EncryptionScope

EncryptionScope or the result of cls(response)

Exceptions

Type Description
HttpResponseError

list

Lists all the encryption scopes available under the specified storage account.

list(resource_group_name: str, account_name: str, maxpagesize: int | None = None, filter: str | None = None, include: str | ListEncryptionScopesInclude | None = None, **kwargs: Any) -> Iterable[EncryptionScope]

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group within the user's subscription. The name is case insensitive. Required.
account_name
Required
str

The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only. Required.
maxpagesize
Required
int

Optional, specifies the maximum number of encryption scopes that will be included in the list response. Default value is None.
filter
Required
str

Optional. When specified, only encryption scope names starting with the filter will be listed. Default value is None.
include
Required
str or ListEncryptionScopesInclude

Optional, when specified, will list encryption scopes with the specific state. Defaults to All. Known values are: "All", "Enabled", and "Disabled". Default value is None.

Returns

Type Description
ItemPaged[EncryptionScope]

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

Exceptions

Type Description
HttpResponseError

patch

Update encryption scope properties as specified in the request body. Update fails if the specified encryption scope does not already exist.

patch(resource_group_name: str, account_name: str, encryption_scope_name: str, encryption_scope: _models.EncryptionScope, *, content_type: str = 'application/json', **kwargs: Any) -> _models.EncryptionScope

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group within the user's subscription. The name is case insensitive. Required.
account_name
Required
str

The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only. Required.
encryption_scope_name
Required
str

The name of the encryption scope within the specified storage account. Encryption scope names must be between 3 and 63 characters in length and use numbers, lower-case letters and dash (-) only. Every dash (-) character must be immediately preceded and followed by a letter or number. Required.
encryption_scope
Required
EncryptionScope or IO[bytes]

Encryption scope properties to be used for the update. Is either a EncryptionScope type or a IO[bytes] type. Required.

Returns

Type Description
EncryptionScope

EncryptionScope or the result of cls(response)

Exceptions

Type Description
HttpResponseError

put

Synchronously creates or updates an encryption scope under the specified storage account. If an encryption scope is already created and a subsequent request is issued with different properties, the encryption scope properties will be updated per the specified request.

put(resource_group_name: str, account_name: str, encryption_scope_name: str, encryption_scope: _models.EncryptionScope, *, content_type: str = 'application/json', **kwargs: Any) -> _models.EncryptionScope

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group within the user's subscription. The name is case insensitive. Required.
account_name
Required
str

The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only. Required.
encryption_scope_name
Required
str

The name of the encryption scope within the specified storage account. Encryption scope names must be between 3 and 63 characters in length and use numbers, lower-case letters and dash (-) only. Every dash (-) character must be immediately preceded and followed by a letter or number. Required.
encryption_scope
Required
EncryptionScope or IO[bytes]

Encryption scope properties to be used for the create or update. Is either a EncryptionScope type or a IO[bytes] type. Required.

Returns

Type Description
EncryptionScope

EncryptionScope or the result of cls(response)

Exceptions

Type Description
HttpResponseError

Attributes

models 

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