SshPublicKeysOperations Class

SshPublicKeysOperations async operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Inheritance
builtins.object
SshPublicKeysOperations

Constructor

SshPublicKeysOperations(client, config, serializer, deserializer) -> None

Parameters

client
Required

Client for service requests.

config
Required

Configuration of service client.

serializer
Required

An object model serializer.

deserializer
Required

An object model deserializer.

Variables

models

Alias to model classes used in this operation group.

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: azure.mgmt.compute.v2019_12_01.models._models_py3.SshPublicKeyResource, **kwargs: typing.Any) -> azure.mgmt.compute.v2019_12_01.models._models_py3.SshPublicKeyResource

Parameters

resource_group_name
str
Required

The name of the resource group.

ssh_public_key_name
str
Required

The name of the SSH public key.

parameters
SshPublicKeyResource
Required

Parameters supplied to create the SSH public key.

cls
callable

A custom type or function that will be passed the direct response

Returns

SshPublicKeyResource, or the result of cls(response)

Return type

delete

Delete an SSH public key.

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

Parameters

resource_group_name
str
Required

The name of the resource group.

ssh_public_key_name
str
Required

The name of the SSH public key.

cls
callable

A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

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, **kwargs: typing.Any) -> azure.mgmt.compute.v2019_12_01.models._models_py3.SshPublicKeyGenerateKeyPairResult

Parameters

resource_group_name
str
Required

The name of the resource group.

ssh_public_key_name
str
Required

The name of the SSH public key.

cls
callable

A custom type or function that will be passed the direct response

Returns

SshPublicKeyGenerateKeyPairResult, or the result of cls(response)

Return type

get

Retrieves information about an SSH public key.

get(resource_group_name: str, ssh_public_key_name: str, **kwargs: typing.Any) -> azure.mgmt.compute.v2019_12_01.models._models_py3.SshPublicKeyResource

Parameters

resource_group_name
str
Required

The name of the resource group.

ssh_public_key_name
str
Required

The name of the SSH public key.

cls
callable

A custom type or function that will be passed the direct response

Returns

SshPublicKeyResource, or the result of cls(response)

Return type

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: typing.Any) -> typing.AsyncIterable[_ForwardRef('_models.SshPublicKeysGroupListResult')]

Parameters

resource_group_name
str
Required

The name of the resource group.

cls
callable

A custom type or function that will be passed the direct response

Returns

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

Return type

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: typing.Any) -> typing.AsyncIterable[_ForwardRef('_models.SshPublicKeysGroupListResult')]

Parameters

cls
callable

A custom type or function that will be passed the direct response

Returns

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

Return type

update

Updates a new SSH public key resource.

update(resource_group_name: str, ssh_public_key_name: str, parameters: azure.mgmt.compute.v2019_12_01.models._models_py3.SshPublicKeyUpdateResource, **kwargs: typing.Any) -> azure.mgmt.compute.v2019_12_01.models._models_py3.SshPublicKeyResource

Parameters

resource_group_name
str
Required

The name of the resource group.

ssh_public_key_name
str
Required

The name of the SSH public key.

parameters
SshPublicKeyUpdateResource
Required

Parameters supplied to update the SSH public key.

cls
callable

A custom type or function that will be passed the direct response

Returns

SshPublicKeyResource, or the result of cls(response)

Return type

Attributes

models

models = <module 'azure.mgmt.compute.v2019_12_01.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.6.8\\x64\\lib\\site-packages\\azure\\mgmt\\compute\\v2019_12_01\\models\\__init__.py'>