import "github.com/Azure/azure-sdk-for-go/services/search/mgmt/2015-02-28/search"
Package search implements the Azure ARM Search service API version 2015-02-28.
Client that can be used to manage Azure Search services and API keys.
adminkeys.go client.go enums.go models.go querykeys.go services.go version.go
const ( // DefaultBaseURI is the default URI used for the service Search DefaultBaseURI = "https://management.azure.com" )
UserAgent returns the UserAgent string to use when sending http.Requests.
Version returns the semantic version (see http://semver.org) of the client.
type AdminKeyResult struct { autorest.Response `json:"-"` // PrimaryKey - READ-ONLY; The primary API key of the Search service. PrimaryKey *string `json:"primaryKey,omitempty"` // SecondaryKey - READ-ONLY; The secondary API key of the Search service. SecondaryKey *string `json:"secondaryKey,omitempty"` }
AdminKeyResult response containing the primary and secondary API keys for a given Azure Search service.
type AdminKeysClient struct { BaseClient }
AdminKeysClient is the client that can be used to manage Azure Search services and API keys.
func NewAdminKeysClient(subscriptionID string) AdminKeysClient
NewAdminKeysClient creates an instance of the AdminKeysClient client.
func NewAdminKeysClientWithBaseURI(baseURI string, subscriptionID string) AdminKeysClient
NewAdminKeysClientWithBaseURI creates an instance of the AdminKeysClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).
func (client AdminKeysClient) List(ctx context.Context, resourceGroupName string, serviceName string) (result AdminKeyResult, err error)
List returns the primary and secondary API keys for the given Azure Search service. Parameters: resourceGroupName - the name of the resource group within the current subscription. serviceName - the name of the Search service for which to list admin keys.
func (client AdminKeysClient) ListPreparer(ctx context.Context, resourceGroupName string, serviceName string) (*http.Request, error)
ListPreparer prepares the List request.
func (client AdminKeysClient) ListResponder(resp *http.Response) (result AdminKeyResult, err error)
ListResponder handles the response to the List request. The method always closes the http.Response Body.
ListSender sends the List request. The method will close the http.Response Body if it receives an error.
BaseClient is the base client for Search.
func New(subscriptionID string) BaseClient
New creates an instance of the BaseClient client.
func NewWithBaseURI(baseURI string, subscriptionID string) BaseClient
NewWithBaseURI creates an instance of the BaseClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).
type ListQueryKeysResult struct { autorest.Response `json:"-"` // Value - READ-ONLY; 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.
ProvisioningState enumerates the values for provisioning state.
const ( // Failed ... Failed ProvisioningState = "failed" // Provisioning ... Provisioning ProvisioningState = "provisioning" // Succeeded ... Succeeded ProvisioningState = "succeeded" )
func PossibleProvisioningStateValues() []ProvisioningState
PossibleProvisioningStateValues returns an array of possible values for the ProvisioningState const type.
type QueryKey struct { // Name - READ-ONLY; The name of the query API key; may be empty. Name *string `json:"name,omitempty"` // Key - READ-ONLY; 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 struct { BaseClient }
QueryKeysClient is the client that can be used to manage Azure Search services and API keys.
func NewQueryKeysClient(subscriptionID string) QueryKeysClient
NewQueryKeysClient creates an instance of the QueryKeysClient client.
func NewQueryKeysClientWithBaseURI(baseURI string, subscriptionID string) QueryKeysClient
NewQueryKeysClientWithBaseURI creates an instance of the QueryKeysClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).
func (client QueryKeysClient) List(ctx context.Context, resourceGroupName string, serviceName string) (result ListQueryKeysResult, err error)
List returns the list of query API keys for the given Azure Search service. Parameters: resourceGroupName - the name of the resource group within the current subscription. serviceName - the name of the Search service for which to list query keys.
func (client QueryKeysClient) ListPreparer(ctx context.Context, resourceGroupName string, serviceName string) (*http.Request, error)
ListPreparer prepares the List request.
func (client QueryKeysClient) ListResponder(resp *http.Response) (result ListQueryKeysResult, err error)
ListResponder handles the response to the List request. The method always closes the http.Response Body.
ListSender sends the List request. The method will close the http.Response Body if it receives an error.
type Resource struct { // ID - READ-ONLY; Resource Id ID *string `json:"id,omitempty"` // Name - READ-ONLY; Resource name Name *string `json:"name,omitempty"` // Type - READ-ONLY; Resource type Type *string `json:"type,omitempty"` // Location - Resource location Location *string `json:"location,omitempty"` // Tags - Resource tags Tags map[string]*string `json:"tags"` }
Resource ...
MarshalJSON is the custom marshaler for Resource.
type ServiceCreateOrUpdateParameters struct { // Location - The geographic location of the Search service. Location *string `json:"location,omitempty"` // Tags - Tags to help categorize the Search service in the Azure Portal. Tags map[string]*string `json:"tags"` // Properties - Properties of the Search service. Properties *ServiceProperties `json:"properties,omitempty"` }
ServiceCreateOrUpdateParameters properties that describe an Azure Search service.
func (scoup ServiceCreateOrUpdateParameters) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for ServiceCreateOrUpdateParameters.
type ServiceListResult struct { autorest.Response `json:"-"` // Value - READ-ONLY; The Search services in the resource group. Value *[]ServiceResource `json:"value,omitempty"` }
ServiceListResult response containing a list of Azure Search services for a given resource group.
type ServiceProperties struct { // Sku - The SKU of the Search Service, which determines price tier and capacity limits. Sku *Sku `json:"sku,omitempty"` // ReplicaCount - The number of replicas in the Search service. If specified, it must be a value between 1 and 6 inclusive. 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. PartitionCount *int32 `json:"partitionCount,omitempty"` }
ServiceProperties defines properties of an Azure Search service that can be modified.
type ServiceReadableProperties struct { // Status - READ-ONLY; The status of the Search service. Possible values include: 'ServiceStatusRunning', 'ServiceStatusProvisioning', 'ServiceStatusDeleting', 'ServiceStatusDegraded', 'ServiceStatusDisabled', 'ServiceStatusError' Status ServiceStatus `json:"status,omitempty"` // StatusDetails - READ-ONLY; The details of the Search service status. StatusDetails *string `json:"statusDetails,omitempty"` // ProvisioningState - READ-ONLY; The state of the last provisioning operation performed on the Search service. Possible values include: 'Succeeded', 'Provisioning', 'Failed' ProvisioningState ProvisioningState `json:"provisioningState,omitempty"` // Sku - The SKU of the Search Service, which determines price tier and capacity limits. Sku *Sku `json:"sku,omitempty"` // ReplicaCount - The number of replicas in the Search service. If specified, it must be a value between 1 and 6 inclusive. 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. PartitionCount *int32 `json:"partitionCount,omitempty"` }
ServiceReadableProperties defines all the properties of an Azure Search service.
func (srp ServiceReadableProperties) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for ServiceReadableProperties.
type ServiceResource struct { autorest.Response `json:"-"` // ID - READ-ONLY; The resource Id of the Azure Search service. ID *string `json:"id,omitempty"` // Name - The name of the Search service. Name *string `json:"name,omitempty"` // Location - The geographic location of the Search service. Location *string `json:"location,omitempty"` // Tags - Tags to help categorize the Search service in the Azure Portal. Tags map[string]*string `json:"tags"` // Properties - READ-ONLY; Properties of the Search service. Properties *ServiceReadableProperties `json:"properties,omitempty"` }
ServiceResource describes an Azure Search service and its current state.
func (sr ServiceResource) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for ServiceResource.
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" )
func PossibleServiceStatusValues() []ServiceStatus
PossibleServiceStatusValues returns an array of possible values for the ServiceStatus const type.
type ServicesClient struct { BaseClient }
ServicesClient is the client that can be used to manage Azure Search services and API keys.
func NewServicesClient(subscriptionID string) ServicesClient
NewServicesClient creates an instance of the ServicesClient client.
func NewServicesClientWithBaseURI(baseURI string, subscriptionID string) ServicesClient
NewServicesClientWithBaseURI creates an instance of the ServicesClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).
func (client ServicesClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, serviceName string, parameters ServiceCreateOrUpdateParameters) (result ServiceResource, 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. Parameters: resourceGroupName - the name of the resource group within the current subscription. serviceName - the name of the Search service to create or update. parameters - the properties to set or update on the Search service.
func (client ServicesClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, serviceName string, parameters ServiceCreateOrUpdateParameters) (*http.Request, error)
CreateOrUpdatePreparer prepares the CreateOrUpdate request.
func (client ServicesClient) CreateOrUpdateResponder(resp *http.Response) (result ServiceResource, err error)
CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.
CreateOrUpdateSender sends the CreateOrUpdate request. The method will close the http.Response Body if it receives an error.
func (client ServicesClient) Delete(ctx context.Context, resourceGroupName string, serviceName string) (result autorest.Response, err error)
Delete deletes a Search service in the given resource group, along with its associated resources. Parameters: resourceGroupName - the name of the resource group within the current subscription. serviceName - the name of the Search service to delete.
func (client ServicesClient) DeletePreparer(ctx context.Context, resourceGroupName string, serviceName string) (*http.Request, error)
DeletePreparer prepares the Delete request.
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.
DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.
func (client ServicesClient) List(ctx context.Context, resourceGroupName string) (result ServiceListResult, err error)
List returns a list of all Search services in the given resource group. Parameters: resourceGroupName - the name of the resource group within the current subscription.
func (client ServicesClient) ListPreparer(ctx context.Context, resourceGroupName string) (*http.Request, error)
ListPreparer prepares the List request.
func (client ServicesClient) ListResponder(resp *http.Response) (result ServiceListResult, err error)
ListResponder handles the response to the List request. The method always closes the http.Response Body.
ListSender sends the List request. The method will close the http.Response Body if it receives an error.
type Sku struct { // Name - The SKU of the Search service. Possible values include: 'Free', 'Standard', 'Standard2' Name SkuType `json:"name,omitempty"` }
Sku defines the SKU of an Azure Search Service, which determines price tier and capacity limits.
SkuType enumerates the values for sku type.
const ( // Free ... Free SkuType = "free" // Standard ... Standard SkuType = "standard" // Standard2 ... Standard2 SkuType = "standard2" )
PossibleSkuTypeValues returns an array of possible values for the SkuType const type.
SubResource ...
Path | Synopsis |
---|---|
searchapi |
Package search imports 7 packages (graph) and is imported by 4 packages. Updated 2021-01-20. Refresh now. Tools for package owners.