235 строки
19 KiB
YAML
235 строки
19 KiB
YAML
### YamlMime:JavaType
|
|
uid: "com.microsoft.azure.management.search.SearchService"
|
|
fullName: "com.microsoft.azure.management.search.SearchService"
|
|
name: "SearchService"
|
|
nameWithType: "SearchService"
|
|
summary: "An immutable client-side representation of an Azure registry."
|
|
syntax: "public interface **SearchService**</br> extends <xref href=\"com.microsoft.azure.management.resources.fluentcore.arm.models.GroupableResource?alt=com.microsoft.azure.management.resources.fluentcore.arm.models.GroupableResource&text=GroupableResource\" 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.search.implementation.SearchServiceInner?alt=com.microsoft.azure.management.search.implementation.SearchServiceInner&text=SearchServiceInner\" data-throw-if-not-resolved=\"False\" />>, <xref href=\"com.microsoft.azure.management.resources.fluentcore.model.Refreshable?alt=com.microsoft.azure.management.resources.fluentcore.model.Refreshable&text=Refreshable\" 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.Updatable?alt=com.microsoft.azure.management.resources.fluentcore.model.Updatable&text=Updatable\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.microsoft.azure.management.search.SearchService.Update?alt=com.microsoft.azure.management.search.SearchService.Update&text=Update\" data-throw-if-not-resolved=\"False\" />>"
|
|
methods:
|
|
- uid: "com.microsoft.azure.management.search.SearchService.createQueryKey(java.lang.String)"
|
|
fullName: "com.microsoft.azure.management.search.SearchService.createQueryKey(String name)"
|
|
name: "createQueryKey(String name)"
|
|
nameWithType: "SearchService.createQueryKey(String name)"
|
|
summary: "Regenerates either the primary or secondary admin API key."
|
|
modifiers:
|
|
- "abstract"
|
|
parameters:
|
|
- 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 name)"
|
|
desc: "Regenerates either the primary or secondary admin API key.\n\nYou 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.SearchService.createQueryKeyAsync(java.lang.String)"
|
|
fullName: "com.microsoft.azure.management.search.SearchService.createQueryKeyAsync(String name)"
|
|
name: "createQueryKeyAsync(String name)"
|
|
nameWithType: "SearchService.createQueryKeyAsync(String name)"
|
|
summary: "Regenerates either the primary or secondary admin API key."
|
|
modifiers:
|
|
- "abstract"
|
|
parameters:
|
|
- 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 name)"
|
|
desc: "Regenerates either the primary or secondary admin API key.\n\nYou 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.SearchService.deleteQueryKey(java.lang.String)"
|
|
fullName: "com.microsoft.azure.management.search.SearchService.deleteQueryKey(String key)"
|
|
name: "deleteQueryKey(String key)"
|
|
nameWithType: "SearchService.deleteQueryKey(String key)"
|
|
summary: "Deletes the specified query key."
|
|
modifiers:
|
|
- "abstract"
|
|
parameters:
|
|
- 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 key)"
|
|
desc: "Deletes the specified query key.\n\nUnlike 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.SearchService.deleteQueryKeyAsync(java.lang.String)"
|
|
fullName: "com.microsoft.azure.management.search.SearchService.deleteQueryKeyAsync(String key)"
|
|
name: "deleteQueryKeyAsync(String key)"
|
|
nameWithType: "SearchService.deleteQueryKeyAsync(String key)"
|
|
summary: "Deletes the specified query key."
|
|
modifiers:
|
|
- "abstract"
|
|
parameters:
|
|
- 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 key)"
|
|
desc: "Deletes the specified query key.\n\nUnlike 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.SearchService.getAdminKeys()"
|
|
fullName: "com.microsoft.azure.management.search.SearchService.getAdminKeys()"
|
|
name: "getAdminKeys()"
|
|
nameWithType: "SearchService.getAdminKeys()"
|
|
summary: "The primary and secondary admin API keys for the specified Azure Search service."
|
|
modifiers:
|
|
- "abstract"
|
|
syntax: "public abstract AdminKeys getAdminKeys()"
|
|
desc: "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.SearchService.getAdminKeysAsync()"
|
|
fullName: "com.microsoft.azure.management.search.SearchService.getAdminKeysAsync()"
|
|
name: "getAdminKeysAsync()"
|
|
nameWithType: "SearchService.getAdminKeysAsync()"
|
|
summary: "The primary and secondary admin API keys for the specified Azure Search service."
|
|
modifiers:
|
|
- "abstract"
|
|
syntax: "public abstract Observable<AdminKeys> getAdminKeysAsync()"
|
|
desc: "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.SearchService.hostingMode()"
|
|
fullName: "com.microsoft.azure.management.search.SearchService.hostingMode()"
|
|
name: "hostingMode()"
|
|
nameWithType: "SearchService.hostingMode()"
|
|
summary: "The hosting mode value."
|
|
modifiers:
|
|
- "abstract"
|
|
syntax: "public abstract HostingMode hostingMode()"
|
|
desc: "The hosting mode value.\n\nApplicable only for the standard3 SKU. You can set this property to enable up to 3 high density partitions that allow up to 1000 indexes, which is much higher than the maximum indexes allowed for any other SKU. For the standard3 SKU, the value is either 'default' or 'highDensity'. For all other SKUs, this value must be 'default'."
|
|
returns:
|
|
description: "the hosting mode value."
|
|
type: "<xref href=\"com.microsoft.azure.management.search.HostingMode?alt=com.microsoft.azure.management.search.HostingMode&text=HostingMode\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.management.search.SearchService.listQueryKeys()"
|
|
fullName: "com.microsoft.azure.management.search.SearchService.listQueryKeys()"
|
|
name: "listQueryKeys()"
|
|
nameWithType: "SearchService.listQueryKeys()"
|
|
summary: "Returns the list of query API keys for the given Azure Search service."
|
|
modifiers:
|
|
- "abstract"
|
|
syntax: "public abstract List<QueryKey> listQueryKeys()"
|
|
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.SearchService.listQueryKeysAsync()"
|
|
fullName: "com.microsoft.azure.management.search.SearchService.listQueryKeysAsync()"
|
|
name: "listQueryKeysAsync()"
|
|
nameWithType: "SearchService.listQueryKeysAsync()"
|
|
summary: "Returns the list of query API keys for the given Azure Search service."
|
|
modifiers:
|
|
- "abstract"
|
|
syntax: "public abstract Observable<QueryKey> listQueryKeysAsync()"
|
|
desc: "Returns the list of query API keys for the given Azure Search service."
|
|
returns:
|
|
description: "the observable to the List<QueryKey> object"
|
|
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.SearchService.partitionCount()"
|
|
fullName: "com.microsoft.azure.management.search.SearchService.partitionCount()"
|
|
name: "partitionCount()"
|
|
nameWithType: "SearchService.partitionCount()"
|
|
modifiers:
|
|
- "abstract"
|
|
syntax: "public abstract int partitionCount()"
|
|
returns:
|
|
description: "the number of partitions used by the service"
|
|
type: "<xref href=\"int?alt=int&text=int\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.management.search.SearchService.provisioningState()"
|
|
fullName: "com.microsoft.azure.management.search.SearchService.provisioningState()"
|
|
name: "provisioningState()"
|
|
nameWithType: "SearchService.provisioningState()"
|
|
summary: "The state of the last provisioning operation performed on the Search service."
|
|
modifiers:
|
|
- "abstract"
|
|
syntax: "public abstract ProvisioningState provisioningState()"
|
|
desc: "The state of the last provisioning operation performed on the Search service.\n\nProvisioning is an intermediate state that occurs while service capacity is being established. After capacity is set up, provisioningState changes to either 'succeeded' or 'failed'. Client applications can poll provisioning status (the recommended polling interval is from 30 seconds to one minute) by using the Get Search Service operation to see when an operation is completed. If you are using the free service, this value tends to come back as 'succeeded' directly in the call to Create Search service. This is because the free service uses capacity that is already set up."
|
|
returns:
|
|
description: "the provisioning state of the resource"
|
|
type: "<xref href=\"com.microsoft.azure.management.search.ProvisioningState?alt=com.microsoft.azure.management.search.ProvisioningState&text=ProvisioningState\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.management.search.SearchService.regenerateAdminKeys(com.microsoft.azure.management.search.AdminKeyKind)"
|
|
fullName: "com.microsoft.azure.management.search.SearchService.regenerateAdminKeys(AdminKeyKind keyKind)"
|
|
name: "regenerateAdminKeys(AdminKeyKind keyKind)"
|
|
nameWithType: "SearchService.regenerateAdminKeys(AdminKeyKind keyKind)"
|
|
summary: "Regenerates either the primary or secondary admin API key."
|
|
modifiers:
|
|
- "abstract"
|
|
parameters:
|
|
- description: "specifies which key to regenerate"
|
|
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(AdminKeyKind keyKind)"
|
|
desc: "Regenerates either the primary or secondary admin API key.\n\nYou 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.SearchService.regenerateAdminKeysAsync(com.microsoft.azure.management.search.AdminKeyKind)"
|
|
fullName: "com.microsoft.azure.management.search.SearchService.regenerateAdminKeysAsync(AdminKeyKind keyKind)"
|
|
name: "regenerateAdminKeysAsync(AdminKeyKind keyKind)"
|
|
nameWithType: "SearchService.regenerateAdminKeysAsync(AdminKeyKind keyKind)"
|
|
summary: "Regenerates either the primary or secondary admin API key."
|
|
modifiers:
|
|
- "abstract"
|
|
parameters:
|
|
- description: "Specifies which key to regenerate"
|
|
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(AdminKeyKind keyKind)"
|
|
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.AdminKeys?alt=com.microsoft.azure.management.search.AdminKeys&text=AdminKeys\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.microsoft.azure.management.search.SearchService.replicaCount()"
|
|
fullName: "com.microsoft.azure.management.search.SearchService.replicaCount()"
|
|
name: "replicaCount()"
|
|
nameWithType: "SearchService.replicaCount()"
|
|
modifiers:
|
|
- "abstract"
|
|
syntax: "public abstract int replicaCount()"
|
|
returns:
|
|
description: "the number of replicas used by the service"
|
|
type: "<xref href=\"int?alt=int&text=int\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.management.search.SearchService.sku()"
|
|
fullName: "com.microsoft.azure.management.search.SearchService.sku()"
|
|
name: "sku()"
|
|
nameWithType: "SearchService.sku()"
|
|
modifiers:
|
|
- "abstract"
|
|
syntax: "public abstract Sku sku()"
|
|
returns:
|
|
description: "the SKU type of the service"
|
|
type: "<xref href=\"com.microsoft.azure.management.search.Sku?alt=com.microsoft.azure.management.search.Sku&text=Sku\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.management.search.SearchService.status()"
|
|
fullName: "com.microsoft.azure.management.search.SearchService.status()"
|
|
name: "status()"
|
|
nameWithType: "SearchService.status()"
|
|
summary: "The status of the Search service."
|
|
modifiers:
|
|
- "abstract"
|
|
syntax: "public abstract SearchServiceStatus status()"
|
|
desc: "The status of the Search service.\n\nPossible values include: 'running': the Search service is running and no provisioning operations are underway. 'provisioning': the Search service is being provisioned or scaled up or down. 'deleting': the Search service is being deleted. 'degraded': the Search service is degraded. This can occur when the underlying search units are not healthy. The Search service is most likely operational, but performance might be slow and some requests might be dropped. 'disabled': the Search service is disabled. In this state, the service will reject all API requests. 'error': the Search service is in an error state. If your service is in the degraded, disabled, or error states, it means the Azure Search team is actively investigating the underlying issue. Dedicated services in these states are still chargeable based on the number of search units provisioned."
|
|
returns:
|
|
description: "the status of the service"
|
|
type: "<xref href=\"com.microsoft.azure.management.search.SearchServiceStatus?alt=com.microsoft.azure.management.search.SearchServiceStatus&text=SearchServiceStatus\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.management.search.SearchService.statusDetails()"
|
|
fullName: "com.microsoft.azure.management.search.SearchService.statusDetails()"
|
|
name: "statusDetails()"
|
|
nameWithType: "SearchService.statusDetails()"
|
|
modifiers:
|
|
- "abstract"
|
|
syntax: "public abstract String statusDetails()"
|
|
returns:
|
|
description: "the details of the status."
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
type: "interface"
|
|
desc: "An immutable client-side representation of an Azure registry."
|
|
implements:
|
|
- "<xref href=\"com.microsoft.azure.management.resources.fluentcore.arm.models.GroupableResource?alt=com.microsoft.azure.management.resources.fluentcore.arm.models.GroupableResource&text=GroupableResource\" 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.search.implementation.SearchServiceInner?alt=com.microsoft.azure.management.search.implementation.SearchServiceInner&text=SearchServiceInner\" data-throw-if-not-resolved=\"False\" />>"
|
|
- "<xref href=\"com.microsoft.azure.management.resources.fluentcore.model.Refreshable?alt=com.microsoft.azure.management.resources.fluentcore.model.Refreshable&text=Refreshable\" 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.Updatable?alt=com.microsoft.azure.management.resources.fluentcore.model.Updatable&text=Updatable\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.microsoft.azure.management.search.SearchService.Update?alt=com.microsoft.azure.management.search.SearchService.Update&text=Update\" data-throw-if-not-resolved=\"False\" />>"
|
|
metadata: {}
|
|
package: "com.microsoft.azure.management.search"
|
|
artifact: com.microsoft.azure:azure-mgmt-search:1.41.4
|