azure.mgmt.compute.v2023_09_01.aio.operations.SshPublicKeysOperations.yml

### YamlMime:PythonClass
uid: azure.mgmt.compute.v2023_09_01.aio.operations.SshPublicKeysOperations
name: SshPublicKeysOperations
fullName: azure.mgmt.compute.v2023_09_01.aio.operations.SshPublicKeysOperations
module: azure.mgmt.compute.v2023_09_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.compute.v2023_09_01.aio.ComputeManagementClient>'s\n\
  >\n> <xref:ssh_public_keys> attribute.\n>"
constructor:
  syntax: SshPublicKeysOperations(*args, **kwargs)
methods:
- uid: azure.mgmt.compute.v2023_09_01.aio.operations.SshPublicKeysOperations.create
  name: create
  summary: Creates a new SSH public key resource.
  signature: 'async create(resource_group_name: str, ssh_public_key_name: str, parameters:
    _models.SshPublicKeyResource, *, content_type: str = ''application/json'', **kwargs:
    Any) -> _models.SshPublicKeyResource'
  parameters:
  - name: resource_group_name
    description: The name of the resource group. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: ssh_public_key_name
    description: The name of the SSH public key. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: parameters
    description: 'Parameters supplied to create the SSH public key. Is either a

      SshPublicKeyResource type or a IO[bytes] type. Required.'
    isRequired: true
    types:
    - <xref:azure.mgmt.compute.v2023_09_01.models.SshPublicKeyResource>
    - <xref:typing.IO>[<xref:bytes>]
  return:
    description: SshPublicKeyResource or the result of cls(response)
    types:
    - <xref:azure.mgmt.compute.v2023_09_01.models.SshPublicKeyResource>
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.compute.v2023_09_01.aio.operations.SshPublicKeysOperations.delete
  name: delete
  summary: Delete an SSH public key.
  signature: 'async delete(resource_group_name: str, ssh_public_key_name: str, **kwargs:
    Any) -> None'
  parameters:
  - name: resource_group_name
    description: The name of the resource group. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: ssh_public_key_name
    description: The name of the SSH public key. Required.
    isRequired: true
    types:
    - <xref:str>
  return:
    description: None or the result of cls(response)
    types:
    - <xref:None>
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.compute.v2023_09_01.aio.operations.SshPublicKeysOperations.generate_key_pair
  name: generate_key_pair
  summary: 'Generates and returns a public/private key pair and populates the SSH
    public key resource with

    the public key. The length of the key will be 3072 bits. This operation can only
    be performed

    once per SSH public key resource.'
  signature: 'async generate_key_pair(resource_group_name: str, ssh_public_key_name:
    str, parameters: _models.SshGenerateKeyPairInputParameters | None = None, *, content_type:
    str = ''application/json'', **kwargs: Any) -> _models.SshPublicKeyGenerateKeyPairResult'
  parameters:
  - name: resource_group_name
    description: The name of the resource group. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: ssh_public_key_name
    description: The name of the SSH public key. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: parameters
    description: 'Parameters supplied to generate the SSH public key. Is either a

      SshGenerateKeyPairInputParameters type or a IO[bytes] type. Default value is
      None.'
    isRequired: true
    types:
    - <xref:azure.mgmt.compute.v2023_09_01.models.SshGenerateKeyPairInputParameters>
    - <xref:typing.IO>[<xref:bytes>]
  return:
    description: SshPublicKeyGenerateKeyPairResult or the result of cls(response)
    types:
    - <xref:azure.mgmt.compute.v2023_09_01.models.SshPublicKeyGenerateKeyPairResult>
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.compute.v2023_09_01.aio.operations.SshPublicKeysOperations.get
  name: get
  summary: Retrieves information about an SSH public key.
  signature: 'async get(resource_group_name: str, ssh_public_key_name: str, **kwargs:
    Any) -> SshPublicKeyResource'
  parameters:
  - name: resource_group_name
    description: The name of the resource group. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: ssh_public_key_name
    description: The name of the SSH public key. Required.
    isRequired: true
    types:
    - <xref:str>
  return:
    description: SshPublicKeyResource or the result of cls(response)
    types:
    - <xref:azure.mgmt.compute.v2023_09_01.models.SshPublicKeyResource>
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.compute.v2023_09_01.aio.operations.SshPublicKeysOperations.list_by_resource_group
  name: list_by_resource_group
  summary: 'Lists all of the SSH public keys in the specified resource group. Use
    the nextLink property in

    the response to get the next page of SSH public keys.'
  signature: 'list_by_resource_group(resource_group_name: str, **kwargs: Any) -> AsyncIterable[SshPublicKeyResource]'
  parameters:
  - name: resource_group_name
    description: The name of the resource group. Required.
    isRequired: true
    types:
    - <xref:str>
  return:
    description: 'An iterator like instance of either SshPublicKeyResource or the
      result of

      cls(response)'
    types:
    - <xref:azure.core.async_paging.AsyncItemPaged>[<xref:azure.mgmt.compute.v2023_09_01.models.SshPublicKeyResource>]
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.compute.v2023_09_01.aio.operations.SshPublicKeysOperations.list_by_subscription
  name: list_by_subscription
  summary: 'Lists all of the SSH public keys in the subscription. Use the nextLink
    property in the response

    to get the next page of SSH public keys.'
  signature: 'list_by_subscription(**kwargs: Any) -> AsyncIterable[SshPublicKeyResource]'
  return:
    description: 'An iterator like instance of either SshPublicKeyResource or the
      result of

      cls(response)'
    types:
    - <xref:azure.core.async_paging.AsyncItemPaged>[<xref:azure.mgmt.compute.v2023_09_01.models.SshPublicKeyResource>]
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.compute.v2023_09_01.aio.operations.SshPublicKeysOperations.update
  name: update
  summary: Updates a new SSH public key resource.
  signature: 'async update(resource_group_name: str, ssh_public_key_name: str, parameters:
    _models.SshPublicKeyUpdateResource, *, content_type: str = ''application/json'',
    **kwargs: Any) -> _models.SshPublicKeyResource'
  parameters:
  - name: resource_group_name
    description: The name of the resource group. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: ssh_public_key_name
    description: The name of the SSH public key. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: parameters
    description: 'Parameters supplied to update the SSH public key. Is either a

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