281 строка
31 KiB
YAML
281 строка
31 KiB
YAML
### YamlMime:JavaType
|
|
uid: "com.microsoft.azure.management.search.SearchServices"
|
|
fullName: "com.microsoft.azure.management.search.SearchServices"
|
|
name: "SearchServices"
|
|
nameWithType: "SearchServices"
|
|
summary: "Entry point to Search service management API in Azure."
|
|
syntax: "public interface **SearchServices**</br> extends <xref href=\"com.microsoft.azure.management.resources.fluentcore.collection.SupportsCreating?alt=com.microsoft.azure.management.resources.fluentcore.collection.SupportsCreating&text=SupportsCreating\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.microsoft.azure.management.search.SearchService.DefinitionStages.Blank?alt=com.microsoft.azure.management.search.SearchService.DefinitionStages.Blank&text=Blank\" data-throw-if-not-resolved=\"False\" />>, <xref href=\"com.microsoft.azure.management.resources.fluentcore.collection.SupportsListing?alt=com.microsoft.azure.management.resources.fluentcore.collection.SupportsListing&text=SupportsListing\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.microsoft.azure.management.search.SearchService?alt=com.microsoft.azure.management.search.SearchService&text=SearchService\" data-throw-if-not-resolved=\"False\" />>, <xref href=\"com.microsoft.azure.management.resources.fluentcore.arm.collection.SupportsListingByResourceGroup?alt=com.microsoft.azure.management.resources.fluentcore.arm.collection.SupportsListingByResourceGroup&text=SupportsListingByResourceGroup\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.microsoft.azure.management.search.SearchService?alt=com.microsoft.azure.management.search.SearchService&text=SearchService\" data-throw-if-not-resolved=\"False\" />>, <xref href=\"com.microsoft.azure.management.resources.fluentcore.arm.collection.SupportsGettingByResourceGroup?alt=com.microsoft.azure.management.resources.fluentcore.arm.collection.SupportsGettingByResourceGroup&text=SupportsGettingByResourceGroup\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.microsoft.azure.management.search.SearchService?alt=com.microsoft.azure.management.search.SearchService&text=SearchService\" data-throw-if-not-resolved=\"False\" />>, <xref href=\"com.microsoft.azure.management.resources.fluentcore.arm.collection.SupportsGettingById?alt=com.microsoft.azure.management.resources.fluentcore.arm.collection.SupportsGettingById&text=SupportsGettingById\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.microsoft.azure.management.search.SearchService?alt=com.microsoft.azure.management.search.SearchService&text=SearchService\" data-throw-if-not-resolved=\"False\" />>, <xref href=\"com.microsoft.azure.management.resources.fluentcore.collection.SupportsDeletingById?alt=com.microsoft.azure.management.resources.fluentcore.collection.SupportsDeletingById&text=SupportsDeletingById\" data-throw-if-not-resolved=\"False\" />, <xref href=\"com.microsoft.azure.management.resources.fluentcore.arm.collection.SupportsDeletingByResourceGroup?alt=com.microsoft.azure.management.resources.fluentcore.arm.collection.SupportsDeletingByResourceGroup&text=SupportsDeletingByResourceGroup\" data-throw-if-not-resolved=\"False\" />, <xref href=\"com.microsoft.azure.management.resources.fluentcore.collection.SupportsBatchCreation?alt=com.microsoft.azure.management.resources.fluentcore.collection.SupportsBatchCreation&text=SupportsBatchCreation\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.microsoft.azure.management.search.SearchService?alt=com.microsoft.azure.management.search.SearchService&text=SearchService\" data-throw-if-not-resolved=\"False\" />>, <xref href=\"com.microsoft.azure.management.resources.fluentcore.arm.models.HasManager?alt=com.microsoft.azure.management.resources.fluentcore.arm.models.HasManager&text=HasManager\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.microsoft.azure.management.search.implementation.SearchServiceManager?alt=com.microsoft.azure.management.search.implementation.SearchServiceManager&text=SearchServiceManager\" data-throw-if-not-resolved=\"False\" />>, <xref href=\"com.microsoft.azure.management.resources.fluentcore.model.HasInner?alt=com.microsoft.azure.management.resources.fluentcore.model.HasInner&text=HasInner\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.microsoft.azure.management.search.implementation.ServicesInner?alt=com.microsoft.azure.management.search.implementation.ServicesInner&text=ServicesInner\" data-throw-if-not-resolved=\"False\" />>"
|
|
methods:
|
|
- uid: "com.microsoft.azure.management.search.SearchServices.checkNameAvailability(java.lang.String)"
|
|
fullName: "com.microsoft.azure.management.search.SearchServices.checkNameAvailability(String name)"
|
|
name: "checkNameAvailability(String name)"
|
|
nameWithType: "SearchServices.checkNameAvailability(String name)"
|
|
summary: "Checks if the specified Search service name is valid and available."
|
|
modifiers:
|
|
- "abstract"
|
|
parameters:
|
|
- description: "the Search service name to check"
|
|
name: "name"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public abstract CheckNameAvailabilityResult checkNameAvailability(String name)"
|
|
desc: "Checks if the specified Search service name is valid and available."
|
|
returns:
|
|
description: "whether the name is available and other info if not"
|
|
type: "<xref href=\"com.microsoft.azure.management.search.CheckNameAvailabilityResult?alt=com.microsoft.azure.management.search.CheckNameAvailabilityResult&text=CheckNameAvailabilityResult\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.management.search.SearchServices.checkNameAvailabilityAsync(java.lang.String)"
|
|
fullName: "com.microsoft.azure.management.search.SearchServices.checkNameAvailabilityAsync(String name)"
|
|
name: "checkNameAvailabilityAsync(String name)"
|
|
nameWithType: "SearchServices.checkNameAvailabilityAsync(String name)"
|
|
summary: "Checks if Search service name is valid and is not in use asynchronously."
|
|
modifiers:
|
|
- "abstract"
|
|
parameters:
|
|
- description: "the Search service name to check"
|
|
name: "name"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public abstract Observable<CheckNameAvailabilityResult> checkNameAvailabilityAsync(String name)"
|
|
desc: "Checks if Search service name is valid and is not in use asynchronously."
|
|
returns:
|
|
description: "a representation of the deferred computation of this call, returning whether the name is available or other info if not"
|
|
type: "<xref href=\"rx.Observable?alt=rx.Observable&text=Observable\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.microsoft.azure.management.search.CheckNameAvailabilityResult?alt=com.microsoft.azure.management.search.CheckNameAvailabilityResult&text=CheckNameAvailabilityResult\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.microsoft.azure.management.search.SearchServices.checkNameAvailabilityAsync(java.lang.String,com.microsoft.rest.ServiceCallback<com.microsoft.azure.management.search.CheckNameAvailabilityResult>)"
|
|
fullName: "com.microsoft.azure.management.search.SearchServices.checkNameAvailabilityAsync(String name, ServiceCallback<CheckNameAvailabilityResult> callback)"
|
|
name: "checkNameAvailabilityAsync(String name, ServiceCallback<CheckNameAvailabilityResult> callback)"
|
|
nameWithType: "SearchServices.checkNameAvailabilityAsync(String name, ServiceCallback<CheckNameAvailabilityResult> callback)"
|
|
summary: "Checks if Search service name is valid and is not in use asynchronously."
|
|
modifiers:
|
|
- "abstract"
|
|
parameters:
|
|
- description: "the Search service name to check"
|
|
name: "name"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "the callback to call on success or failure"
|
|
name: "callback"
|
|
type: "<xref href=\"com.microsoft.rest.ServiceCallback?alt=com.microsoft.rest.ServiceCallback&text=ServiceCallback\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.microsoft.azure.management.search.CheckNameAvailabilityResult?alt=com.microsoft.azure.management.search.CheckNameAvailabilityResult&text=CheckNameAvailabilityResult\" data-throw-if-not-resolved=\"False\" />>"
|
|
syntax: "public abstract ServiceFuture<CheckNameAvailabilityResult> checkNameAvailabilityAsync(String name, ServiceCallback<CheckNameAvailabilityResult> callback)"
|
|
desc: "Checks if Search service name is valid and is not in use asynchronously."
|
|
returns:
|
|
description: "a handle to cancel the request"
|
|
type: "<xref href=\"com.microsoft.rest.ServiceFuture?alt=com.microsoft.rest.ServiceFuture&text=ServiceFuture\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.microsoft.azure.management.search.CheckNameAvailabilityResult?alt=com.microsoft.azure.management.search.CheckNameAvailabilityResult&text=CheckNameAvailabilityResult\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.microsoft.azure.management.search.SearchServices.createQueryKey(java.lang.String,java.lang.String,java.lang.String)"
|
|
fullName: "com.microsoft.azure.management.search.SearchServices.createQueryKey(String resourceGroupName, String searchServiceName, String name)"
|
|
name: "createQueryKey(String resourceGroupName, String searchServiceName, String name)"
|
|
nameWithType: "SearchServices.createQueryKey(String resourceGroupName, String searchServiceName, String name)"
|
|
summary: "Regenerates either the primary or secondary admin API key."
|
|
modifiers:
|
|
- "abstract"
|
|
parameters:
|
|
- description: "The name of the resource group within the current subscription. You can obtain this value from the Azure Resource Manager API or the portal."
|
|
name: "resourceGroupName"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "The name of the Azure Search service associated with the specified resource group."
|
|
name: "searchServiceName"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "The name of the new query API key."
|
|
name: "name"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public abstract QueryKey createQueryKey(String resourceGroupName, String searchServiceName, String name)"
|
|
desc: "Regenerates either the primary or secondary admin API key. You can only regenerate one key at a time."
|
|
returns:
|
|
description: "the QueryKey object if successful."
|
|
type: "<xref href=\"com.microsoft.azure.management.search.QueryKey?alt=com.microsoft.azure.management.search.QueryKey&text=QueryKey\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.management.search.SearchServices.createQueryKeyAsync(java.lang.String,java.lang.String,java.lang.String)"
|
|
fullName: "com.microsoft.azure.management.search.SearchServices.createQueryKeyAsync(String resourceGroupName, String searchServiceName, String name)"
|
|
name: "createQueryKeyAsync(String resourceGroupName, String searchServiceName, String name)"
|
|
nameWithType: "SearchServices.createQueryKeyAsync(String resourceGroupName, String searchServiceName, String name)"
|
|
summary: "Regenerates either the primary or secondary admin API key."
|
|
modifiers:
|
|
- "abstract"
|
|
parameters:
|
|
- description: "The name of the resource group within the current subscription. You can obtain this value from the Azure Resource Manager API or the portal."
|
|
name: "resourceGroupName"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "The name of the Azure Search service associated with the specified resource group."
|
|
name: "searchServiceName"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "The name of the new query API key."
|
|
name: "name"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public abstract Observable<QueryKey> createQueryKeyAsync(String resourceGroupName, String searchServiceName, String name)"
|
|
desc: "Regenerates either the primary or secondary admin API key. You can only regenerate one key at a time."
|
|
returns:
|
|
description: "a representation of the future computation of this call"
|
|
type: "<xref href=\"rx.Observable?alt=rx.Observable&text=Observable\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.microsoft.azure.management.search.QueryKey?alt=com.microsoft.azure.management.search.QueryKey&text=QueryKey\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.microsoft.azure.management.search.SearchServices.deleteQueryKey(java.lang.String,java.lang.String,java.lang.String)"
|
|
fullName: "com.microsoft.azure.management.search.SearchServices.deleteQueryKey(String resourceGroupName, String searchServiceName, String key)"
|
|
name: "deleteQueryKey(String resourceGroupName, String searchServiceName, String key)"
|
|
nameWithType: "SearchServices.deleteQueryKey(String resourceGroupName, String searchServiceName, String key)"
|
|
summary: "Deletes the specified query key."
|
|
modifiers:
|
|
- "abstract"
|
|
parameters:
|
|
- description: "The name of the resource group within the current subscription. You can obtain this value from the Azure Resource Manager API or the portal."
|
|
name: "resourceGroupName"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "The name of the Azure Search service associated with the specified resource group."
|
|
name: "searchServiceName"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "The query key to be deleted. Query keys are identified by value, not by name."
|
|
name: "key"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public abstract void deleteQueryKey(String resourceGroupName, String searchServiceName, String key)"
|
|
desc: "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."
|
|
- uid: "com.microsoft.azure.management.search.SearchServices.deleteQueryKeyAsync(java.lang.String,java.lang.String,java.lang.String)"
|
|
fullName: "com.microsoft.azure.management.search.SearchServices.deleteQueryKeyAsync(String resourceGroupName, String searchServiceName, String key)"
|
|
name: "deleteQueryKeyAsync(String resourceGroupName, String searchServiceName, String key)"
|
|
nameWithType: "SearchServices.deleteQueryKeyAsync(String resourceGroupName, String searchServiceName, String key)"
|
|
summary: "Deletes the specified query key."
|
|
modifiers:
|
|
- "abstract"
|
|
parameters:
|
|
- description: "The name of the resource group within the current subscription. You can obtain this value from the Azure Resource Manager API or the portal."
|
|
name: "resourceGroupName"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "The name of the Azure Search service associated with the specified resource group."
|
|
name: "searchServiceName"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "The query key to be deleted. Query keys are identified by value, not by name."
|
|
name: "key"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public abstract Completable deleteQueryKeyAsync(String resourceGroupName, String searchServiceName, String key)"
|
|
desc: "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."
|
|
returns:
|
|
description: "a representation of the future computation of this call"
|
|
type: "<xref href=\"rx.Completable?alt=rx.Completable&text=Completable\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.management.search.SearchServices.getAdminKeys(java.lang.String,java.lang.String)"
|
|
fullName: "com.microsoft.azure.management.search.SearchServices.getAdminKeys(String resourceGroupName, String searchServiceName)"
|
|
name: "getAdminKeys(String resourceGroupName, String searchServiceName)"
|
|
nameWithType: "SearchServices.getAdminKeys(String resourceGroupName, String searchServiceName)"
|
|
summary: "Gets the primary and secondary admin API keys for the specified Azure Search service."
|
|
modifiers:
|
|
- "abstract"
|
|
parameters:
|
|
- description: "The name of the resource group within the current subscription; you can obtain this value from the Azure Resource Manager API or the portal"
|
|
name: "resourceGroupName"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "The name of the Azure Search service associated with the specified resource group"
|
|
name: "searchServiceName"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public abstract AdminKeys getAdminKeys(String resourceGroupName, String searchServiceName)"
|
|
desc: "Gets the primary and secondary admin API keys for the specified Azure Search service."
|
|
returns:
|
|
description: "the AdminKeys object if successful"
|
|
type: "<xref href=\"com.microsoft.azure.management.search.AdminKeys?alt=com.microsoft.azure.management.search.AdminKeys&text=AdminKeys\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.management.search.SearchServices.getAdminKeysAsync(java.lang.String,java.lang.String)"
|
|
fullName: "com.microsoft.azure.management.search.SearchServices.getAdminKeysAsync(String resourceGroupName, String searchServiceName)"
|
|
name: "getAdminKeysAsync(String resourceGroupName, String searchServiceName)"
|
|
nameWithType: "SearchServices.getAdminKeysAsync(String resourceGroupName, String searchServiceName)"
|
|
summary: "Gets the primary and secondary admin API keys for the specified Azure Search service."
|
|
modifiers:
|
|
- "abstract"
|
|
parameters:
|
|
- description: "The name of the resource group within the current subscription; you can obtain this value from the Azure Resource Manager API or the portal"
|
|
name: "resourceGroupName"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "The name of the Azure Search service associated with the specified resource group"
|
|
name: "searchServiceName"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public abstract Observable<AdminKeys> getAdminKeysAsync(String resourceGroupName, String searchServiceName)"
|
|
desc: "Gets the primary and secondary admin API keys for the specified Azure Search service."
|
|
returns:
|
|
description: "a representation of the future computation of this call"
|
|
type: "<xref href=\"rx.Observable?alt=rx.Observable&text=Observable\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.microsoft.azure.management.search.AdminKeys?alt=com.microsoft.azure.management.search.AdminKeys&text=AdminKeys\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.microsoft.azure.management.search.SearchServices.listQueryKeys(java.lang.String,java.lang.String)"
|
|
fullName: "com.microsoft.azure.management.search.SearchServices.listQueryKeys(String resourceGroupName, String searchServiceName)"
|
|
name: "listQueryKeys(String resourceGroupName, String searchServiceName)"
|
|
nameWithType: "SearchServices.listQueryKeys(String resourceGroupName, String searchServiceName)"
|
|
summary: "Returns the list of query API keys for the given Azure Search service."
|
|
modifiers:
|
|
- "abstract"
|
|
parameters:
|
|
- description: "The name of the resource group within the current subscription; you can obtain this value from the Azure Resource Manager API or the portal"
|
|
name: "resourceGroupName"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "The name of the Azure Search service associated with the specified resource group"
|
|
name: "searchServiceName"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public abstract List<QueryKey> listQueryKeys(String resourceGroupName, String searchServiceName)"
|
|
desc: "Returns the list of query API keys for the given Azure Search service."
|
|
returns:
|
|
description: "the List<QueryKey> object if successful"
|
|
type: "<xref href=\"java.util.List?alt=java.util.List&text=List\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.microsoft.azure.management.search.QueryKey?alt=com.microsoft.azure.management.search.QueryKey&text=QueryKey\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.microsoft.azure.management.search.SearchServices.listQueryKeysAsync(java.lang.String,java.lang.String)"
|
|
fullName: "com.microsoft.azure.management.search.SearchServices.listQueryKeysAsync(String resourceGroupName, String searchServiceName)"
|
|
name: "listQueryKeysAsync(String resourceGroupName, String searchServiceName)"
|
|
nameWithType: "SearchServices.listQueryKeysAsync(String resourceGroupName, String searchServiceName)"
|
|
summary: "Returns the list of query API keys for the given Azure Search service."
|
|
modifiers:
|
|
- "abstract"
|
|
parameters:
|
|
- description: "The name of the resource group within the current subscription. You can obtain this value from the Azure Resource Manager API or the portal."
|
|
name: "resourceGroupName"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "The name of the Azure Search service associated with the specified resource group."
|
|
name: "searchServiceName"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public abstract Observable<QueryKey> listQueryKeysAsync(String resourceGroupName, String searchServiceName)"
|
|
desc: "Returns the list of query API keys for the given Azure Search service."
|
|
returns:
|
|
description: "a representation of the future computation of this call"
|
|
type: "<xref href=\"rx.Observable?alt=rx.Observable&text=Observable\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.microsoft.azure.management.search.QueryKey?alt=com.microsoft.azure.management.search.QueryKey&text=QueryKey\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.microsoft.azure.management.search.SearchServices.regenerateAdminKeys(java.lang.String,java.lang.String,com.microsoft.azure.management.search.AdminKeyKind)"
|
|
fullName: "com.microsoft.azure.management.search.SearchServices.regenerateAdminKeys(String resourceGroupName, String searchServiceName, AdminKeyKind keyKind)"
|
|
name: "regenerateAdminKeys(String resourceGroupName, String searchServiceName, AdminKeyKind keyKind)"
|
|
nameWithType: "SearchServices.regenerateAdminKeys(String resourceGroupName, String searchServiceName, AdminKeyKind keyKind)"
|
|
summary: "Regenerates either the primary or secondary admin API key."
|
|
modifiers:
|
|
- "abstract"
|
|
parameters:
|
|
- description: "The name of the resource group within the current subscription. You can obtain this value from the Azure Resource Manager API or the portal."
|
|
name: "resourceGroupName"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "The name of the Azure Search service associated with the specified resource group."
|
|
name: "searchServiceName"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "Specifies which key to regenerate. Valid values include 'primary' and 'secondary'.\n Possible values include: 'primary', 'secondary'"
|
|
name: "keyKind"
|
|
type: "<xref href=\"com.microsoft.azure.management.search.AdminKeyKind?alt=com.microsoft.azure.management.search.AdminKeyKind&text=AdminKeyKind\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public abstract AdminKeys regenerateAdminKeys(String resourceGroupName, String searchServiceName, AdminKeyKind keyKind)"
|
|
desc: "Regenerates either the primary or secondary admin API key. You can only regenerate one key at a time."
|
|
returns:
|
|
description: "the AdminKeys object if successful."
|
|
type: "<xref href=\"com.microsoft.azure.management.search.AdminKeys?alt=com.microsoft.azure.management.search.AdminKeys&text=AdminKeys\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.management.search.SearchServices.regenerateAdminKeysAsync(java.lang.String,java.lang.String,com.microsoft.azure.management.search.AdminKeyKind)"
|
|
fullName: "com.microsoft.azure.management.search.SearchServices.regenerateAdminKeysAsync(String resourceGroupName, String searchServiceName, AdminKeyKind keyKind)"
|
|
name: "regenerateAdminKeysAsync(String resourceGroupName, String searchServiceName, AdminKeyKind keyKind)"
|
|
nameWithType: "SearchServices.regenerateAdminKeysAsync(String resourceGroupName, String searchServiceName, AdminKeyKind keyKind)"
|
|
summary: "Regenerates either the primary or secondary admin API key."
|
|
modifiers:
|
|
- "abstract"
|
|
parameters:
|
|
- description: "The name of the resource group within the current subscription. You can obtain this value from the Azure Resource Manager API or the portal."
|
|
name: "resourceGroupName"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "The name of the Azure Search service associated with the specified resource group."
|
|
name: "searchServiceName"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "Specifies which key to regenerate. Valid values include 'primary' and 'secondary'.\n Possible values include: 'primary', 'secondary'"
|
|
name: "keyKind"
|
|
type: "<xref href=\"com.microsoft.azure.management.search.AdminKeyKind?alt=com.microsoft.azure.management.search.AdminKeyKind&text=AdminKeyKind\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public abstract Observable<AdminKeys> regenerateAdminKeysAsync(String resourceGroupName, String searchServiceName, AdminKeyKind keyKind)"
|
|
desc: "Regenerates either the primary or secondary admin API key. You can only regenerate one key at a time."
|
|
returns:
|
|
description: "the observable to the AdminKeyResultInner object"
|
|
type: "<xref href=\"rx.Observable?alt=rx.Observable&text=Observable\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.microsoft.azure.management.search.AdminKeys?alt=com.microsoft.azure.management.search.AdminKeys&text=AdminKeys\" data-throw-if-not-resolved=\"False\" />>"
|
|
type: "interface"
|
|
desc: "Entry point to Search service management API in Azure."
|
|
implements:
|
|
- "<xref href=\"com.microsoft.azure.management.resources.fluentcore.arm.collection.SupportsDeletingByResourceGroup?alt=com.microsoft.azure.management.resources.fluentcore.arm.collection.SupportsDeletingByResourceGroup&text=SupportsDeletingByResourceGroup\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.microsoft.azure.management.resources.fluentcore.arm.collection.SupportsGettingById?alt=com.microsoft.azure.management.resources.fluentcore.arm.collection.SupportsGettingById&text=SupportsGettingById\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.microsoft.azure.management.search.SearchService?alt=com.microsoft.azure.management.search.SearchService&text=SearchService\" data-throw-if-not-resolved=\"False\" />>"
|
|
- "<xref href=\"com.microsoft.azure.management.resources.fluentcore.arm.collection.SupportsGettingByResourceGroup?alt=com.microsoft.azure.management.resources.fluentcore.arm.collection.SupportsGettingByResourceGroup&text=SupportsGettingByResourceGroup\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.microsoft.azure.management.search.SearchService?alt=com.microsoft.azure.management.search.SearchService&text=SearchService\" data-throw-if-not-resolved=\"False\" />>"
|
|
- "<xref href=\"com.microsoft.azure.management.resources.fluentcore.arm.collection.SupportsListingByResourceGroup?alt=com.microsoft.azure.management.resources.fluentcore.arm.collection.SupportsListingByResourceGroup&text=SupportsListingByResourceGroup\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.microsoft.azure.management.search.SearchService?alt=com.microsoft.azure.management.search.SearchService&text=SearchService\" data-throw-if-not-resolved=\"False\" />>"
|
|
- "<xref href=\"com.microsoft.azure.management.resources.fluentcore.arm.models.HasManager?alt=com.microsoft.azure.management.resources.fluentcore.arm.models.HasManager&text=HasManager\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.microsoft.azure.management.search.implementation.SearchServiceManager?alt=com.microsoft.azure.management.search.implementation.SearchServiceManager&text=SearchServiceManager\" data-throw-if-not-resolved=\"False\" />>"
|
|
- "<xref href=\"com.microsoft.azure.management.resources.fluentcore.collection.SupportsBatchCreation?alt=com.microsoft.azure.management.resources.fluentcore.collection.SupportsBatchCreation&text=SupportsBatchCreation\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.microsoft.azure.management.search.SearchService?alt=com.microsoft.azure.management.search.SearchService&text=SearchService\" data-throw-if-not-resolved=\"False\" />>"
|
|
- "<xref href=\"com.microsoft.azure.management.resources.fluentcore.collection.SupportsCreating?alt=com.microsoft.azure.management.resources.fluentcore.collection.SupportsCreating&text=SupportsCreating\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.microsoft.azure.management.search.SearchService.DefinitionStages.Blank?alt=com.microsoft.azure.management.search.SearchService.DefinitionStages.Blank&text=Blank\" data-throw-if-not-resolved=\"False\" />>"
|
|
- "<xref href=\"com.microsoft.azure.management.resources.fluentcore.collection.SupportsDeletingById?alt=com.microsoft.azure.management.resources.fluentcore.collection.SupportsDeletingById&text=SupportsDeletingById\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.microsoft.azure.management.resources.fluentcore.collection.SupportsListing?alt=com.microsoft.azure.management.resources.fluentcore.collection.SupportsListing&text=SupportsListing\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.microsoft.azure.management.search.SearchService?alt=com.microsoft.azure.management.search.SearchService&text=SearchService\" data-throw-if-not-resolved=\"False\" />>"
|
|
- "<xref href=\"com.microsoft.azure.management.resources.fluentcore.model.HasInner?alt=com.microsoft.azure.management.resources.fluentcore.model.HasInner&text=HasInner\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.microsoft.azure.management.search.implementation.ServicesInner?alt=com.microsoft.azure.management.search.implementation.ServicesInner&text=ServicesInner\" data-throw-if-not-resolved=\"False\" />>"
|
|
metadata: {}
|
|
package: "com.microsoft.azure.management.search"
|
|
artifact: com.microsoft.azure:azure-mgmt-search:1.41.4
|