azure.mgmt.storage.v2023_05_01.operations.EncryptionScopesOperations.yml

### YamlMime:PythonClass
uid: azure.mgmt.storage.v2023_05_01.operations.EncryptionScopesOperations
name: EncryptionScopesOperations
fullName: azure.mgmt.storage.v2023_05_01.operations.EncryptionScopesOperations
module: azure.mgmt.storage.v2023_05_01.operations
inheritances:
- builtins.object
summary: "> [!WARNING]\n> DO NOT instantiate this class directly.\n>\n> \n>\n> Instead,\
  \ you should access the following operations through\n>\n> <xref:azure.mgmt.storage.v2023_05_01.StorageManagementClient>'s\n\
  >\n> <xref:encryption_scopes> attribute.\n>"
constructor:
  syntax: EncryptionScopesOperations(*args, **kwargs)
methods:
- uid: azure.mgmt.storage.v2023_05_01.operations.EncryptionScopesOperations.get
  name: get
  summary: Returns the properties for the specified encryption scope.
  signature: 'get(resource_group_name: str, account_name: str, encryption_scope_name:
    str, **kwargs: Any) -> EncryptionScope'
  parameters:
  - name: resource_group_name
    description: 'The name of the resource group within the user''s subscription.
      The

      name is case insensitive. Required.'
    isRequired: true
    types:
    - <xref:str>
  - name: account_name
    description: '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.'
    isRequired: true
    types:
    - <xref:str>
  - name: encryption_scope_name
    description: '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.'
    isRequired: true
    types:
    - <xref:str>
  return:
    description: EncryptionScope or the result of cls(response)
    types:
    - <xref:azure.mgmt.storage.v2023_05_01.models.EncryptionScope>
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.storage.v2023_05_01.operations.EncryptionScopesOperations.list
  name: list
  summary: Lists all the encryption scopes available under the specified storage account.
  signature: '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: resource_group_name
    description: 'The name of the resource group within the user''s subscription.
      The

      name is case insensitive. Required.'
    isRequired: true
    types:
    - <xref:str>
  - name: account_name
    description: '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.'
    isRequired: true
    types:
    - <xref:str>
  - name: maxpagesize
    description: 'Optional, specifies the maximum number of encryption scopes that
      will be

      included in the list response. Default value is None.'
    isRequired: true
    types:
    - <xref:int>
  - name: filter
    description: 'Optional. When specified, only encryption scope names starting with
      the filter

      will be listed. Default value is None.'
    isRequired: true
    types:
    - <xref:str>
  - name: include
    description: '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.'
    isRequired: true
    types:
    - <xref:str>
    - <xref:azure.mgmt.storage.v2023_05_01.models.ListEncryptionScopesInclude>
  return:
    description: An iterator like instance of either EncryptionScope or the result
      of cls(response)
    types:
    - <xref:azure.core.paging.ItemPaged>[<xref:azure.mgmt.storage.v2023_05_01.models.EncryptionScope>]
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.storage.v2023_05_01.operations.EncryptionScopesOperations.patch
  name: patch
  summary: 'Update encryption scope properties as specified in the request body. Update
    fails if the

    specified encryption scope does not already exist.'
  signature: '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: resource_group_name
    description: 'The name of the resource group within the user''s subscription.
      The

      name is case insensitive. Required.'
    isRequired: true
    types:
    - <xref:str>
  - name: account_name
    description: '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.'
    isRequired: true
    types:
    - <xref:str>
  - name: encryption_scope_name
    description: '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.'
    isRequired: true
    types:
    - <xref:str>
  - name: encryption_scope
    description: 'Encryption scope properties to be used for the update. Is either
      a

      EncryptionScope type or a IO[bytes] type. Required.'
    isRequired: true
    types:
    - <xref:azure.mgmt.storage.v2023_05_01.models.EncryptionScope>
    - <xref:typing.IO>[<xref:bytes>]
  return:
    description: EncryptionScope or the result of cls(response)
    types:
    - <xref:azure.mgmt.storage.v2023_05_01.models.EncryptionScope>
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.storage.v2023_05_01.operations.EncryptionScopesOperations.put
  name: put
  summary: '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.'
  signature: '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: resource_group_name
    description: 'The name of the resource group within the user''s subscription.
      The

      name is case insensitive. Required.'
    isRequired: true
    types:
    - <xref:str>
  - name: account_name
    description: '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.'
    isRequired: true
    types:
    - <xref:str>
  - name: encryption_scope_name
    description: '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.'
    isRequired: true
    types:
    - <xref:str>
  - name: encryption_scope
    description: 'Encryption scope properties to be used for the create or update.
      Is

      either a EncryptionScope type or a IO[bytes] type. Required.'
    isRequired: true
    types:
    - <xref:azure.mgmt.storage.v2023_05_01.models.EncryptionScope>
    - <xref:typing.IO>[<xref:bytes>]
  return:
    description: EncryptionScope or the result of cls(response)
    types:
    - <xref:azure.mgmt.storage.v2023_05_01.models.EncryptionScope>
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
attributes:
- uid: azure.mgmt.storage.v2023_05_01.operations.EncryptionScopesOperations.models
  name: models
  signature: models = <module 'azure.mgmt.storage.v2023_05_01.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.9\\x64\\Lib\\site-packages\\azure\\mgmt\\storage\\v2023_05_01\\models\\__init__.py'>