com.azure.resourcemanager.compute.fluent

Interface SshPublicKeysClient

All Superinterfaces:

InnerSupportsDelete<Void>, InnerSupportsGet<SshPublicKeyResourceInner>, InnerSupportsListing<SshPublicKeyResourceInner>

public interface SshPublicKeysClient
extends InnerSupportsGet<SshPublicKeyResourceInner>, InnerSupportsListing<SshPublicKeyResourceInner>, InnerSupportsDelete<Void>

An instance of this class provides access to all the operations defined in SshPublicKeysClient.

Method Summary

Modifier and Type	Method and Description
SshPublicKeyResourceInner	create(String resourceGroupName, String sshPublicKeyName, SshPublicKeyResourceInner parameters) Creates a new SSH public key resource.
Mono<SshPublicKeyResourceInner>	createAsync(String resourceGroupName, String sshPublicKeyName, SshPublicKeyResourceInner parameters) Creates a new SSH public key resource.
com.azure.core.http.rest.Response<SshPublicKeyResourceInner>	createWithResponse(String resourceGroupName, String sshPublicKeyName, SshPublicKeyResourceInner parameters, com.azure.core.util.Context context) Creates a new SSH public key resource.
Mono<com.azure.core.http.rest.Response<SshPublicKeyResourceInner>>	createWithResponseAsync(String resourceGroupName, String sshPublicKeyName, SshPublicKeyResourceInner parameters) Creates a new SSH public key resource.
void	delete(String resourceGroupName, String sshPublicKeyName) Delete an SSH public key.
Mono<Void>	deleteAsync(String resourceGroupName, String sshPublicKeyName) Delete an SSH public key.
com.azure.core.http.rest.Response<Void>	deleteWithResponse(String resourceGroupName, String sshPublicKeyName, com.azure.core.util.Context context) Delete an SSH public key.
Mono<com.azure.core.http.rest.Response<Void>>	deleteWithResponseAsync(String resourceGroupName, String sshPublicKeyName) Delete an SSH public key.
SshPublicKeyGenerateKeyPairResultInner	generateKeyPair(String resourceGroupName, String sshPublicKeyName) Generates and returns a public/private key pair and populates the SSH public key resource with the public key.
Mono<SshPublicKeyGenerateKeyPairResultInner>	generateKeyPairAsync(String resourceGroupName, String sshPublicKeyName) Generates and returns a public/private key pair and populates the SSH public key resource with the public key.
com.azure.core.http.rest.Response<SshPublicKeyGenerateKeyPairResultInner>	generateKeyPairWithResponse(String resourceGroupName, String sshPublicKeyName, com.azure.core.util.Context context) Generates and returns a public/private key pair and populates the SSH public key resource with the public key.
Mono<com.azure.core.http.rest.Response<SshPublicKeyGenerateKeyPairResultInner>>	generateKeyPairWithResponseAsync(String resourceGroupName, String sshPublicKeyName) Generates and returns a public/private key pair and populates the SSH public key resource with the public key.
SshPublicKeyResourceInner	getByResourceGroup(String resourceGroupName, String sshPublicKeyName) Retrieves information about an SSH public key.
Mono<SshPublicKeyResourceInner>	getByResourceGroupAsync(String resourceGroupName, String sshPublicKeyName) Retrieves information about an SSH public key.
com.azure.core.http.rest.Response<SshPublicKeyResourceInner>	getByResourceGroupWithResponse(String resourceGroupName, String sshPublicKeyName, com.azure.core.util.Context context) Retrieves information about an SSH public key.
Mono<com.azure.core.http.rest.Response<SshPublicKeyResourceInner>>	getByResourceGroupWithResponseAsync(String resourceGroupName, String sshPublicKeyName) Retrieves information about an SSH public key.
com.azure.core.http.rest.PagedIterable<SshPublicKeyResourceInner>	list() Lists all of the SSH public keys in the subscription.
com.azure.core.http.rest.PagedIterable<SshPublicKeyResourceInner>	list(com.azure.core.util.Context context) Lists all of the SSH public keys in the subscription.
com.azure.core.http.rest.PagedFlux<SshPublicKeyResourceInner>	listAsync() Lists all of the SSH public keys in the subscription.
com.azure.core.http.rest.PagedIterable<SshPublicKeyResourceInner>	listByResourceGroup(String resourceGroupName) Lists all of the SSH public keys in the specified resource group.
com.azure.core.http.rest.PagedIterable<SshPublicKeyResourceInner>	listByResourceGroup(String resourceGroupName, com.azure.core.util.Context context) Lists all of the SSH public keys in the specified resource group.
com.azure.core.http.rest.PagedFlux<SshPublicKeyResourceInner>	listByResourceGroupAsync(String resourceGroupName) Lists all of the SSH public keys in the specified resource group.
SshPublicKeyResourceInner	update(String resourceGroupName, String sshPublicKeyName, SshPublicKeyUpdateResource parameters) Updates a new SSH public key resource.
Mono<SshPublicKeyResourceInner>	updateAsync(String resourceGroupName, String sshPublicKeyName, SshPublicKeyUpdateResource parameters) Updates a new SSH public key resource.
com.azure.core.http.rest.Response<SshPublicKeyResourceInner>	updateWithResponse(String resourceGroupName, String sshPublicKeyName, SshPublicKeyUpdateResource parameters, com.azure.core.util.Context context) Updates a new SSH public key resource.
Mono<com.azure.core.http.rest.Response<SshPublicKeyResourceInner>>	updateWithResponseAsync(String resourceGroupName, String sshPublicKeyName, SshPublicKeyUpdateResource parameters) Updates a new SSH public key resource.

Method Detail

listAsync

com.azure.core.http.rest.PagedFlux<SshPublicKeyResourceInner> listAsync()

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.

Specified by:

listAsync in interface InnerSupportsListing<SshPublicKeyResourceInner>

Returns:

the list SSH public keys operation response.

Throws:

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

list

com.azure.core.http.rest.PagedIterable<SshPublicKeyResourceInner> list()

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.

Specified by:

list in interface InnerSupportsListing<SshPublicKeyResourceInner>

Returns:

the list SSH public keys operation response.

Throws:

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

list

com.azure.core.http.rest.PagedIterable<SshPublicKeyResourceInner> list(com.azure.core.util.Context context)

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.

Parameters:

context - The context to associate with this operation.

Returns:

the list SSH public keys operation response.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

listByResourceGroupAsync

com.azure.core.http.rest.PagedFlux<SshPublicKeyResourceInner> listByResourceGroupAsync(String resourceGroupName)

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.

Specified by:

listByResourceGroupAsync in interface InnerSupportsListing<SshPublicKeyResourceInner>

Parameters:

resourceGroupName - The name of the resource group.

Returns:

the list SSH public keys operation response.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

listByResourceGroup

com.azure.core.http.rest.PagedIterable<SshPublicKeyResourceInner> listByResourceGroup(String resourceGroupName)

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.

Specified by:

listByResourceGroup in interface InnerSupportsListing<SshPublicKeyResourceInner>

Parameters:

resourceGroupName - The name of the resource group.

Returns:

the list SSH public keys operation response.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

listByResourceGroup

com.azure.core.http.rest.PagedIterable<SshPublicKeyResourceInner> listByResourceGroup(String resourceGroupName,
                                                                                      com.azure.core.util.Context context)

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.

Parameters:

resourceGroupName - The name of the resource group.

context - The context to associate with this operation.

Returns:

the list SSH public keys operation response.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

createWithResponseAsync

Mono<com.azure.core.http.rest.Response<SshPublicKeyResourceInner>> createWithResponseAsync(String resourceGroupName,
                                                                                           String sshPublicKeyName,
                                                                                           SshPublicKeyResourceInner parameters)

Creates a new SSH public key resource.

Parameters:

resourceGroupName - The name of the resource group.

sshPublicKeyName - The name of the SSH public key.

parameters - Specifies information about the SSH public key.

Returns:

specifies information about the SSH public key.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

createAsync

Mono<SshPublicKeyResourceInner> createAsync(String resourceGroupName,
                                            String sshPublicKeyName,
                                            SshPublicKeyResourceInner parameters)

Creates a new SSH public key resource.

Parameters:

resourceGroupName - The name of the resource group.

sshPublicKeyName - The name of the SSH public key.

parameters - Specifies information about the SSH public key.

Returns:

specifies information about the SSH public key.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

create

SshPublicKeyResourceInner create(String resourceGroupName,
                                 String sshPublicKeyName,
                                 SshPublicKeyResourceInner parameters)

Creates a new SSH public key resource.

Parameters:

resourceGroupName - The name of the resource group.

sshPublicKeyName - The name of the SSH public key.

parameters - Specifies information about the SSH public key.

Returns:

specifies information about the SSH public key.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

createWithResponse

com.azure.core.http.rest.Response<SshPublicKeyResourceInner> createWithResponse(String resourceGroupName,
                                                                                String sshPublicKeyName,
                                                                                SshPublicKeyResourceInner parameters,
                                                                                com.azure.core.util.Context context)

Creates a new SSH public key resource.

Parameters:

resourceGroupName - The name of the resource group.

sshPublicKeyName - The name of the SSH public key.

parameters - Specifies information about the SSH public key.

context - The context to associate with this operation.

Returns:

specifies information about the SSH public key.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

updateWithResponseAsync

Mono<com.azure.core.http.rest.Response<SshPublicKeyResourceInner>> updateWithResponseAsync(String resourceGroupName,
                                                                                           String sshPublicKeyName,
                                                                                           SshPublicKeyUpdateResource parameters)

Updates a new SSH public key resource.

Parameters:

resourceGroupName - The name of the resource group.

sshPublicKeyName - The name of the SSH public key.

parameters - Specifies information about the SSH public key.

Returns:

specifies information about the SSH public key.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

updateAsync

Mono<SshPublicKeyResourceInner> updateAsync(String resourceGroupName,
                                            String sshPublicKeyName,
                                            SshPublicKeyUpdateResource parameters)

Updates a new SSH public key resource.

Parameters:

resourceGroupName - The name of the resource group.

sshPublicKeyName - The name of the SSH public key.

parameters - Specifies information about the SSH public key.

Returns:

specifies information about the SSH public key.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

update

SshPublicKeyResourceInner update(String resourceGroupName,
                                 String sshPublicKeyName,
                                 SshPublicKeyUpdateResource parameters)

Updates a new SSH public key resource.

Parameters:

resourceGroupName - The name of the resource group.

sshPublicKeyName - The name of the SSH public key.

parameters - Specifies information about the SSH public key.

Returns:

specifies information about the SSH public key.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

updateWithResponse

com.azure.core.http.rest.Response<SshPublicKeyResourceInner> updateWithResponse(String resourceGroupName,
                                                                                String sshPublicKeyName,
                                                                                SshPublicKeyUpdateResource parameters,
                                                                                com.azure.core.util.Context context)

Updates a new SSH public key resource.

Parameters:

resourceGroupName - The name of the resource group.

sshPublicKeyName - The name of the SSH public key.

parameters - Specifies information about the SSH public key.

context - The context to associate with this operation.

Returns:

specifies information about the SSH public key.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

deleteWithResponseAsync

Mono<com.azure.core.http.rest.Response<Void>> deleteWithResponseAsync(String resourceGroupName,
                                                                      String sshPublicKeyName)

Delete an SSH public key.

Parameters:

resourceGroupName - The name of the resource group.

sshPublicKeyName - The name of the SSH public key.

Returns:

the completion.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

deleteAsync

Mono<Void> deleteAsync(String resourceGroupName,
                       String sshPublicKeyName)

Delete an SSH public key.

Specified by:

deleteAsync in interface InnerSupportsDelete<Void>

Parameters:

resourceGroupName - The name of the resource group.

sshPublicKeyName - The name of the SSH public key.

Returns:

the completion.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

delete

void delete(String resourceGroupName,
            String sshPublicKeyName)

Delete an SSH public key.

Parameters:

resourceGroupName - The name of the resource group.

sshPublicKeyName - The name of the SSH public key.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

deleteWithResponse

com.azure.core.http.rest.Response<Void> deleteWithResponse(String resourceGroupName,
                                                           String sshPublicKeyName,
                                                           com.azure.core.util.Context context)

Delete an SSH public key.

Parameters:

resourceGroupName - The name of the resource group.

sshPublicKeyName - The name of the SSH public key.

context - The context to associate with this operation.

Returns:

the response.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

getByResourceGroupWithResponseAsync

Mono<com.azure.core.http.rest.Response<SshPublicKeyResourceInner>> getByResourceGroupWithResponseAsync(String resourceGroupName,
                                                                                                       String sshPublicKeyName)

Retrieves information about an SSH public key.

Parameters:

resourceGroupName - The name of the resource group.

sshPublicKeyName - The name of the SSH public key.

Returns:

specifies information about the SSH public key.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

getByResourceGroupAsync

Mono<SshPublicKeyResourceInner> getByResourceGroupAsync(String resourceGroupName,
                                                        String sshPublicKeyName)

Retrieves information about an SSH public key.

Specified by:

getByResourceGroupAsync in interface InnerSupportsGet<SshPublicKeyResourceInner>

Parameters:

resourceGroupName - The name of the resource group.

sshPublicKeyName - The name of the SSH public key.

Returns:

specifies information about the SSH public key.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

getByResourceGroup

SshPublicKeyResourceInner getByResourceGroup(String resourceGroupName,
                                             String sshPublicKeyName)

Retrieves information about an SSH public key.

Specified by:

getByResourceGroup in interface InnerSupportsGet<SshPublicKeyResourceInner>

Parameters:

resourceGroupName - The name of the resource group.

sshPublicKeyName - The name of the SSH public key.

Returns:

specifies information about the SSH public key.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

getByResourceGroupWithResponse

com.azure.core.http.rest.Response<SshPublicKeyResourceInner> getByResourceGroupWithResponse(String resourceGroupName,
                                                                                            String sshPublicKeyName,
                                                                                            com.azure.core.util.Context context)

Retrieves information about an SSH public key.

Parameters:

resourceGroupName - The name of the resource group.

sshPublicKeyName - The name of the SSH public key.

context - The context to associate with this operation.

Returns:

specifies information about the SSH public key.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

generateKeyPairWithResponseAsync

Mono<com.azure.core.http.rest.Response<SshPublicKeyGenerateKeyPairResultInner>> generateKeyPairWithResponseAsync(String resourceGroupName,
                                                                                                                 String sshPublicKeyName)

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.

Parameters:

resourceGroupName - The name of the resource group.

sshPublicKeyName - The name of the SSH public key.

Returns:

response from generation of an SSH key pair.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

generateKeyPairAsync

Mono<SshPublicKeyGenerateKeyPairResultInner> generateKeyPairAsync(String resourceGroupName,
                                                                  String sshPublicKeyName)

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.

Parameters:

resourceGroupName - The name of the resource group.

sshPublicKeyName - The name of the SSH public key.

Returns:

response from generation of an SSH key pair.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

generateKeyPair

SshPublicKeyGenerateKeyPairResultInner generateKeyPair(String resourceGroupName,
                                                       String sshPublicKeyName)

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.

Parameters:

resourceGroupName - The name of the resource group.

sshPublicKeyName - The name of the SSH public key.

Returns:

response from generation of an SSH key pair.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

generateKeyPairWithResponse

com.azure.core.http.rest.Response<SshPublicKeyGenerateKeyPairResultInner> generateKeyPairWithResponse(String resourceGroupName,
                                                                                                      String sshPublicKeyName,
                                                                                                      com.azure.core.util.Context context)

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.

Parameters:

resourceGroupName - The name of the resource group.

sshPublicKeyName - The name of the SSH public key.

context - The context to associate with this operation.

Returns:

response from generation of an SSH key pair.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.