const (
// DefaultBaseURI is the default URI used for the service Search
DefaultBaseURI = "https://management.azure.com"
)
func UserAgent() string
UserAgent returns the UserAgent string to use when sending http.Requests.
func Version() string
Version returns the semantic version (see http://semver.org) of the client.
AdminKeyKind enumerates the values for admin key kind.
type AdminKeyKind string
const (
// Primary ...
Primary AdminKeyKind = "primary"
// Secondary ...
Secondary AdminKeyKind = "secondary"
)
func PossibleAdminKeyKindValues() []AdminKeyKind
PossibleAdminKeyKindValues returns an array of possible values for the AdminKeyKind const type.
AdminKeyResult response containing the primary and secondary admin API keys for a given Azure Cognitive Search service.
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"`
}
func (akr AdminKeyResult) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for AdminKeyResult.
AdminKeysClient is the client that can be used to manage Azure Cognitive Search services and API keys.
type AdminKeysClient struct {
BaseClient
}
func NewAdminKeysClient(subscriptionID string) AdminKeysClient
NewAdminKeysClient creates an instance of the AdminKeysClient client.
func NewAdminKeysClientWithBaseURI(baseURI string, subscriptionID string) AdminKeysClient
NewAdminKeysClientWithBaseURI creates an instance of the AdminKeysClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).
func (client AdminKeysClient) 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 (client AdminKeysClient) GetPreparer(ctx context.Context, resourceGroupName string, searchServiceName string, clientRequestID *uuid.UUID) (*http.Request, error)
GetPreparer prepares the Get request.
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 (client AdminKeysClient) GetSender(req *http.Request) (*http.Response, error)
GetSender sends the Get request. The method will close the http.Response Body if it receives an error.
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 (client AdminKeysClient) RegeneratePreparer(ctx context.Context, resourceGroupName string, searchServiceName string, keyKind AdminKeyKind, clientRequestID *uuid.UUID) (*http.Request, error)
RegeneratePreparer prepares the Regenerate request.
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 (client AdminKeysClient) RegenerateSender(req *http.Request) (*http.Response, error)
RegenerateSender sends the Regenerate request. The method will close the http.Response Body if it receives an error.
AsyncOperationResult the details of a long running asynchronous shared private link resource operation
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"`
}
AzureEntityResource the resource model definition for an Azure Resource Manager resource with an etag.
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"`
}
func (aer AzureEntityResource) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for AzureEntityResource.
BaseClient is the base client for Search.
type BaseClient struct {
autorest.Client
BaseURI string
SubscriptionID string
}
func New(subscriptionID string) BaseClient
New creates an instance of the BaseClient client.
func NewWithBaseURI(baseURI string, subscriptionID string) BaseClient
NewWithBaseURI creates an instance of the BaseClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).
CheckNameAvailabilityInput input of check name availability API.
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"`
}
CheckNameAvailabilityOutput output of check name availability API.
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"`
}
func (cnao CheckNameAvailabilityOutput) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for CheckNameAvailabilityOutput.
CloudError contains information about an API error.
type CloudError struct {
// Error - Describes a particular API error with an error code and a message.
Error *CloudErrorBody `json:"error,omitempty"`
}
CloudErrorBody describes a particular API error with an error code and a message.
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"`
}
HostingMode enumerates the values for hosting mode.
type HostingMode string
const (
// Default ...
Default HostingMode = "default"
// HighDensity ...
HighDensity HostingMode = "highDensity"
)
func PossibleHostingModeValues() []HostingMode
PossibleHostingModeValues returns an array of possible values for the HostingMode const type.
IPRule the IP restriction rule of the Azure Cognitive Search service.
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"`
}
Identity identity for the resource.
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"`
}
func (i Identity) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for Identity.
IdentityType enumerates the values for identity type.
type IdentityType string
const (
// None ...
None IdentityType = "None"
// SystemAssigned ...
SystemAssigned IdentityType = "SystemAssigned"
)
func PossibleIdentityTypeValues() []IdentityType
PossibleIdentityTypeValues returns an array of possible values for the IdentityType const type.
ListQueryKeysResult response containing the query API keys for a given Azure Cognitive Search service.
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"`
}
func (lqkr ListQueryKeysResult) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
func (lqkr ListQueryKeysResult) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for ListQueryKeysResult.
ListQueryKeysResultIterator provides access to a complete listing of QueryKey values.
type ListQueryKeysResultIterator struct {
// contains filtered or unexported fields
}
func NewListQueryKeysResultIterator(page ListQueryKeysResultPage) ListQueryKeysResultIterator
Creates a new instance of the ListQueryKeysResultIterator type.
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 (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 (iter ListQueryKeysResultIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter ListQueryKeysResultIterator) Response() ListQueryKeysResult
Response returns the raw server response from the last page request.
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.
ListQueryKeysResultPage contains a page of QueryKey values.
type ListQueryKeysResultPage struct {
// contains filtered or unexported fields
}
func NewListQueryKeysResultPage(cur ListQueryKeysResult, getNextPage func(context.Context, ListQueryKeysResult) (ListQueryKeysResult, error)) ListQueryKeysResultPage
Creates a new instance of the ListQueryKeysResultPage type.
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 (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 (page ListQueryKeysResultPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page ListQueryKeysResultPage) Response() ListQueryKeysResult
Response returns the raw server response from the last page request.
func (page ListQueryKeysResultPage) Values() []QueryKey
Values returns the slice of values for the current page or nil if there are no values.
NetworkRuleSet network specific rules that determine how the Azure Cognitive Search service may be reached.
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"`
}
Operation describes a REST API 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"`
}
func (o Operation) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for Operation.
OperationDisplay the object that describes the operation.
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"`
}
func (o OperationDisplay) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for OperationDisplay.
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 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"`
}
func (olr OperationListResult) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for OperationListResult.
OperationsClient is the client that can be used to manage Azure Cognitive Search services and API keys.
type OperationsClient struct {
BaseClient
}
func NewOperationsClient(subscriptionID string) OperationsClient
NewOperationsClient creates an instance of the OperationsClient client.
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 (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 (client OperationsClient) ListPreparer(ctx context.Context) (*http.Request, error)
ListPreparer prepares the List request.
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 (client OperationsClient) ListSender(req *http.Request) (*http.Response, error)
ListSender sends the List request. The method will close the http.Response Body if it receives an error.
PrivateEndpointConnection describes an existing Private Endpoint connection to the Azure Cognitive Search service.
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"`
}
func (pec PrivateEndpointConnection) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for PrivateEndpointConnection.
PrivateEndpointConnectionListResult response containing a list of Private Endpoint connections.
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"`
}
func (peclr PrivateEndpointConnectionListResult) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
func (peclr PrivateEndpointConnectionListResult) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for PrivateEndpointConnectionListResult.
PrivateEndpointConnectionListResultIterator provides access to a complete listing of PrivateEndpointConnection values.
type PrivateEndpointConnectionListResultIterator struct {
// contains filtered or unexported fields
}
func NewPrivateEndpointConnectionListResultIterator(page PrivateEndpointConnectionListResultPage) PrivateEndpointConnectionListResultIterator
Creates a new instance of the PrivateEndpointConnectionListResultIterator type.
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 (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 (iter PrivateEndpointConnectionListResultIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter PrivateEndpointConnectionListResultIterator) Response() PrivateEndpointConnectionListResult
Response returns the raw server response from the last page request.
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.
PrivateEndpointConnectionListResultPage contains a page of PrivateEndpointConnection values.
type PrivateEndpointConnectionListResultPage struct {
// contains filtered or unexported fields
}
func NewPrivateEndpointConnectionListResultPage(cur PrivateEndpointConnectionListResult, getNextPage func(context.Context, PrivateEndpointConnectionListResult) (PrivateEndpointConnectionListResult, error)) PrivateEndpointConnectionListResultPage
Creates a new instance of the PrivateEndpointConnectionListResultPage type.
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 (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 (page PrivateEndpointConnectionListResultPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page PrivateEndpointConnectionListResultPage) Response() PrivateEndpointConnectionListResult
Response returns the raw server response from the last page request.
func (page PrivateEndpointConnectionListResultPage) Values() []PrivateEndpointConnection
Values returns the slice of values for the current page or nil if there are no values.
PrivateEndpointConnectionProperties describes the properties of an existing Private Endpoint connection to the Azure Cognitive Search service.
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"`
}
PrivateEndpointConnectionPropertiesPrivateEndpoint the private endpoint resource from Microsoft.Network provider.
type PrivateEndpointConnectionPropertiesPrivateEndpoint struct {
// ID - The resource id of the private endpoint resource from Microsoft.Network provider.
ID *string `json:"id,omitempty"`
}
PrivateEndpointConnectionPropertiesPrivateLinkServiceConnectionState describes the current state of an existing Private Link Service connection to the Azure Private Endpoint.
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"`
}
PrivateEndpointConnectionsClient is the client that can be used to manage Azure Cognitive Search services and API keys.
type PrivateEndpointConnectionsClient struct {
BaseClient
}
func NewPrivateEndpointConnectionsClient(subscriptionID string) PrivateEndpointConnectionsClient
NewPrivateEndpointConnectionsClient creates an instance of the PrivateEndpointConnectionsClient client.
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 (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 (client PrivateEndpointConnectionsClient) DeletePreparer(ctx context.Context, resourceGroupName string, searchServiceName string, privateEndpointConnectionName string, clientRequestID *uuid.UUID) (*http.Request, error)
DeletePreparer prepares the Delete request.
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 (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 (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 (client PrivateEndpointConnectionsClient) GetPreparer(ctx context.Context, resourceGroupName string, searchServiceName string, privateEndpointConnectionName string, clientRequestID *uuid.UUID) (*http.Request, error)
GetPreparer prepares the Get request.
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 (client PrivateEndpointConnectionsClient) GetSender(req *http.Request) (*http.Response, error)
GetSender sends the Get request. The method will close the http.Response Body if it receives an error.
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 (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 (client PrivateEndpointConnectionsClient) ListByServicePreparer(ctx context.Context, resourceGroupName string, searchServiceName string, clientRequestID *uuid.UUID) (*http.Request, error)
ListByServicePreparer prepares the ListByService request.
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 (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 (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 (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 (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 (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.
PrivateLinkResource describes a supported private link resource for the Azure Cognitive Search service.
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"`
}
func (plr PrivateLinkResource) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for PrivateLinkResource.
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 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 - READ-ONLY; The list of resources that are onboarded to private link service, that are supported by Azure Cognitive Search.
ShareablePrivateLinkResourceTypes *[]ShareablePrivateLinkResourceType `json:"shareablePrivateLinkResourceTypes,omitempty"`
}
func (plrp PrivateLinkResourceProperties) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for PrivateLinkResourceProperties.
PrivateLinkResourcesClient is the client that can be used to manage Azure Cognitive Search services and API keys.
type PrivateLinkResourcesClient struct {
BaseClient
}
func NewPrivateLinkResourcesClient(subscriptionID string) PrivateLinkResourcesClient
NewPrivateLinkResourcesClient creates an instance of the PrivateLinkResourcesClient client.
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 (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 (client PrivateLinkResourcesClient) ListSupportedPreparer(ctx context.Context, resourceGroupName string, searchServiceName string, clientRequestID *uuid.UUID) (*http.Request, error)
ListSupportedPreparer prepares the ListSupported request.
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 (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.
PrivateLinkResourcesResult response containing a list of supported Private Link Resources.
type PrivateLinkResourcesResult struct {
autorest.Response `json:"-"`
// Value - READ-ONLY; The list of supported Private Link Resources.
Value *[]PrivateLinkResource `json:"value,omitempty"`
}
func (plrr PrivateLinkResourcesResult) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for PrivateLinkResourcesResult.
PrivateLinkServiceConnectionStatus enumerates the values for private link service connection status.
type PrivateLinkServiceConnectionStatus string
const (
// Approved ...
Approved PrivateLinkServiceConnectionStatus = "Approved"
// Disconnected ...
Disconnected PrivateLinkServiceConnectionStatus = "Disconnected"
// Pending ...
Pending PrivateLinkServiceConnectionStatus = "Pending"
// Rejected ...
Rejected PrivateLinkServiceConnectionStatus = "Rejected"
)
func PossiblePrivateLinkServiceConnectionStatusValues() []PrivateLinkServiceConnectionStatus
PossiblePrivateLinkServiceConnectionStatusValues returns an array of possible values for the PrivateLinkServiceConnectionStatus const type.
ProvisioningState enumerates the values for provisioning state.
type ProvisioningState string
const (
// Failed ...
Failed ProvisioningState = "failed"
// Provisioning ...
Provisioning ProvisioningState = "provisioning"
// Succeeded ...
Succeeded ProvisioningState = "succeeded"
)
func PossibleProvisioningStateValues() []ProvisioningState
PossibleProvisioningStateValues returns an array of possible values for the ProvisioningState const type.
ProxyResource the resource model definition for an Azure Resource Manager proxy resource. It will have everything other than required location and tags
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"`
}
func (pr ProxyResource) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for ProxyResource.
PublicNetworkAccess enumerates the values for public network access.
type PublicNetworkAccess string
const (
// Disabled ...
Disabled PublicNetworkAccess = "disabled"
// Enabled ...
Enabled PublicNetworkAccess = "enabled"
)
func PossiblePublicNetworkAccessValues() []PublicNetworkAccess
PossiblePublicNetworkAccessValues returns an array of possible values for the PublicNetworkAccess const type.
QueryKey describes an API key for a given Azure Cognitive Search service that has permissions for query operations only.
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"`
}
func (qk QueryKey) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for QueryKey.
QueryKeysClient is the client that can be used to manage Azure Cognitive Search services and API keys.
type QueryKeysClient struct {
BaseClient
}
func NewQueryKeysClient(subscriptionID string) QueryKeysClient
NewQueryKeysClient creates an instance of the QueryKeysClient client.
func NewQueryKeysClientWithBaseURI(baseURI string, subscriptionID string) QueryKeysClient
NewQueryKeysClientWithBaseURI creates an instance of the QueryKeysClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).
func (client QueryKeysClient) 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 (client QueryKeysClient) CreatePreparer(ctx context.Context, resourceGroupName string, searchServiceName string, name string, clientRequestID *uuid.UUID) (*http.Request, error)
CreatePreparer prepares the Create request.
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 (client QueryKeysClient) CreateSender(req *http.Request) (*http.Response, error)
CreateSender sends the Create request. The method will close the http.Response Body if it receives an error.
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 (client QueryKeysClient) DeletePreparer(ctx context.Context, resourceGroupName string, searchServiceName string, key string, clientRequestID *uuid.UUID) (*http.Request, error)
DeletePreparer prepares the Delete request.
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 (client QueryKeysClient) 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 (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 (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 (client QueryKeysClient) ListBySearchServicePreparer(ctx context.Context, resourceGroupName string, searchServiceName string, clientRequestID *uuid.UUID) (*http.Request, error)
ListBySearchServicePreparer prepares the ListBySearchService request.
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 (client QueryKeysClient) ListBySearchServiceSender(req *http.Request) (*http.Response, error)
ListBySearchServiceSender sends the ListBySearchService request. The method will close the http.Response Body if it receives an error.
Resource common fields that are returned in the response for all Azure Resource Manager resources
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"`
}
func (r Resource) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for Resource.
Service describes an Azure Cognitive Search service and its current state.
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"`
}
func (s Service) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for Service.
func (s *Service) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for Service struct.
ServiceListResult response containing a list of Azure Cognitive Search services.
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"`
}
func (slr ServiceListResult) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
func (slr ServiceListResult) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for ServiceListResult.
ServiceListResultIterator provides access to a complete listing of Service values.
type ServiceListResultIterator struct {
// contains filtered or unexported fields
}
func NewServiceListResultIterator(page ServiceListResultPage) ServiceListResultIterator
Creates a new instance of the ServiceListResultIterator type.
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 (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 (iter ServiceListResultIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter ServiceListResultIterator) Response() ServiceListResult
Response returns the raw server response from the last page request.
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.
ServiceListResultPage contains a page of Service values.
type ServiceListResultPage struct {
// contains filtered or unexported fields
}
func NewServiceListResultPage(cur ServiceListResult, getNextPage func(context.Context, ServiceListResult) (ServiceListResult, error)) ServiceListResultPage
Creates a new instance of the ServiceListResultPage type.
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 (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 (page ServiceListResultPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page ServiceListResultPage) Response() ServiceListResult
Response returns the raw server response from the last page request.
func (page ServiceListResultPage) Values() []Service
Values returns the slice of values for the current page or nil if there are no values.
ServiceProperties properties of the search service.
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 - READ-ONLY; The list of shared private link resources managed by the Azure Cognitive Search service.
SharedPrivateLinkResources *[]SharedPrivateLinkResource `json:"sharedPrivateLinkResources,omitempty"`
}
func (sp ServiceProperties) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for ServiceProperties.
ServiceStatus enumerates the values for service status.
type ServiceStatus string
const (
// ServiceStatusDegraded ...
ServiceStatusDegraded ServiceStatus = "degraded"
// ServiceStatusDeleting ...
ServiceStatusDeleting ServiceStatus = "deleting"
// ServiceStatusDisabled ...
ServiceStatusDisabled ServiceStatus = "disabled"
// ServiceStatusError ...
ServiceStatusError ServiceStatus = "error"
// ServiceStatusProvisioning ...
ServiceStatusProvisioning ServiceStatus = "provisioning"
// ServiceStatusRunning ...
ServiceStatusRunning ServiceStatus = "running"
)
func PossibleServiceStatusValues() []ServiceStatus
PossibleServiceStatusValues returns an array of possible values for the ServiceStatus const type.
ServiceUpdate the parameters used to update an Azure Cognitive Search service.
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"`
}
func (su ServiceUpdate) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for ServiceUpdate.
func (su *ServiceUpdate) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for ServiceUpdate struct.
ServicesClient is the client that can be used to manage Azure Cognitive Search services and API keys.
type ServicesClient struct {
BaseClient
}
func NewServicesClient(subscriptionID string) ServicesClient
NewServicesClient creates an instance of the ServicesClient client.
func NewServicesClientWithBaseURI(baseURI string, subscriptionID string) ServicesClient
NewServicesClientWithBaseURI creates an instance of the ServicesClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).
func (client ServicesClient) 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 (client ServicesClient) CheckNameAvailabilityPreparer(ctx context.Context, checkNameAvailabilityInput CheckNameAvailabilityInput, clientRequestID *uuid.UUID) (*http.Request, error)
CheckNameAvailabilityPreparer prepares the CheckNameAvailability request.
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 (client ServicesClient) CheckNameAvailabilitySender(req *http.Request) (*http.Response, error)
CheckNameAvailabilitySender sends the CheckNameAvailability request. The method will close the http.Response Body if it receives an error.
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 (client ServicesClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, searchServiceName string, service Service, clientRequestID *uuid.UUID) (*http.Request, error)
CreateOrUpdatePreparer prepares the CreateOrUpdate request.
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 (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 (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 (client ServicesClient) DeletePreparer(ctx context.Context, resourceGroupName string, searchServiceName string, clientRequestID *uuid.UUID) (*http.Request, error)
DeletePreparer prepares the Delete request.
func (client ServicesClient) DeleteResponder(resp *http.Response) (result autorest.Response, err error)
DeleteResponder handles the response to the Delete request. The method always closes the http.Response Body.
func (client ServicesClient) 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 (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 (client ServicesClient) GetPreparer(ctx context.Context, resourceGroupName string, searchServiceName string, clientRequestID *uuid.UUID) (*http.Request, error)
GetPreparer prepares the Get request.
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 (client ServicesClient) GetSender(req *http.Request) (*http.Response, error)
GetSender sends the Get request. The method will close the http.Response Body if it receives an error.
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 (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 (client ServicesClient) ListByResourceGroupPreparer(ctx context.Context, resourceGroupName string, clientRequestID *uuid.UUID) (*http.Request, error)
ListByResourceGroupPreparer prepares the ListByResourceGroup request.
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 (client ServicesClient) ListByResourceGroupSender(req *http.Request) (*http.Response, error)
ListByResourceGroupSender sends the ListByResourceGroup request. The method will close the http.Response Body if it receives an error.
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 (client ServicesClient) ListBySubscriptionComplete(ctx context.Context, clientRequestID *uuid.UUID) (result ServiceListResultIterator, err error)
ListBySubscriptionComplete enumerates all values, automatically crossing page boundaries as required.
func (client ServicesClient) ListBySubscriptionPreparer(ctx context.Context, clientRequestID *uuid.UUID) (*http.Request, error)
ListBySubscriptionPreparer prepares the ListBySubscription request.
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 (client ServicesClient) ListBySubscriptionSender(req *http.Request) (*http.Response, error)
ListBySubscriptionSender sends the ListBySubscription request. The method will close the http.Response Body if it receives an error.
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 (client ServicesClient) UpdatePreparer(ctx context.Context, resourceGroupName string, searchServiceName string, service ServiceUpdate, clientRequestID *uuid.UUID) (*http.Request, error)
UpdatePreparer prepares the Update request.
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 (client ServicesClient) 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.
ServicesCreateOrUpdateFuture an abstraction for monitoring and retrieving the results of a long-running operation.
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)
}
func (future *ServicesCreateOrUpdateFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
ShareablePrivateLinkResourceProperties describes the properties of a resource type that has been onboarded to private link service, supported by Azure Cognitive Search.
type ShareablePrivateLinkResourceProperties struct {
// Type - READ-ONLY; The resource provider type for the resource that has been onboarded to private link service, supported by Azure Cognitive Search.
Type *string `json:"type,omitempty"`
// GroupID - READ-ONLY; The resource provider group id for the resource that has been onboarded to private link service, supported by Azure Cognitive Search.
GroupID *string `json:"groupId,omitempty"`
// Description - READ-ONLY; The description of the resource type that has been onboarded to private link service, supported by Azure Cognitive Search.
Description *string `json:"description,omitempty"`
}
func (splrp ShareablePrivateLinkResourceProperties) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for ShareablePrivateLinkResourceProperties.
ShareablePrivateLinkResourceType describes an resource type that has been onboarded to private link service, supported by Azure Cognitive Search.
type ShareablePrivateLinkResourceType struct {
// Name - READ-ONLY; The name of the resource type that has been onboarded to private link service, supported by Azure Cognitive Search.
Name *string `json:"name,omitempty"`
// Properties - READ-ONLY; Describes the properties of a resource type that has been onboarded to private link service, supported by Azure Cognitive Search.
Properties *ShareablePrivateLinkResourceProperties `json:"properties,omitempty"`
}
func (splrt ShareablePrivateLinkResourceType) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for ShareablePrivateLinkResourceType.
SharedPrivateLinkResource describes a Shared Private Link Resource managed by the Azure Cognitive Search service.
type SharedPrivateLinkResource struct {
autorest.Response `json:"-"`
// Properties - Describes the properties of a Shared Private Link Resource managed by the Azure Cognitive Search service.
Properties *SharedPrivateLinkResourceProperties `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"`
}
func (splr SharedPrivateLinkResource) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for SharedPrivateLinkResource.
SharedPrivateLinkResourceAsyncOperationResult enumerates the values for shared private link resource async operation result.
type SharedPrivateLinkResourceAsyncOperationResult string
const (
// SharedPrivateLinkResourceAsyncOperationResultFailed ...
SharedPrivateLinkResourceAsyncOperationResult = "Failed"
// SharedPrivateLinkResourceAsyncOperationResultRunning ...
SharedPrivateLinkResourceAsyncOperationResult = "Running"
// SharedPrivateLinkResourceAsyncOperationResultSucceeded ...
SharedPrivateLinkResourceAsyncOperationResult = "Succeeded"
)
func PossibleSharedPrivateLinkResourceAsyncOperationResultValues() []SharedPrivateLinkResourceAsyncOperationResult
PossibleSharedPrivateLinkResourceAsyncOperationResultValues returns an array of possible values for the SharedPrivateLinkResourceAsyncOperationResult const type.
SharedPrivateLinkResourceListResult response containing a list of Shared Private Link Resources.
type SharedPrivateLinkResourceListResult struct {
autorest.Response `json:"-"`
// Value - READ-ONLY; The list of Shared Private Link Resources.
Value *[]SharedPrivateLinkResource `json:"value,omitempty"`
// NextLink - The URL to get the next set of shared private link resources, if there are any.
NextLink *string `json:"nextLink,omitempty"`
}
func (splrlr SharedPrivateLinkResourceListResult) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
func (splrlr SharedPrivateLinkResourceListResult) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for SharedPrivateLinkResourceListResult.
SharedPrivateLinkResourceListResultIterator provides access to a complete listing of SharedPrivateLinkResource values.
type SharedPrivateLinkResourceListResultIterator struct {
// contains filtered or unexported fields
}
func NewSharedPrivateLinkResourceListResultIterator(page SharedPrivateLinkResourceListResultPage) SharedPrivateLinkResourceListResultIterator
Creates a new instance of the SharedPrivateLinkResourceListResultIterator type.
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 (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 (iter SharedPrivateLinkResourceListResultIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter SharedPrivateLinkResourceListResultIterator) Response() SharedPrivateLinkResourceListResult
Response returns the raw server response from the last page request.
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.
SharedPrivateLinkResourceListResultPage contains a page of SharedPrivateLinkResource values.
type SharedPrivateLinkResourceListResultPage struct {
// contains filtered or unexported fields
}
func NewSharedPrivateLinkResourceListResultPage(cur SharedPrivateLinkResourceListResult, getNextPage func(context.Context, SharedPrivateLinkResourceListResult) (SharedPrivateLinkResourceListResult, error)) SharedPrivateLinkResourceListResultPage
Creates a new instance of the SharedPrivateLinkResourceListResultPage type.
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 (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 (page SharedPrivateLinkResourceListResultPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page SharedPrivateLinkResourceListResultPage) Response() SharedPrivateLinkResourceListResult
Response returns the raw server response from the last page request.
func (page SharedPrivateLinkResourceListResultPage) Values() []SharedPrivateLinkResource
Values returns the slice of values for the current page or nil if there are no values.
SharedPrivateLinkResourceProperties describes the properties of an existing Shared Private Link Resource managed by the Azure Cognitive Search service.
type SharedPrivateLinkResourceProperties struct {
// PrivateLinkResourceID - The resource id of the resource the shared private link resource is for.
PrivateLinkResourceID *string `json:"privateLinkResourceId,omitempty"`
// GroupID - The group id from the provider of resource the shared private link resource is for.
GroupID *string `json:"groupId,omitempty"`
// RequestMessage - The request message for requesting approval of the shared private link resource.
RequestMessage *string `json:"requestMessage,omitempty"`
// ResourceRegion - Optional. Can be used to specify the Azure Resource Manager location of the resource to which a shared private link is to be created. This is only required for those resources whose DNS configuration are regional (such as Azure Kubernetes Service).
ResourceRegion *string `json:"resourceRegion,omitempty"`
// Status - Status of the shared private link resource. Can be Pending, Approved, Rejected or Disconnected. Possible values include: 'SharedPrivateLinkResourceStatusPending', 'SharedPrivateLinkResourceStatusApproved', 'SharedPrivateLinkResourceStatusRejected', 'SharedPrivateLinkResourceStatusDisconnected'
Status SharedPrivateLinkResourceStatus `json:"status,omitempty"`
// ProvisioningState - The provisioning state of the shared private link resource. Can be Updating, Deleting, Failed, Succeeded or Incomplete. Possible values include: 'SharedPrivateLinkResourceProvisioningStateUpdating', 'SharedPrivateLinkResourceProvisioningStateDeleting', 'SharedPrivateLinkResourceProvisioningStateFailed', 'SharedPrivateLinkResourceProvisioningStateSucceeded', 'SharedPrivateLinkResourceProvisioningStateIncomplete'
ProvisioningState SharedPrivateLinkResourceProvisioningState `json:"provisioningState,omitempty"`
}
SharedPrivateLinkResourceProvisioningState enumerates the values for shared private link resource provisioning state.
type SharedPrivateLinkResourceProvisioningState string
const (
// SharedPrivateLinkResourceProvisioningStateDeleting ...
SharedPrivateLinkResourceProvisioningState = "Deleting"
// SharedPrivateLinkResourceProvisioningStateFailed ...
SharedPrivateLinkResourceProvisioningState = "Failed"
// SharedPrivateLinkResourceProvisioningStateIncomplete ...
SharedPrivateLinkResourceProvisioningState = "Incomplete"
// SharedPrivateLinkResourceProvisioningStateSucceeded ...
SharedPrivateLinkResourceProvisioningState = "Succeeded"
// SharedPrivateLinkResourceProvisioningStateUpdating ...
SharedPrivateLinkResourceProvisioningState = "Updating"
)
func PossibleSharedPrivateLinkResourceProvisioningStateValues() []SharedPrivateLinkResourceProvisioningState
PossibleSharedPrivateLinkResourceProvisioningStateValues returns an array of possible values for the SharedPrivateLinkResourceProvisioningState const type.
SharedPrivateLinkResourceStatus enumerates the values for shared private link resource status.
type SharedPrivateLinkResourceStatus string
const (
// SharedPrivateLinkResourceStatusApproved ...
SharedPrivateLinkResourceStatus = "Approved"
// SharedPrivateLinkResourceStatusDisconnected ...
SharedPrivateLinkResourceStatus = "Disconnected"
// SharedPrivateLinkResourceStatusPending ...
SharedPrivateLinkResourceStatus = "Pending"
// SharedPrivateLinkResourceStatusRejected ...
SharedPrivateLinkResourceStatus = "Rejected"
)
func PossibleSharedPrivateLinkResourceStatusValues() []SharedPrivateLinkResourceStatus
PossibleSharedPrivateLinkResourceStatusValues returns an array of possible values for the SharedPrivateLinkResourceStatus const type.
SharedPrivateLinkResourcesClient is the client that can be used to manage Azure Cognitive Search services and API keys.
type SharedPrivateLinkResourcesClient struct {
BaseClient
}
func NewSharedPrivateLinkResourcesClient(subscriptionID string) SharedPrivateLinkResourcesClient
NewSharedPrivateLinkResourcesClient creates an instance of the SharedPrivateLinkResourcesClient client.
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 (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 (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 (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 (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 (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 (client SharedPrivateLinkResourcesClient) DeletePreparer(ctx context.Context, resourceGroupName string, searchServiceName string, sharedPrivateLinkResourceName string, clientRequestID *uuid.UUID) (*http.Request, error)
DeletePreparer prepares the Delete request.
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 (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 (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 (client SharedPrivateLinkResourcesClient) GetPreparer(ctx context.Context, resourceGroupName string, searchServiceName string, sharedPrivateLinkResourceName string, clientRequestID *uuid.UUID) (*http.Request, error)
GetPreparer prepares the Get request.
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 (client SharedPrivateLinkResourcesClient) GetSender(req *http.Request) (*http.Response, error)
GetSender sends the Get request. The method will close the http.Response Body if it receives an error.
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 (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 (client SharedPrivateLinkResourcesClient) ListByServicePreparer(ctx context.Context, resourceGroupName string, searchServiceName string, clientRequestID *uuid.UUID) (*http.Request, error)
ListByServicePreparer prepares the ListByService request.
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 (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.
SharedPrivateLinkResourcesCreateOrUpdateFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type SharedPrivateLinkResourcesCreateOrUpdateFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(SharedPrivateLinkResourcesClient) (SharedPrivateLinkResource, error)
}
func (future *SharedPrivateLinkResourcesCreateOrUpdateFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
SharedPrivateLinkResourcesDeleteFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type SharedPrivateLinkResourcesDeleteFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(SharedPrivateLinkResourcesClient) (autorest.Response, error)
}
func (future *SharedPrivateLinkResourcesDeleteFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
Sku defines the SKU of an Azure Cognitive Search Service, which determines price tier and capacity limits.
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"`
}
SkuName enumerates the values for sku name.
type SkuName string
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() []SkuName
PossibleSkuNameValues returns an array of possible values for the SkuName const type.
TrackedResource the resource model definition for an Azure Resource Manager tracked top level resource
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"`
}
func (tr TrackedResource) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for TrackedResource.
UnavailableNameReason enumerates the values for unavailable name reason.
type UnavailableNameReason string
const (
// AlreadyExists ...
AlreadyExists UnavailableNameReason = "AlreadyExists"
// Invalid ...
Invalid UnavailableNameReason = "Invalid"
)
func PossibleUnavailableNameReasonValues() []UnavailableNameReason
PossibleUnavailableNameReasonValues returns an array of possible values for the UnavailableNameReason const type.