Documentation
¶
Overview ¶
Package search implements the Azure ARM Search service API version 2020-08-01.
Client that can be used to manage Azure Cognitive 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 AsyncOperationResult
- type AzureEntityResource
- type BaseClient
- type CheckNameAvailabilityInput
- type CheckNameAvailabilityOutput
- type CloudError
- type CloudErrorBody
- type HostingMode
- type IPRule
- type Identity
- type IdentityType
- type ListQueryKeysResult
- type ListQueryKeysResultIterator
- func (iter *ListQueryKeysResultIterator) Next() error
- func (iter *ListQueryKeysResultIterator) NextWithContext(ctx context.Context) (err error)
- func (iter ListQueryKeysResultIterator) NotDone() bool
- func (iter ListQueryKeysResultIterator) Response() ListQueryKeysResult
- func (iter ListQueryKeysResultIterator) Value() QueryKey
- type ListQueryKeysResultPage
- func (page *ListQueryKeysResultPage) Next() error
- func (page *ListQueryKeysResultPage) NextWithContext(ctx context.Context) (err error)
- func (page ListQueryKeysResultPage) NotDone() bool
- func (page ListQueryKeysResultPage) Response() ListQueryKeysResult
- func (page ListQueryKeysResultPage) Values() []QueryKey
- type NetworkRuleSet
- type Operation
- type OperationDisplay
- type OperationListResult
- type OperationsClient
- func (client OperationsClient) List(ctx context.Context) (result OperationListResult, err error)
- func (client OperationsClient) ListPreparer(ctx context.Context) (*http.Request, error)
- func (client OperationsClient) ListResponder(resp *http.Response) (result OperationListResult, err error)
- func (client OperationsClient) ListSender(req *http.Request) (*http.Response, error)
- type PrivateEndpointConnection
- type PrivateEndpointConnectionListResult
- type PrivateEndpointConnectionListResultIterator
- func (iter *PrivateEndpointConnectionListResultIterator) Next() error
- func (iter *PrivateEndpointConnectionListResultIterator) NextWithContext(ctx context.Context) (err error)
- func (iter PrivateEndpointConnectionListResultIterator) NotDone() bool
- func (iter PrivateEndpointConnectionListResultIterator) Response() PrivateEndpointConnectionListResult
- func (iter PrivateEndpointConnectionListResultIterator) Value() PrivateEndpointConnection
- type PrivateEndpointConnectionListResultPage
- func (page *PrivateEndpointConnectionListResultPage) Next() error
- func (page *PrivateEndpointConnectionListResultPage) NextWithContext(ctx context.Context) (err error)
- func (page PrivateEndpointConnectionListResultPage) NotDone() bool
- func (page PrivateEndpointConnectionListResultPage) Response() PrivateEndpointConnectionListResult
- func (page PrivateEndpointConnectionListResultPage) Values() []PrivateEndpointConnection
- type PrivateEndpointConnectionProperties
- type PrivateEndpointConnectionPropertiesPrivateEndpoint
- type PrivateEndpointConnectionPropertiesPrivateLinkServiceConnectionState
- type PrivateEndpointConnectionsClient
- func (client PrivateEndpointConnectionsClient) Delete(ctx context.Context, resourceGroupName string, searchServiceName string, ...) (result PrivateEndpointConnection, err error)
- func (client PrivateEndpointConnectionsClient) DeletePreparer(ctx context.Context, resourceGroupName string, searchServiceName string, ...) (*http.Request, error)
- func (client PrivateEndpointConnectionsClient) DeleteResponder(resp *http.Response) (result PrivateEndpointConnection, err error)
- func (client PrivateEndpointConnectionsClient) DeleteSender(req *http.Request) (*http.Response, error)
- func (client PrivateEndpointConnectionsClient) Get(ctx context.Context, resourceGroupName string, searchServiceName string, ...) (result PrivateEndpointConnection, err error)
- func (client PrivateEndpointConnectionsClient) GetPreparer(ctx context.Context, resourceGroupName string, searchServiceName string, ...) (*http.Request, error)
- func (client PrivateEndpointConnectionsClient) GetResponder(resp *http.Response) (result PrivateEndpointConnection, err error)
- func (client PrivateEndpointConnectionsClient) GetSender(req *http.Request) (*http.Response, error)
- func (client PrivateEndpointConnectionsClient) ListByService(ctx context.Context, resourceGroupName string, searchServiceName string, ...) (result PrivateEndpointConnectionListResultPage, err error)
- func (client PrivateEndpointConnectionsClient) ListByServiceComplete(ctx context.Context, resourceGroupName string, searchServiceName string, ...) (result PrivateEndpointConnectionListResultIterator, err error)
- func (client PrivateEndpointConnectionsClient) ListByServicePreparer(ctx context.Context, resourceGroupName string, searchServiceName string, ...) (*http.Request, error)
- func (client PrivateEndpointConnectionsClient) ListByServiceResponder(resp *http.Response) (result PrivateEndpointConnectionListResult, err error)
- func (client PrivateEndpointConnectionsClient) ListByServiceSender(req *http.Request) (*http.Response, error)
- func (client PrivateEndpointConnectionsClient) Update(ctx context.Context, resourceGroupName string, searchServiceName string, ...) (result PrivateEndpointConnection, err error)
- func (client PrivateEndpointConnectionsClient) UpdatePreparer(ctx context.Context, resourceGroupName string, searchServiceName string, ...) (*http.Request, error)
- func (client PrivateEndpointConnectionsClient) UpdateResponder(resp *http.Response) (result PrivateEndpointConnection, err error)
- func (client PrivateEndpointConnectionsClient) UpdateSender(req *http.Request) (*http.Response, error)
- type PrivateLinkResource
- type PrivateLinkResourceProperties
- type PrivateLinkResourcesClient
- func (client PrivateLinkResourcesClient) ListSupported(ctx context.Context, resourceGroupName string, searchServiceName string, ...) (result PrivateLinkResourcesResult, err error)
- func (client PrivateLinkResourcesClient) ListSupportedPreparer(ctx context.Context, resourceGroupName string, searchServiceName string, ...) (*http.Request, error)
- func (client PrivateLinkResourcesClient) ListSupportedResponder(resp *http.Response) (result PrivateLinkResourcesResult, err error)
- func (client PrivateLinkResourcesClient) ListSupportedSender(req *http.Request) (*http.Response, error)
- type PrivateLinkResourcesResult
- type PrivateLinkServiceConnectionStatus
- type ProvisioningState
- type ProxyResource
- type PublicNetworkAccess
- 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 ListQueryKeysResultPage, err error)
- func (client QueryKeysClient) ListBySearchServiceComplete(ctx context.Context, resourceGroupName string, searchServiceName string, ...) (result ListQueryKeysResultIterator, 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 ServiceListResultIterator
- func (iter *ServiceListResultIterator) Next() error
- func (iter *ServiceListResultIterator) NextWithContext(ctx context.Context) (err error)
- func (iter ServiceListResultIterator) NotDone() bool
- func (iter ServiceListResultIterator) Response() ServiceListResult
- func (iter ServiceListResultIterator) Value() Service
- type ServiceListResultPage
- type ServiceProperties
- type ServiceStatus
- type ServiceUpdate
- 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 ServiceListResultPage, err error)
- func (client ServicesClient) ListByResourceGroupComplete(ctx context.Context, resourceGroupName string, clientRequestID *uuid.UUID) (result ServiceListResultIterator, 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)
- func (client ServicesClient) ListBySubscription(ctx context.Context, clientRequestID *uuid.UUID) (result ServiceListResultPage, err error)
- func (client ServicesClient) ListBySubscriptionComplete(ctx context.Context, clientRequestID *uuid.UUID) (result ServiceListResultIterator, err error)
- func (client ServicesClient) ListBySubscriptionPreparer(ctx context.Context, clientRequestID *uuid.UUID) (*http.Request, error)
- func (client ServicesClient) ListBySubscriptionResponder(resp *http.Response) (result ServiceListResult, err error)
- func (client ServicesClient) ListBySubscriptionSender(req *http.Request) (*http.Response, error)
- func (client ServicesClient) Update(ctx context.Context, resourceGroupName string, searchServiceName string, ...) (result Service, err error)
- func (client ServicesClient) UpdatePreparer(ctx context.Context, resourceGroupName string, searchServiceName string, ...) (*http.Request, error)
- func (client ServicesClient) UpdateResponder(resp *http.Response) (result Service, err error)
- func (client ServicesClient) UpdateSender(req *http.Request) (*http.Response, error)
- type ServicesCreateOrUpdateFuture
- type ShareablePrivateLinkResourceProperties
- type ShareablePrivateLinkResourceType
- type SharedPrivateLinkResource
- type SharedPrivateLinkResourceAsyncOperationResult
- type SharedPrivateLinkResourceListResult
- type SharedPrivateLinkResourceListResultIterator
- func (iter *SharedPrivateLinkResourceListResultIterator) Next() error
- func (iter *SharedPrivateLinkResourceListResultIterator) NextWithContext(ctx context.Context) (err error)
- func (iter SharedPrivateLinkResourceListResultIterator) NotDone() bool
- func (iter SharedPrivateLinkResourceListResultIterator) Response() SharedPrivateLinkResourceListResult
- func (iter SharedPrivateLinkResourceListResultIterator) Value() SharedPrivateLinkResource
- type SharedPrivateLinkResourceListResultPage
- func (page *SharedPrivateLinkResourceListResultPage) Next() error
- func (page *SharedPrivateLinkResourceListResultPage) NextWithContext(ctx context.Context) (err error)
- func (page SharedPrivateLinkResourceListResultPage) NotDone() bool
- func (page SharedPrivateLinkResourceListResultPage) Response() SharedPrivateLinkResourceListResult
- func (page SharedPrivateLinkResourceListResultPage) Values() []SharedPrivateLinkResource
- type SharedPrivateLinkResourceProperties
- type SharedPrivateLinkResourceProvisioningState
- type SharedPrivateLinkResourceStatus
- type SharedPrivateLinkResourcesClient
- func (client SharedPrivateLinkResourcesClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, searchServiceName string, ...) (result SharedPrivateLinkResourcesCreateOrUpdateFuture, err error)
- func (client SharedPrivateLinkResourcesClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, searchServiceName string, ...) (*http.Request, error)
- func (client SharedPrivateLinkResourcesClient) CreateOrUpdateResponder(resp *http.Response) (result SharedPrivateLinkResource, err error)
- func (client SharedPrivateLinkResourcesClient) CreateOrUpdateSender(req *http.Request) (future SharedPrivateLinkResourcesCreateOrUpdateFuture, err error)
- func (client SharedPrivateLinkResourcesClient) Delete(ctx context.Context, resourceGroupName string, searchServiceName string, ...) (result SharedPrivateLinkResourcesDeleteFuture, err error)
- func (client SharedPrivateLinkResourcesClient) DeletePreparer(ctx context.Context, resourceGroupName string, searchServiceName string, ...) (*http.Request, error)
- func (client SharedPrivateLinkResourcesClient) DeleteResponder(resp *http.Response) (result autorest.Response, err error)
- func (client SharedPrivateLinkResourcesClient) DeleteSender(req *http.Request) (future SharedPrivateLinkResourcesDeleteFuture, err error)
- func (client SharedPrivateLinkResourcesClient) Get(ctx context.Context, resourceGroupName string, searchServiceName string, ...) (result SharedPrivateLinkResource, err error)
- func (client SharedPrivateLinkResourcesClient) GetPreparer(ctx context.Context, resourceGroupName string, searchServiceName string, ...) (*http.Request, error)
- func (client SharedPrivateLinkResourcesClient) GetResponder(resp *http.Response) (result SharedPrivateLinkResource, err error)
- func (client SharedPrivateLinkResourcesClient) GetSender(req *http.Request) (*http.Response, error)
- func (client SharedPrivateLinkResourcesClient) ListByService(ctx context.Context, resourceGroupName string, searchServiceName string, ...) (result SharedPrivateLinkResourceListResultPage, err error)
- func (client SharedPrivateLinkResourcesClient) ListByServiceComplete(ctx context.Context, resourceGroupName string, searchServiceName string, ...) (result SharedPrivateLinkResourceListResultIterator, err error)
- func (client SharedPrivateLinkResourcesClient) ListByServicePreparer(ctx context.Context, resourceGroupName string, searchServiceName string, ...) (*http.Request, error)
- func (client SharedPrivateLinkResourcesClient) ListByServiceResponder(resp *http.Response) (result SharedPrivateLinkResourceListResult, err error)
- func (client SharedPrivateLinkResourcesClient) ListByServiceSender(req *http.Request) (*http.Response, error)
- type SharedPrivateLinkResourcesCreateOrUpdateFuture
- type SharedPrivateLinkResourcesDeleteFuture
- type Sku
- type SkuName
- type TrackedResource
- 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" )
func PossibleAdminKeyKindValues ¶
func PossibleAdminKeyKindValues() []AdminKeyKind
PossibleAdminKeyKindValues returns an array of possible values for the AdminKeyKind const type.
type AdminKeyResult ¶
type AdminKeyResult struct { autorest.Response `json:"-"` // PrimaryKey - READ-ONLY; The primary admin API key of the search service. PrimaryKey *string `json:"primaryKey,omitempty"` // SecondaryKey - READ-ONLY; 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 Cognitive Search service.
type AdminKeysClient ¶
type AdminKeysClient struct {
BaseClient
}
AdminKeysClient is the client that can be used to manage Azure Cognitive 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 using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).
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 Cognitive Search service. Parameters: resourceGroupName - 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 - the name of the Azure Cognitive Search service associated with the specified resource group. clientRequestID - 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. Parameters: resourceGroupName - 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 - the name of the Azure Cognitive Search service associated with the specified resource group. keyKind - specifies which key to regenerate. Valid values include 'primary' and 'secondary'. clientRequestID - 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 AsyncOperationResult ¶
type AsyncOperationResult struct { // Status - The current status of the long running asynchronous shared private link resource operation. Possible values include: 'SharedPrivateLinkResourceAsyncOperationResultRunning', 'SharedPrivateLinkResourceAsyncOperationResultSucceeded', 'SharedPrivateLinkResourceAsyncOperationResultFailed' Status SharedPrivateLinkResourceAsyncOperationResult `json:"status,omitempty"` }
AsyncOperationResult the details of a long running asynchronous shared private link resource operation
type AzureEntityResource ¶
type AzureEntityResource struct { // Etag - READ-ONLY; Resource Etag. Etag *string `json:"etag,omitempty"` // ID - READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} ID *string `json:"id,omitempty"` // Name - READ-ONLY; The name of the resource Name *string `json:"name,omitempty"` // Type - READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" Type *string `json:"type,omitempty"` }
AzureEntityResource the resource model definition for an Azure Resource Manager resource with an etag.
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 using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).
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 - READ-ONLY; A value indicating whether the name is available. IsNameAvailable *bool `json:"nameAvailable,omitempty"` // Reason - READ-ONLY; 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 - READ-ONLY; 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 - Describes a particular API error with an error code and a message. 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 programmatically 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" )
func PossibleHostingModeValues ¶
func PossibleHostingModeValues() []HostingMode
PossibleHostingModeValues returns an array of possible values for the HostingMode const type.
type IPRule ¶
type IPRule struct { // Value - Value corresponding to a single IPv4 address (eg., 123.1.2.3) or an IP range in CIDR format (eg., 123.1.2.3/24) to be allowed. Value *string `json:"value,omitempty"` }
IPRule the IP restriction rule of the Azure Cognitive Search service.
type Identity ¶
type Identity struct { // PrincipalID - READ-ONLY; The principal ID of resource identity. PrincipalID *string `json:"principalId,omitempty"` // TenantID - READ-ONLY; The tenant ID of resource. TenantID *string `json:"tenantId,omitempty"` // Type - The identity type. Possible values include: 'None', 'SystemAssigned' Type IdentityType `json:"type,omitempty"` }
Identity identity for the resource.
func (Identity) MarshalJSON ¶
MarshalJSON is the custom marshaler for Identity.
type IdentityType ¶
type IdentityType string
IdentityType enumerates the values for identity type.
const ( // None ... None IdentityType = "None" // SystemAssigned ... SystemAssigned IdentityType = "SystemAssigned" )
func PossibleIdentityTypeValues ¶
func PossibleIdentityTypeValues() []IdentityType
PossibleIdentityTypeValues returns an array of possible values for the IdentityType const type.
type ListQueryKeysResult ¶
type ListQueryKeysResult struct { autorest.Response `json:"-"` // Value - READ-ONLY; The query keys for the Azure Cognitive Search service. Value *[]QueryKey `json:"value,omitempty"` // NextLink - READ-ONLY; Request URL that can be used to query next page of query keys. Returned when the total number of requested query keys exceed maximum page size. NextLink *string `json:"nextLink,omitempty"` }
ListQueryKeysResult response containing the query API keys for a given Azure Cognitive Search service.
func (ListQueryKeysResult) IsEmpty ¶
func (lqkr ListQueryKeysResult) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
type ListQueryKeysResultIterator ¶
type ListQueryKeysResultIterator struct {
// contains filtered or unexported fields
}
ListQueryKeysResultIterator provides access to a complete listing of QueryKey values.
func NewListQueryKeysResultIterator ¶
func NewListQueryKeysResultIterator(page ListQueryKeysResultPage) ListQueryKeysResultIterator
Creates a new instance of the ListQueryKeysResultIterator type.
func (*ListQueryKeysResultIterator) Next ¶
func (iter *ListQueryKeysResultIterator) Next() error
Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (*ListQueryKeysResultIterator) NextWithContext ¶
func (iter *ListQueryKeysResultIterator) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.
func (ListQueryKeysResultIterator) NotDone ¶
func (iter ListQueryKeysResultIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (ListQueryKeysResultIterator) Response ¶
func (iter ListQueryKeysResultIterator) Response() ListQueryKeysResult
Response returns the raw server response from the last page request.
func (ListQueryKeysResultIterator) Value ¶
func (iter ListQueryKeysResultIterator) Value() QueryKey
Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.
type ListQueryKeysResultPage ¶
type ListQueryKeysResultPage struct {
// contains filtered or unexported fields
}
ListQueryKeysResultPage contains a page of QueryKey values.
func NewListQueryKeysResultPage ¶
func NewListQueryKeysResultPage(cur ListQueryKeysResult, getNextPage func(context.Context, ListQueryKeysResult) (ListQueryKeysResult, error)) ListQueryKeysResultPage
Creates a new instance of the ListQueryKeysResultPage type.
func (*ListQueryKeysResultPage) Next ¶
func (page *ListQueryKeysResultPage) Next() error
Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (*ListQueryKeysResultPage) NextWithContext ¶
func (page *ListQueryKeysResultPage) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.
func (ListQueryKeysResultPage) NotDone ¶
func (page ListQueryKeysResultPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (ListQueryKeysResultPage) Response ¶
func (page ListQueryKeysResultPage) Response() ListQueryKeysResult
Response returns the raw server response from the last page request.
func (ListQueryKeysResultPage) Values ¶
func (page ListQueryKeysResultPage) Values() []QueryKey
Values returns the slice of values for the current page or nil if there are no values.
type NetworkRuleSet ¶
type NetworkRuleSet struct { // IPRules - A list of IP restriction rules that defines the inbound network(s) with allowing access to the search service endpoint. At the meantime, all other public IP networks are blocked by the firewall. These restriction rules are applied only when the 'publicNetworkAccess' of the search service is 'enabled'; otherwise, traffic over public interface is not allowed even with any public IP rules, and private endpoint connections would be the exclusive access method. IPRules *[]IPRule `json:"ipRules,omitempty"` }
NetworkRuleSet network specific rules that determine how the Azure Cognitive Search service may be reached.
type Operation ¶
type Operation struct { // Name - READ-ONLY; The name of the operation. This name is of the form {provider}/{resource}/{operation}. Name *string `json:"name,omitempty"` // Display - READ-ONLY; The object that describes the operation. Display *OperationDisplay `json:"display,omitempty"` }
Operation describes a REST API operation.
type OperationDisplay ¶
type OperationDisplay struct { // Provider - READ-ONLY; The friendly name of the resource provider. Provider *string `json:"provider,omitempty"` // Operation - READ-ONLY; The operation type: read, write, delete, listKeys/action, etc. Operation *string `json:"operation,omitempty"` // Resource - READ-ONLY; The resource type on which the operation is performed. Resource *string `json:"resource,omitempty"` // Description - READ-ONLY; The friendly name of the operation. Description *string `json:"description,omitempty"` }
OperationDisplay the object that describes the operation.
type OperationListResult ¶
type OperationListResult struct { autorest.Response `json:"-"` // Value - READ-ONLY; The list of operations supported by the resource provider. Value *[]Operation `json:"value,omitempty"` // NextLink - READ-ONLY; The URL to get the next set of operation list results, if any. NextLink *string `json:"nextLink,omitempty"` }
OperationListResult the result of the request to list REST API operations. It contains a list of operations and a URL to get the next set of results.
type OperationsClient ¶
type OperationsClient struct {
BaseClient
}
OperationsClient is the client that can be used to manage Azure Cognitive Search services and API keys.
func NewOperationsClient ¶
func NewOperationsClient(subscriptionID string) OperationsClient
NewOperationsClient creates an instance of the OperationsClient client.
func NewOperationsClientWithBaseURI ¶
func NewOperationsClientWithBaseURI(baseURI string, subscriptionID string) OperationsClient
NewOperationsClientWithBaseURI creates an instance of the OperationsClient 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 (OperationsClient) List ¶
func (client OperationsClient) List(ctx context.Context) (result OperationListResult, err error)
List lists all of the available REST API operations of the Microsoft.Search provider.
func (OperationsClient) ListPreparer ¶
ListPreparer prepares the List request.
func (OperationsClient) ListResponder ¶
func (client OperationsClient) ListResponder(resp *http.Response) (result OperationListResult, err error)
ListResponder handles the response to the List request. The method always closes the http.Response Body.
func (OperationsClient) ListSender ¶
ListSender sends the List request. The method will close the http.Response Body if it receives an error.
type PrivateEndpointConnection ¶
type PrivateEndpointConnection struct { autorest.Response `json:"-"` // Properties - Describes the properties of an existing Private Endpoint connection to the Azure Cognitive Search service. Properties *PrivateEndpointConnectionProperties `json:"properties,omitempty"` // ID - READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} ID *string `json:"id,omitempty"` // Name - READ-ONLY; The name of the resource Name *string `json:"name,omitempty"` // Type - READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" Type *string `json:"type,omitempty"` }
PrivateEndpointConnection describes an existing Private Endpoint connection to the Azure Cognitive Search service.
func (PrivateEndpointConnection) MarshalJSON ¶
func (pec PrivateEndpointConnection) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for PrivateEndpointConnection.
type PrivateEndpointConnectionListResult ¶
type PrivateEndpointConnectionListResult struct { autorest.Response `json:"-"` // Value - READ-ONLY; The list of Private Endpoint connections. Value *[]PrivateEndpointConnection `json:"value,omitempty"` // NextLink - READ-ONLY; Request URL that can be used to query next page of private endpoint connections. Returned when the total number of requested private endpoint connections exceed maximum page size. NextLink *string `json:"nextLink,omitempty"` }
PrivateEndpointConnectionListResult response containing a list of Private Endpoint connections.
func (PrivateEndpointConnectionListResult) IsEmpty ¶
func (peclr PrivateEndpointConnectionListResult) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
type PrivateEndpointConnectionListResultIterator ¶
type PrivateEndpointConnectionListResultIterator struct {
// contains filtered or unexported fields
}
PrivateEndpointConnectionListResultIterator provides access to a complete listing of PrivateEndpointConnection values.
func NewPrivateEndpointConnectionListResultIterator ¶
func NewPrivateEndpointConnectionListResultIterator(page PrivateEndpointConnectionListResultPage) PrivateEndpointConnectionListResultIterator
Creates a new instance of the PrivateEndpointConnectionListResultIterator type.
func (*PrivateEndpointConnectionListResultIterator) Next ¶
func (iter *PrivateEndpointConnectionListResultIterator) Next() error
Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (*PrivateEndpointConnectionListResultIterator) NextWithContext ¶
func (iter *PrivateEndpointConnectionListResultIterator) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.
func (PrivateEndpointConnectionListResultIterator) NotDone ¶
func (iter PrivateEndpointConnectionListResultIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (PrivateEndpointConnectionListResultIterator) Response ¶
func (iter PrivateEndpointConnectionListResultIterator) Response() PrivateEndpointConnectionListResult
Response returns the raw server response from the last page request.
func (PrivateEndpointConnectionListResultIterator) Value ¶
func (iter PrivateEndpointConnectionListResultIterator) Value() PrivateEndpointConnection
Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.
type PrivateEndpointConnectionListResultPage ¶
type PrivateEndpointConnectionListResultPage struct {
// contains filtered or unexported fields
}
PrivateEndpointConnectionListResultPage contains a page of PrivateEndpointConnection values.
func NewPrivateEndpointConnectionListResultPage ¶
func NewPrivateEndpointConnectionListResultPage(cur PrivateEndpointConnectionListResult, getNextPage func(context.Context, PrivateEndpointConnectionListResult) (PrivateEndpointConnectionListResult, error)) PrivateEndpointConnectionListResultPage
Creates a new instance of the PrivateEndpointConnectionListResultPage type.
func (*PrivateEndpointConnectionListResultPage) Next ¶
func (page *PrivateEndpointConnectionListResultPage) Next() error
Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (*PrivateEndpointConnectionListResultPage) NextWithContext ¶
func (page *PrivateEndpointConnectionListResultPage) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.
func (PrivateEndpointConnectionListResultPage) NotDone ¶
func (page PrivateEndpointConnectionListResultPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (PrivateEndpointConnectionListResultPage) Response ¶
func (page PrivateEndpointConnectionListResultPage) Response() PrivateEndpointConnectionListResult
Response returns the raw server response from the last page request.
func (PrivateEndpointConnectionListResultPage) Values ¶
func (page PrivateEndpointConnectionListResultPage) Values() []PrivateEndpointConnection
Values returns the slice of values for the current page or nil if there are no values.
type PrivateEndpointConnectionProperties ¶
type PrivateEndpointConnectionProperties struct { // PrivateEndpoint - The private endpoint resource from Microsoft.Network provider. PrivateEndpoint *PrivateEndpointConnectionPropertiesPrivateEndpoint `json:"privateEndpoint,omitempty"` // PrivateLinkServiceConnectionState - Describes the current state of an existing Private Link Service connection to the Azure Private Endpoint. PrivateLinkServiceConnectionState *PrivateEndpointConnectionPropertiesPrivateLinkServiceConnectionState `json:"privateLinkServiceConnectionState,omitempty"` }
PrivateEndpointConnectionProperties describes the properties of an existing Private Endpoint connection to the Azure Cognitive Search service.
type PrivateEndpointConnectionPropertiesPrivateEndpoint ¶
type PrivateEndpointConnectionPropertiesPrivateEndpoint struct { // ID - The resource id of the private endpoint resource from Microsoft.Network provider. ID *string `json:"id,omitempty"` }
PrivateEndpointConnectionPropertiesPrivateEndpoint the private endpoint resource from Microsoft.Network provider.
type PrivateEndpointConnectionPropertiesPrivateLinkServiceConnectionState ¶
type PrivateEndpointConnectionPropertiesPrivateLinkServiceConnectionState struct { // Status - Status of the the private link service connection. Can be Pending, Approved, Rejected, or Disconnected. Possible values include: 'Pending', 'Approved', 'Rejected', 'Disconnected' Status PrivateLinkServiceConnectionStatus `json:"status,omitempty"` // Description - The description for the private link service connection state. Description *string `json:"description,omitempty"` // ActionsRequired - A description of any extra actions that may be required. ActionsRequired *string `json:"actionsRequired,omitempty"` }
PrivateEndpointConnectionPropertiesPrivateLinkServiceConnectionState describes the current state of an existing Private Link Service connection to the Azure Private Endpoint.
type PrivateEndpointConnectionsClient ¶
type PrivateEndpointConnectionsClient struct {
BaseClient
}
PrivateEndpointConnectionsClient is the client that can be used to manage Azure Cognitive Search services and API keys.
func NewPrivateEndpointConnectionsClient ¶
func NewPrivateEndpointConnectionsClient(subscriptionID string) PrivateEndpointConnectionsClient
NewPrivateEndpointConnectionsClient creates an instance of the PrivateEndpointConnectionsClient client.
func NewPrivateEndpointConnectionsClientWithBaseURI ¶
func NewPrivateEndpointConnectionsClientWithBaseURI(baseURI string, subscriptionID string) PrivateEndpointConnectionsClient
NewPrivateEndpointConnectionsClientWithBaseURI creates an instance of the PrivateEndpointConnectionsClient 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 (PrivateEndpointConnectionsClient) Delete ¶
func (client PrivateEndpointConnectionsClient) Delete(ctx context.Context, resourceGroupName string, searchServiceName string, privateEndpointConnectionName string, clientRequestID *uuid.UUID) (result PrivateEndpointConnection, err error)
Delete disconnects the private endpoint connection and deletes it from the search service. Parameters: resourceGroupName - 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 - the name of the Azure Cognitive Search service associated with the specified resource group. privateEndpointConnectionName - the name of the private endpoint connection to the Azure Cognitive Search service with the specified resource group. clientRequestID - 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 (PrivateEndpointConnectionsClient) DeletePreparer ¶
func (client PrivateEndpointConnectionsClient) DeletePreparer(ctx context.Context, resourceGroupName string, searchServiceName string, privateEndpointConnectionName string, clientRequestID *uuid.UUID) (*http.Request, error)
DeletePreparer prepares the Delete request.
func (PrivateEndpointConnectionsClient) DeleteResponder ¶
func (client PrivateEndpointConnectionsClient) DeleteResponder(resp *http.Response) (result PrivateEndpointConnection, err error)
DeleteResponder handles the response to the Delete request. The method always closes the http.Response Body.
func (PrivateEndpointConnectionsClient) DeleteSender ¶
func (client PrivateEndpointConnectionsClient) DeleteSender(req *http.Request) (*http.Response, error)
DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.
func (PrivateEndpointConnectionsClient) Get ¶
func (client PrivateEndpointConnectionsClient) Get(ctx context.Context, resourceGroupName string, searchServiceName string, privateEndpointConnectionName string, clientRequestID *uuid.UUID) (result PrivateEndpointConnection, err error)
Get gets the details of the private endpoint connection to the search service in the given resource group. Parameters: resourceGroupName - 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 - the name of the Azure Cognitive Search service associated with the specified resource group. privateEndpointConnectionName - the name of the private endpoint connection to the Azure Cognitive Search service with the specified resource group. clientRequestID - 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 (PrivateEndpointConnectionsClient) GetPreparer ¶
func (client PrivateEndpointConnectionsClient) GetPreparer(ctx context.Context, resourceGroupName string, searchServiceName string, privateEndpointConnectionName string, clientRequestID *uuid.UUID) (*http.Request, error)
GetPreparer prepares the Get request.
func (PrivateEndpointConnectionsClient) GetResponder ¶
func (client PrivateEndpointConnectionsClient) GetResponder(resp *http.Response) (result PrivateEndpointConnection, err error)
GetResponder handles the response to the Get request. The method always closes the http.Response Body.
func (PrivateEndpointConnectionsClient) GetSender ¶
GetSender sends the Get request. The method will close the http.Response Body if it receives an error.
func (PrivateEndpointConnectionsClient) ListByService ¶
func (client PrivateEndpointConnectionsClient) ListByService(ctx context.Context, resourceGroupName string, searchServiceName string, clientRequestID *uuid.UUID) (result PrivateEndpointConnectionListResultPage, err error)
ListByService gets a list of all private endpoint connections in the given service. Parameters: resourceGroupName - 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 - the name of the Azure Cognitive Search service associated with the specified resource group. clientRequestID - 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 (PrivateEndpointConnectionsClient) ListByServiceComplete ¶
func (client PrivateEndpointConnectionsClient) ListByServiceComplete(ctx context.Context, resourceGroupName string, searchServiceName string, clientRequestID *uuid.UUID) (result PrivateEndpointConnectionListResultIterator, err error)
ListByServiceComplete enumerates all values, automatically crossing page boundaries as required.
func (PrivateEndpointConnectionsClient) ListByServicePreparer ¶
func (client PrivateEndpointConnectionsClient) ListByServicePreparer(ctx context.Context, resourceGroupName string, searchServiceName string, clientRequestID *uuid.UUID) (*http.Request, error)
ListByServicePreparer prepares the ListByService request.
func (PrivateEndpointConnectionsClient) ListByServiceResponder ¶
func (client PrivateEndpointConnectionsClient) ListByServiceResponder(resp *http.Response) (result PrivateEndpointConnectionListResult, err error)
ListByServiceResponder handles the response to the ListByService request. The method always closes the http.Response Body.
func (PrivateEndpointConnectionsClient) ListByServiceSender ¶
func (client PrivateEndpointConnectionsClient) ListByServiceSender(req *http.Request) (*http.Response, error)
ListByServiceSender sends the ListByService request. The method will close the http.Response Body if it receives an error.
func (PrivateEndpointConnectionsClient) Update ¶
func (client PrivateEndpointConnectionsClient) Update(ctx context.Context, resourceGroupName string, searchServiceName string, privateEndpointConnectionName string, privateEndpointConnection PrivateEndpointConnection, clientRequestID *uuid.UUID) (result PrivateEndpointConnection, err error)
Update updates a Private Endpoint connection to the search service in the given resource group. Parameters: resourceGroupName - 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 - the name of the Azure Cognitive Search service associated with the specified resource group. privateEndpointConnectionName - the name of the private endpoint connection to the Azure Cognitive Search service with the specified resource group. privateEndpointConnection - the definition of the private endpoint connection to update. clientRequestID - 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 (PrivateEndpointConnectionsClient) UpdatePreparer ¶
func (client PrivateEndpointConnectionsClient) UpdatePreparer(ctx context.Context, resourceGroupName string, searchServiceName string, privateEndpointConnectionName string, privateEndpointConnection PrivateEndpointConnection, clientRequestID *uuid.UUID) (*http.Request, error)
UpdatePreparer prepares the Update request.
func (PrivateEndpointConnectionsClient) UpdateResponder ¶
func (client PrivateEndpointConnectionsClient) UpdateResponder(resp *http.Response) (result PrivateEndpointConnection, err error)
UpdateResponder handles the response to the Update request. The method always closes the http.Response Body.
func (PrivateEndpointConnectionsClient) UpdateSender ¶
func (client PrivateEndpointConnectionsClient) UpdateSender(req *http.Request) (*http.Response, error)
UpdateSender sends the Update request. The method will close the http.Response Body if it receives an error.
type PrivateLinkResource ¶
type PrivateLinkResource struct { // Properties - READ-ONLY; Describes the properties of a supported private link resource for the Azure Cognitive Search service. Properties *PrivateLinkResourceProperties `json:"properties,omitempty"` // ID - READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} ID *string `json:"id,omitempty"` // Name - READ-ONLY; The name of the resource Name *string `json:"name,omitempty"` // Type - READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" Type *string `json:"type,omitempty"` }
PrivateLinkResource describes a supported private link resource for the Azure Cognitive Search service.
type PrivateLinkResourceProperties ¶
type PrivateLinkResourceProperties struct { // GroupID - READ-ONLY; The group ID of the private link resource. GroupID *string `json:"groupId,omitempty"` // RequiredMembers - READ-ONLY; The list of required members of the private link resource. RequiredMembers *[]string `json:"requiredMembers,omitempty"` // RequiredZoneNames - READ-ONLY; The list of required DNS zone names of the private link resource. RequiredZoneNames *[]string `json:"requiredZoneNames,omitempty"` ShareablePrivateLinkResourceTypes *[]ShareablePrivateLinkResourceType `json:"shareablePrivateLinkResourceTypes,omitempty"` }
PrivateLinkResourceProperties describes the properties of a supported private link resource for the Azure Cognitive Search service. For a given API version, this represents the 'supported' groupIds when creating a shared private link resource.
type PrivateLinkResourcesClient ¶
type PrivateLinkResourcesClient struct {
BaseClient
}
PrivateLinkResourcesClient is the client that can be used to manage Azure Cognitive Search services and API keys.
func NewPrivateLinkResourcesClient ¶
func NewPrivateLinkResourcesClient(subscriptionID string) PrivateLinkResourcesClient
NewPrivateLinkResourcesClient creates an instance of the PrivateLinkResourcesClient client.
func NewPrivateLinkResourcesClientWithBaseURI ¶
func NewPrivateLinkResourcesClientWithBaseURI(baseURI string, subscriptionID string) PrivateLinkResourcesClient
NewPrivateLinkResourcesClientWithBaseURI creates an instance of the PrivateLinkResourcesClient 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 (PrivateLinkResourcesClient) ListSupported ¶
func (client PrivateLinkResourcesClient) ListSupported(ctx context.Context, resourceGroupName string, searchServiceName string, clientRequestID *uuid.UUID) (result PrivateLinkResourcesResult, err error)
ListSupported gets a list of all supported private link resource types for the given service. Parameters: resourceGroupName - 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 - the name of the Azure Cognitive Search service associated with the specified resource group. clientRequestID - 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 (PrivateLinkResourcesClient) ListSupportedPreparer ¶
func (client PrivateLinkResourcesClient) ListSupportedPreparer(ctx context.Context, resourceGroupName string, searchServiceName string, clientRequestID *uuid.UUID) (*http.Request, error)
ListSupportedPreparer prepares the ListSupported request.
func (PrivateLinkResourcesClient) ListSupportedResponder ¶
func (client PrivateLinkResourcesClient) ListSupportedResponder(resp *http.Response) (result PrivateLinkResourcesResult, err error)
ListSupportedResponder handles the response to the ListSupported request. The method always closes the http.Response Body.
func (PrivateLinkResourcesClient) ListSupportedSender ¶
func (client PrivateLinkResourcesClient) ListSupportedSender(req *http.Request) (*http.Response, error)
ListSupportedSender sends the ListSupported request. The method will close the http.Response Body if it receives an error.
type PrivateLinkResourcesResult ¶
type PrivateLinkResourcesResult struct { autorest.Response `json:"-"` // Value - READ-ONLY; The list of supported Private Link Resources. Value *[]PrivateLinkResource `json:"value,omitempty"` }
PrivateLinkResourcesResult response containing a list of supported Private Link Resources.
type PrivateLinkServiceConnectionStatus ¶
type PrivateLinkServiceConnectionStatus string
PrivateLinkServiceConnectionStatus enumerates the values for private link service connection status.
const ( // Approved ... Approved PrivateLinkServiceConnectionStatus = "Approved" // Disconnected ... Disconnected PrivateLinkServiceConnectionStatus = "Disconnected" // Pending ... Pending PrivateLinkServiceConnectionStatus = "Pending" // Rejected ... Rejected PrivateLinkServiceConnectionStatus = "Rejected" )
func PossiblePrivateLinkServiceConnectionStatusValues ¶
func PossiblePrivateLinkServiceConnectionStatusValues() []PrivateLinkServiceConnectionStatus
PossiblePrivateLinkServiceConnectionStatusValues returns an array of possible values for the PrivateLinkServiceConnectionStatus const type.
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" )
func PossibleProvisioningStateValues ¶
func PossibleProvisioningStateValues() []ProvisioningState
PossibleProvisioningStateValues returns an array of possible values for the ProvisioningState const type.
type ProxyResource ¶
type ProxyResource struct { // ID - READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} ID *string `json:"id,omitempty"` // Name - READ-ONLY; The name of the resource Name *string `json:"name,omitempty"` // Type - READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" Type *string `json:"type,omitempty"` }
ProxyResource the resource model definition for an Azure Resource Manager proxy resource. It will have everything other than required location and tags
type PublicNetworkAccess ¶
type PublicNetworkAccess string
PublicNetworkAccess enumerates the values for public network access.
const ( // Disabled ... Disabled PublicNetworkAccess = "disabled" // Enabled ... Enabled PublicNetworkAccess = "enabled" )
func PossiblePublicNetworkAccessValues ¶
func PossiblePublicNetworkAccessValues() []PublicNetworkAccess
PossiblePublicNetworkAccessValues returns an array of possible values for the PublicNetworkAccess const type.
type QueryKey ¶
type QueryKey struct { autorest.Response `json:"-"` // 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 Cognitive 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 Cognitive 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 using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).
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. Parameters: resourceGroupName - 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 - the name of the Azure Cognitive Search service associated with the specified resource group. name - the name of the new query API key. clientRequestID - 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. Parameters: resourceGroupName - 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 - the name of the Azure Cognitive Search service associated with the specified resource group. key - the query key to be deleted. Query keys are identified by value, not by name. clientRequestID - 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 ListQueryKeysResultPage, err error)
ListBySearchService returns the list of query API keys for the given Azure Cognitive Search service. Parameters: resourceGroupName - 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 - the name of the Azure Cognitive Search service associated with the specified resource group. clientRequestID - 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) ListBySearchServiceComplete ¶
func (client QueryKeysClient) ListBySearchServiceComplete(ctx context.Context, resourceGroupName string, searchServiceName string, clientRequestID *uuid.UUID) (result ListQueryKeysResultIterator, err error)
ListBySearchServiceComplete enumerates all values, automatically crossing page boundaries as required.
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 - READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} ID *string `json:"id,omitempty"` // Name - READ-ONLY; The name of the resource Name *string `json:"name,omitempty"` // Type - READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" Type *string `json:"type,omitempty"` }
Resource common fields that are returned in the response for all Azure Resource Manager resources
type Service ¶
type Service struct { autorest.Response `json:"-"` // ServiceProperties - Properties of the search service. *ServiceProperties `json:"properties,omitempty"` // Sku - The SKU of the Search Service, which determines price tier and capacity limits. This property is required when creating a new Search Service. Sku *Sku `json:"sku,omitempty"` // Identity - The identity of the resource. Identity *Identity `json:"identity,omitempty"` // Tags - Resource tags. Tags map[string]*string `json:"tags"` // Location - The geo-location where the resource lives Location *string `json:"location,omitempty"` // ID - READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} ID *string `json:"id,omitempty"` // Name - READ-ONLY; The name of the resource Name *string `json:"name,omitempty"` // Type - READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" Type *string `json:"type,omitempty"` }
Service describes an Azure Cognitive Search service and its current state.
func (Service) MarshalJSON ¶
MarshalJSON is the custom marshaler for Service.
func (*Service) UnmarshalJSON ¶
UnmarshalJSON is the custom unmarshaler for Service struct.
type ServiceListResult ¶
type ServiceListResult struct { autorest.Response `json:"-"` // Value - READ-ONLY; The list of search services. Value *[]Service `json:"value,omitempty"` // NextLink - READ-ONLY; Request URL that can be used to query next page of search services. Returned when the total number of requested search services exceed maximum page size. NextLink *string `json:"nextLink,omitempty"` }
ServiceListResult response containing a list of Azure Cognitive Search services.
func (ServiceListResult) IsEmpty ¶
func (slr ServiceListResult) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
type ServiceListResultIterator ¶
type ServiceListResultIterator struct {
// contains filtered or unexported fields
}
ServiceListResultIterator provides access to a complete listing of Service values.
func NewServiceListResultIterator ¶
func NewServiceListResultIterator(page ServiceListResultPage) ServiceListResultIterator
Creates a new instance of the ServiceListResultIterator type.
func (*ServiceListResultIterator) Next ¶
func (iter *ServiceListResultIterator) Next() error
Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (*ServiceListResultIterator) NextWithContext ¶
func (iter *ServiceListResultIterator) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.
func (ServiceListResultIterator) NotDone ¶
func (iter ServiceListResultIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (ServiceListResultIterator) Response ¶
func (iter ServiceListResultIterator) Response() ServiceListResult
Response returns the raw server response from the last page request.
func (ServiceListResultIterator) Value ¶
func (iter ServiceListResultIterator) Value() Service
Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.
type ServiceListResultPage ¶
type ServiceListResultPage struct {
// contains filtered or unexported fields
}
ServiceListResultPage contains a page of Service values.
func NewServiceListResultPage ¶
func NewServiceListResultPage(cur ServiceListResult, getNextPage func(context.Context, ServiceListResult) (ServiceListResult, error)) ServiceListResultPage
Creates a new instance of the ServiceListResultPage type.
func (*ServiceListResultPage) Next ¶
func (page *ServiceListResultPage) Next() error
Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (*ServiceListResultPage) NextWithContext ¶
func (page *ServiceListResultPage) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.
func (ServiceListResultPage) NotDone ¶
func (page ServiceListResultPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (ServiceListResultPage) Response ¶
func (page ServiceListResultPage) Response() ServiceListResult
Response returns the raw server response from the last page request.
func (ServiceListResultPage) Values ¶
func (page ServiceListResultPage) Values() []Service
Values returns the slice of values for the current page or nil if there are no values.
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"` // PublicNetworkAccess - This value can be set to 'enabled' to avoid breaking changes on existing customer resources and templates. If set to 'disabled', traffic over public interface is not allowed, and private endpoint connections would be the exclusive access method. Possible values include: 'Enabled', 'Disabled' PublicNetworkAccess PublicNetworkAccess `json:"publicNetworkAccess,omitempty"` // Status - READ-ONLY; 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 Cognitive 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 - 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. 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"` // NetworkRuleSet - Network specific rules that determine how the Azure Cognitive Search service may be reached. NetworkRuleSet *NetworkRuleSet `json:"networkRuleSet,omitempty"` // PrivateEndpointConnections - READ-ONLY; The list of private endpoint connections to the Azure Cognitive Search service. PrivateEndpointConnections *[]PrivateEndpointConnection `json:"privateEndpointConnections,omitempty"` SharedPrivateLinkResources *[]SharedPrivateLinkResource `json:"sharedPrivateLinkResources,omitempty"` }
ServiceProperties properties of the search service.
func (ServiceProperties) MarshalJSON ¶
func (sp ServiceProperties) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for ServiceProperties.
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" )
func PossibleServiceStatusValues ¶
func PossibleServiceStatusValues() []ServiceStatus
PossibleServiceStatusValues returns an array of possible values for the ServiceStatus const type.
type ServiceUpdate ¶
type ServiceUpdate struct { // ServiceProperties - Properties of the search service. *ServiceProperties `json:"properties,omitempty"` // Sku - The SKU of the Search Service, which determines price tier and capacity limits. This property is required when creating a new Search Service. Sku *Sku `json:"sku,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). This property is required when creating a new resource. Location *string `json:"location,omitempty"` // Tags - Tags to help categorize the resource in the Azure portal. Tags map[string]*string `json:"tags"` // Identity - The identity of the resource. Identity *Identity `json:"identity,omitempty"` // ID - READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} ID *string `json:"id,omitempty"` // Name - READ-ONLY; The name of the resource Name *string `json:"name,omitempty"` // Type - READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" Type *string `json:"type,omitempty"` }
ServiceUpdate the parameters used to update an Azure Cognitive Search service.
func (ServiceUpdate) MarshalJSON ¶
func (su ServiceUpdate) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for ServiceUpdate.
func (*ServiceUpdate) UnmarshalJSON ¶
func (su *ServiceUpdate) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for ServiceUpdate struct.
type ServicesClient ¶
type ServicesClient struct {
BaseClient
}
ServicesClient is the client that can be used to manage Azure Cognitive 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 using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).
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). Parameters: checkNameAvailabilityInput - the resource name and type to check. clientRequestID - 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. Parameters: resourceGroupName - 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 - the name of the Azure Cognitive 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 - the definition of the search service to create or update. clientRequestID - 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. Parameters: resourceGroupName - 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 - the name of the Azure Cognitive Search service associated with the specified resource group. clientRequestID - 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. Parameters: resourceGroupName - 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 - the name of the Azure Cognitive Search service associated with the specified resource group. clientRequestID - 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 ServiceListResultPage, err error)
ListByResourceGroup gets a list of all search services in the given resource group. Parameters: resourceGroupName - 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 - 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) ListByResourceGroupComplete ¶
func (client ServicesClient) ListByResourceGroupComplete(ctx context.Context, resourceGroupName string, clientRequestID *uuid.UUID) (result ServiceListResultIterator, err error)
ListByResourceGroupComplete enumerates all values, automatically crossing page boundaries as required.
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.
func (ServicesClient) ListBySubscription ¶
func (client ServicesClient) ListBySubscription(ctx context.Context, clientRequestID *uuid.UUID) (result ServiceListResultPage, err error)
ListBySubscription gets a list of all search services in the given subscription. Parameters: clientRequestID - 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) ListBySubscriptionComplete ¶
func (client ServicesClient) ListBySubscriptionComplete(ctx context.Context, clientRequestID *uuid.UUID) (result ServiceListResultIterator, err error)
ListBySubscriptionComplete enumerates all values, automatically crossing page boundaries as required.
func (ServicesClient) ListBySubscriptionPreparer ¶
func (client ServicesClient) ListBySubscriptionPreparer(ctx context.Context, clientRequestID *uuid.UUID) (*http.Request, error)
ListBySubscriptionPreparer prepares the ListBySubscription request.
func (ServicesClient) ListBySubscriptionResponder ¶
func (client ServicesClient) ListBySubscriptionResponder(resp *http.Response) (result ServiceListResult, err error)
ListBySubscriptionResponder handles the response to the ListBySubscription request. The method always closes the http.Response Body.
func (ServicesClient) ListBySubscriptionSender ¶
ListBySubscriptionSender sends the ListBySubscription request. The method will close the http.Response Body if it receives an error.
func (ServicesClient) Update ¶
func (client ServicesClient) Update(ctx context.Context, resourceGroupName string, searchServiceName string, service ServiceUpdate, clientRequestID *uuid.UUID) (result Service, err error)
Update updates an existing search service in the given resource group. Parameters: resourceGroupName - 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 - the name of the Azure Cognitive Search service to update. service - the definition of the search service to update. clientRequestID - 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) UpdatePreparer ¶
func (client ServicesClient) UpdatePreparer(ctx context.Context, resourceGroupName string, searchServiceName string, service ServiceUpdate, clientRequestID *uuid.UUID) (*http.Request, error)
UpdatePreparer prepares the Update request.
func (ServicesClient) UpdateResponder ¶
func (client ServicesClient) UpdateResponder(resp *http.Response) (result Service, err error)
UpdateResponder handles the response to the Update request. The method always closes the http.Response Body.
func (ServicesClient) UpdateSender ¶
UpdateSender sends the Update request. The method will close the http.Response Body if it receives an error.
type ServicesCreateOrUpdateFuture ¶
type ServicesCreateOrUpdateFuture struct { azure.FutureAPI // Result returns the result of the asynchronous operation. // If the operation has not completed it will return an error. Result func(ServicesClient) (Service, error) }
ServicesCreateOrUpdateFuture an abstraction for monitoring and retrieving the results of a long-running operation.
func (*ServicesCreateOrUpdateFuture) UnmarshalJSON ¶
func (future *ServicesCreateOrUpdateFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
type ShareablePrivateLinkResourceProperties ¶
type ShareablePrivateLinkResourceProperties struct { string `json:"type,omitempty"` GroupID *string `json:"groupId,omitempty"` Description *string `json:"description,omitempty"` }Type *
ShareablePrivateLinkResourceProperties describes the properties of a resource type that has been onboarded to private link service, supported by Azure Cognitive Search.
type ShareablePrivateLinkResourceType ¶
type ShareablePrivateLinkResourceType struct { string `json:"name,omitempty"` Properties *ShareablePrivateLinkResourceProperties `json:"properties,omitempty"` }Name *
ShareablePrivateLinkResourceType describes an resource type that has been onboarded to private link service, supported by Azure Cognitive Search.
type SharedPrivateLinkResource ¶
type SharedPrivateLinkResource struct { SharedPrivateLinkResourceProperties `json:"properties,omitempty"` ID *string `json:"id,omitempty"` Name *string `json:"name,omitempty"` Type *string `json:"type,omitempty"` }Properties *
SharedPrivateLinkResource describes a Shared Private Link Resource managed by the Azure Cognitive Search service.
func (SharedPrivateLinkResource) MarshalJSON ¶
func (splr SharedPrivateLinkResource) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for SharedPrivateLinkResource.
type SharedPrivateLinkResourceAsyncOperationResult ¶
type SharedPrivateLinkResourceAsyncOperationResult string
SharedPrivateLinkResourceAsyncOperationResult enumerates the values for shared private link resource async operation result.
const ( SharedPrivateLinkResourceAsyncOperationResult = "Failed" SharedPrivateLinkResourceAsyncOperationResultRunning SharedPrivateLinkResourceAsyncOperationResult = "Running" SharedPrivateLinkResourceAsyncOperationResultSucceeded SharedPrivateLinkResourceAsyncOperationResult = "Succeeded" )SharedPrivateLinkResourceAsyncOperationResultFailed
func PossibleSharedPrivateLinkResourceAsyncOperationResultValues ¶
func PossibleSharedPrivateLinkResourceAsyncOperationResultValues() []SharedPrivateLinkResourceAsyncOperationResult
PossibleSharedPrivateLinkResourceAsyncOperationResultValues returns an array of possible values for the SharedPrivateLinkResourceAsyncOperationResult const type.
type SharedPrivateLinkResourceListResult ¶
type SharedPrivateLinkResourceListResult struct { SharedPrivateLinkResource `json:"value,omitempty"` NextLink *string `json:"nextLink,omitempty"` }Value *[]
SharedPrivateLinkResourceListResult response containing a list of Shared Private Link Resources.
func (SharedPrivateLinkResourceListResult) IsEmpty ¶
func (splrlr SharedPrivateLinkResourceListResult) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
func (SharedPrivateLinkResourceListResult) MarshalJSON ¶
func (splrlr SharedPrivateLinkResourceListResult) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for SharedPrivateLinkResourceListResult.
type SharedPrivateLinkResourceListResultIterator ¶
type SharedPrivateLinkResourceListResultIterator struct {
// contains filtered or unexported fields
}
SharedPrivateLinkResourceListResultIterator provides access to a complete listing of SharedPrivateLinkResource values.
func NewSharedPrivateLinkResourceListResultIterator ¶
func NewSharedPrivateLinkResourceListResultIterator(page SharedPrivateLinkResourceListResultPage) SharedPrivateLinkResourceListResultIterator
Creates a new instance of the SharedPrivateLinkResourceListResultIterator type.
func (*SharedPrivateLinkResourceListResultIterator) Next ¶
func (iter *SharedPrivateLinkResourceListResultIterator) Next() error
Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (*SharedPrivateLinkResourceListResultIterator) NextWithContext ¶
func (iter *SharedPrivateLinkResourceListResultIterator) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.
func (SharedPrivateLinkResourceListResultIterator) NotDone ¶
func (iter SharedPrivateLinkResourceListResultIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (SharedPrivateLinkResourceListResultIterator) Response ¶
func (iter SharedPrivateLinkResourceListResultIterator) Response() SharedPrivateLinkResourceListResult
Response returns the raw server response from the last page request.
func (SharedPrivateLinkResourceListResultIterator) Value ¶
func (iter SharedPrivateLinkResourceListResultIterator) Value() SharedPrivateLinkResource
Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.
type SharedPrivateLinkResourceListResultPage ¶
type SharedPrivateLinkResourceListResultPage struct {
// contains filtered or unexported fields
}
SharedPrivateLinkResourceListResultPage contains a page of SharedPrivateLinkResource values.
func NewSharedPrivateLinkResourceListResultPage ¶
func NewSharedPrivateLinkResourceListResultPage(cur SharedPrivateLinkResourceListResult, getNextPage func(context.Context, SharedPrivateLinkResourceListResult) (SharedPrivateLinkResourceListResult, error)) SharedPrivateLinkResourceListResultPage
Creates a new instance of the SharedPrivateLinkResourceListResultPage type.
func (*SharedPrivateLinkResourceListResultPage) Next ¶
func (page *SharedPrivateLinkResourceListResultPage) Next() error
Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (*SharedPrivateLinkResourceListResultPage) NextWithContext ¶
func (page *SharedPrivateLinkResourceListResultPage) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.
func (SharedPrivateLinkResourceListResultPage) NotDone ¶
func (page SharedPrivateLinkResourceListResultPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (SharedPrivateLinkResourceListResultPage) Response ¶
func (page SharedPrivateLinkResourceListResultPage) Response() SharedPrivateLinkResourceListResult
Response returns the raw server response from the last page request.
func (SharedPrivateLinkResourceListResultPage) Values ¶
func (page SharedPrivateLinkResourceListResultPage) Values() []SharedPrivateLinkResource
Values returns the slice of values for the current page or nil if there are no values.
type SharedPrivateLinkResourceProperties ¶
type SharedPrivateLinkResourceProperties struct { string `json:"privateLinkResourceId,omitempty"` GroupID *string `json:"groupId,omitempty"` RequestMessage *string `json:"requestMessage,omitempty"` ResourceRegion *string `json:"resourceRegion,omitempty"` Status SharedPrivateLinkResourceStatus `json:"status,omitempty"` ProvisioningState SharedPrivateLinkResourceProvisioningState `json:"provisioningState,omitempty"` }PrivateLinkResourceID *
SharedPrivateLinkResourceProperties describes the properties of an existing Shared Private Link Resource managed by the Azure Cognitive Search service.
type SharedPrivateLinkResourceProvisioningState ¶
type SharedPrivateLinkResourceProvisioningState string
SharedPrivateLinkResourceProvisioningState enumerates the values for shared private link resource provisioning state.
const ( SharedPrivateLinkResourceProvisioningState = "Deleting" SharedPrivateLinkResourceProvisioningStateFailed SharedPrivateLinkResourceProvisioningState = "Failed" SharedPrivateLinkResourceProvisioningStateIncomplete SharedPrivateLinkResourceProvisioningState = "Incomplete" SharedPrivateLinkResourceProvisioningStateSucceeded SharedPrivateLinkResourceProvisioningState = "Succeeded" SharedPrivateLinkResourceProvisioningStateUpdating SharedPrivateLinkResourceProvisioningState = "Updating" )SharedPrivateLinkResourceProvisioningStateDeleting
func PossibleSharedPrivateLinkResourceProvisioningStateValues ¶
func PossibleSharedPrivateLinkResourceProvisioningStateValues() []SharedPrivateLinkResourceProvisioningState
PossibleSharedPrivateLinkResourceProvisioningStateValues returns an array of possible values for the SharedPrivateLinkResourceProvisioningState const type.
type SharedPrivateLinkResourceStatus ¶
type SharedPrivateLinkResourceStatus string
SharedPrivateLinkResourceStatus enumerates the values for shared private link resource status.
const ( SharedPrivateLinkResourceStatus = "Approved" SharedPrivateLinkResourceStatusDisconnected SharedPrivateLinkResourceStatus = "Disconnected" SharedPrivateLinkResourceStatusPending SharedPrivateLinkResourceStatus = "Pending" SharedPrivateLinkResourceStatusRejected SharedPrivateLinkResourceStatus = "Rejected" )SharedPrivateLinkResourceStatusApproved
func PossibleSharedPrivateLinkResourceStatusValues ¶
func PossibleSharedPrivateLinkResourceStatusValues() []SharedPrivateLinkResourceStatus
PossibleSharedPrivateLinkResourceStatusValues returns an array of possible values for the SharedPrivateLinkResourceStatus const type.
type SharedPrivateLinkResourcesClient ¶
type SharedPrivateLinkResourcesClient struct {
}SharedPrivateLinkResourcesClient is the client that can be used to manage Azure Cognitive Search services and API keys.
func NewSharedPrivateLinkResourcesClient ¶
func NewSharedPrivateLinkResourcesClient(subscriptionID string) SharedPrivateLinkResourcesClient
NewSharedPrivateLinkResourcesClient creates an instance of the SharedPrivateLinkResourcesClient client.
func NewSharedPrivateLinkResourcesClientWithBaseURI ¶
func NewSharedPrivateLinkResourcesClientWithBaseURI(baseURI string, subscriptionID string) SharedPrivateLinkResourcesClient
NewSharedPrivateLinkResourcesClientWithBaseURI creates an instance of the SharedPrivateLinkResourcesClient 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 (SharedPrivateLinkResourcesClient) CreateOrUpdate ¶
func (client SharedPrivateLinkResourcesClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, searchServiceName string, sharedPrivateLinkResourceName string, sharedPrivateLinkResource SharedPrivateLinkResource, clientRequestID *uuid.UUID) (result SharedPrivateLinkResourcesCreateOrUpdateFuture, err error)
CreateOrUpdate initiates the creation or update of a shared private link resource managed by the search service in the given resource group. Parameters: resourceGroupName - 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 - the name of the Azure Cognitive Search service associated with the specified resource group. sharedPrivateLinkResourceName - the name of the shared private link resource managed by the Azure Cognitive Search service within the specified resource group. sharedPrivateLinkResource - the definition of the shared private link resource to create or update. clientRequestID - 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 (SharedPrivateLinkResourcesClient) CreateOrUpdatePreparer ¶
func (client SharedPrivateLinkResourcesClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, searchServiceName string, sharedPrivateLinkResourceName string, sharedPrivateLinkResource SharedPrivateLinkResource, clientRequestID *uuid.UUID) (*http.Request, error)
CreateOrUpdatePreparer prepares the CreateOrUpdate request.
func (SharedPrivateLinkResourcesClient) CreateOrUpdateResponder ¶
func (client SharedPrivateLinkResourcesClient) CreateOrUpdateResponder(resp *http.Response) (result SharedPrivateLinkResource, err error)
CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.
func (SharedPrivateLinkResourcesClient) CreateOrUpdateSender ¶
func (client SharedPrivateLinkResourcesClient) CreateOrUpdateSender(req *http.Request) (future SharedPrivateLinkResourcesCreateOrUpdateFuture, err error)
CreateOrUpdateSender sends the CreateOrUpdate request. The method will close the http.Response Body if it receives an error.
func (SharedPrivateLinkResourcesClient) Delete ¶
func (client SharedPrivateLinkResourcesClient) Delete(ctx context.Context, resourceGroupName string, searchServiceName string, sharedPrivateLinkResourceName string, clientRequestID *uuid.UUID) (result SharedPrivateLinkResourcesDeleteFuture, err error)
Delete initiates the deletion of the shared private link resource from the search service. Parameters: resourceGroupName - 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 - the name of the Azure Cognitive Search service associated with the specified resource group. sharedPrivateLinkResourceName - the name of the shared private link resource managed by the Azure Cognitive Search service within the specified resource group. clientRequestID - 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 (SharedPrivateLinkResourcesClient) DeletePreparer ¶
func (client SharedPrivateLinkResourcesClient) DeletePreparer(ctx context.Context, resourceGroupName string, searchServiceName string, sharedPrivateLinkResourceName string, clientRequestID *uuid.UUID) (*http.Request, error)
DeletePreparer prepares the Delete request.
func (SharedPrivateLinkResourcesClient) DeleteResponder ¶
func (client SharedPrivateLinkResourcesClient) 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 (SharedPrivateLinkResourcesClient) DeleteSender ¶
func (client SharedPrivateLinkResourcesClient) DeleteSender(req *http.Request) (future SharedPrivateLinkResourcesDeleteFuture, err error)
DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.
func (SharedPrivateLinkResourcesClient) Get ¶
func (client SharedPrivateLinkResourcesClient) Get(ctx context.Context, resourceGroupName string, searchServiceName string, sharedPrivateLinkResourceName string, clientRequestID *uuid.UUID) (result SharedPrivateLinkResource, err error)
Get gets the details of the shared private link resource managed by the search service in the given resource group. Parameters: resourceGroupName - 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 - the name of the Azure Cognitive Search service associated with the specified resource group. sharedPrivateLinkResourceName - the name of the shared private link resource managed by the Azure Cognitive Search service within the specified resource group. clientRequestID - 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 (SharedPrivateLinkResourcesClient) GetPreparer ¶
func (client SharedPrivateLinkResourcesClient) GetPreparer(ctx context.Context, resourceGroupName string, searchServiceName string, sharedPrivateLinkResourceName string, clientRequestID *uuid.UUID) (*http.Request, error)
GetPreparer prepares the Get request.
func (SharedPrivateLinkResourcesClient) GetResponder ¶
func (client SharedPrivateLinkResourcesClient) GetResponder(resp *http.Response) (result SharedPrivateLinkResource, err error)
GetResponder handles the response to the Get request. The method always closes the http.Response Body.
func (SharedPrivateLinkResourcesClient) GetSender ¶
GetSender sends the Get request. The method will close the http.Response Body if it receives an error.
func (SharedPrivateLinkResourcesClient) ListByService ¶
func (client SharedPrivateLinkResourcesClient) ListByService(ctx context.Context, resourceGroupName string, searchServiceName string, clientRequestID *uuid.UUID) (result SharedPrivateLinkResourceListResultPage, err error)
ListByService gets a list of all shared private link resources managed by the given service. Parameters: resourceGroupName - 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 - the name of the Azure Cognitive Search service associated with the specified resource group. clientRequestID - 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 (SharedPrivateLinkResourcesClient) ListByServiceComplete ¶
func (client SharedPrivateLinkResourcesClient) ListByServiceComplete(ctx context.Context, resourceGroupName string, searchServiceName string, clientRequestID *uuid.UUID) (result SharedPrivateLinkResourceListResultIterator, err error)
ListByServiceComplete enumerates all values, automatically crossing page boundaries as required.
func (SharedPrivateLinkResourcesClient) ListByServicePreparer ¶
func (client SharedPrivateLinkResourcesClient) ListByServicePreparer(ctx context.Context, resourceGroupName string, searchServiceName string, clientRequestID *uuid.UUID) (*http.Request, error)
ListByServicePreparer prepares the ListByService request.
func (SharedPrivateLinkResourcesClient) ListByServiceResponder ¶
func (client SharedPrivateLinkResourcesClient) ListByServiceResponder(resp *http.Response) (result SharedPrivateLinkResourceListResult, err error)
ListByServiceResponder handles the response to the ListByService request. The method always closes the http.Response Body.
func (SharedPrivateLinkResourcesClient) ListByServiceSender ¶
func (client SharedPrivateLinkResourcesClient) ListByServiceSender(req *http.Request) (*http.Response, error)
ListByServiceSender sends the ListByService request. The method will close the http.Response Body if it receives an error.
type SharedPrivateLinkResourcesCreateOrUpdateFuture ¶
type SharedPrivateLinkResourcesCreateOrUpdateFuture struct { // If the operation has not completed it will return an error. Result func(SharedPrivateLinkResourcesClient) (SharedPrivateLinkResource, error) }
SharedPrivateLinkResourcesCreateOrUpdateFuture an abstraction for monitoring and retrieving the results of a long-running operation.
func (*SharedPrivateLinkResourcesCreateOrUpdateFuture) UnmarshalJSON ¶
func (future *SharedPrivateLinkResourcesCreateOrUpdateFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
type SharedPrivateLinkResourcesDeleteFuture ¶
type SharedPrivateLinkResourcesDeleteFuture struct { // If the operation has not completed it will return an error. Result func(SharedPrivateLinkResourcesClient) (autorest.Response, error) }
SharedPrivateLinkResourcesDeleteFuture an abstraction for monitoring and retrieving the results of a long-running operation.
func (*SharedPrivateLinkResourcesDeleteFuture) UnmarshalJSON ¶
func (future *SharedPrivateLinkResourcesDeleteFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
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': 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', 'StorageOptimizedL1', 'StorageOptimizedL2' Name SkuName `json:"name,omitempty"` }
Sku defines the SKU of an Azure Cognitive Search Service, which determines price tier and capacity limits.
type SkuName ¶
type SkuName string
SkuName enumerates the values for sku name.
const ( // Basic ... Basic SkuName = "basic" // Free ... Free SkuName = "free" // Standard ... Standard SkuName = "standard" // Standard2 ... Standard2 SkuName = "standard2" // Standard3 ... Standard3 SkuName = "standard3" // StorageOptimizedL1 ... StorageOptimizedL1 SkuName = "storage_optimized_l1" // StorageOptimizedL2 ... StorageOptimizedL2 SkuName = "storage_optimized_l2" )
func PossibleSkuNameValues ¶
func PossibleSkuNameValues() []SkuName
PossibleSkuNameValues returns an array of possible values for the SkuName const type.
type TrackedResource ¶
type TrackedResource struct { // Tags - Resource tags. Tags map[string]*string `json:"tags"` // Location - The geo-location where the resource lives Location *string `json:"location,omitempty"` // ID - READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} ID *string `json:"id,omitempty"` // Name - READ-ONLY; The name of the resource Name *string `json:"name,omitempty"` // Type - READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" Type *string `json:"type,omitempty"` }
TrackedResource the resource model definition for an Azure Resource Manager tracked top level resource
func (TrackedResource) MarshalJSON ¶
func (tr TrackedResource) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for TrackedResource.
type UnavailableNameReason ¶
type UnavailableNameReason string
UnavailableNameReason enumerates the values for unavailable name reason.
const ( // AlreadyExists ... AlreadyExists UnavailableNameReason = "AlreadyExists" // Invalid ... Invalid UnavailableNameReason = "Invalid" )
func PossibleUnavailableNameReasonValues ¶
func PossibleUnavailableNameReasonValues() []UnavailableNameReason
PossibleUnavailableNameReasonValues returns an array of possible values for the UnavailableNameReason const type.