Interface ServerKeysClient
public interface ServerKeysClient
An instance of this class provides access to all the operations defined in ServerKeysClient.
-
Method Summary
Modifier and TypeMethodDescriptioncom.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<ServerKeyInner>,ServerKeyInner> beginCreateOrUpdate(String resourceGroupName, String serverName, String keyName, ServerKeyInner parameters) Creates or updates a server key.com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<ServerKeyInner>,ServerKeyInner> beginCreateOrUpdate(String resourceGroupName, String serverName, String keyName, ServerKeyInner parameters, com.azure.core.util.Context context) Creates or updates a server key.com.azure.core.util.polling.PollerFlux<com.azure.core.management.polling.PollResult<ServerKeyInner>,ServerKeyInner> beginCreateOrUpdateAsync(String resourceGroupName, String serverName, String keyName, ServerKeyInner parameters) Creates or updates a server key.beginDelete(String resourceGroupName, String serverName, String keyName) Deletes the server key with the given name.beginDelete(String resourceGroupName, String serverName, String keyName, com.azure.core.util.Context context) Deletes the server key with the given name.beginDeleteAsync(String resourceGroupName, String serverName, String keyName) Deletes the server key with the given name.createOrUpdate(String resourceGroupName, String serverName, String keyName, ServerKeyInner parameters) Creates or updates a server key.createOrUpdate(String resourceGroupName, String serverName, String keyName, ServerKeyInner parameters, com.azure.core.util.Context context) Creates or updates a server key.createOrUpdateAsync(String resourceGroupName, String serverName, String keyName, ServerKeyInner parameters) Creates or updates a server key.Mono<com.azure.core.http.rest.Response<Flux<ByteBuffer>>>createOrUpdateWithResponseAsync(String resourceGroupName, String serverName, String keyName, ServerKeyInner parameters) Creates or updates a server key.voidDeletes the server key with the given name.voiddelete(String resourceGroupName, String serverName, String keyName, com.azure.core.util.Context context) Deletes the server key with the given name.deleteAsync(String resourceGroupName, String serverName, String keyName) Deletes the server key with the given name.Mono<com.azure.core.http.rest.Response<Flux<ByteBuffer>>>deleteWithResponseAsync(String resourceGroupName, String serverName, String keyName) Deletes the server key with the given name.Gets a server key.Gets a server key.com.azure.core.http.rest.Response<ServerKeyInner>getWithResponse(String resourceGroupName, String serverName, String keyName, com.azure.core.util.Context context) Gets a server key.Mono<com.azure.core.http.rest.Response<ServerKeyInner>>getWithResponseAsync(String resourceGroupName, String serverName, String keyName) Gets a server key.com.azure.core.http.rest.PagedIterable<ServerKeyInner>listByServer(String resourceGroupName, String serverName) Gets a list of server keys.com.azure.core.http.rest.PagedIterable<ServerKeyInner>listByServer(String resourceGroupName, String serverName, com.azure.core.util.Context context) Gets a list of server keys.com.azure.core.http.rest.PagedFlux<ServerKeyInner>listByServerAsync(String resourceGroupName, String serverName) Gets a list of server keys.
-
Method Details
-
listByServerAsync
com.azure.core.http.rest.PagedFlux<ServerKeyInner> listByServerAsync(String resourceGroupName, String serverName) Gets a list of server keys.- Parameters:
resourceGroupName- The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.serverName- The name of the server.- Returns:
- a list of server keys as paginated response with
PagedFlux. - 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.
-
listByServer
com.azure.core.http.rest.PagedIterable<ServerKeyInner> listByServer(String resourceGroupName, String serverName) Gets a list of server keys.- Parameters:
resourceGroupName- The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.serverName- The name of the server.- Returns:
- a list of server keys as paginated response with
PagedIterable. - 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.
-
listByServer
com.azure.core.http.rest.PagedIterable<ServerKeyInner> listByServer(String resourceGroupName, String serverName, com.azure.core.util.Context context) Gets a list of server keys.- Parameters:
resourceGroupName- The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.serverName- The name of the server.context- The context to associate with this operation.- Returns:
- a list of server keys as paginated response with
PagedIterable. - 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.
-
getWithResponseAsync
Mono<com.azure.core.http.rest.Response<ServerKeyInner>> getWithResponseAsync(String resourceGroupName, String serverName, String keyName) Gets a server key.- Parameters:
resourceGroupName- The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.serverName- The name of the server.keyName- The name of the server key to be retrieved.- Returns:
- a server key along with
Responseon successful completion ofMono. - 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.
-
getAsync
Gets a server key.- Parameters:
resourceGroupName- The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.serverName- The name of the server.keyName- The name of the server key to be retrieved.- Returns:
- a server key on successful completion of
Mono. - 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.
-
getWithResponse
com.azure.core.http.rest.Response<ServerKeyInner> getWithResponse(String resourceGroupName, String serverName, String keyName, com.azure.core.util.Context context) Gets a server key.- Parameters:
resourceGroupName- The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.serverName- The name of the server.keyName- The name of the server key to be retrieved.context- The context to associate with this operation.- Returns:
- a server key along with
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.
-
get
Gets a server key.- Parameters:
resourceGroupName- The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.serverName- The name of the server.keyName- The name of the server key to be retrieved.- Returns:
- a server 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.
-
createOrUpdateWithResponseAsync
Mono<com.azure.core.http.rest.Response<Flux<ByteBuffer>>> createOrUpdateWithResponseAsync(String resourceGroupName, String serverName, String keyName, ServerKeyInner parameters) Creates or updates a server key.- Parameters:
resourceGroupName- The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.serverName- The name of the server.keyName- The name of the server key to be operated on (updated or created). The key name is required to be in the format of 'vault_key_version'. For example, if the keyId is https://YourVaultName.vault.azure.net/keys/YourKeyName/YourKeyVersion, then the server key name should be formatted as: YourVaultName_YourKeyName_YourKeyVersion.parameters- The requested server key resource state.- Returns:
- a server key along with
Responseon successful completion ofMono. - 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.
-
beginCreateOrUpdateAsync
com.azure.core.util.polling.PollerFlux<com.azure.core.management.polling.PollResult<ServerKeyInner>,ServerKeyInner> beginCreateOrUpdateAsync(String resourceGroupName, String serverName, String keyName, ServerKeyInner parameters) Creates or updates a server key.- Parameters:
resourceGroupName- The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.serverName- The name of the server.keyName- The name of the server key to be operated on (updated or created). The key name is required to be in the format of 'vault_key_version'. For example, if the keyId is https://YourVaultName.vault.azure.net/keys/YourKeyName/YourKeyVersion, then the server key name should be formatted as: YourVaultName_YourKeyName_YourKeyVersion.parameters- The requested server key resource state.- Returns:
- the
PollerFluxfor polling of a server 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.
-
beginCreateOrUpdate
com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<ServerKeyInner>,ServerKeyInner> beginCreateOrUpdate(String resourceGroupName, String serverName, String keyName, ServerKeyInner parameters) Creates or updates a server key.- Parameters:
resourceGroupName- The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.serverName- The name of the server.keyName- The name of the server key to be operated on (updated or created). The key name is required to be in the format of 'vault_key_version'. For example, if the keyId is https://YourVaultName.vault.azure.net/keys/YourKeyName/YourKeyVersion, then the server key name should be formatted as: YourVaultName_YourKeyName_YourKeyVersion.parameters- The requested server key resource state.- Returns:
- the
SyncPollerfor polling of a server 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.
-
beginCreateOrUpdate
com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<ServerKeyInner>,ServerKeyInner> beginCreateOrUpdate(String resourceGroupName, String serverName, String keyName, ServerKeyInner parameters, com.azure.core.util.Context context) Creates or updates a server key.- Parameters:
resourceGroupName- The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.serverName- The name of the server.keyName- The name of the server key to be operated on (updated or created). The key name is required to be in the format of 'vault_key_version'. For example, if the keyId is https://YourVaultName.vault.azure.net/keys/YourKeyName/YourKeyVersion, then the server key name should be formatted as: YourVaultName_YourKeyName_YourKeyVersion.parameters- The requested server key resource state.context- The context to associate with this operation.- Returns:
- the
SyncPollerfor polling of a server 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.
-
createOrUpdateAsync
Mono<ServerKeyInner> createOrUpdateAsync(String resourceGroupName, String serverName, String keyName, ServerKeyInner parameters) Creates or updates a server key.- Parameters:
resourceGroupName- The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.serverName- The name of the server.keyName- The name of the server key to be operated on (updated or created). The key name is required to be in the format of 'vault_key_version'. For example, if the keyId is https://YourVaultName.vault.azure.net/keys/YourKeyName/YourKeyVersion, then the server key name should be formatted as: YourVaultName_YourKeyName_YourKeyVersion.parameters- The requested server key resource state.- Returns:
- a server key on successful completion of
Mono. - 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.
-
createOrUpdate
ServerKeyInner createOrUpdate(String resourceGroupName, String serverName, String keyName, ServerKeyInner parameters) Creates or updates a server key.- Parameters:
resourceGroupName- The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.serverName- The name of the server.keyName- The name of the server key to be operated on (updated or created). The key name is required to be in the format of 'vault_key_version'. For example, if the keyId is https://YourVaultName.vault.azure.net/keys/YourKeyName/YourKeyVersion, then the server key name should be formatted as: YourVaultName_YourKeyName_YourKeyVersion.parameters- The requested server key resource state.- Returns:
- a server 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.
-
createOrUpdate
ServerKeyInner createOrUpdate(String resourceGroupName, String serverName, String keyName, ServerKeyInner parameters, com.azure.core.util.Context context) Creates or updates a server key.- Parameters:
resourceGroupName- The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.serverName- The name of the server.keyName- The name of the server key to be operated on (updated or created). The key name is required to be in the format of 'vault_key_version'. For example, if the keyId is https://YourVaultName.vault.azure.net/keys/YourKeyName/YourKeyVersion, then the server key name should be formatted as: YourVaultName_YourKeyName_YourKeyVersion.parameters- The requested server key resource state.context- The context to associate with this operation.- Returns:
- a server 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<Flux<ByteBuffer>>> deleteWithResponseAsync(String resourceGroupName, String serverName, String keyName) Deletes the server key with the given name.- Parameters:
resourceGroupName- The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.serverName- The name of the server.keyName- The name of the server key to be deleted.- Returns:
- the
Responseon successful completion ofMono. - 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.
-
beginDeleteAsync
com.azure.core.util.polling.PollerFlux<com.azure.core.management.polling.PollResult<Void>,Void> beginDeleteAsync(String resourceGroupName, String serverName, String keyName) Deletes the server key with the given name.- Parameters:
resourceGroupName- The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.serverName- The name of the server.keyName- The name of the server key to be deleted.- Returns:
- the
PollerFluxfor polling of long-running operation. - 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.
-
beginDelete
com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Void>,Void> beginDelete(String resourceGroupName, String serverName, String keyName) Deletes the server key with the given name.- Parameters:
resourceGroupName- The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.serverName- The name of the server.keyName- The name of the server key to be deleted.- Returns:
- the
SyncPollerfor polling of long-running operation. - 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.
-
beginDelete
com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Void>,Void> beginDelete(String resourceGroupName, String serverName, String keyName, com.azure.core.util.Context context) Deletes the server key with the given name.- Parameters:
resourceGroupName- The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.serverName- The name of the server.keyName- The name of the server key to be deleted.context- The context to associate with this operation.- Returns:
- the
SyncPollerfor polling of long-running operation. - 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
Deletes the server key with the given name.- Parameters:
resourceGroupName- The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.serverName- The name of the server.keyName- The name of the server key to be deleted.- Returns:
- A
Monothat completes when a successful response is received. - 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
Deletes the server key with the given name.- Parameters:
resourceGroupName- The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.serverName- The name of the server.keyName- The name of the server key to be deleted.- 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 serverName, String keyName, com.azure.core.util.Context context) Deletes the server key with the given name.- Parameters:
resourceGroupName- The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.serverName- The name of the server.keyName- The name of the server key to be deleted.context- The context to associate with this operation.- 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.
-