Documentation ¶
Overview ¶
Package search implements the Azure ARM Search service API version 2015-08-19.
Client that can be used to manage Azure Search services and API keys.
Index ¶
- Constants
- func UserAgent() string
- func Version() string
- type AdminKeyKind
- type AdminKeyResult
- type AdminKeysClient
- func (client AdminKeysClient) Get(ctx context.Context, resourceGroupName string, searchServiceName string, ...) (result AdminKeyResult, err error)
- func (client AdminKeysClient) GetPreparer(ctx context.Context, resourceGroupName string, searchServiceName string, ...) (*http.Request, error)
- func (client AdminKeysClient) GetResponder(resp *http.Response) (result AdminKeyResult, err error)
- func (client AdminKeysClient) GetSender(req *http.Request) (*http.Response, error)
- func (client AdminKeysClient) Regenerate(ctx context.Context, resourceGroupName string, searchServiceName string, ...) (result AdminKeyResult, err error)
- func (client AdminKeysClient) RegeneratePreparer(ctx context.Context, resourceGroupName string, searchServiceName string, ...) (*http.Request, error)
- func (client AdminKeysClient) RegenerateResponder(resp *http.Response) (result AdminKeyResult, err error)
- func (client AdminKeysClient) RegenerateSender(req *http.Request) (*http.Response, error)
- type BaseClient
- type CheckNameAvailabilityInput
- type CheckNameAvailabilityOutput
- type CloudError
- type CloudErrorBody
- type HostingMode
- type ListQueryKeysResult
- type ProvisioningState
- type QueryKey
- type QueryKeysClient
- func (client QueryKeysClient) Create(ctx context.Context, resourceGroupName string, searchServiceName string, ...) (result QueryKey, err error)
- func (client QueryKeysClient) CreatePreparer(ctx context.Context, resourceGroupName string, searchServiceName string, ...) (*http.Request, error)
- func (client QueryKeysClient) CreateResponder(resp *http.Response) (result QueryKey, err error)
- func (client QueryKeysClient) CreateSender(req *http.Request) (*http.Response, error)
- func (client QueryKeysClient) Delete(ctx context.Context, resourceGroupName string, searchServiceName string, ...) (result autorest.Response, err error)
- func (client QueryKeysClient) DeletePreparer(ctx context.Context, resourceGroupName string, searchServiceName string, ...) (*http.Request, error)
- func (client QueryKeysClient) DeleteResponder(resp *http.Response) (result autorest.Response, err error)
- func (client QueryKeysClient) DeleteSender(req *http.Request) (*http.Response, error)
- func (client QueryKeysClient) ListBySearchService(ctx context.Context, resourceGroupName string, searchServiceName string, ...) (result ListQueryKeysResult, err error)
- func (client QueryKeysClient) ListBySearchServicePreparer(ctx context.Context, resourceGroupName string, searchServiceName string, ...) (*http.Request, error)
- func (client QueryKeysClient) ListBySearchServiceResponder(resp *http.Response) (result ListQueryKeysResult, err error)
- func (client QueryKeysClient) ListBySearchServiceSender(req *http.Request) (*http.Response, error)
- type Resource
- type Service
- type ServiceListResult
- type ServiceProperties
- type ServiceStatus
- type ServicesClient
- func (client ServicesClient) CheckNameAvailability(ctx context.Context, checkNameAvailabilityInput CheckNameAvailabilityInput, ...) (result CheckNameAvailabilityOutput, err error)
- func (client ServicesClient) CheckNameAvailabilityPreparer(ctx context.Context, checkNameAvailabilityInput CheckNameAvailabilityInput, ...) (*http.Request, error)
- func (client ServicesClient) CheckNameAvailabilityResponder(resp *http.Response) (result CheckNameAvailabilityOutput, err error)
- func (client ServicesClient) CheckNameAvailabilitySender(req *http.Request) (*http.Response, error)
- func (client ServicesClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, searchServiceName string, ...) (result ServicesCreateOrUpdateFuture, err error)
- func (client ServicesClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, searchServiceName string, ...) (*http.Request, error)
- func (client ServicesClient) CreateOrUpdateResponder(resp *http.Response) (result Service, err error)
- func (client ServicesClient) CreateOrUpdateSender(req *http.Request) (future ServicesCreateOrUpdateFuture, err error)
- func (client ServicesClient) Delete(ctx context.Context, resourceGroupName string, searchServiceName string, ...) (result autorest.Response, err error)
- func (client ServicesClient) DeletePreparer(ctx context.Context, resourceGroupName string, searchServiceName string, ...) (*http.Request, error)
- func (client ServicesClient) DeleteResponder(resp *http.Response) (result autorest.Response, err error)
- func (client ServicesClient) DeleteSender(req *http.Request) (*http.Response, error)
- func (client ServicesClient) Get(ctx context.Context, resourceGroupName string, searchServiceName string, ...) (result Service, err error)
- func (client ServicesClient) GetPreparer(ctx context.Context, resourceGroupName string, searchServiceName string, ...) (*http.Request, error)
- func (client ServicesClient) GetResponder(resp *http.Response) (result Service, err error)
- func (client ServicesClient) GetSender(req *http.Request) (*http.Response, error)
- func (client ServicesClient) ListByResourceGroup(ctx context.Context, resourceGroupName string, clientRequestID *uuid.UUID) (result ServiceListResult, err error)
- func (client ServicesClient) ListByResourceGroupPreparer(ctx context.Context, resourceGroupName string, clientRequestID *uuid.UUID) (*http.Request, error)
- func (client ServicesClient) ListByResourceGroupResponder(resp *http.Response) (result ServiceListResult, err error)
- func (client ServicesClient) ListByResourceGroupSender(req *http.Request) (*http.Response, error)
- type ServicesCreateOrUpdateFuture
- type Sku
- type SkuName
- type UnavailableNameReason
Constants ¶
const (
// DefaultBaseURI is the default URI used for the service Search
DefaultBaseURI = "https://management.azure.com"
)
Variables ¶
This section is empty.
Functions ¶
func UserAgent ¶
func UserAgent() string
UserAgent returns the UserAgent string to use when sending http.Requests.
func Version ¶
func Version() string
Version returns the semantic version (see http://semver.org) of the client.
Types ¶
type AdminKeyKind ¶
type AdminKeyKind string
AdminKeyKind enumerates the values for admin key kind.
const ( // Primary ... Primary AdminKeyKind = "primary" // Secondary ... Secondary AdminKeyKind = "secondary" )
type AdminKeyResult ¶
type AdminKeyResult struct { autorest.Response `json:"-"` // PrimaryKey - The primary admin API key of the Search service. PrimaryKey *string `json:"primaryKey,omitempty"` // SecondaryKey - The secondary admin API key of the Search service. SecondaryKey *string `json:"secondaryKey,omitempty"` }
AdminKeyResult response containing the primary and secondary admin API keys for a given Azure Search service.
type AdminKeysClient ¶
type AdminKeysClient struct {
BaseClient
}
AdminKeysClient is the client that can be used to manage Azure Search services and API keys.
func NewAdminKeysClient ¶
func NewAdminKeysClient(subscriptionID string) AdminKeysClient
NewAdminKeysClient creates an instance of the AdminKeysClient client.
func NewAdminKeysClientWithBaseURI ¶
func NewAdminKeysClientWithBaseURI(baseURI string, subscriptionID string) AdminKeysClient
NewAdminKeysClientWithBaseURI creates an instance of the AdminKeysClient client.
func (AdminKeysClient) Get ¶
func (client AdminKeysClient) Get(ctx context.Context, resourceGroupName string, searchServiceName string, clientRequestID *uuid.UUID) (result AdminKeyResult, err error)
Get gets the primary and secondary admin API keys for the specified Azure Search service.
resourceGroupName is 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 is the name of the Azure Search service associated with the specified resource group. clientRequestID is 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.
func (AdminKeysClient) GetPreparer ¶
func (client AdminKeysClient) GetPreparer(ctx context.Context, resourceGroupName string, searchServiceName string, clientRequestID *uuid.UUID) (*http.Request, error)
GetPreparer prepares the Get request.
func (AdminKeysClient) GetResponder ¶
func (client AdminKeysClient) GetResponder(resp *http.Response) (result AdminKeyResult, err error)
GetResponder handles the response to the Get request. The method always closes the http.Response Body.
func (AdminKeysClient) GetSender ¶
GetSender sends the Get request. The method will close the http.Response Body if it receives an error.
func (AdminKeysClient) Regenerate ¶
func (client AdminKeysClient) Regenerate(ctx context.Context, resourceGroupName string, searchServiceName string, keyKind AdminKeyKind, clientRequestID *uuid.UUID) (result AdminKeyResult, err error)
Regenerate regenerates either the primary or secondary admin API key. You can only regenerate one key at a time.
resourceGroupName is 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 is the name of the Azure Search service associated with the specified resource group. keyKind is specifies which key to regenerate. Valid values include 'primary' and 'secondary'. clientRequestID is 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.
func (AdminKeysClient) RegeneratePreparer ¶
func (client AdminKeysClient) RegeneratePreparer(ctx context.Context, resourceGroupName string, searchServiceName string, keyKind AdminKeyKind, clientRequestID *uuid.UUID) (*http.Request, error)
RegeneratePreparer prepares the Regenerate request.
func (AdminKeysClient) RegenerateResponder ¶
func (client AdminKeysClient) RegenerateResponder(resp *http.Response) (result AdminKeyResult, err error)
RegenerateResponder handles the response to the Regenerate request. The method always closes the http.Response Body.
func (AdminKeysClient) RegenerateSender ¶
RegenerateSender sends the Regenerate request. The method will close the http.Response Body if it receives an error.
type BaseClient ¶
BaseClient is the base client for Search.
func New ¶
func New(subscriptionID string) BaseClient
New creates an instance of the BaseClient client.
func NewWithBaseURI ¶
func NewWithBaseURI(baseURI string, subscriptionID string) BaseClient
NewWithBaseURI creates an instance of the BaseClient client.
type CheckNameAvailabilityInput ¶
type CheckNameAvailabilityInput struct { // Name - 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. Name *string `json:"name,omitempty"` // Type - The type of the resource whose name is to be validated. This value must always be 'searchServices'. Type *string `json:"type,omitempty"` }
CheckNameAvailabilityInput input of check name availability API.
type CheckNameAvailabilityOutput ¶
type CheckNameAvailabilityOutput struct { autorest.Response `json:"-"` // IsNameAvailable - A value indicating whether the name is available. IsNameAvailable *bool `json:"nameAvailable,omitempty"` // Reason - 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' Reason UnavailableNameReason `json:"reason,omitempty"` // Message - A message that explains why the name is invalid and provides resource naming requirements. Available only if 'Invalid' is returned in the 'reason' property. Message *string `json:"message,omitempty"` }
CheckNameAvailabilityOutput output of check name availability API.
type CloudError ¶
type CloudError struct {
Error *CloudErrorBody `json:"error,omitempty"`
}
CloudError contains information about an API error.
type CloudErrorBody ¶
type CloudErrorBody struct { // Code - An error code that describes the error condition more precisely than an HTTP status code. Can be used to programatically handle specific error cases. Code *string `json:"code,omitempty"` // Message - A message that describes the error in detail and provides debugging information. Message *string `json:"message,omitempty"` // Target - The target of the particular error (for example, the name of the property in error). Target *string `json:"target,omitempty"` // Details - Contains nested errors that are related to this error. Details *[]CloudErrorBody `json:"details,omitempty"` }
CloudErrorBody describes a particular API error with an error code and a message.
type HostingMode ¶
type HostingMode string
HostingMode enumerates the values for hosting mode.
const ( // Default ... Default HostingMode = "default" // HighDensity ... HighDensity HostingMode = "highDensity" )
type ListQueryKeysResult ¶
type ListQueryKeysResult struct { autorest.Response `json:"-"` // Value - The query keys for the Azure Search service. Value *[]QueryKey `json:"value,omitempty"` }
ListQueryKeysResult response containing the query API keys for a given Azure Search service.
type ProvisioningState ¶
type ProvisioningState string
ProvisioningState enumerates the values for provisioning state.
const ( // Failed ... Failed ProvisioningState = "failed" // Provisioning ... Provisioning ProvisioningState = "provisioning" // Succeeded ... Succeeded ProvisioningState = "succeeded" )
type QueryKey ¶
type QueryKey struct { autorest.Response `json:"-"` // Name - The name of the query API key; may be empty. Name *string `json:"name,omitempty"` // Key - The value of the query API key. Key *string `json:"key,omitempty"` }
QueryKey describes an API key for a given Azure Search service that has permissions for query operations only.
type QueryKeysClient ¶
type QueryKeysClient struct {
BaseClient
}
QueryKeysClient is the client that can be used to manage Azure Search services and API keys.
func NewQueryKeysClient ¶
func NewQueryKeysClient(subscriptionID string) QueryKeysClient
NewQueryKeysClient creates an instance of the QueryKeysClient client.
func NewQueryKeysClientWithBaseURI ¶
func NewQueryKeysClientWithBaseURI(baseURI string, subscriptionID string) QueryKeysClient
NewQueryKeysClientWithBaseURI creates an instance of the QueryKeysClient client.
func (QueryKeysClient) Create ¶
func (client QueryKeysClient) Create(ctx context.Context, resourceGroupName string, searchServiceName string, name string, clientRequestID *uuid.UUID) (result QueryKey, err error)
Create generates a new query key for the specified Search service. You can create up to 50 query keys per service.
resourceGroupName is 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 is the name of the Azure Search service associated with the specified resource group. name is the name of the new query API key. clientRequestID is 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.
func (QueryKeysClient) CreatePreparer ¶
func (client QueryKeysClient) CreatePreparer(ctx context.Context, resourceGroupName string, searchServiceName string, name string, clientRequestID *uuid.UUID) (*http.Request, error)
CreatePreparer prepares the Create request.
func (QueryKeysClient) CreateResponder ¶
func (client QueryKeysClient) CreateResponder(resp *http.Response) (result QueryKey, err error)
CreateResponder handles the response to the Create request. The method always closes the http.Response Body.
func (QueryKeysClient) CreateSender ¶
CreateSender sends the Create request. The method will close the http.Response Body if it receives an error.
func (QueryKeysClient) Delete ¶
func (client QueryKeysClient) Delete(ctx context.Context, resourceGroupName string, searchServiceName string, key string, clientRequestID *uuid.UUID) (result autorest.Response, err error)
Delete 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.
resourceGroupName is 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 is the name of the Azure Search service associated with the specified resource group. key is the query key to be deleted. Query keys are identified by value, not by name. clientRequestID is 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.
func (QueryKeysClient) DeletePreparer ¶
func (client QueryKeysClient) DeletePreparer(ctx context.Context, resourceGroupName string, searchServiceName string, key string, clientRequestID *uuid.UUID) (*http.Request, error)
DeletePreparer prepares the Delete request.
func (QueryKeysClient) DeleteResponder ¶
func (client QueryKeysClient) DeleteResponder(resp *http.Response) (result autorest.Response, err error)
DeleteResponder handles the response to the Delete request. The method always closes the http.Response Body.
func (QueryKeysClient) DeleteSender ¶
DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.
func (QueryKeysClient) ListBySearchService ¶
func (client QueryKeysClient) ListBySearchService(ctx context.Context, resourceGroupName string, searchServiceName string, clientRequestID *uuid.UUID) (result ListQueryKeysResult, err error)
ListBySearchService returns the list of query API keys for the given Azure Search service.
resourceGroupName is 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 is the name of the Azure Search service associated with the specified resource group. clientRequestID is 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.
func (QueryKeysClient) ListBySearchServicePreparer ¶
func (client QueryKeysClient) ListBySearchServicePreparer(ctx context.Context, resourceGroupName string, searchServiceName string, clientRequestID *uuid.UUID) (*http.Request, error)
ListBySearchServicePreparer prepares the ListBySearchService request.
func (QueryKeysClient) ListBySearchServiceResponder ¶
func (client QueryKeysClient) ListBySearchServiceResponder(resp *http.Response) (result ListQueryKeysResult, err error)
ListBySearchServiceResponder handles the response to the ListBySearchService request. The method always closes the http.Response Body.
func (QueryKeysClient) ListBySearchServiceSender ¶
ListBySearchServiceSender sends the ListBySearchService request. The method will close the http.Response Body if it receives an error.
type Resource ¶
type Resource struct { // ID - The ID of the resource. This can be used with the Azure Resource Manager to link resources together. ID *string `json:"id,omitempty"` // Name - The name of the resource. Name *string `json:"name,omitempty"` // Type - The resource type. Type *string `json:"type,omitempty"` // Location - 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). Location *string `json:"location,omitempty"` // Tags - Tags to help categorize the resource in the Azure portal. Tags *map[string]*string `json:"tags,omitempty"` }
Resource base type for all Azure resources.
type Service ¶
type Service struct { autorest.Response `json:"-"` // ID - The ID of the resource. This can be used with the Azure Resource Manager to link resources together. ID *string `json:"id,omitempty"` // Name - The name of the resource. Name *string `json:"name,omitempty"` // Type - The resource type. Type *string `json:"type,omitempty"` // Location - 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). Location *string `json:"location,omitempty"` // Tags - Tags to help categorize the resource in the Azure portal. Tags *map[string]*string `json:"tags,omitempty"` // ServiceProperties - Properties of the Search service. *ServiceProperties `json:"properties,omitempty"` // Sku - The SKU of the Search Service, which determines price tier and capacity limits. Sku *Sku `json:"sku,omitempty"` }
Service describes an Azure Search service and its current state.
func (*Service) UnmarshalJSON ¶
UnmarshalJSON is the custom unmarshaler for Service struct.
type ServiceListResult ¶
type ServiceListResult struct { autorest.Response `json:"-"` // Value - The list of Search services. Value *[]Service `json:"value,omitempty"` }
ServiceListResult response containing a list of Azure Search services.
type ServiceProperties ¶
type ServiceProperties struct { // ReplicaCount - 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. ReplicaCount *int32 `json:"replicaCount,omitempty"` // PartitionCount - 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. PartitionCount *int32 `json:"partitionCount,omitempty"` // 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' HostingMode HostingMode `json:"hostingMode,omitempty"` // Status - 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: 'ServiceStatusRunning', 'ServiceStatusProvisioning', 'ServiceStatusDeleting', 'ServiceStatusDegraded', 'ServiceStatusDisabled', 'ServiceStatusError' Status ServiceStatus `json:"status,omitempty"` // StatusDetails - The details of the Search service status. StatusDetails *string `json:"statusDetails,omitempty"` // 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' ProvisioningState ProvisioningState `json:"provisioningState,omitempty"` }
ServiceProperties properties of the Search service.
type ServiceStatus ¶
type ServiceStatus string
ServiceStatus enumerates the values for service status.
const ( // ServiceStatusDegraded ... ServiceStatusDegraded ServiceStatus = "degraded" // ServiceStatusDeleting ... ServiceStatusDeleting ServiceStatus = "deleting" // ServiceStatusDisabled ... ServiceStatusDisabled ServiceStatus = "disabled" // ServiceStatusError ... ServiceStatusError ServiceStatus = "error" // ServiceStatusProvisioning ... ServiceStatusProvisioning ServiceStatus = "provisioning" // ServiceStatusRunning ... ServiceStatusRunning ServiceStatus = "running" )
type ServicesClient ¶
type ServicesClient struct {
BaseClient
}
ServicesClient is the client that can be used to manage Azure Search services and API keys.
func NewServicesClient ¶
func NewServicesClient(subscriptionID string) ServicesClient
NewServicesClient creates an instance of the ServicesClient client.
func NewServicesClientWithBaseURI ¶
func NewServicesClientWithBaseURI(baseURI string, subscriptionID string) ServicesClient
NewServicesClientWithBaseURI creates an instance of the ServicesClient client.
func (ServicesClient) CheckNameAvailability ¶
func (client ServicesClient) CheckNameAvailability(ctx context.Context, checkNameAvailabilityInput CheckNameAvailabilityInput, clientRequestID *uuid.UUID) (result CheckNameAvailabilityOutput, err error)
CheckNameAvailability checks whether or not the given Search service name is available for use. Search service names must be globally unique since they are part of the service URI (https://<name>.search.windows.net).
checkNameAvailabilityInput is the resource name and type to check. clientRequestID is 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.
func (ServicesClient) CheckNameAvailabilityPreparer ¶
func (client ServicesClient) CheckNameAvailabilityPreparer(ctx context.Context, checkNameAvailabilityInput CheckNameAvailabilityInput, clientRequestID *uuid.UUID) (*http.Request, error)
CheckNameAvailabilityPreparer prepares the CheckNameAvailability request.
func (ServicesClient) CheckNameAvailabilityResponder ¶
func (client ServicesClient) CheckNameAvailabilityResponder(resp *http.Response) (result CheckNameAvailabilityOutput, err error)
CheckNameAvailabilityResponder handles the response to the CheckNameAvailability request. The method always closes the http.Response Body.
func (ServicesClient) CheckNameAvailabilitySender ¶
CheckNameAvailabilitySender sends the CheckNameAvailability request. The method will close the http.Response Body if it receives an error.
func (ServicesClient) CreateOrUpdate ¶
func (client ServicesClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, searchServiceName string, service Service, clientRequestID *uuid.UUID) (result ServicesCreateOrUpdateFuture, err error)
CreateOrUpdate creates or updates a Search service in the given resource group. If the Search service already exists, all properties will be updated with the given values.
resourceGroupName is 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 is the name of the Azure Search service to create or update. 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. Search service names must be globally unique since they are part of the service URI (https://<name>.search.windows.net). You cannot change the service name after the service is created. service is the definition of the Search service to create or update. clientRequestID is 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.
func (ServicesClient) CreateOrUpdatePreparer ¶
func (client ServicesClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, searchServiceName string, service Service, clientRequestID *uuid.UUID) (*http.Request, error)
CreateOrUpdatePreparer prepares the CreateOrUpdate request.
func (ServicesClient) CreateOrUpdateResponder ¶
func (client ServicesClient) CreateOrUpdateResponder(resp *http.Response) (result Service, err error)
CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.
func (ServicesClient) CreateOrUpdateSender ¶
func (client ServicesClient) CreateOrUpdateSender(req *http.Request) (future ServicesCreateOrUpdateFuture, err error)
CreateOrUpdateSender sends the CreateOrUpdate request. The method will close the http.Response Body if it receives an error.
func (ServicesClient) Delete ¶
func (client ServicesClient) Delete(ctx context.Context, resourceGroupName string, searchServiceName string, clientRequestID *uuid.UUID) (result autorest.Response, err error)
Delete deletes a Search service in the given resource group, along with its associated resources.
resourceGroupName is 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 is the name of the Azure Search service associated with the specified resource group. clientRequestID is 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.
func (ServicesClient) DeletePreparer ¶
func (client ServicesClient) DeletePreparer(ctx context.Context, resourceGroupName string, searchServiceName string, clientRequestID *uuid.UUID) (*http.Request, error)
DeletePreparer prepares the Delete request.
func (ServicesClient) DeleteResponder ¶
func (client ServicesClient) DeleteResponder(resp *http.Response) (result autorest.Response, err error)
DeleteResponder handles the response to the Delete request. The method always closes the http.Response Body.
func (ServicesClient) DeleteSender ¶
DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.
func (ServicesClient) Get ¶
func (client ServicesClient) Get(ctx context.Context, resourceGroupName string, searchServiceName string, clientRequestID *uuid.UUID) (result Service, err error)
Get gets the Search service with the given name in the given resource group.
resourceGroupName is 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 is the name of the Azure Search service associated with the specified resource group. clientRequestID is 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.
func (ServicesClient) GetPreparer ¶
func (client ServicesClient) GetPreparer(ctx context.Context, resourceGroupName string, searchServiceName string, clientRequestID *uuid.UUID) (*http.Request, error)
GetPreparer prepares the Get request.
func (ServicesClient) GetResponder ¶
func (client ServicesClient) GetResponder(resp *http.Response) (result Service, err error)
GetResponder handles the response to the Get request. The method always closes the http.Response Body.
func (ServicesClient) GetSender ¶
GetSender sends the Get request. The method will close the http.Response Body if it receives an error.
func (ServicesClient) ListByResourceGroup ¶
func (client ServicesClient) ListByResourceGroup(ctx context.Context, resourceGroupName string, clientRequestID *uuid.UUID) (result ServiceListResult, err error)
ListByResourceGroup gets a list of all Search services in the given resource group.
resourceGroupName is the name of the resource group within the current subscription. You can obtain this value from the Azure Resource Manager API or the portal. clientRequestID is 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.
func (ServicesClient) ListByResourceGroupPreparer ¶
func (client ServicesClient) ListByResourceGroupPreparer(ctx context.Context, resourceGroupName string, clientRequestID *uuid.UUID) (*http.Request, error)
ListByResourceGroupPreparer prepares the ListByResourceGroup request.
func (ServicesClient) ListByResourceGroupResponder ¶
func (client ServicesClient) ListByResourceGroupResponder(resp *http.Response) (result ServiceListResult, err error)
ListByResourceGroupResponder handles the response to the ListByResourceGroup request. The method always closes the http.Response Body.
func (ServicesClient) ListByResourceGroupSender ¶
ListByResourceGroupSender sends the ListByResourceGroup request. The method will close the http.Response Body if it receives an error.
type ServicesCreateOrUpdateFuture ¶
ServicesCreateOrUpdateFuture an abstraction for monitoring and retrieving the results of a long-running operation.
func (ServicesCreateOrUpdateFuture) Result ¶
func (future ServicesCreateOrUpdateFuture) Result(client ServicesClient) (s Service, err error)
Result returns the result of the asynchronous operation. If the operation has not completed it will return an error.
type Sku ¶
type Sku struct { // Name - 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': Offers maximum capacity per search unit 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'). Possible values include: 'Free', 'Basic', 'Standard', 'Standard2', 'Standard3' Name SkuName `json:"name,omitempty"` }
Sku defines the SKU of an Azure Search Service, which determines price tier and capacity limits.
type UnavailableNameReason ¶
type UnavailableNameReason string
UnavailableNameReason enumerates the values for unavailable name reason.
const ( // AlreadyExists ... AlreadyExists UnavailableNameReason = "AlreadyExists" // Invalid ... Invalid UnavailableNameReason = "Invalid" )