servers

package
v0.20231213.1172325 Latest Latest
Warning

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

 Go to latest Published: Dec 13, 2023 License: MPL-2.0 Imports: 12 Imported by: 0

README

github.com/hashicorp/go-azure-sdk/resource-manager/sql/2021-11-01/servers Documentation

The servers SDK allows for interaction with the Azure Resource Manager Service sql (API Version 2021-11-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-sdk/resource-manager/sql/2021-11-01/servers"

Client Initialization

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

Example Usage: ServersClient.CheckNameAvailability

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

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


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.CreateOrUpdate

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

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


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

Example Usage: ServersClient.Delete

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

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

Example Usage: ServersClient.Get

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

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

Example Usage: ServersClient.ImportDatabase

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

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


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

Example Usage: ServersClient.List

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

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

Example Usage: ServersClient.ListByResourceGroup

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

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

Example Usage: ServersClient.Update

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

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


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 PossibleValuesForAdministratorType 

func PossibleValuesForAdministratorType() []string

func PossibleValuesForCheckNameAvailabilityReason 

func PossibleValuesForCheckNameAvailabilityReason() []string

func PossibleValuesForCheckNameAvailabilityResourceType 

func PossibleValuesForCheckNameAvailabilityResourceType() []string

func PossibleValuesForPrincipalType 

func PossibleValuesForPrincipalType() []string

func PossibleValuesForPrivateEndpointProvisioningState 

func PossibleValuesForPrivateEndpointProvisioningState() []string

func PossibleValuesForPrivateLinkServiceConnectionStateActionsRequire 

func PossibleValuesForPrivateLinkServiceConnectionStateActionsRequire() []string

func PossibleValuesForPrivateLinkServiceConnectionStateStatus 

func PossibleValuesForPrivateLinkServiceConnectionStateStatus() []string

func PossibleValuesForServerNetworkAccessFlag 

func PossibleValuesForServerNetworkAccessFlag() []string

func PossibleValuesForServerWorkspaceFeature 

func PossibleValuesForServerWorkspaceFeature() []string

func PossibleValuesForStorageKeyType 

func PossibleValuesForStorageKeyType() []string

Types

type AdministratorType 

type AdministratorType string
const (
	AdministratorTypeActiveDirectory AdministratorType = "ActiveDirectory"
)

func (*AdministratorType) UnmarshalJSON 

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

type CheckNameAvailabilityOperationResponse 

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

type CheckNameAvailabilityReason 

type CheckNameAvailabilityReason string
const (
	CheckNameAvailabilityReasonAlreadyExists CheckNameAvailabilityReason = "AlreadyExists"
	CheckNameAvailabilityReasonInvalid       CheckNameAvailabilityReason = "Invalid"
)

func (*CheckNameAvailabilityReason) UnmarshalJSON 

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

type CheckNameAvailabilityRequest 

type CheckNameAvailabilityRequest struct {
	Name string                            `json:"name"`
	Type CheckNameAvailabilityResourceType `json:"type"`
}

type CheckNameAvailabilityResourceType 

type CheckNameAvailabilityResourceType string
const (
	CheckNameAvailabilityResourceTypeMicrosoftPointSqlServers CheckNameAvailabilityResourceType = "Microsoft.Sql/servers"
)

func (*CheckNameAvailabilityResourceType) UnmarshalJSON 

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

type CheckNameAvailabilityResponse 

type CheckNameAvailabilityResponse struct {
	Available *bool                        `json:"available,omitempty"`
	Message   *string                      `json:"message,omitempty"`
	Name      *string                      `json:"name,omitempty"`
	Reason    *CheckNameAvailabilityReason `json:"reason,omitempty"`
}

type CreateOrUpdateOperationResponse 

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

type DeleteOperationResponse 

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

type GetOperationOptions 

type GetOperationOptions struct {
	Expand *string
}

func DefaultGetOperationOptions 

func DefaultGetOperationOptions() GetOperationOptions

func (GetOperationOptions) ToHeaders 

func (o GetOperationOptions) ToHeaders() *client.Headers

func (GetOperationOptions) ToOData 

func (o GetOperationOptions) ToOData() *odata.Query

func (GetOperationOptions) ToQuery 

func (o GetOperationOptions) ToQuery() *client.QueryParams

type GetOperationResponse 

type GetOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *Server
}

type ImportDatabaseOperationResponse 

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

type ImportExportOperationResult 

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

type ImportExportOperationResultProperties 

type ImportExportOperationResultProperties struct {
	BlobUri                    *string                                   `json:"blobUri,omitempty"`
	DatabaseName               *string                                   `json:"databaseName,omitempty"`
	ErrorMessage               *string                                   `json:"errorMessage,omitempty"`
	LastModifiedTime           *string                                   `json:"lastModifiedTime,omitempty"`
	PrivateEndpointConnections *[]PrivateEndpointConnectionRequestStatus `json:"privateEndpointConnections,omitempty"`
	QueuedTime                 *string                                   `json:"queuedTime,omitempty"`
	RequestId                  *string                                   `json:"requestId,omitempty"`
	RequestType                *string                                   `json:"requestType,omitempty"`
	ServerName                 *string                                   `json:"serverName,omitempty"`
	Status                     *string                                   `json:"status,omitempty"`
}

type ImportNewDatabaseDefinition 

type ImportNewDatabaseDefinition struct {
	AdministratorLogin         string                    `json:"administratorLogin"`
	AdministratorLoginPassword string                    `json:"administratorLoginPassword"`
	AuthenticationType         *string                   `json:"authenticationType,omitempty"`
	DatabaseName               *string                   `json:"databaseName,omitempty"`
	Edition                    *string                   `json:"edition,omitempty"`
	MaxSizeBytes               *string                   `json:"maxSizeBytes,omitempty"`
	NetworkIsolation           *NetworkIsolationSettings `json:"networkIsolation,omitempty"`
	ServiceObjectiveName       *string                   `json:"serviceObjectiveName,omitempty"`
	StorageKey                 string                    `json:"storageKey"`
	StorageKeyType             StorageKeyType            `json:"storageKeyType"`
	StorageUri                 string                    `json:"storageUri"`
}

type ListByResourceGroupCompleteResult 

type ListByResourceGroupCompleteResult struct {
	Items []Server
}

type ListByResourceGroupOperationOptions 

type ListByResourceGroupOperationOptions struct {
	Expand *string
}

func DefaultListByResourceGroupOperationOptions 

func DefaultListByResourceGroupOperationOptions() ListByResourceGroupOperationOptions

func (ListByResourceGroupOperationOptions) ToHeaders 

func (o ListByResourceGroupOperationOptions) ToHeaders() *client.Headers

func (ListByResourceGroupOperationOptions) ToOData 

func (o ListByResourceGroupOperationOptions) ToOData() *odata.Query

func (ListByResourceGroupOperationOptions) ToQuery 

func (o ListByResourceGroupOperationOptions) ToQuery() *client.QueryParams

type ListByResourceGroupOperationResponse 

type ListByResourceGroupOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]Server
}

type ListCompleteResult 

type ListCompleteResult struct {
	Items []Server
}

type ListOperationOptions 

type ListOperationOptions struct {
	Expand *string
}

func DefaultListOperationOptions 

func DefaultListOperationOptions() ListOperationOptions

func (ListOperationOptions) ToHeaders 

func (o ListOperationOptions) ToHeaders() *client.Headers

func (ListOperationOptions) ToOData 

func (o ListOperationOptions) ToOData() *odata.Query

func (ListOperationOptions) ToQuery 

func (o ListOperationOptions) ToQuery() *client.QueryParams

type ListOperationResponse 

type ListOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]Server
}

type NetworkIsolationSettings 

type NetworkIsolationSettings struct {
	SqlServerResourceId      *string `json:"sqlServerResourceId,omitempty"`
	StorageAccountResourceId *string `json:"storageAccountResourceId,omitempty"`
}

type PrincipalType 

type PrincipalType string
const (
	PrincipalTypeApplication PrincipalType = "Application"
	PrincipalTypeGroup       PrincipalType = "Group"
	PrincipalTypeUser        PrincipalType = "User"
)

func (*PrincipalType) UnmarshalJSON 

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

type PrivateEndpointConnectionProperties 

type PrivateEndpointConnectionProperties struct {
	GroupIds                          *[]string                                  `json:"groupIds,omitempty"`
	PrivateEndpoint                   *PrivateEndpointProperty                   `json:"privateEndpoint,omitempty"`
	PrivateLinkServiceConnectionState *PrivateLinkServiceConnectionStateProperty `json:"privateLinkServiceConnectionState,omitempty"`
	ProvisioningState                 *PrivateEndpointProvisioningState          `json:"provisioningState,omitempty"`
}

type PrivateEndpointConnectionRequestStatus 

type PrivateEndpointConnectionRequestStatus struct {
	PrivateEndpointConnectionName *string `json:"privateEndpointConnectionName,omitempty"`
	PrivateLinkServiceId          *string `json:"privateLinkServiceId,omitempty"`
	Status                        *string `json:"status,omitempty"`
}

type PrivateEndpointProperty 

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

type PrivateEndpointProvisioningState 

type PrivateEndpointProvisioningState string
const (
	PrivateEndpointProvisioningStateApproving PrivateEndpointProvisioningState = "Approving"
	PrivateEndpointProvisioningStateDropping  PrivateEndpointProvisioningState = "Dropping"
	PrivateEndpointProvisioningStateFailed    PrivateEndpointProvisioningState = "Failed"
	PrivateEndpointProvisioningStateReady     PrivateEndpointProvisioningState = "Ready"
	PrivateEndpointProvisioningStateRejecting PrivateEndpointProvisioningState = "Rejecting"
)

func (*PrivateEndpointProvisioningState) UnmarshalJSON 

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

type PrivateLinkServiceConnectionStateActionsRequire 

type PrivateLinkServiceConnectionStateActionsRequire string
const (
	PrivateLinkServiceConnectionStateActionsRequireNone PrivateLinkServiceConnectionStateActionsRequire = "None"
)

func (*PrivateLinkServiceConnectionStateActionsRequire) UnmarshalJSON 

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

type PrivateLinkServiceConnectionStateProperty 

type PrivateLinkServiceConnectionStateProperty struct {
	ActionsRequired *PrivateLinkServiceConnectionStateActionsRequire `json:"actionsRequired,omitempty"`
	Description     string                                           `json:"description"`
	Status          PrivateLinkServiceConnectionStateStatus          `json:"status"`
}

type PrivateLinkServiceConnectionStateStatus 

type PrivateLinkServiceConnectionStateStatus string
const (
	PrivateLinkServiceConnectionStateStatusApproved     PrivateLinkServiceConnectionStateStatus = "Approved"
	PrivateLinkServiceConnectionStateStatusDisconnected PrivateLinkServiceConnectionStateStatus = "Disconnected"
	PrivateLinkServiceConnectionStateStatusPending      PrivateLinkServiceConnectionStateStatus = "Pending"
	PrivateLinkServiceConnectionStateStatusRejected     PrivateLinkServiceConnectionStateStatus = "Rejected"
)

func (*PrivateLinkServiceConnectionStateStatus) UnmarshalJSON 

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

type Server 

type Server struct {
	Id         *string                                  `json:"id,omitempty"`
	Identity   *identity.LegacySystemAndUserAssignedMap `json:"identity,omitempty"`
	Kind       *string                                  `json:"kind,omitempty"`
	Location   string                                   `json:"location"`
	Name       *string                                  `json:"name,omitempty"`
	Properties *ServerProperties                        `json:"properties,omitempty"`
	Tags       *map[string]string                       `json:"tags,omitempty"`
	Type       *string                                  `json:"type,omitempty"`
}

type ServerExternalAdministrator 

type ServerExternalAdministrator struct {
	AdministratorType         *AdministratorType `json:"administratorType,omitempty"`
	AzureADOnlyAuthentication *bool              `json:"azureADOnlyAuthentication,omitempty"`
	Login                     *string            `json:"login,omitempty"`
	PrincipalType             *PrincipalType     `json:"principalType,omitempty"`
	Sid                       *string            `json:"sid,omitempty"`
	TenantId                  *string            `json:"tenantId,omitempty"`
}

type ServerNetworkAccessFlag 

type ServerNetworkAccessFlag string
const (
	ServerNetworkAccessFlagDisabled ServerNetworkAccessFlag = "Disabled"
	ServerNetworkAccessFlagEnabled  ServerNetworkAccessFlag = "Enabled"
)

func (*ServerNetworkAccessFlag) UnmarshalJSON 

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

type ServerOperationPredicate 

type ServerOperationPredicate struct {
	Id       *string
	Kind     *string
	Location *string
	Name     *string
	Type     *string
}

func (ServerOperationPredicate) Matches 

func (p ServerOperationPredicate) Matches(input Server) bool

type ServerPrivateEndpointConnection 

type ServerPrivateEndpointConnection struct {
	Id         *string                              `json:"id,omitempty"`
	Properties *PrivateEndpointConnectionProperties `json:"properties,omitempty"`
}

type ServerProperties 

type ServerProperties struct {
	AdministratorLogin            *string                            `json:"administratorLogin,omitempty"`
	AdministratorLoginPassword    *string                            `json:"administratorLoginPassword,omitempty"`
	Administrators                *ServerExternalAdministrator       `json:"administrators,omitempty"`
	FederatedClientId             *string                            `json:"federatedClientId,omitempty"`
	FullyQualifiedDomainName      *string                            `json:"fullyQualifiedDomainName,omitempty"`
	KeyId                         *string                            `json:"keyId,omitempty"`
	MinimalTlsVersion             *string                            `json:"minimalTlsVersion,omitempty"`
	PrimaryUserAssignedIdentityId *string                            `json:"primaryUserAssignedIdentityId,omitempty"`
	PrivateEndpointConnections    *[]ServerPrivateEndpointConnection `json:"privateEndpointConnections,omitempty"`
	PublicNetworkAccess           *ServerNetworkAccessFlag           `json:"publicNetworkAccess,omitempty"`
	RestrictOutboundNetworkAccess *ServerNetworkAccessFlag           `json:"restrictOutboundNetworkAccess,omitempty"`
	State                         *string                            `json:"state,omitempty"`
	Version                       *string                            `json:"version,omitempty"`
	WorkspaceFeature              *ServerWorkspaceFeature            `json:"workspaceFeature,omitempty"`
}

type ServerUpdate 

type ServerUpdate struct {
	Identity   *identity.LegacySystemAndUserAssignedMap `json:"identity,omitempty"`
	Properties *ServerProperties                        `json:"properties,omitempty"`
	Tags       *map[string]string                       `json:"tags,omitempty"`
}

type ServerWorkspaceFeature 

type ServerWorkspaceFeature string
const (
	ServerWorkspaceFeatureConnected    ServerWorkspaceFeature = "Connected"
	ServerWorkspaceFeatureDisconnected ServerWorkspaceFeature = "Disconnected"
)

func (*ServerWorkspaceFeature) UnmarshalJSON 

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

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 commonids.SubscriptionId, input CheckNameAvailabilityRequest) (result CheckNameAvailabilityOperationResponse, err error)

CheckNameAvailability ...

func (ServersClient) CreateOrUpdate 

func (c ServersClient) CreateOrUpdate(ctx context.Context, id commonids.SqlServerId, input Server) (result CreateOrUpdateOperationResponse, err error)

CreateOrUpdate ...

func (ServersClient) CreateOrUpdateThenPoll 

func (c ServersClient) CreateOrUpdateThenPoll(ctx context.Context, id commonids.SqlServerId, input Server) error

CreateOrUpdateThenPoll performs CreateOrUpdate then polls until it's completed

func (ServersClient) Delete 

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

Delete ...

func (ServersClient) DeleteThenPoll 

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

DeleteThenPoll performs Delete then polls until it's completed

func (ServersClient) Get 

func (c ServersClient) Get(ctx context.Context, id commonids.SqlServerId, options GetOperationOptions) (result GetOperationResponse, err error)

Get ...

func (ServersClient) ImportDatabase 

func (c ServersClient) ImportDatabase(ctx context.Context, id commonids.SqlServerId, input ImportNewDatabaseDefinition) (result ImportDatabaseOperationResponse, err error)

ImportDatabase ...

func (ServersClient) ImportDatabaseThenPoll 

func (c ServersClient) ImportDatabaseThenPoll(ctx context.Context, id commonids.SqlServerId, input ImportNewDatabaseDefinition) error

ImportDatabaseThenPoll performs ImportDatabase then polls until it's completed

func (ServersClient) List 

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

List ...

func (ServersClient) ListByResourceGroup 

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

ListByResourceGroup ...

func (ServersClient) ListByResourceGroupComplete 

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

ListByResourceGroupComplete retrieves all the results into a single object

func (ServersClient) ListByResourceGroupCompleteMatchingPredicate 

func (c ServersClient) ListByResourceGroupCompleteMatchingPredicate(ctx context.Context, id commonids.ResourceGroupId, options ListByResourceGroupOperationOptions, predicate ServerOperationPredicate) (result ListByResourceGroupCompleteResult, err error)

ListByResourceGroupCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (ServersClient) ListComplete 

func (c ServersClient) ListComplete(ctx context.Context, id commonids.SubscriptionId, options ListOperationOptions) (ListCompleteResult, error)

ListComplete retrieves all the results into a single object

func (ServersClient) ListCompleteMatchingPredicate 

func (c ServersClient) ListCompleteMatchingPredicate(ctx context.Context, id commonids.SubscriptionId, options ListOperationOptions, predicate ServerOperationPredicate) (result ListCompleteResult, err error)

ListCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (ServersClient) Update 

func (c ServersClient) Update(ctx context.Context, id commonids.SqlServerId, input ServerUpdate) (result UpdateOperationResponse, err error)

Update ...

func (ServersClient) UpdateThenPoll 

func (c ServersClient) UpdateThenPoll(ctx context.Context, id commonids.SqlServerId, input ServerUpdate) error

UpdateThenPoll performs Update then polls until it's completed

type StorageKeyType 

type StorageKeyType string
const (
	StorageKeyTypeSharedAccessKey  StorageKeyType = "SharedAccessKey"
	StorageKeyTypeStorageAccessKey StorageKeyType = "StorageAccessKey"
)

func (*StorageKeyType) UnmarshalJSON 

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

type UpdateOperationResponse 

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

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.