Share via

SshPublicKeysOperations Class

  • Reference

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

ComputeManagementClient's

<xref:ssh_public_keys> attribute.

Inheritance
builtins.object
SshPublicKeysOperations

Constructor

SshPublicKeysOperations(*args, **kwargs)

Methods

create

Creates a new SSH public key resource.
delete

Delete an SSH public key.
generate_key_pair

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.
get

Retrieves information about an SSH public key.
list_by_resource_group

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.
list_by_subscription

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.
update

Updates a new SSH public key resource.

create

Creates a new SSH public key resource.

create(resource_group_name: str, ssh_public_key_name: str, parameters: _models.SshPublicKeyResource, *, content_type: str = 'application/json', **kwargs: Any) -> _models.SshPublicKeyResource

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group. Required.
ssh_public_key_name
Required
str

The name of the SSH public key. Required.
parameters
Required
SshPublicKeyResource or IO[bytes]

Parameters supplied to create the SSH public key. Is either a SshPublicKeyResource type or a IO[bytes] type. Required.

Returns

Type Description
SshPublicKeyResource

SshPublicKeyResource or the result of cls(response)

Exceptions

Type Description
HttpResponseError

delete

Delete an SSH public key.

delete(resource_group_name: str, ssh_public_key_name: str, **kwargs: Any) -> None

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group. Required.
ssh_public_key_name
Required
str

The name of the SSH public key. Required.

Returns

Type Description
None

None or the result of cls(response)

Exceptions

Type Description
HttpResponseError

generate_key_pair

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.

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 Description
resource_group_name
Required
str

The name of the resource group. Required.
ssh_public_key_name
Required
str

The name of the SSH public key. Required.
parameters
Required
SshGenerateKeyPairInputParameters or IO[bytes]

Parameters supplied to generate the SSH public key. Is either a SshGenerateKeyPairInputParameters type or a IO[bytes] type. Default value is None.

Returns

Type Description
SshPublicKeyGenerateKeyPairResult

SshPublicKeyGenerateKeyPairResult or the result of cls(response)

Exceptions

Type Description
HttpResponseError

get

Retrieves information about an SSH public key.

get(resource_group_name: str, ssh_public_key_name: str, **kwargs: Any) -> SshPublicKeyResource

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group. Required.
ssh_public_key_name
Required
str

The name of the SSH public key. Required.

Returns

Type Description
SshPublicKeyResource

SshPublicKeyResource or the result of cls(response)

Exceptions

Type Description
HttpResponseError

list_by_resource_group

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.

list_by_resource_group(resource_group_name: str, **kwargs: Any) -> Iterable[SshPublicKeyResource]

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group. Required.

Returns

Type Description
ItemPaged[SshPublicKeyResource]

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

Exceptions

Type Description
HttpResponseError

list_by_subscription

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.

list_by_subscription(**kwargs: Any) -> Iterable[SshPublicKeyResource]

Returns

Type Description
ItemPaged[SshPublicKeyResource]

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

Exceptions

Type Description
HttpResponseError

update

Updates a new SSH public key resource.

update(resource_group_name: str, ssh_public_key_name: str, parameters: _models.SshPublicKeyUpdateResource, *, content_type: str = 'application/json', **kwargs: Any) -> _models.SshPublicKeyResource

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group. Required.
ssh_public_key_name
Required
str

The name of the SSH public key. Required.
parameters
Required
SshPublicKeyUpdateResource or IO[bytes]

Parameters supplied to update the SSH public key. Is either a SshPublicKeyUpdateResource type or a IO[bytes] type. Required.

Returns

Type Description
SshPublicKeyResource

SshPublicKeyResource or the result of cls(response)

Exceptions

Type Description
HttpResponseError

Attributes

models 

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'>