azure.mgmt.keyvault.v2023_07_01.operations.ManagedHsmKeysOperations.yml

### YamlMime:PythonClass
uid: azure.mgmt.keyvault.v2023_07_01.operations.ManagedHsmKeysOperations
name: ManagedHsmKeysOperations
fullName: azure.mgmt.keyvault.v2023_07_01.operations.ManagedHsmKeysOperations
module: azure.mgmt.keyvault.v2023_07_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.keyvault.v2023_07_01.KeyVaultManagementClient>'s\n\
  >\n> <xref:managed_hsm_keys> attribute.\n>"
constructor:
  syntax: ManagedHsmKeysOperations(*args, **kwargs)
methods:
- uid: azure.mgmt.keyvault.v2023_07_01.operations.ManagedHsmKeysOperations.create_if_not_exist
  name: create_if_not_exist
  summary: 'Creates the first version of a new key if it does not exist. If it already
    exists, then the

    existing key is returned without any write operations being performed. This API
    does not create

    subsequent versions, and does not update existing keys.'
  signature: 'create_if_not_exist(resource_group_name: str, name: str, key_name: str,
    parameters: _models.ManagedHsmKeyCreateParameters, *, content_type: str = ''application/json'',
    **kwargs: Any) -> _models.ManagedHsmKey'
  parameters:
  - name: resource_group_name
    description: 'The name of the resource group. The name is case insensitive.

      Required.'
    isRequired: true
    types:
    - <xref:str>
  - name: name
    description: The name of the Managed HSM Pool within the specified resource group.
      Required.
    isRequired: true
    types:
    - <xref:str>
  - name: key_name
    description: 'The name of the key to be created. The value you provide may be
      copied

      globally for the purpose of running the service. The value provided should not
      include

      personally identifiable or sensitive information. Required.'
    isRequired: true
    types:
    - <xref:str>
  - name: parameters
    description: 'The parameters used to create the specified key. Is either a

      ManagedHsmKeyCreateParameters type or a IO type. Required.'
    isRequired: true
    types:
    - <xref:azure.mgmt.keyvault.v2023_07_01.models.ManagedHsmKeyCreateParameters>
    - <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: ManagedHsmKey or the result of cls(response)
    types:
    - <xref:azure.mgmt.keyvault.v2023_07_01.models.ManagedHsmKey>
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.keyvault.v2023_07_01.operations.ManagedHsmKeysOperations.get
  name: get
  summary: Gets the current version of the specified key from the specified managed
    HSM.
  signature: 'get(resource_group_name: str, name: str, key_name: str, **kwargs: Any)
    -> ManagedHsmKey'
  parameters:
  - name: resource_group_name
    description: 'The name of the resource group. The name is case insensitive.

      Required.'
    isRequired: true
    types:
    - <xref:str>
  - name: name
    description: The name of the Managed HSM Pool within the specified resource group.
      Required.
    isRequired: true
    types:
    - <xref:str>
  - name: key_name
    description: 'The name of the key to be created. The value you provide may be
      copied

      globally for the purpose of running the service. The value provided should not
      include

      personally identifiable or sensitive information. 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: ManagedHsmKey or the result of cls(response)
    types:
    - <xref:azure.mgmt.keyvault.v2023_07_01.models.ManagedHsmKey>
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.keyvault.v2023_07_01.operations.ManagedHsmKeysOperations.get_version
  name: get_version
  summary: Gets the specified version of the specified key in the specified managed
    HSM.
  signature: 'get_version(resource_group_name: str, name: str, key_name: str, key_version:
    str, **kwargs: Any) -> ManagedHsmKey'
  parameters:
  - name: resource_group_name
    description: 'The name of the resource group. The name is case insensitive.

      Required.'
    isRequired: true
    types:
    - <xref:str>
  - name: name
    description: The name of the Managed HSM Pool within the specified resource group.
      Required.
    isRequired: true
    types:
    - <xref:str>
  - name: key_name
    description: 'The name of the key to be created. The value you provide may be
      copied

      globally for the purpose of running the service. The value provided should not
      include

      personally identifiable or sensitive information. Required.'
    isRequired: true
    types:
    - <xref:str>
  - name: key_version
    description: The version of the key to be retrieved. 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: ManagedHsmKey or the result of cls(response)
    types:
    - <xref:azure.mgmt.keyvault.v2023_07_01.models.ManagedHsmKey>
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.keyvault.v2023_07_01.operations.ManagedHsmKeysOperations.list
  name: list
  summary: Lists the keys in the specified managed HSM.
  signature: 'list(resource_group_name: str, name: str, **kwargs: Any) -> Iterable[ManagedHsmKey]'
  parameters:
  - name: resource_group_name
    description: 'The name of the resource group. The name is case insensitive.

      Required.'
    isRequired: true
    types:
    - <xref:str>
  - name: name
    description: The name of the Managed HSM Pool within the specified resource group.
      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: An iterator like instance of either ManagedHsmKey or the result of
      cls(response)
    types:
    - <xref:azure.core.paging.ItemPaged>[<xref:azure.mgmt.keyvault.v2023_07_01.models.ManagedHsmKey>]
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.keyvault.v2023_07_01.operations.ManagedHsmKeysOperations.list_versions
  name: list_versions
  summary: Lists the versions of the specified key in the specified managed HSM.
  signature: 'list_versions(resource_group_name: str, name: str, key_name: str, **kwargs:
    Any) -> Iterable[ManagedHsmKey]'
  parameters:
  - name: resource_group_name
    description: 'The name of the resource group. The name is case insensitive.

      Required.'
    isRequired: true
    types:
    - <xref:str>
  - name: name
    description: The name of the Managed HSM Pool within the specified resource group.
      Required.
    isRequired: true
    types:
    - <xref:str>
  - name: key_name
    description: 'The name of the key to be created. The value you provide may be
      copied

      globally for the purpose of running the service. The value provided should not
      include

      personally identifiable or sensitive information. 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: An iterator like instance of either ManagedHsmKey or the result of
      cls(response)
    types:
    - <xref:azure.core.paging.ItemPaged>[<xref:azure.mgmt.keyvault.v2023_07_01.models.ManagedHsmKey>]
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
attributes:
- uid: azure.mgmt.keyvault.v2023_07_01.operations.ManagedHsmKeysOperations.models
  name: models
  signature: models = <module 'azure.mgmt.keyvault.v2023_07_01.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.9\\x64\\Lib\\site-packages\\azure\\mgmt\\keyvault\\v2023_07_01\\models\\__init__.py'>