Regenerates either the primary or secondary admin API key.
Method Details
checkNameAvailability
public abstract CheckNameAvailabilityResult checkNameAvailability(String name)
Checks if the specified Search service name is valid and available.
Parameters:
name
- the Search service name to check
Returns:
whether the name is available and other info if not
checkNameAvailabilityAsync
public abstract Observable checkNameAvailabilityAsync(String name)
Checks if Search service name is valid and is not in use asynchronously.
Parameters:
name
- the Search service name to check
Returns:
a representation of the deferred computation of this call, returning whether the name is available or other info if not
checkNameAvailabilityAsync
public abstract ServiceFuture checkNameAvailabilityAsync(String name, ServiceCallback callback)
Checks if Search service name is valid and is not in use asynchronously.
Parameters:
name
- the Search service name to check
callback
- the callback to call on success or failure
Returns:
a handle to cancel the request
createQueryKey
public abstract QueryKey createQueryKey(String resourceGroupName, String searchServiceName, String name)
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 Search service associated with the specified resource group.
name
- The name of the new query API key.
Returns:
the QueryKey object if successful.
createQueryKeyAsync
public abstract Observable createQueryKeyAsync(String resourceGroupName, String searchServiceName, String name)
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 Search service associated with the specified resource group.
name
- The name of the new query API key.
Returns:
a representation of the future computation of this call
deleteQueryKey
public abstract void deleteQueryKey(String resourceGroupName, String searchServiceName, String key)
Deletes the specified query key. Unlike admin keys, query keys are not regenerated. The process for regenerating a query key is to delete and then recreate it.
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 Search service associated with the specified resource group.
key
- The query key to be deleted. Query keys are identified by value, not by name.
deleteQueryKeyAsync
public abstract Completable deleteQueryKeyAsync(String resourceGroupName, String searchServiceName, String key)
Deletes the specified query key. Unlike admin keys, query keys are not regenerated. The process for regenerating a query key is to delete and then recreate it.
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 Search service associated with the specified resource group.
key
- The query key to be deleted. Query keys are identified by value, not by name.
Returns:
a representation of the future computation of this call
getAdminKeys
public abstract AdminKeys getAdminKeys(String resourceGroupName, String searchServiceName)
Gets the primary and secondary admin API keys for the specified Azure 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 Search service associated with the specified resource group
Returns:
the AdminKeys object if successful
getAdminKeysAsync
public abstract Observable getAdminKeysAsync(String resourceGroupName, String searchServiceName)
Gets the primary and secondary admin API keys for the specified Azure 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 Search service associated with the specified resource group
Returns:
a representation of the future computation of this call
listQueryKeys
public abstract List listQueryKeys(String resourceGroupName, String searchServiceName)
Returns the list of query API keys for the given Azure 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 Search service associated with the specified resource group
Returns:
the List<QueryKey> object if successful
listQueryKeysAsync
public abstract Observable listQueryKeysAsync(String resourceGroupName, String searchServiceName)
Returns the list of query API keys for the given Azure 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 Search service associated with the specified resource group.
Returns:
a representation of the future computation of this call
regenerateAdminKeys
public abstract AdminKeys regenerateAdminKeys(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 Search service associated with the specified resource group.
keyKind
- Specifies which key to regenerate. Valid values include 'primary' and 'secondary'.
Possible values include: 'primary', 'secondary'
Returns:
the AdminKeys object if successful.
regenerateAdminKeysAsync
public abstract Observable regenerateAdminKeysAsync(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 Search service associated with the specified resource group.
keyKind
- Specifies which key to regenerate. Valid values include 'primary' and 'secondary'.
Possible values include: 'primary', 'secondary'
