azure.mgmt.keyvault.v2022_07_01.aio.operations.ManagedHsmsOperations.yml

### YamlMime:PythonClass
uid: azure.mgmt.keyvault.v2022_07_01.aio.operations.ManagedHsmsOperations
name: ManagedHsmsOperations
fullName: azure.mgmt.keyvault.v2022_07_01.aio.operations.ManagedHsmsOperations
module: azure.mgmt.keyvault.v2022_07_01.aio.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.keyvault.v2022_07_01.aio.KeyVaultManagementClient>'s\n\
  >\n> <xref:managed_hsms> attribute.\n>"
constructor:
  syntax: ManagedHsmsOperations(*args, **kwargs)
methods:
- uid: azure.mgmt.keyvault.v2022_07_01.aio.operations.ManagedHsmsOperations.begin_create_or_update
  name: begin_create_or_update
  summary: Create or update a managed HSM Pool in the specified subscription.
  signature: 'async begin_create_or_update(resource_group_name: str, name: str, parameters:
    _models.ManagedHsm, *, content_type: str = ''application/json'', **kwargs: Any)
    -> AsyncLROPoller[_models.ManagedHsm]'
  parameters:
  - name: resource_group_name
    description: 'Name of the resource group that contains the managed HSM pool.

      Required.'
    isRequired: true
    types:
    - <xref:str>
  - name: name
    description: Name of the managed HSM Pool. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: parameters
    description: 'Parameters to create or update the managed HSM Pool. Is either a
      ManagedHsm

      type or a IO type. Required.'
    isRequired: true
    types:
    - <xref:azure.mgmt.keyvault.v2022_07_01.models.ManagedHsm>
    - <xref:typing.IO>
  keywordOnlyParameters:
  - name: content_type
    description: 'Body Parameter content-type. Known values are: ''application/json''.

      Default value is None.'
    types:
    - <xref:str>
  - name: cls
    description: A custom type or function that will be passed the direct response
    types:
    - <xref:callable>
  - name: continuation_token
    description: A continuation token to restart a poller from a saved state.
    types:
    - <xref:str>
  - name: polling
    description: '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.'
    types:
    - <xref:bool>
    - <xref:azure.core.polling.AsyncPollingMethod>
  - name: polling_interval
    description: 'Default waiting time between two polls for LRO operations if no

      Retry-After header is present.'
    types:
    - <xref:int>
  return:
    description: 'An instance of AsyncLROPoller that returns either ManagedHsm or
      the result of

      cls(response)'
    types:
    - <xref:azure.core.polling.AsyncLROPoller>[<xref:azure.mgmt.keyvault.v2022_07_01.models.ManagedHsm>]
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.keyvault.v2022_07_01.aio.operations.ManagedHsmsOperations.begin_delete
  name: begin_delete
  summary: Deletes the specified managed HSM Pool.
  signature: 'async begin_delete(resource_group_name: str, name: str, **kwargs: Any)
    -> AsyncLROPoller[None]'
  parameters:
  - name: resource_group_name
    description: 'Name of the resource group that contains the managed HSM pool.

      Required.'
    isRequired: true
    types:
    - <xref:str>
  - name: name
    description: The name of the managed HSM Pool to delete. Required.
    isRequired: true
    types:
    - <xref:str>
  keywordOnlyParameters:
  - name: cls
    description: A custom type or function that will be passed the direct response
    types:
    - <xref:callable>
  - name: continuation_token
    description: A continuation token to restart a poller from a saved state.
    types:
    - <xref:str>
  - name: polling
    description: '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.'
    types:
    - <xref:bool>
    - <xref:azure.core.polling.AsyncPollingMethod>
  - name: polling_interval
    description: 'Default waiting time between two polls for LRO operations if no

      Retry-After header is present.'
    types:
    - <xref:int>
  return:
    description: An instance of AsyncLROPoller that returns either None or the result
      of cls(response)
    types:
    - <xref:azure.core.polling.AsyncLROPoller>[<xref:None>]
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.keyvault.v2022_07_01.aio.operations.ManagedHsmsOperations.begin_purge_deleted
  name: begin_purge_deleted
  summary: Permanently deletes the specified managed HSM.
  signature: 'async begin_purge_deleted(name: str, location: str, **kwargs: Any) ->
    AsyncLROPoller[None]'
  parameters:
  - name: name
    description: The name of the soft-deleted managed HSM. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: location
    description: The location of the soft-deleted managed HSM. Required.
    isRequired: true
    types:
    - <xref:str>
  keywordOnlyParameters:
  - name: cls
    description: A custom type or function that will be passed the direct response
    types:
    - <xref:callable>
  - name: continuation_token
    description: A continuation token to restart a poller from a saved state.
    types:
    - <xref:str>
  - name: polling
    description: '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.'
    types:
    - <xref:bool>
    - <xref:azure.core.polling.AsyncPollingMethod>
  - name: polling_interval
    description: 'Default waiting time between two polls for LRO operations if no

      Retry-After header is present.'
    types:
    - <xref:int>
  return:
    description: An instance of AsyncLROPoller that returns either None or the result
      of cls(response)
    types:
    - <xref:azure.core.polling.AsyncLROPoller>[<xref:None>]
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.keyvault.v2022_07_01.aio.operations.ManagedHsmsOperations.begin_update
  name: begin_update
  summary: Update a managed HSM Pool in the specified subscription.
  signature: 'async begin_update(resource_group_name: str, name: str, parameters:
    _models.ManagedHsm, *, content_type: str = ''application/json'', **kwargs: Any)
    -> AsyncLROPoller[_models.ManagedHsm]'
  parameters:
  - name: resource_group_name
    description: 'Name of the resource group that contains the managed HSM pool.

      Required.'
    isRequired: true
    types:
    - <xref:str>
  - name: name
    description: Name of the managed HSM Pool. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: parameters
    description: 'Parameters to patch the managed HSM Pool. Is either a ManagedHsm
      type or a

      IO type. Required.'
    isRequired: true
    types:
    - <xref:azure.mgmt.keyvault.v2022_07_01.models.ManagedHsm>
    - <xref:typing.IO>
  keywordOnlyParameters:
  - name: content_type
    description: 'Body Parameter content-type. Known values are: ''application/json''.

      Default value is None.'
    types:
    - <xref:str>
  - name: cls
    description: A custom type or function that will be passed the direct response
    types:
    - <xref:callable>
  - name: continuation_token
    description: A continuation token to restart a poller from a saved state.
    types:
    - <xref:str>
  - name: polling
    description: '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.'
    types:
    - <xref:bool>
    - <xref:azure.core.polling.AsyncPollingMethod>
  - name: polling_interval
    description: 'Default waiting time between two polls for LRO operations if no

      Retry-After header is present.'
    types:
    - <xref:int>
  return:
    description: 'An instance of AsyncLROPoller that returns either ManagedHsm or
      the result of

      cls(response)'
    types:
    - <xref:azure.core.polling.AsyncLROPoller>[<xref:azure.mgmt.keyvault.v2022_07_01.models.ManagedHsm>]
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.keyvault.v2022_07_01.aio.operations.ManagedHsmsOperations.check_mhsm_name_availability
  name: check_mhsm_name_availability
  summary: Checks that the managed hsm name is valid and is not already in use.
  signature: 'async check_mhsm_name_availability(mhsm_name: _models.CheckMhsmNameAvailabilityParameters,
    *, content_type: str = ''application/json'', **kwargs: Any) -> _models.CheckMhsmNameAvailabilityResult'
  parameters:
  - name: mhsm_name
    description: 'The name of the managed hsm. Is either a CheckMhsmNameAvailabilityParameters

      type or a IO type. Required.'
    isRequired: true
    types:
    - <xref:azure.mgmt.keyvault.v2022_07_01.models.CheckMhsmNameAvailabilityParameters>
    - <xref:typing.IO>
  keywordOnlyParameters:
  - name: content_type
    description: 'Body Parameter content-type. Known values are: ''application/json''.

      Default value is None.'
    types:
    - <xref:str>
  - name: cls
    description: A custom type or function that will be passed the direct response
    types:
    - <xref:callable>
  return:
    description: CheckMhsmNameAvailabilityResult or the result of cls(response)
    types:
    - <xref:azure.mgmt.keyvault.v2022_07_01.models.CheckMhsmNameAvailabilityResult>
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.keyvault.v2022_07_01.aio.operations.ManagedHsmsOperations.get
  name: get
  summary: Gets the specified managed HSM Pool.
  signature: 'async get(resource_group_name: str, name: str, **kwargs: Any) -> ManagedHsm
    | None'
  parameters:
  - name: resource_group_name
    description: 'Name of the resource group that contains the managed HSM pool.

      Required.'
    isRequired: true
    types:
    - <xref:str>
  - name: name
    description: The name of the managed HSM Pool. Required.
    isRequired: true
    types:
    - <xref:str>
  keywordOnlyParameters:
  - name: cls
    description: A custom type or function that will be passed the direct response
    types:
    - <xref:callable>
  return:
    description: ManagedHsm or None or the result of cls(response)
    types:
    - <xref:azure.mgmt.keyvault.v2022_07_01.models.ManagedHsm>
    - <xref:None>
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.keyvault.v2022_07_01.aio.operations.ManagedHsmsOperations.get_deleted
  name: get_deleted
  summary: Gets the specified deleted managed HSM.
  signature: 'async get_deleted(name: str, location: str, **kwargs: Any) -> DeletedManagedHsm'
  parameters:
  - name: name
    description: The name of the deleted managed HSM. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: location
    description: The location of the deleted managed HSM. Required.
    isRequired: true
    types:
    - <xref:str>
  keywordOnlyParameters:
  - name: cls
    description: A custom type or function that will be passed the direct response
    types:
    - <xref:callable>
  return:
    description: DeletedManagedHsm or the result of cls(response)
    types:
    - <xref:azure.mgmt.keyvault.v2022_07_01.models.DeletedManagedHsm>
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.keyvault.v2022_07_01.aio.operations.ManagedHsmsOperations.list_by_resource_group
  name: list_by_resource_group
  summary: 'The List operation gets information about the managed HSM Pools associated
    with the

    subscription and within the specified resource group.'
  signature: 'list_by_resource_group(resource_group_name: str, top: int | None = None,
    **kwargs: Any) -> AsyncIterable[ManagedHsm]'
  parameters:
  - name: resource_group_name
    description: 'Name of the resource group that contains the managed HSM pool.

      Required.'
    isRequired: true
    types:
    - <xref:str>
  - name: top
    description: Maximum number of results to return. Default value is None.
    isRequired: true
    types:
    - <xref:int>
  keywordOnlyParameters:
  - name: cls
    description: A custom type or function that will be passed the direct response
    types:
    - <xref:callable>
  return:
    description: An iterator like instance of either ManagedHsm or the result of cls(response)
    types:
    - <xref:azure.core.async_paging.AsyncItemPaged>[<xref:azure.mgmt.keyvault.v2022_07_01.models.ManagedHsm>]
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.keyvault.v2022_07_01.aio.operations.ManagedHsmsOperations.list_by_subscription
  name: list_by_subscription
  summary: 'The List operation gets information about the managed HSM Pools associated
    with the

    subscription.'
  signature: 'list_by_subscription(top: int | None = None, **kwargs: Any) -> AsyncIterable[ManagedHsm]'
  parameters:
  - name: top
    description: Maximum number of results to return. Default value is None.
    isRequired: true
    types:
    - <xref:int>
  keywordOnlyParameters:
  - name: cls
    description: A custom type or function that will be passed the direct response
    types:
    - <xref:callable>
  return:
    description: An iterator like instance of either ManagedHsm or the result of cls(response)
    types:
    - <xref:azure.core.async_paging.AsyncItemPaged>[<xref:azure.mgmt.keyvault.v2022_07_01.models.ManagedHsm>]
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.keyvault.v2022_07_01.aio.operations.ManagedHsmsOperations.list_deleted
  name: list_deleted
  summary: 'The List operation gets information about the deleted managed HSMs associated
    with the

    subscription.'
  signature: 'list_deleted(**kwargs: Any) -> AsyncIterable[DeletedManagedHsm]'
  keywordOnlyParameters:
  - name: cls
    description: A custom type or function that will be passed the direct response
    types:
    - <xref:callable>
  return:
    description: An iterator like instance of either DeletedManagedHsm or the result
      of cls(response)
    types:
    - <xref:azure.core.async_paging.AsyncItemPaged>[<xref:azure.mgmt.keyvault.v2022_07_01.models.DeletedManagedHsm>]
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
attributes:
- uid: azure.mgmt.keyvault.v2022_07_01.aio.operations.ManagedHsmsOperations.models
  name: models
  signature: models = <module 'azure.mgmt.keyvault.v2022_07_01.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.9\\x64\\Lib\\site-packages\\azure\\mgmt\\keyvault\\v2022_07_01\\models\\__init__.py'>