Package com.azure.resourcemanager.search.fluent

Interface AdminKeysClient

public interface AdminKeysClient

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

Method Summary

Modifier and Type	Method	Description
AdminKeyResultInner	get(String resourceGroupName, String searchServiceName)	Gets the primary and secondary admin API keys for the specified Azure Cognitive Search service.
Mono<AdminKeyResultInner>	getAsync(String resourceGroupName, String searchServiceName)	Gets the primary and secondary admin API keys for the specified Azure Cognitive Search service.
Mono<AdminKeyResultInner>	getAsync(String resourceGroupName, String searchServiceName, UUID clientRequestId)	Gets the primary and secondary admin API keys for the specified Azure Cognitive Search service.
com.azure.core.http.rest.Response<AdminKeyResultInner>	getWithResponse(String resourceGroupName, String searchServiceName, UUID clientRequestId, com.azure.core.util.Context context)	Gets the primary and secondary admin API keys for the specified Azure Cognitive Search service.
Mono<com.azure.core.http.rest.Response<AdminKeyResultInner>>	getWithResponseAsync(String resourceGroupName, String searchServiceName, UUID clientRequestId)	Gets the primary and secondary admin API keys for the specified Azure Cognitive Search service.
AdminKeyResultInner	regenerate(String resourceGroupName, String searchServiceName, AdminKeyKind keyKind)	Regenerates either the primary or secondary admin API key.
Mono<AdminKeyResultInner>	regenerateAsync(String resourceGroupName, String searchServiceName, AdminKeyKind keyKind)	Regenerates either the primary or secondary admin API key.
Mono<AdminKeyResultInner>	regenerateAsync(String resourceGroupName, String searchServiceName, AdminKeyKind keyKind, UUID clientRequestId)	Regenerates either the primary or secondary admin API key.
com.azure.core.http.rest.Response<AdminKeyResultInner>	regenerateWithResponse(String resourceGroupName, String searchServiceName, AdminKeyKind keyKind, UUID clientRequestId, com.azure.core.util.Context context)	Regenerates either the primary or secondary admin API key.
Mono<com.azure.core.http.rest.Response<AdminKeyResultInner>>	regenerateWithResponseAsync(String resourceGroupName, String searchServiceName, AdminKeyKind keyKind, UUID clientRequestId)	Regenerates either the primary or secondary admin API key.

Method Detail

getWithResponseAsync

Mono<com.azure.core.http.rest.Response<AdminKeyResultInner>> getWithResponseAsync(String resourceGroupName,
                                                                                  String searchServiceName,
                                                                                  UUID clientRequestId)

Gets the primary and secondary admin API keys for the specified Azure Cognitive 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 Azure Cognitive 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 Azure Cognitive Search service.

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

Mono<AdminKeyResultInner> getAsync(String resourceGroupName,
                                   String searchServiceName,
                                   UUID clientRequestId)

Gets the primary and secondary admin API keys for the specified Azure Cognitive 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 Azure Cognitive 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 Azure Cognitive Search service.

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

Mono<AdminKeyResultInner> getAsync(String resourceGroupName,
                                   String searchServiceName)

Gets the primary and secondary admin API keys for the specified Azure Cognitive 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 Azure Cognitive Search service associated with the specified resource group.

Returns:

the primary and secondary admin API keys for the specified Azure Cognitive Search service.

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

AdminKeyResultInner get(String resourceGroupName,
                        String searchServiceName)

Gets the primary and secondary admin API keys for the specified Azure Cognitive 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 Azure Cognitive Search service associated with the specified resource group.

Returns:

the primary and secondary admin API keys for the specified Azure Cognitive Search service.

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<AdminKeyResultInner> getWithResponse(String resourceGroupName,
                                                                       String searchServiceName,
                                                                       UUID clientRequestId,
                                                                       com.azure.core.util.Context context)

Gets the primary and secondary admin API keys for the specified Azure Cognitive 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 Azure Cognitive 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 Azure Cognitive Search service.

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.

regenerateWithResponseAsync

Mono<com.azure.core.http.rest.Response<AdminKeyResultInner>> 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 Azure Cognitive 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 Azure Cognitive Search service.

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.

regenerateAsync

Mono<AdminKeyResultInner> regenerateAsync(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 Azure Cognitive 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 Azure Cognitive Search service.

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.

regenerateAsync

Mono<AdminKeyResultInner> 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 Azure Cognitive 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 Azure Cognitive Search service.

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.

regenerate

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 Azure Cognitive 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 Azure Cognitive Search service.

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.

regenerateWithResponse

com.azure.core.http.rest.Response<AdminKeyResultInner> regenerateWithResponse(String resourceGroupName,
                                                                              String searchServiceName,
                                                                              AdminKeyKind keyKind,
                                                                              UUID clientRequestId,
                                                                              com.azure.core.util.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 Azure Cognitive 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 Azure Cognitive Search service.

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.