services

package
v0.20230315.1105537 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Mar 15, 2023 License: MPL-2.0 Imports: 11 Imported by: 0

README

github.com/hashicorp/go-azure-sdk/resource-manager/search/2020-03-13/services Documentation

The services SDK allows for interaction with the Azure Resource Manager Service search (API Version 2020-03-13).

This readme covers example usages, but further information on using this SDK can be found in the project root.

Import Path

import "github.com/hashicorp/go-azure-sdk/resource-manager/search/2020-03-13/services"

Client Initialization

client := services.NewServicesClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: ServicesClient.CheckNameAvailability

ctx := context.TODO()
id := services.NewSubscriptionID("12345678-1234-9876-4563-123456789012")

payload := services.CheckNameAvailabilityInput{
	// ...
}


read, err := client.CheckNameAvailability(ctx, id, payload, services.DefaultCheckNameAvailabilityOperationOptions())
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Example Usage: ServicesClient.CreateOrUpdate

ctx := context.TODO()
id := services.NewSearchServiceID("12345678-1234-9876-4563-123456789012", "example-resource-group", "searchServiceValue")

payload := services.SearchService{
	// ...
}


if err := client.CreateOrUpdateThenPoll(ctx, id, payload, services.DefaultCreateOrUpdateOperationOptions()); err != nil {
	// handle the error
}

Example Usage: ServicesClient.Delete

ctx := context.TODO()
id := services.NewSearchServiceID("12345678-1234-9876-4563-123456789012", "example-resource-group", "searchServiceValue")

read, err := client.Delete(ctx, id, services.DefaultDeleteOperationOptions())
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Example Usage: ServicesClient.Get

ctx := context.TODO()
id := services.NewSearchServiceID("12345678-1234-9876-4563-123456789012", "example-resource-group", "searchServiceValue")

read, err := client.Get(ctx, id, services.DefaultGetOperationOptions())
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Example Usage: ServicesClient.ListByResourceGroup

ctx := context.TODO()
id := services.NewResourceGroupID("12345678-1234-9876-4563-123456789012", "example-resource-group")

// alternatively `client.ListByResourceGroup(ctx, id, services.DefaultListByResourceGroupOperationOptions())` can be used to do batched pagination
items, err := client.ListByResourceGroupComplete(ctx, id, services.DefaultListByResourceGroupOperationOptions())
if err != nil {
	// handle the error
}
for _, item := range items {
	// do something
}

Example Usage: ServicesClient.ListBySubscription

ctx := context.TODO()
id := services.NewSubscriptionID("12345678-1234-9876-4563-123456789012")

// alternatively `client.ListBySubscription(ctx, id, services.DefaultListBySubscriptionOperationOptions())` can be used to do batched pagination
items, err := client.ListBySubscriptionComplete(ctx, id, services.DefaultListBySubscriptionOperationOptions())
if err != nil {
	// handle the error
}
for _, item := range items {
	// do something
}

Example Usage: ServicesClient.Update

ctx := context.TODO()
id := services.NewSearchServiceID("12345678-1234-9876-4563-123456789012", "example-resource-group", "searchServiceValue")

payload := services.SearchService{
	// ...
}


read, err := client.Update(ctx, id, payload, services.DefaultUpdateOperationOptions())
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func PossibleValuesForHostingMode 

func PossibleValuesForHostingMode() []string

func PossibleValuesForPrivateLinkServiceConnectionStatus 

func PossibleValuesForPrivateLinkServiceConnectionStatus() []string

func PossibleValuesForProvisioningState 

func PossibleValuesForProvisioningState() []string

func PossibleValuesForPublicNetworkAccess 

func PossibleValuesForPublicNetworkAccess() []string

func PossibleValuesForResourceType 

func PossibleValuesForResourceType() []string

func PossibleValuesForSearchServiceStatus 

func PossibleValuesForSearchServiceStatus() []string

func PossibleValuesForSkuName 

func PossibleValuesForSkuName() []string

func PossibleValuesForUnavailableNameReason 

func PossibleValuesForUnavailableNameReason() []string

func ValidateSearchServiceID 

func ValidateSearchServiceID(input interface{}, key string) (warnings []string, errors []error)

ValidateSearchServiceID checks that 'input' can be parsed as a Search Service ID

Types

type CheckNameAvailabilityInput 

type CheckNameAvailabilityInput struct {
	Name string       `json:"name"`
	Type ResourceType `json:"type"`
}

type CheckNameAvailabilityOperationOptions 

type CheckNameAvailabilityOperationOptions struct {
	XMsClientRequestId *string
}

func DefaultCheckNameAvailabilityOperationOptions 

func DefaultCheckNameAvailabilityOperationOptions() CheckNameAvailabilityOperationOptions

type CheckNameAvailabilityOperationResponse 

type CheckNameAvailabilityOperationResponse struct {
	HttpResponse *http.Response
	Model        *CheckNameAvailabilityOutput
}

type CheckNameAvailabilityOutput 

type CheckNameAvailabilityOutput struct {
	Message       *string                `json:"message,omitempty"`
	NameAvailable *bool                  `json:"nameAvailable,omitempty"`
	Reason        *UnavailableNameReason `json:"reason,omitempty"`
}

type CreateOrUpdateOperationOptions 

type CreateOrUpdateOperationOptions struct {
	XMsClientRequestId *string
}

func DefaultCreateOrUpdateOperationOptions 

func DefaultCreateOrUpdateOperationOptions() CreateOrUpdateOperationOptions

type CreateOrUpdateOperationResponse 

type CreateOrUpdateOperationResponse struct {
	Poller       polling.LongRunningPoller
	HttpResponse *http.Response
}

type DeleteOperationOptions 

type DeleteOperationOptions struct {
	XMsClientRequestId *string
}

func DefaultDeleteOperationOptions 

func DefaultDeleteOperationOptions() DeleteOperationOptions

type DeleteOperationResponse 

type DeleteOperationResponse struct {
	HttpResponse *http.Response
}

type GetOperationOptions 

type GetOperationOptions struct {
	XMsClientRequestId *string
}

func DefaultGetOperationOptions 

func DefaultGetOperationOptions() GetOperationOptions

type GetOperationResponse 

type GetOperationResponse struct {
	HttpResponse *http.Response
	Model        *SearchService
}

type HostingMode 

type HostingMode string
const (
	HostingModeDefault     HostingMode = "default"
	HostingModeHighDensity HostingMode = "highDensity"
)

type IPRule added in v0.20220725.1131927 

type IPRule struct {
	Value *string `json:"value,omitempty"`
}

type ListByResourceGroupCompleteResult 

type ListByResourceGroupCompleteResult struct {
	Items []SearchService
}

type ListByResourceGroupOperationOptions 

type ListByResourceGroupOperationOptions struct {
	XMsClientRequestId *string
}

func DefaultListByResourceGroupOperationOptions 

func DefaultListByResourceGroupOperationOptions() ListByResourceGroupOperationOptions

type ListByResourceGroupOperationResponse 

type ListByResourceGroupOperationResponse struct {
	HttpResponse *http.Response
	Model        *[]SearchService
	// contains filtered or unexported fields
}

func (ListByResourceGroupOperationResponse) HasMore 

func (r ListByResourceGroupOperationResponse) HasMore() bool

func (ListByResourceGroupOperationResponse) LoadMore 

func (r ListByResourceGroupOperationResponse) LoadMore(ctx context.Context) (resp ListByResourceGroupOperationResponse, err error)

type ListBySubscriptionCompleteResult 

type ListBySubscriptionCompleteResult struct {
	Items []SearchService
}

type ListBySubscriptionOperationOptions 

type ListBySubscriptionOperationOptions struct {
	XMsClientRequestId *string
}

func DefaultListBySubscriptionOperationOptions 

func DefaultListBySubscriptionOperationOptions() ListBySubscriptionOperationOptions

type ListBySubscriptionOperationResponse 

type ListBySubscriptionOperationResponse struct {
	HttpResponse *http.Response
	Model        *[]SearchService
	// contains filtered or unexported fields
}

func (ListBySubscriptionOperationResponse) HasMore 

func (r ListBySubscriptionOperationResponse) HasMore() bool

func (ListBySubscriptionOperationResponse) LoadMore 

func (r ListBySubscriptionOperationResponse) LoadMore(ctx context.Context) (resp ListBySubscriptionOperationResponse, err error)

type NetworkRuleSet 

type NetworkRuleSet struct {
	IPRules *[]IPRule `json:"ipRules,omitempty"`
}

type PrivateEndpointConnection 

type PrivateEndpointConnection struct {
	Id         *string                              `json:"id,omitempty"`
	Name       *string                              `json:"name,omitempty"`
	Properties *PrivateEndpointConnectionProperties `json:"properties,omitempty"`
	Type       *string                              `json:"type,omitempty"`
}

type PrivateEndpointConnectionProperties 

type PrivateEndpointConnectionProperties struct {
	PrivateEndpoint                   *PrivateEndpointConnectionPropertiesPrivateEndpoint                   `json:"privateEndpoint,omitempty"`
	PrivateLinkServiceConnectionState *PrivateEndpointConnectionPropertiesPrivateLinkServiceConnectionState `json:"privateLinkServiceConnectionState,omitempty"`
}

type PrivateEndpointConnectionPropertiesPrivateEndpoint 

type PrivateEndpointConnectionPropertiesPrivateEndpoint struct {
	Id *string `json:"id,omitempty"`
}

type PrivateEndpointConnectionPropertiesPrivateLinkServiceConnectionState 

type PrivateEndpointConnectionPropertiesPrivateLinkServiceConnectionState struct {
	ActionsRequired *string                             `json:"actionsRequired,omitempty"`
	Description     *string                             `json:"description,omitempty"`
	Status          *PrivateLinkServiceConnectionStatus `json:"status,omitempty"`
}

type PrivateLinkServiceConnectionStatus 

type PrivateLinkServiceConnectionStatus string
const (
	PrivateLinkServiceConnectionStatusApproved     PrivateLinkServiceConnectionStatus = "Approved"
	PrivateLinkServiceConnectionStatusDisconnected PrivateLinkServiceConnectionStatus = "Disconnected"
	PrivateLinkServiceConnectionStatusPending      PrivateLinkServiceConnectionStatus = "Pending"
	PrivateLinkServiceConnectionStatusRejected     PrivateLinkServiceConnectionStatus = "Rejected"
)

type ProvisioningState 

type ProvisioningState string
const (
	ProvisioningStateFailed       ProvisioningState = "failed"
	ProvisioningStateProvisioning ProvisioningState = "provisioning"
	ProvisioningStateSucceeded    ProvisioningState = "succeeded"
)

type PublicNetworkAccess 

type PublicNetworkAccess string
const (
	PublicNetworkAccessDisabled PublicNetworkAccess = "disabled"
	PublicNetworkAccessEnabled  PublicNetworkAccess = "enabled"
)

type ResourceType 

type ResourceType string
const (
	ResourceTypeSearchServices ResourceType = "searchServices"
)

type SearchService 

type SearchService struct {
	Id         *string                  `json:"id,omitempty"`
	Identity   *identity.SystemAssigned `json:"identity,omitempty"`
	Location   *string                  `json:"location,omitempty"`
	Name       *string                  `json:"name,omitempty"`
	Properties *SearchServiceProperties `json:"properties,omitempty"`
	Sku        *Sku                     `json:"sku,omitempty"`
	Tags       *map[string]string       `json:"tags,omitempty"`
	Type       *string                  `json:"type,omitempty"`
}

type SearchServiceId 

type SearchServiceId struct {
	SubscriptionId    string
	ResourceGroupName string
	SearchServiceName string
}

SearchServiceId is a struct representing the Resource ID for a Search Service

func NewSearchServiceID 

func NewSearchServiceID(subscriptionId string, resourceGroupName string, searchServiceName string) SearchServiceId

NewSearchServiceID returns a new SearchServiceId struct

func ParseSearchServiceID 

func ParseSearchServiceID(input string) (*SearchServiceId, error)

ParseSearchServiceID parses 'input' into a SearchServiceId

func ParseSearchServiceIDInsensitively 

func ParseSearchServiceIDInsensitively(input string) (*SearchServiceId, error)

ParseSearchServiceIDInsensitively parses 'input' case-insensitively into a SearchServiceId note: this method should only be used for API response data and not user input

func (SearchServiceId) ID 

func (id SearchServiceId) ID() string

ID returns the formatted Search Service ID

func (SearchServiceId) Segments 

func (id SearchServiceId) Segments() []resourceids.Segment

Segments returns a slice of Resource ID Segments which comprise this Search Service ID

func (SearchServiceId) String 

func (id SearchServiceId) String() string

String returns a human-readable description of this Search Service ID

type SearchServiceOperationPredicate 

type SearchServiceOperationPredicate struct {
	Id       *string
	Location *string
	Name     *string
	Type     *string
}

func (SearchServiceOperationPredicate) Matches 

func (p SearchServiceOperationPredicate) Matches(input SearchService) bool

type SearchServiceProperties 

type SearchServiceProperties struct {
	HostingMode                *HostingMode                 `json:"hostingMode,omitempty"`
	NetworkRuleSet             *NetworkRuleSet              `json:"networkRuleSet,omitempty"`
	PartitionCount             *int64                       `json:"partitionCount,omitempty"`
	PrivateEndpointConnections *[]PrivateEndpointConnection `json:"privateEndpointConnections,omitempty"`
	ProvisioningState          *ProvisioningState           `json:"provisioningState,omitempty"`
	PublicNetworkAccess        *PublicNetworkAccess         `json:"publicNetworkAccess,omitempty"`
	ReplicaCount               *int64                       `json:"replicaCount,omitempty"`
	Status                     *SearchServiceStatus         `json:"status,omitempty"`
	StatusDetails              *string                      `json:"statusDetails,omitempty"`
}

type SearchServiceStatus 

type SearchServiceStatus string
const (
	SearchServiceStatusDegraded     SearchServiceStatus = "degraded"
	SearchServiceStatusDeleting     SearchServiceStatus = "deleting"
	SearchServiceStatusDisabled     SearchServiceStatus = "disabled"
	SearchServiceStatusError        SearchServiceStatus = "error"
	SearchServiceStatusProvisioning SearchServiceStatus = "provisioning"
	SearchServiceStatusRunning      SearchServiceStatus = "running"
)

type ServicesClient 

type ServicesClient struct {
	Client autorest.Client
	// contains filtered or unexported fields
}

func NewServicesClientWithBaseURI 

func NewServicesClientWithBaseURI(endpoint string) ServicesClient

func (ServicesClient) CheckNameAvailability 

func (c ServicesClient) CheckNameAvailability(ctx context.Context, id commonids.SubscriptionId, input CheckNameAvailabilityInput, options CheckNameAvailabilityOperationOptions) (result CheckNameAvailabilityOperationResponse, err error)

CheckNameAvailability ...

func (ServicesClient) CreateOrUpdate 

func (c ServicesClient) CreateOrUpdate(ctx context.Context, id SearchServiceId, input SearchService, options CreateOrUpdateOperationOptions) (result CreateOrUpdateOperationResponse, err error)

CreateOrUpdate ...

func (ServicesClient) CreateOrUpdateThenPoll 

func (c ServicesClient) CreateOrUpdateThenPoll(ctx context.Context, id SearchServiceId, input SearchService, options CreateOrUpdateOperationOptions) error

CreateOrUpdateThenPoll performs CreateOrUpdate then polls until it's completed

func (ServicesClient) Delete 

func (c ServicesClient) Delete(ctx context.Context, id SearchServiceId, options DeleteOperationOptions) (result DeleteOperationResponse, err error)

Delete ...

func (ServicesClient) Get 

func (c ServicesClient) Get(ctx context.Context, id SearchServiceId, options GetOperationOptions) (result GetOperationResponse, err error)

Get ...

func (ServicesClient) ListByResourceGroup 

func (c ServicesClient) ListByResourceGroup(ctx context.Context, id commonids.ResourceGroupId, options ListByResourceGroupOperationOptions) (resp ListByResourceGroupOperationResponse, err error)

ListByResourceGroup ...

func (ServicesClient) ListByResourceGroupComplete 

func (c ServicesClient) ListByResourceGroupComplete(ctx context.Context, id commonids.ResourceGroupId, options ListByResourceGroupOperationOptions) (ListByResourceGroupCompleteResult, error)

ListByResourceGroupComplete retrieves all of the results into a single object

func (ServicesClient) ListByResourceGroupCompleteMatchingPredicate 

func (c ServicesClient) ListByResourceGroupCompleteMatchingPredicate(ctx context.Context, id commonids.ResourceGroupId, options ListByResourceGroupOperationOptions, predicate SearchServiceOperationPredicate) (resp ListByResourceGroupCompleteResult, err error)

ListByResourceGroupCompleteMatchingPredicate retrieves all of the results and then applied the predicate

func (ServicesClient) ListBySubscription 

func (c ServicesClient) ListBySubscription(ctx context.Context, id commonids.SubscriptionId, options ListBySubscriptionOperationOptions) (resp ListBySubscriptionOperationResponse, err error)

ListBySubscription ...

func (ServicesClient) ListBySubscriptionComplete 

func (c ServicesClient) ListBySubscriptionComplete(ctx context.Context, id commonids.SubscriptionId, options ListBySubscriptionOperationOptions) (ListBySubscriptionCompleteResult, error)

ListBySubscriptionComplete retrieves all of the results into a single object

func (ServicesClient) ListBySubscriptionCompleteMatchingPredicate 

func (c ServicesClient) ListBySubscriptionCompleteMatchingPredicate(ctx context.Context, id commonids.SubscriptionId, options ListBySubscriptionOperationOptions, predicate SearchServiceOperationPredicate) (resp ListBySubscriptionCompleteResult, err error)

ListBySubscriptionCompleteMatchingPredicate retrieves all of the results and then applied the predicate

func (ServicesClient) Update 

func (c ServicesClient) Update(ctx context.Context, id SearchServiceId, input SearchService, options UpdateOperationOptions) (result UpdateOperationResponse, err error)

Update ...

type Sku 

type Sku struct {
	Name *SkuName `json:"name,omitempty"`
}

type SkuName 

type SkuName string
const (
	SkuNameBasic                SkuName = "basic"
	SkuNameFree                 SkuName = "free"
	SkuNameStandard             SkuName = "standard"
	SkuNameStandardThree        SkuName = "standard3"
	SkuNameStandardTwo          SkuName = "standard2"
	SkuNameStorageOptimizedLOne SkuName = "storage_optimized_l1"
	SkuNameStorageOptimizedLTwo SkuName = "storage_optimized_l2"
)

type UnavailableNameReason 

type UnavailableNameReason string
const (
	UnavailableNameReasonAlreadyExists UnavailableNameReason = "AlreadyExists"
	UnavailableNameReasonInvalid       UnavailableNameReason = "Invalid"
)

type UpdateOperationOptions 

type UpdateOperationOptions struct {
	XMsClientRequestId *string
}

func DefaultUpdateOperationOptions 

func DefaultUpdateOperationOptions() UpdateOperationOptions

type UpdateOperationResponse 

type UpdateOperationResponse struct {
	HttpResponse *http.Response
	Model        *SearchService
}

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.