Share via

AdminKeysClient Interface

  • Reference
Package:
com.azure.resourcemanager.search.fluent
Maven Artifact:
com.azure.resourcemanager:azure-resourcemanager-search:2.44.0

public interface AdminKeysClient

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

Method Summary

Modifier and Type Method and Description
abstract AdminKeyResultInner get(String resourceGroupName, String searchServiceName)

Gets the primary and secondary admin API keys for the specified search service.
abstract Mono<AdminKeyResultInner> getAsync(String resourceGroupName, String searchServiceName)

Gets the primary and secondary admin API keys for the specified search service.
abstract Response<AdminKeyResultInner> getWithResponse(String resourceGroupName, String searchServiceName, UUID clientRequestId, Context context)

Gets the primary and secondary admin API keys for the specified search service.
abstract Mono<Response<AdminKeyResultInner>> getWithResponseAsync(String resourceGroupName, String searchServiceName, UUID clientRequestId)

Gets the primary and secondary admin API keys for the specified search service.
abstract AdminKeyResultInner regenerate(String resourceGroupName, String searchServiceName, AdminKeyKind keyKind)

Regenerates either the primary or secondary admin API key.
abstract Mono<AdminKeyResultInner> regenerateAsync(String resourceGroupName, String searchServiceName, AdminKeyKind keyKind)

Regenerates either the primary or secondary admin API key.
abstract Response<AdminKeyResultInner> regenerateWithResponse(String resourceGroupName, String searchServiceName, AdminKeyKind keyKind, UUID clientRequestId, Context context)

Regenerates either the primary or secondary admin API key.
abstract Mono<Response<AdminKeyResultInner>> regenerateWithResponseAsync(String resourceGroupName, String searchServiceName, AdminKeyKind keyKind, UUID clientRequestId)

Regenerates either the primary or secondary admin API key.

Method Details

get

public abstract AdminKeyResultInner get(String resourceGroupName, String searchServiceName)

Gets the primary and secondary admin API keys for the specified search service.

Parameters:

resourceGroupName - The name of the resource group within the current subscription. You can obtain this value from the Azure Resource Manager API or the portal.
searchServiceName - The name of the search service associated with the specified resource group.

Returns:

the primary and secondary admin API keys for the specified search service.

getAsync

public abstract Mono getAsync(String resourceGroupName, String searchServiceName)

Gets the primary and secondary admin API keys for the specified search service.

Parameters:

resourceGroupName - The name of the resource group within the current subscription. You can obtain this value from the Azure Resource Manager API or the portal.
searchServiceName - The name of the search service associated with the specified resource group.

Returns:

the primary and secondary admin API keys for the specified search service on successful completion of Mono.

getWithResponse

public abstract Response getWithResponse(String resourceGroupName, String searchServiceName, UUID clientRequestId, Context context)

Gets the primary and secondary admin API keys for the specified search service.

Parameters:

resourceGroupName - The name of the resource group within the current subscription. You can obtain this value from the Azure Resource Manager API or the portal.
searchServiceName - The name of the search service associated with the specified resource group.
clientRequestId - A client-generated GUID value that identifies this request. If specified, this will be included in response information as a way to track the request.
context - The context to associate with this operation.

Returns:

the primary and secondary admin API keys for the specified search service along with Response<T>.

getWithResponseAsync

public abstract Mono> getWithResponseAsync(String resourceGroupName, String searchServiceName, UUID clientRequestId)

Gets the primary and secondary admin API keys for the specified search service.

Parameters:

resourceGroupName - The name of the resource group within the current subscription. You can obtain this value from the Azure Resource Manager API or the portal.
searchServiceName - The name of the search service associated with the specified resource group.
clientRequestId - A client-generated GUID value that identifies this request. If specified, this will be included in response information as a way to track the request.

Returns:

the primary and secondary admin API keys for the specified search service along with Response<T> on successful completion of Mono.

regenerate

public abstract AdminKeyResultInner regenerate(String resourceGroupName, String searchServiceName, AdminKeyKind keyKind)

Regenerates either the primary or secondary admin API key. You can only regenerate one key at a time.

Parameters:

resourceGroupName - The name of the resource group within the current subscription. You can obtain this value from the Azure Resource Manager API or the portal.
searchServiceName - The name of the search service associated with the specified resource group.
keyKind - Specifies which key to regenerate. Valid values include 'primary' and 'secondary'.

Returns:

response containing the primary and secondary admin API keys for a given search service.

regenerateAsync

public abstract Mono regenerateAsync(String resourceGroupName, String searchServiceName, AdminKeyKind keyKind)

Regenerates either the primary or secondary admin API key. You can only regenerate one key at a time.

Parameters:

resourceGroupName - The name of the resource group within the current subscription. You can obtain this value from the Azure Resource Manager API or the portal.
searchServiceName - The name of the search service associated with the specified resource group.
keyKind - Specifies which key to regenerate. Valid values include 'primary' and 'secondary'.

Returns:

response containing the primary and secondary admin API keys for a given search service on successful completion of Mono.

regenerateWithResponse

public abstract Response regenerateWithResponse(String resourceGroupName, String searchServiceName, AdminKeyKind keyKind, UUID clientRequestId, Context context)

Regenerates either the primary or secondary admin API key. You can only regenerate one key at a time.

Parameters:

resourceGroupName - The name of the resource group within the current subscription. You can obtain this value from the Azure Resource Manager API or the portal.
searchServiceName - The name of the search service associated with the specified resource group.
keyKind - Specifies which key to regenerate. Valid values include 'primary' and 'secondary'.
clientRequestId - A client-generated GUID value that identifies this request. If specified, this will be included in response information as a way to track the request.
context - The context to associate with this operation.

Returns:

response containing the primary and secondary admin API keys for a given search service along with Response<T>.

regenerateWithResponseAsync

public abstract Mono> regenerateWithResponseAsync(String resourceGroupName, String searchServiceName, AdminKeyKind keyKind, UUID clientRequestId)

Regenerates either the primary or secondary admin API key. You can only regenerate one key at a time.

Parameters:

resourceGroupName - The name of the resource group within the current subscription. You can obtain this value from the Azure Resource Manager API or the portal.
searchServiceName - The name of the search service associated with the specified resource group.
keyKind - Specifies which key to regenerate. Valid values include 'primary' and 'secondary'.
clientRequestId - A client-generated GUID value that identifies this request. If specified, this will be included in response information as a way to track the request.

Returns:

response containing the primary and secondary admin API keys for a given search service along with Response<T> on successful completion of Mono.

Applies to