servers

package
v0.20240715.1100358 Latest Latest
Warning

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

 Go to latest Published: Jul 15, 2024 License: MPL-2.0 Imports: 13 Imported by: 1

README

github.com/hashicorp/go-azure-sdk/resource-manager/analysisservices/2017-08-01/servers Documentation

The servers SDK allows for interaction with the Azure Resource Manager Service analysisservices (API Version 2017-08-01).

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-helpers/resourcemanager/commonids"
import "github.com/hashicorp/go-azure-sdk/resource-manager/analysisservices/2017-08-01/servers"

Client Initialization

client := servers.NewServersClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: ServersClient.CheckNameAvailability

ctx := context.TODO()
id := servers.NewLocationID("12345678-1234-9876-4563-123456789012", "locationValue")

payload := servers.CheckServerNameAvailabilityParameters{
	// ...
}


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

Example Usage: ServersClient.Create

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

payload := servers.AnalysisServicesServer{
	// ...
}


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

Example Usage: ServersClient.Delete

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

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

Example Usage: ServersClient.DissociateGateway

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

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

Example Usage: ServersClient.GetDetails

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

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

Example Usage: ServersClient.List

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

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

Example Usage: ServersClient.ListByResourceGroup

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

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

Example Usage: ServersClient.ListGatewayStatus

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

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

Example Usage: ServersClient.ListSkusForExisting

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

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

Example Usage: ServersClient.Resume

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

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

Example Usage: ServersClient.Suspend

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

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

Example Usage: ServersClient.Update

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

payload := servers.AnalysisServicesServerUpdateParameters{
	// ...
}


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

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func PossibleValuesForConnectionMode 

func PossibleValuesForConnectionMode() []string

func PossibleValuesForManagedMode 

func PossibleValuesForManagedMode() []int64

func PossibleValuesForProvisioningState 

func PossibleValuesForProvisioningState() []string

func PossibleValuesForServerMonitorMode 

func PossibleValuesForServerMonitorMode() []int64

func PossibleValuesForSkuTier 

func PossibleValuesForSkuTier() []string

func PossibleValuesForState 

func PossibleValuesForState() []string

func PossibleValuesForStatus 

func PossibleValuesForStatus() []int64

func ValidateLocationID 

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

ValidateLocationID checks that 'input' can be parsed as a Location ID

func ValidateServerID 

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

ValidateServerID checks that 'input' can be parsed as a Server ID

Types

type AnalysisServicesServer 

type AnalysisServicesServer struct {
	Id         *string                           `json:"id,omitempty"`
	Location   string                            `json:"location"`
	Name       *string                           `json:"name,omitempty"`
	Properties *AnalysisServicesServerProperties `json:"properties,omitempty"`
	Sku        ResourceSku                       `json:"sku"`
	Tags       *map[string]string                `json:"tags,omitempty"`
	Type       *string                           `json:"type,omitempty"`
}

type AnalysisServicesServerMutableProperties 

type AnalysisServicesServerMutableProperties struct {
	AsAdministrators        *ServerAdministrators `json:"asAdministrators,omitempty"`
	BackupBlobContainerUri  *string               `json:"backupBlobContainerUri,omitempty"`
	GatewayDetails          *GatewayDetails       `json:"gatewayDetails,omitempty"`
	IPV4FirewallSettings    *IPv4FirewallSettings `json:"ipV4FirewallSettings,omitempty"`
	ManagedMode             *ManagedMode          `json:"managedMode,omitempty"`
	QuerypoolConnectionMode *ConnectionMode       `json:"querypoolConnectionMode,omitempty"`
	ServerMonitorMode       *ServerMonitorMode    `json:"serverMonitorMode,omitempty"`
}

type AnalysisServicesServerProperties 

type AnalysisServicesServerProperties struct {
	AsAdministrators        *ServerAdministrators `json:"asAdministrators,omitempty"`
	BackupBlobContainerUri  *string               `json:"backupBlobContainerUri,omitempty"`
	GatewayDetails          *GatewayDetails       `json:"gatewayDetails,omitempty"`
	IPV4FirewallSettings    *IPv4FirewallSettings `json:"ipV4FirewallSettings,omitempty"`
	ManagedMode             *ManagedMode          `json:"managedMode,omitempty"`
	ProvisioningState       *ProvisioningState    `json:"provisioningState,omitempty"`
	QuerypoolConnectionMode *ConnectionMode       `json:"querypoolConnectionMode,omitempty"`
	ServerFullName          *string               `json:"serverFullName,omitempty"`
	ServerMonitorMode       *ServerMonitorMode    `json:"serverMonitorMode,omitempty"`
	Sku                     *ResourceSku          `json:"sku,omitempty"`
	State                   *State                `json:"state,omitempty"`
}

type AnalysisServicesServerUpdateParameters 

type AnalysisServicesServerUpdateParameters struct {
	Properties *AnalysisServicesServerMutableProperties `json:"properties,omitempty"`
	Sku        *ResourceSku                             `json:"sku,omitempty"`
	Tags       *map[string]string                       `json:"tags,omitempty"`
}

type AnalysisServicesServers 

type AnalysisServicesServers struct {
	Value []AnalysisServicesServer `json:"value"`
}

type CheckNameAvailabilityOperationResponse 

type CheckNameAvailabilityOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *CheckServerNameAvailabilityResult
}

type CheckServerNameAvailabilityParameters 

type CheckServerNameAvailabilityParameters struct {
	Name *string `json:"name,omitempty"`
	Type *string `json:"type,omitempty"`
}

type CheckServerNameAvailabilityResult 

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

type ConnectionMode 

type ConnectionMode string
const (
	ConnectionModeAll      ConnectionMode = "All"
	ConnectionModeReadOnly ConnectionMode = "ReadOnly"
)

func (*ConnectionMode) UnmarshalJSON 

func (s *ConnectionMode) UnmarshalJSON(bytes []byte) error

type CreateOperationResponse 

type CreateOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *AnalysisServicesServer
}

type DeleteOperationResponse 

type DeleteOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
}

type DissociateGatewayOperationResponse 

type DissociateGatewayOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
}

type GatewayDetails 

type GatewayDetails struct {
	DmtsClusterUri    *string `json:"dmtsClusterUri,omitempty"`
	GatewayObjectId   *string `json:"gatewayObjectId,omitempty"`
	GatewayResourceId *string `json:"gatewayResourceId,omitempty"`
}

type GatewayListStatusLive 

type GatewayListStatusLive struct {
	Status *Status `json:"status,omitempty"`
}

type GetDetailsOperationResponse 

type GetDetailsOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *AnalysisServicesServer
}

type IPv4FirewallRule 

type IPv4FirewallRule struct {
	FirewallRuleName *string `json:"firewallRuleName,omitempty"`
	RangeEnd         *string `json:"rangeEnd,omitempty"`
	RangeStart       *string `json:"rangeStart,omitempty"`
}

type IPv4FirewallSettings 

type IPv4FirewallSettings struct {
	EnablePowerBIService *bool               `json:"enablePowerBIService,omitempty"`
	FirewallRules        *[]IPv4FirewallRule `json:"firewallRules,omitempty"`
}

type ListByResourceGroupOperationResponse 

type ListByResourceGroupOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *AnalysisServicesServers
}

type ListGatewayStatusOperationResponse 

type ListGatewayStatusOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *GatewayListStatusLive
}

type ListOperationResponse 

type ListOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *AnalysisServicesServers
}

type ListSkusForExistingOperationResponse 

type ListSkusForExistingOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *SkuEnumerationForExistingResourceResult
}

type LocationId 

type LocationId struct {
	SubscriptionId string
	LocationName   string
}

LocationId is a struct representing the Resource ID for a Location

func NewLocationID 

func NewLocationID(subscriptionId string, locationName string) LocationId

NewLocationID returns a new LocationId struct

func ParseLocationID 

func ParseLocationID(input string) (*LocationId, error)

ParseLocationID parses 'input' into a LocationId

func ParseLocationIDInsensitively 

func ParseLocationIDInsensitively(input string) (*LocationId, error)

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

func (*LocationId) FromParseResult 

func (id *LocationId) FromParseResult(input resourceids.ParseResult) error

func (LocationId) ID 

func (id LocationId) ID() string

ID returns the formatted Location ID

func (LocationId) Segments 

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

Segments returns a slice of Resource ID Segments which comprise this Location ID

func (LocationId) String 

func (id LocationId) String() string

String returns a human-readable description of this Location ID

type ManagedMode 

type ManagedMode int64
const (
	ManagedModeOne  ManagedMode = 1
	ManagedModeZero ManagedMode = 0
)

type ProvisioningState 

type ProvisioningState string
const (
	ProvisioningStateDeleting     ProvisioningState = "Deleting"
	ProvisioningStateFailed       ProvisioningState = "Failed"
	ProvisioningStatePaused       ProvisioningState = "Paused"
	ProvisioningStatePausing      ProvisioningState = "Pausing"
	ProvisioningStatePreparing    ProvisioningState = "Preparing"
	ProvisioningStateProvisioning ProvisioningState = "Provisioning"
	ProvisioningStateResuming     ProvisioningState = "Resuming"
	ProvisioningStateScaling      ProvisioningState = "Scaling"
	ProvisioningStateSucceeded    ProvisioningState = "Succeeded"
	ProvisioningStateSuspended    ProvisioningState = "Suspended"
	ProvisioningStateSuspending   ProvisioningState = "Suspending"
	ProvisioningStateUpdating     ProvisioningState = "Updating"
)

func (*ProvisioningState) UnmarshalJSON 

func (s *ProvisioningState) UnmarshalJSON(bytes []byte) error

type ResourceSku 

type ResourceSku struct {
	Capacity *int64   `json:"capacity,omitempty"`
	Name     string   `json:"name"`
	Tier     *SkuTier `json:"tier,omitempty"`
}

type ResumeOperationResponse 

type ResumeOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
}

type ServerAdministrators 

type ServerAdministrators struct {
	Members *[]string `json:"members,omitempty"`
}

type ServerId 

type ServerId struct {
	SubscriptionId    string
	ResourceGroupName string
	ServerName        string
}

ServerId is a struct representing the Resource ID for a Server

func NewServerID 

func NewServerID(subscriptionId string, resourceGroupName string, serverName string) ServerId

NewServerID returns a new ServerId struct

func ParseServerID 

func ParseServerID(input string) (*ServerId, error)

ParseServerID parses 'input' into a ServerId

func ParseServerIDInsensitively 

func ParseServerIDInsensitively(input string) (*ServerId, error)

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

func (*ServerId) FromParseResult 

func (id *ServerId) FromParseResult(input resourceids.ParseResult) error

func (ServerId) ID 

func (id ServerId) ID() string

ID returns the formatted Server ID

func (ServerId) Segments 

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

Segments returns a slice of Resource ID Segments which comprise this Server ID

func (ServerId) String 

func (id ServerId) String() string

String returns a human-readable description of this Server ID

type ServerMonitorMode 

type ServerMonitorMode int64
const (
	ServerMonitorModeOne  ServerMonitorMode = 1
	ServerMonitorModeZero ServerMonitorMode = 0
)

type ServersClient 

type ServersClient struct {
	Client *resourcemanager.Client
}

func NewServersClientWithBaseURI 

func NewServersClientWithBaseURI(sdkApi sdkEnv.Api) (*ServersClient, error)

func (ServersClient) CheckNameAvailability 

func (c ServersClient) CheckNameAvailability(ctx context.Context, id LocationId, input CheckServerNameAvailabilityParameters) (result CheckNameAvailabilityOperationResponse, err error)

CheckNameAvailability ...

func (ServersClient) Create 

func (c ServersClient) Create(ctx context.Context, id ServerId, input AnalysisServicesServer) (result CreateOperationResponse, err error)

Create ...

func (ServersClient) CreateThenPoll 

func (c ServersClient) CreateThenPoll(ctx context.Context, id ServerId, input AnalysisServicesServer) error

CreateThenPoll performs Create then polls until it's completed

func (ServersClient) Delete 

func (c ServersClient) Delete(ctx context.Context, id ServerId) (result DeleteOperationResponse, err error)

Delete ...

func (ServersClient) DeleteThenPoll 

func (c ServersClient) DeleteThenPoll(ctx context.Context, id ServerId) error

DeleteThenPoll performs Delete then polls until it's completed

func (ServersClient) DissociateGateway 

func (c ServersClient) DissociateGateway(ctx context.Context, id ServerId) (result DissociateGatewayOperationResponse, err error)

DissociateGateway ...

func (ServersClient) GetDetails 

func (c ServersClient) GetDetails(ctx context.Context, id ServerId) (result GetDetailsOperationResponse, err error)

GetDetails ...

func (ServersClient) List 

func (c ServersClient) List(ctx context.Context, id commonids.SubscriptionId) (result ListOperationResponse, err error)

List ...

func (ServersClient) ListByResourceGroup 

func (c ServersClient) ListByResourceGroup(ctx context.Context, id commonids.ResourceGroupId) (result ListByResourceGroupOperationResponse, err error)

ListByResourceGroup ...

func (ServersClient) ListGatewayStatus 

func (c ServersClient) ListGatewayStatus(ctx context.Context, id ServerId) (result ListGatewayStatusOperationResponse, err error)

ListGatewayStatus ...

func (ServersClient) ListSkusForExisting 

func (c ServersClient) ListSkusForExisting(ctx context.Context, id ServerId) (result ListSkusForExistingOperationResponse, err error)

ListSkusForExisting ...

func (ServersClient) Resume 

func (c ServersClient) Resume(ctx context.Context, id ServerId) (result ResumeOperationResponse, err error)

Resume ...

func (ServersClient) ResumeThenPoll 

func (c ServersClient) ResumeThenPoll(ctx context.Context, id ServerId) error

ResumeThenPoll performs Resume then polls until it's completed

func (ServersClient) Suspend 

func (c ServersClient) Suspend(ctx context.Context, id ServerId) (result SuspendOperationResponse, err error)

Suspend ...

func (ServersClient) SuspendThenPoll 

func (c ServersClient) SuspendThenPoll(ctx context.Context, id ServerId) error

SuspendThenPoll performs Suspend then polls until it's completed

func (ServersClient) Update 

func (c ServersClient) Update(ctx context.Context, id ServerId, input AnalysisServicesServerUpdateParameters) (result UpdateOperationResponse, err error)

Update ...

func (ServersClient) UpdateThenPoll 

func (c ServersClient) UpdateThenPoll(ctx context.Context, id ServerId, input AnalysisServicesServerUpdateParameters) error

UpdateThenPoll performs Update then polls until it's completed

type SkuDetailsForExistingResource 

type SkuDetailsForExistingResource struct {
	ResourceType *string      `json:"resourceType,omitempty"`
	Sku          *ResourceSku `json:"sku,omitempty"`
}

type SkuEnumerationForExistingResourceResult 

type SkuEnumerationForExistingResourceResult struct {
	Value *[]SkuDetailsForExistingResource `json:"value,omitempty"`
}

type SkuTier 

type SkuTier string
const (
	SkuTierBasic       SkuTier = "Basic"
	SkuTierDevelopment SkuTier = "Development"
	SkuTierStandard    SkuTier = "Standard"
)

func (*SkuTier) UnmarshalJSON 

func (s *SkuTier) UnmarshalJSON(bytes []byte) error

type State 

type State string
const (
	StateDeleting     State = "Deleting"
	StateFailed       State = "Failed"
	StatePaused       State = "Paused"
	StatePausing      State = "Pausing"
	StatePreparing    State = "Preparing"
	StateProvisioning State = "Provisioning"
	StateResuming     State = "Resuming"
	StateScaling      State = "Scaling"
	StateSucceeded    State = "Succeeded"
	StateSuspended    State = "Suspended"
	StateSuspending   State = "Suspending"
	StateUpdating     State = "Updating"
)

func (*State) UnmarshalJSON 

func (s *State) UnmarshalJSON(bytes []byte) error

type Status 

type Status int64
const (
	StatusZero Status = 0
)

type SuspendOperationResponse 

type SuspendOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
}

type UpdateOperationResponse 

type UpdateOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *AnalysisServicesServer
}

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.