azure.mgmt.search.models module

class azure.mgmt.search.models.CheckNameAvailabilityInput(*, name: str, **kwargs)[source]

Bases: msrest.serialization.Model

Input of check name availability API.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Parameters

name (str) – Required. The Search service name to validate. Search service names must only contain lowercase letters, digits or dashes, cannot use dash as the first two or last one characters, cannot contain consecutive dashes, and must be between 2 and 60 characters in length.

Variables

type (str) – Required. The type of the resource whose name is to be validated. This value must always be ‘searchServices’. Default value: “searchServices” .

type = 'searchServices'
class azure.mgmt.search.models.CheckNameAvailabilityOutput(**kwargs)[source]

Bases: msrest.serialization.Model

Output of check name availability API.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

  • is_name_available (bool) – A value indicating whether the name is available.

  • reason (str or UnavailableNameReason) – The reason why the name is not available. ‘Invalid’ indicates the name provided does not match the naming requirements (incorrect length, unsupported characters, etc.). ‘AlreadyExists’ indicates that the name is already in use and is therefore unavailable. Possible values include: ‘Invalid’, ‘AlreadyExists’

  • message (str) – A message that explains why the name is invalid and provides resource naming requirements. Available only if ‘Invalid’ is returned in the ‘reason’ property.

class azure.mgmt.search.models.AdminKeyResult(**kwargs)[source]

Bases: msrest.serialization.Model

Response containing the primary and secondary admin API keys for a given Azure Search service.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

  • primary_key (str) – The primary admin API key of the Search service.

  • secondary_key (str) – The secondary admin API key of the Search service.

class azure.mgmt.search.models.QueryKey(**kwargs)[source]

Bases: msrest.serialization.Model

Describes an API key for a given Azure Search service that has permissions for query operations only.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

  • name (str) – The name of the query API key; may be empty.

  • key (str) – The value of the query API key.

class azure.mgmt.search.models.Sku(*, name=None, **kwargs)[source]

Bases: msrest.serialization.Model

Defines the SKU of an Azure Search Service, which determines price tier and capacity limits.

Parameters

name (str or SkuName) – The SKU of the Search service. Valid values include: ‘free’: Shared service. ‘basic’: Dedicated service with up to 3 replicas. ‘standard’: Dedicated service with up to 12 partitions and 12 replicas. ‘standard2’: Similar to standard, but with more capacity per search unit. ‘standard3’: The largest Standard offering with up to 12 partitions and 12 replicas (or up to 3 partitions with more indexes if you also set the hostingMode property to ‘highDensity’). ‘storage_optimized_l1’: Supports 1TB per partition, up to 12 partitions. ‘storage_optimized_l2’: Supports 2TB per partition, up to 12 partitions.’. Possible values include: ‘free’, ‘basic’, ‘standard’, ‘standard2’, ‘standard3’, ‘storage_optimized_l1’, ‘storage_optimized_l2’

class azure.mgmt.search.models.SearchService(*, location: str = None, tags=None, identity=None, replica_count: int = 1, partition_count: int = 1, hosting_mode='default', sku=None, **kwargs)[source]

Bases: azure.mgmt.search.models.resource_py3.Resource

Describes an Azure Search service and its current state.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

  • id (str) – The ID of the resource. This can be used with the Azure Resource Manager to link resources together.

  • name (str) – The name of the resource.

  • type (str) – The resource type.

  • status (str or SearchServiceStatus) – The status of the Search service. Possible 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. Possible values include: ‘running’, ‘provisioning’, ‘deleting’, ‘degraded’, ‘disabled’, ‘error’

  • status_details (str) – The details of the Search service status.

  • provisioning_state (str or ProvisioningState) – The state of the last provisioning operation performed on the Search service. Provisioning 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. Possible values include: ‘succeeded’, ‘provisioning’, ‘failed’

Parameters

  • location (str) – The geographic location of the resource. This must be one of the supported and registered Azure Geo Regions (for example, West US, East US, Southeast Asia, and so forth). This property is required when creating a new resource.

  • tags (dict[str, str]) – Tags to help categorize the resource in the Azure portal.

  • identity (Identity) – The identity of the resource.

  • replica_count (int) – The number of replicas in the Search service. If specified, it must be a value between 1 and 12 inclusive for standard SKUs or between 1 and 3 inclusive for basic SKU. Default value: 1 .

  • partition_count (int) – The number of partitions in the Search service; if specified, it can be 1, 2, 3, 4, 6, or 12. Values greater than 1 are only valid for standard SKUs. For ‘standard3’ services with hostingMode set to ‘highDensity’, the allowed values are between 1 and 3. Default value: 1 .

  • hosting_mode (str or HostingMode) – Applicable 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’. Possible values include: ‘default’, ‘highDensity’. Default value: “default” .

  • sku (Sku) – The SKU of the Search Service, which determines price tier and capacity limits. This property is required when creating a new Search Service.

class azure.mgmt.search.models.Identity(*, type, **kwargs)[source]

Bases: msrest.serialization.Model

Identity for the resource.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables

  • principal_id (str) – The principal ID of resource identity.

  • tenant_id (str) – The tenant ID of resource.

Parameters

type (str or IdentityType) – Required. The identity type. Possible values include: ‘None’, ‘SystemAssigned’

class azure.mgmt.search.models.Resource(*, location: str = None, tags=None, identity=None, **kwargs)[source]

Bases: msrest.serialization.Model

Base type for all Azure resources.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

  • id (str) – The ID of the resource. This can be used with the Azure Resource Manager to link resources together.

  • name (str) – The name of the resource.

  • type (str) – The resource type.

Parameters

  • location (str) – The geographic location of the resource. This must be one of the supported and registered Azure Geo Regions (for example, West US, East US, Southeast Asia, and so forth). This property is required when creating a new resource.

  • tags (dict[str, str]) – Tags to help categorize the resource in the Azure portal.

  • identity (Identity) – The identity of the resource.

class azure.mgmt.search.models.OperationDisplay(**kwargs)[source]

Bases: msrest.serialization.Model

The object that describes the operation.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

  • provider (str) – The friendly name of the resource provider.

  • operation (str) – The operation type: read, write, delete, listKeys/action, etc.

  • resource (str) – The resource type on which the operation is performed.

  • description (str) – The friendly name of the operation.

class azure.mgmt.search.models.Operation(**kwargs)[source]

Bases: msrest.serialization.Model

Describes a REST API operation.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

  • name (str) – The name of the operation. This name is of the form {provider}/{resource}/{operation}.

  • display (OperationDisplay) – The object that describes the operation.

class azure.mgmt.search.models.SearchManagementRequestOptions(*, client_request_id: str = None, **kwargs)[source]

Bases: msrest.serialization.Model

Additional parameters for a set of operations.

Parameters

client_request_id (str) – 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.

class azure.mgmt.search.models.OperationPaged(*args, **kwargs)[source]

Bases: msrest.paging.Paged

A paging container for iterating over a list of Operation object

Bring async to Paging.

“async_command” is mandatory keyword argument for this mixin to work.

class azure.mgmt.search.models.QueryKeyPaged(*args, **kwargs)[source]

Bases: msrest.paging.Paged

A paging container for iterating over a list of QueryKey object

Bring async to Paging.

“async_command” is mandatory keyword argument for this mixin to work.

class azure.mgmt.search.models.SearchServicePaged(*args, **kwargs)[source]

Bases: msrest.paging.Paged

A paging container for iterating over a list of SearchService object

Bring async to Paging.

“async_command” is mandatory keyword argument for this mixin to work.

class azure.mgmt.search.models.UnavailableNameReason[source]

Bases: str, enum.Enum

An enumeration.

already_exists = 'AlreadyExists'
invalid = 'Invalid'
class azure.mgmt.search.models.SkuName[source]

Bases: str, enum.Enum

An enumeration.

basic = 'basic'
free = 'free'
standard = 'standard'
standard2 = 'standard2'
standard3 = 'standard3'
storage_optimized_l1 = 'storage_optimized_l1'
storage_optimized_l2 = 'storage_optimized_l2'
class azure.mgmt.search.models.HostingMode[source]

Bases: str, enum.Enum

An enumeration.

default = 'default'
high_density = 'highDensity'
class azure.mgmt.search.models.SearchServiceStatus[source]

Bases: str, enum.Enum

An enumeration.

degraded = 'degraded'
deleting = 'deleting'
disabled = 'disabled'
error = 'error'
provisioning = 'provisioning'
running = 'running'
class azure.mgmt.search.models.ProvisioningState[source]

Bases: str, enum.Enum

An enumeration.

failed = 'failed'
provisioning = 'provisioning'
succeeded = 'succeeded'
class azure.mgmt.search.models.IdentityType[source]

Bases: str, enum.Enum

An enumeration.

none = 'None'
system_assigned = 'SystemAssigned'
class azure.mgmt.search.models.AdminKeyKind[source]

Bases: str, enum.Enum

An enumeration.

primary = 'primary'
secondary = 'secondary'