Documentation ¶
Index ¶
- Constants
- func UserAgent() string
- func Version() string
- type AdminKeyResult
- type AdminKeysManagementClient
- func (client AdminKeysManagementClient) List(resourceGroupName string, serviceName string) (result AdminKeyResult, ae error)
- func (client AdminKeysManagementClient) ListPreparer(resourceGroupName string, serviceName string) (*http.Request, error)
- func (client AdminKeysManagementClient) ListResponder(resp *http.Response) (result AdminKeyResult, err error)
- func (client AdminKeysManagementClient) ListSender(req *http.Request) (*http.Response, error)
- type ListQueryKeysResult
- type ManagementClient
- type ProvisioningState
- type QueryKey
- type QueryKeysManagementClient
- func (client QueryKeysManagementClient) List(resourceGroupName string, serviceName string) (result ListQueryKeysResult, ae error)
- func (client QueryKeysManagementClient) ListPreparer(resourceGroupName string, serviceName string) (*http.Request, error)
- func (client QueryKeysManagementClient) ListResponder(resp *http.Response) (result ListQueryKeysResult, err error)
- func (client QueryKeysManagementClient) ListSender(req *http.Request) (*http.Response, error)
- type Resource
- type ServiceCreateOrUpdateParameters
- type ServiceListResult
- type ServiceProperties
- type ServiceReadableProperties
- type ServiceResource
- type ServiceStatus
- type ServicesManagementClient
- func (client ServicesManagementClient) CreateOrUpdate(resourceGroupName string, serviceName string, ...) (result ServiceResource, ae error)
- func (client ServicesManagementClient) CreateOrUpdatePreparer(resourceGroupName string, serviceName string, ...) (*http.Request, error)
- func (client ServicesManagementClient) CreateOrUpdateResponder(resp *http.Response) (result ServiceResource, err error)
- func (client ServicesManagementClient) CreateOrUpdateSender(req *http.Request) (*http.Response, error)
- func (client ServicesManagementClient) Delete(resourceGroupName string, serviceName string) (result autorest.Response, ae error)
- func (client ServicesManagementClient) DeletePreparer(resourceGroupName string, serviceName string) (*http.Request, error)
- func (client ServicesManagementClient) DeleteResponder(resp *http.Response) (result autorest.Response, err error)
- func (client ServicesManagementClient) DeleteSender(req *http.Request) (*http.Response, error)
- func (client ServicesManagementClient) List(resourceGroupName string) (result ServiceListResult, ae error)
- func (client ServicesManagementClient) ListPreparer(resourceGroupName string) (*http.Request, error)
- func (client ServicesManagementClient) ListResponder(resp *http.Response) (result ServiceListResult, err error)
- func (client ServicesManagementClient) ListSender(req *http.Request) (*http.Response, error)
- type Sku
- type SkuType
- type SubResource
Constants ¶
const ( // APIVersion is the version of the Search APIVersion = "2015-02-28" // 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 AdminKeyResult ¶
type AdminKeyResult struct { autorest.Response `json:"-"` PrimaryKey *string `json:"primaryKey,omitempty"` SecondaryKey *string `json:"secondaryKey,omitempty"` }
AdminKeyResult is response containing the primary and secondary API keys for a given Azure Search service.
type AdminKeysManagementClient ¶
type AdminKeysManagementClient struct {
ManagementClient
}
AdminKeysManagementClient is the client that can be used to manage Azure Search services and API keys.
func NewAdminKeysManagementClient ¶
func NewAdminKeysManagementClient(subscriptionID string) AdminKeysManagementClient
NewAdminKeysManagementClient creates an instance of the AdminKeysManagementClient client.
func NewAdminKeysManagementClientWithBaseURI ¶
func NewAdminKeysManagementClientWithBaseURI(baseURI string, subscriptionID string) AdminKeysManagementClient
NewAdminKeysManagementClientWithBaseURI creates an instance of the AdminKeysManagementClient client.
func (AdminKeysManagementClient) List ¶
func (client AdminKeysManagementClient) List(resourceGroupName string, serviceName string) (result AdminKeyResult, ae error)
List returns the primary and secondary API keys for the given Azure Search service.
resourceGroupName is the name of the resource group within the current subscription. serviceName is the name of the Search service for which to list admin keys.
func (AdminKeysManagementClient) ListPreparer ¶
func (client AdminKeysManagementClient) ListPreparer(resourceGroupName string, serviceName string) (*http.Request, error)
ListPreparer prepares the List request.
func (AdminKeysManagementClient) ListResponder ¶
func (client AdminKeysManagementClient) ListResponder(resp *http.Response) (result AdminKeyResult, err error)
ListResponder handles the response to the List request. The method always closes the http.Response Body.
func (AdminKeysManagementClient) ListSender ¶
ListSender sends the List request. The method will close the http.Response Body if it receives an error.
type ListQueryKeysResult ¶
type ListQueryKeysResult struct { autorest.Response `json:"-"` Value *[]QueryKey `json:"value,omitempty"` }
ListQueryKeysResult is response containing the query API keys for a given Azure Search service.
type ManagementClient ¶
ManagementClient is the client that can be used to manage Azure Search services and API keys.
func New ¶
func New(subscriptionID string) ManagementClient
New creates an instance of the ManagementClient client.
func NewWithBaseURI ¶
func NewWithBaseURI(baseURI string, subscriptionID string) ManagementClient
NewWithBaseURI creates an instance of the ManagementClient client.
type ProvisioningState ¶
type ProvisioningState string
ProvisioningState enumerates the values for provisioning state.
const ( // Failed specifies the failed state for provisioning state. Failed ProvisioningState = "failed" // Provisioning specifies the provisioning state for provisioning state. Provisioning ProvisioningState = "provisioning" // Succeeded specifies the succeeded state for provisioning state. Succeeded ProvisioningState = "succeeded" )
type QueryKey ¶
QueryKey is describes an API key for a given Azure Search service that has permissions for query operations only.
type QueryKeysManagementClient ¶
type QueryKeysManagementClient struct {
ManagementClient
}
QueryKeysManagementClient is the client that can be used to manage Azure Search services and API keys.
func NewQueryKeysManagementClient ¶
func NewQueryKeysManagementClient(subscriptionID string) QueryKeysManagementClient
NewQueryKeysManagementClient creates an instance of the QueryKeysManagementClient client.
func NewQueryKeysManagementClientWithBaseURI ¶
func NewQueryKeysManagementClientWithBaseURI(baseURI string, subscriptionID string) QueryKeysManagementClient
NewQueryKeysManagementClientWithBaseURI creates an instance of the QueryKeysManagementClient client.
func (QueryKeysManagementClient) List ¶
func (client QueryKeysManagementClient) List(resourceGroupName string, serviceName string) (result ListQueryKeysResult, ae error)
List 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. serviceName is the name of the Search service for which to list query keys.
func (QueryKeysManagementClient) ListPreparer ¶
func (client QueryKeysManagementClient) ListPreparer(resourceGroupName string, serviceName string) (*http.Request, error)
ListPreparer prepares the List request.
func (QueryKeysManagementClient) ListResponder ¶
func (client QueryKeysManagementClient) ListResponder(resp *http.Response) (result ListQueryKeysResult, err error)
ListResponder handles the response to the List request. The method always closes the http.Response Body.
func (QueryKeysManagementClient) ListSender ¶
ListSender sends the List request. The method will close the http.Response Body if it receives an error.
type Resource ¶
type Resource struct { ID *string `json:"id,omitempty"` Name *string `json:"name,omitempty"` Type *string `json:"type,omitempty"` Location *string `json:"location,omitempty"` Tags *map[string]*string `json:"tags,omitempty"` }
Resource is
type ServiceCreateOrUpdateParameters ¶
type ServiceCreateOrUpdateParameters struct { Location *string `json:"location,omitempty"` Tags *map[string]*string `json:"tags,omitempty"` Properties *ServiceProperties `json:"properties,omitempty"` }
ServiceCreateOrUpdateParameters is properties that describe an Azure Search service.
type ServiceListResult ¶
type ServiceListResult struct { autorest.Response `json:"-"` Value *[]ServiceResource `json:"value,omitempty"` }
ServiceListResult is response containing a list of Azure Search services for a given resource group.
type ServiceProperties ¶
type ServiceProperties struct { Sku *Sku `json:"sku,omitempty"` ReplicaCount *int `json:"replicaCount,omitempty"` PartitionCount *int `json:"partitionCount,omitempty"` }
ServiceProperties is defines properties of an Azure Search service that can be modified.
type ServiceReadableProperties ¶
type ServiceReadableProperties struct { Status string `json:"status,omitempty"` StatusDetails *string `json:"statusDetails,omitempty"` ProvisioningState string `json:"provisioningState,omitempty"` Sku *Sku `json:"sku,omitempty"` ReplicaCount *int `json:"replicaCount,omitempty"` PartitionCount *int `json:"partitionCount,omitempty"` }
ServiceReadableProperties is defines all the properties of an Azure Search service.
type ServiceResource ¶
type ServiceResource struct { autorest.Response `json:"-"` Name *string `json:"name,omitempty"` Location *string `json:"location,omitempty"` Tags *map[string]*string `json:"tags,omitempty"` Properties *ServiceReadableProperties `json:"properties,omitempty"` }
ServiceResource is describes an Azure Search service and its current state.
type ServiceStatus ¶
type ServiceStatus string
ServiceStatus enumerates the values for service status.
const ( // ServiceStatusDegraded specifies the service status degraded state for // service status. ServiceStatusDegraded ServiceStatus = "degraded" // ServiceStatusDeleting specifies the service status deleting state for // service status. ServiceStatusDeleting ServiceStatus = "deleting" // ServiceStatusDisabled specifies the service status disabled state for // service status. ServiceStatusDisabled ServiceStatus = "disabled" // ServiceStatusError specifies the service status error state for service // status. ServiceStatusError ServiceStatus = "error" // ServiceStatusProvisioning specifies the service status provisioning // state for service status. ServiceStatusProvisioning ServiceStatus = "provisioning" // ServiceStatusRunning specifies the service status running state for // service status. ServiceStatusRunning ServiceStatus = "running" )
type ServicesManagementClient ¶
type ServicesManagementClient struct {
ManagementClient
}
ServicesManagementClient is the client that can be used to manage Azure Search services and API keys.
func NewServicesManagementClient ¶
func NewServicesManagementClient(subscriptionID string) ServicesManagementClient
NewServicesManagementClient creates an instance of the ServicesManagementClient client.
func NewServicesManagementClientWithBaseURI ¶
func NewServicesManagementClientWithBaseURI(baseURI string, subscriptionID string) ServicesManagementClient
NewServicesManagementClientWithBaseURI creates an instance of the ServicesManagementClient client.
func (ServicesManagementClient) CreateOrUpdate ¶
func (client ServicesManagementClient) CreateOrUpdate(resourceGroupName string, serviceName string, parameters ServiceCreateOrUpdateParameters) (result ServiceResource, ae 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. serviceName is the name of the Search service to create or update. parameters is the properties to set or update on the Search service.
func (ServicesManagementClient) CreateOrUpdatePreparer ¶
func (client ServicesManagementClient) CreateOrUpdatePreparer(resourceGroupName string, serviceName string, parameters ServiceCreateOrUpdateParameters) (*http.Request, error)
CreateOrUpdatePreparer prepares the CreateOrUpdate request.
func (ServicesManagementClient) CreateOrUpdateResponder ¶
func (client ServicesManagementClient) CreateOrUpdateResponder(resp *http.Response) (result ServiceResource, err error)
CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.
func (ServicesManagementClient) CreateOrUpdateSender ¶
func (client ServicesManagementClient) CreateOrUpdateSender(req *http.Request) (*http.Response, error)
CreateOrUpdateSender sends the CreateOrUpdate request. The method will close the http.Response Body if it receives an error.
func (ServicesManagementClient) Delete ¶
func (client ServicesManagementClient) Delete(resourceGroupName string, serviceName string) (result autorest.Response, ae 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. serviceName is the name of the Search service to delete.
func (ServicesManagementClient) DeletePreparer ¶
func (client ServicesManagementClient) DeletePreparer(resourceGroupName string, serviceName string) (*http.Request, error)
DeletePreparer prepares the Delete request.
func (ServicesManagementClient) DeleteResponder ¶
func (client ServicesManagementClient) 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 (ServicesManagementClient) DeleteSender ¶
DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.
func (ServicesManagementClient) List ¶
func (client ServicesManagementClient) List(resourceGroupName string) (result ServiceListResult, ae error)
List returns a list of all Search services in the given resource group.
resourceGroupName is the name of the resource group within the current subscription.
func (ServicesManagementClient) ListPreparer ¶
func (client ServicesManagementClient) ListPreparer(resourceGroupName string) (*http.Request, error)
ListPreparer prepares the List request.
func (ServicesManagementClient) ListResponder ¶
func (client ServicesManagementClient) ListResponder(resp *http.Response) (result ServiceListResult, err error)
ListResponder handles the response to the List request. The method always closes the http.Response Body.
func (ServicesManagementClient) ListSender ¶
ListSender sends the List request. The method will close the http.Response Body if it receives an error.
type Sku ¶
type Sku struct {
Name string `json:"name,omitempty"`
}
Sku is defines the SKU of an Azure Search Service, which determines price tier and capacity limits.