registeredserverresource

package
v0.20240119.1124806 Latest Latest
Warning

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

 Go to latest Published: Jan 19, 2024 License: MPL-2.0 Imports: 14 Imported by: 0

README

github.com/hashicorp/go-azure-sdk/resource-manager/storagesync/2022-09-01/registeredserverresource Documentation

The registeredserverresource SDK allows for interaction with the Azure Resource Manager Service storagesync (API Version 2022-09-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/storagesync/2022-09-01/registeredserverresource"

Client Initialization

client := registeredserverresource.NewRegisteredServerResourceClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: RegisteredServerResourceClient.RegisteredServersCreate

ctx := context.TODO()
id := registeredserverresource.NewRegisteredServerID("12345678-1234-9876-4563-123456789012", "example-resource-group", "storageSyncServiceValue", "serverIdValue")

payload := registeredserverresource.RegisteredServerCreateParameters{
	// ...
}


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

Example Usage: RegisteredServerResourceClient.RegisteredServersDelete

ctx := context.TODO()
id := registeredserverresource.NewRegisteredServerID("12345678-1234-9876-4563-123456789012", "example-resource-group", "storageSyncServiceValue", "serverIdValue")

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

Example Usage: RegisteredServerResourceClient.RegisteredServersGet

ctx := context.TODO()
id := registeredserverresource.NewRegisteredServerID("12345678-1234-9876-4563-123456789012", "example-resource-group", "storageSyncServiceValue", "serverIdValue")

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

Example Usage: RegisteredServerResourceClient.RegisteredServersListByStorageSyncService

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

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

Example Usage: RegisteredServerResourceClient.RegisteredServersUpdate

ctx := context.TODO()
id := registeredserverresource.NewRegisteredServerID("12345678-1234-9876-4563-123456789012", "example-resource-group", "storageSyncServiceValue", "serverIdValue")

payload := registeredserverresource.RegisteredServerUpdateParameters{
	// ...
}


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

Example Usage: RegisteredServerResourceClient.RegisteredServerstriggerRollover

ctx := context.TODO()
id := registeredserverresource.NewRegisteredServerID("12345678-1234-9876-4563-123456789012", "example-resource-group", "storageSyncServiceValue", "serverIdValue")

payload := registeredserverresource.TriggerRolloverRequest{
	// ...
}


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

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func PossibleValuesForRegisteredServerAgentVersionStatus 

func PossibleValuesForRegisteredServerAgentVersionStatus() []string

func PossibleValuesForServerAuthType 

func PossibleValuesForServerAuthType() []string

func ValidateRegisteredServerID 

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

ValidateRegisteredServerID checks that 'input' can be parsed as a Registered Server ID

func ValidateStorageSyncServiceID 

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

ValidateStorageSyncServiceID checks that 'input' can be parsed as a Storage Sync Service ID

Types

type RegisteredServer 

type RegisteredServer struct {
	Id         *string                     `json:"id,omitempty"`
	Name       *string                     `json:"name,omitempty"`
	Properties *RegisteredServerProperties `json:"properties,omitempty"`
	SystemData *systemdata.SystemData      `json:"systemData,omitempty"`
	Type       *string                     `json:"type,omitempty"`
}

type RegisteredServerAgentVersionStatus 

type RegisteredServerAgentVersionStatus string
const (
	RegisteredServerAgentVersionStatusBlocked    RegisteredServerAgentVersionStatus = "Blocked"
	RegisteredServerAgentVersionStatusExpired    RegisteredServerAgentVersionStatus = "Expired"
	RegisteredServerAgentVersionStatusNearExpiry RegisteredServerAgentVersionStatus = "NearExpiry"
	RegisteredServerAgentVersionStatusOk         RegisteredServerAgentVersionStatus = "Ok"
)

func (*RegisteredServerAgentVersionStatus) UnmarshalJSON 

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

type RegisteredServerArray 

type RegisteredServerArray struct {
	Value *[]RegisteredServer `json:"value,omitempty"`
}

type RegisteredServerCreateParameters 

type RegisteredServerCreateParameters struct {
	Id         *string                                     `json:"id,omitempty"`
	Name       *string                                     `json:"name,omitempty"`
	Properties *RegisteredServerCreateParametersProperties `json:"properties,omitempty"`
	SystemData *systemdata.SystemData                      `json:"systemData,omitempty"`
	Type       *string                                     `json:"type,omitempty"`
}

type RegisteredServerCreateParametersProperties 

type RegisteredServerCreateParametersProperties struct {
	AgentVersion      *string `json:"agentVersion,omitempty"`
	ApplicationId     *string `json:"applicationId,omitempty"`
	ClusterId         *string `json:"clusterId,omitempty"`
	ClusterName       *string `json:"clusterName,omitempty"`
	FriendlyName      *string `json:"friendlyName,omitempty"`
	Identity          *bool   `json:"identity,omitempty"`
	LastHeartBeat     *string `json:"lastHeartBeat,omitempty"`
	ServerCertificate *string `json:"serverCertificate,omitempty"`
	ServerId          *string `json:"serverId,omitempty"`
	ServerOSVersion   *string `json:"serverOSVersion,omitempty"`
	ServerRole        *string `json:"serverRole,omitempty"`
}

type RegisteredServerId 

type RegisteredServerId struct {
	SubscriptionId         string
	ResourceGroupName      string
	StorageSyncServiceName string
	ServerId               string
}

RegisteredServerId is a struct representing the Resource ID for a Registered Server

func NewRegisteredServerID 

func NewRegisteredServerID(subscriptionId string, resourceGroupName string, storageSyncServiceName string, serverId string) RegisteredServerId

NewRegisteredServerID returns a new RegisteredServerId struct

func ParseRegisteredServerID 

func ParseRegisteredServerID(input string) (*RegisteredServerId, error)

ParseRegisteredServerID parses 'input' into a RegisteredServerId

func ParseRegisteredServerIDInsensitively 

func ParseRegisteredServerIDInsensitively(input string) (*RegisteredServerId, error)

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

func (*RegisteredServerId) FromParseResult added in v0.20231127.1171502 

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

func (RegisteredServerId) ID 

func (id RegisteredServerId) ID() string

ID returns the formatted Registered Server ID

func (RegisteredServerId) Segments 

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

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

func (RegisteredServerId) String 

func (id RegisteredServerId) String() string

String returns a human-readable description of this Registered Server ID

type RegisteredServerProperties 

type RegisteredServerProperties struct {
	ActiveAuthType             *ServerAuthType                     `json:"activeAuthType,omitempty"`
	AgentVersion               *string                             `json:"agentVersion,omitempty"`
	AgentVersionExpirationDate *string                             `json:"agentVersionExpirationDate,omitempty"`
	AgentVersionStatus         *RegisteredServerAgentVersionStatus `json:"agentVersionStatus,omitempty"`
	ApplicationId              *string                             `json:"applicationId,omitempty"`
	ClusterId                  *string                             `json:"clusterId,omitempty"`
	ClusterName                *string                             `json:"clusterName,omitempty"`
	DiscoveryEndpointUri       *string                             `json:"discoveryEndpointUri,omitempty"`
	FriendlyName               *string                             `json:"friendlyName,omitempty"`
	Identity                   *bool                               `json:"identity,omitempty"`
	LastHeartBeat              *string                             `json:"lastHeartBeat,omitempty"`
	LastOperationName          *string                             `json:"lastOperationName,omitempty"`
	LastWorkflowId             *string                             `json:"lastWorkflowId,omitempty"`
	LatestApplicationId        *string                             `json:"latestApplicationId,omitempty"`
	ManagementEndpointUri      *string                             `json:"managementEndpointUri,omitempty"`
	MonitoringConfiguration    *string                             `json:"monitoringConfiguration,omitempty"`
	MonitoringEndpointUri      *string                             `json:"monitoringEndpointUri,omitempty"`
	ProvisioningState          *string                             `json:"provisioningState,omitempty"`
	ResourceLocation           *string                             `json:"resourceLocation,omitempty"`
	ServerCertificate          *string                             `json:"serverCertificate,omitempty"`
	ServerId                   *string                             `json:"serverId,omitempty"`
	ServerManagementErrorCode  *int64                              `json:"serverManagementErrorCode,omitempty"`
	ServerName                 *string                             `json:"serverName,omitempty"`
	ServerOSVersion            *string                             `json:"serverOSVersion,omitempty"`
	ServerRole                 *string                             `json:"serverRole,omitempty"`
	ServiceLocation            *string                             `json:"serviceLocation,omitempty"`
	StorageSyncServiceUid      *string                             `json:"storageSyncServiceUid,omitempty"`
}

func (*RegisteredServerProperties) GetAgentVersionExpirationDateAsTime 

func (o *RegisteredServerProperties) GetAgentVersionExpirationDateAsTime() (*time.Time, error)

func (*RegisteredServerProperties) SetAgentVersionExpirationDateAsTime 

func (o *RegisteredServerProperties) SetAgentVersionExpirationDateAsTime(input time.Time)

type RegisteredServerResourceClient 

type RegisteredServerResourceClient struct {
	Client *resourcemanager.Client
}

func NewRegisteredServerResourceClientWithBaseURI 

func NewRegisteredServerResourceClientWithBaseURI(sdkApi sdkEnv.Api) (*RegisteredServerResourceClient, error)

func (RegisteredServerResourceClient) RegisteredServersCreate 

func (c RegisteredServerResourceClient) RegisteredServersCreate(ctx context.Context, id RegisteredServerId, input RegisteredServerCreateParameters) (result RegisteredServersCreateOperationResponse, err error)

RegisteredServersCreate ...

func (RegisteredServerResourceClient) RegisteredServersCreateThenPoll 

func (c RegisteredServerResourceClient) RegisteredServersCreateThenPoll(ctx context.Context, id RegisteredServerId, input RegisteredServerCreateParameters) error

RegisteredServersCreateThenPoll performs RegisteredServersCreate then polls until it's completed

func (RegisteredServerResourceClient) RegisteredServersDelete 

func (c RegisteredServerResourceClient) RegisteredServersDelete(ctx context.Context, id RegisteredServerId) (result RegisteredServersDeleteOperationResponse, err error)

RegisteredServersDelete ...

func (RegisteredServerResourceClient) RegisteredServersDeleteThenPoll 

func (c RegisteredServerResourceClient) RegisteredServersDeleteThenPoll(ctx context.Context, id RegisteredServerId) error

RegisteredServersDeleteThenPoll performs RegisteredServersDelete then polls until it's completed

func (RegisteredServerResourceClient) RegisteredServersGet 

func (c RegisteredServerResourceClient) RegisteredServersGet(ctx context.Context, id RegisteredServerId) (result RegisteredServersGetOperationResponse, err error)

RegisteredServersGet ...

func (RegisteredServerResourceClient) RegisteredServersListByStorageSyncService 

func (c RegisteredServerResourceClient) RegisteredServersListByStorageSyncService(ctx context.Context, id StorageSyncServiceId) (result RegisteredServersListByStorageSyncServiceOperationResponse, err error)

RegisteredServersListByStorageSyncService ...

func (RegisteredServerResourceClient) RegisteredServersUpdate 

func (c RegisteredServerResourceClient) RegisteredServersUpdate(ctx context.Context, id RegisteredServerId, input RegisteredServerUpdateParameters) (result RegisteredServersUpdateOperationResponse, err error)

RegisteredServersUpdate ...

func (RegisteredServerResourceClient) RegisteredServersUpdateThenPoll 

func (c RegisteredServerResourceClient) RegisteredServersUpdateThenPoll(ctx context.Context, id RegisteredServerId, input RegisteredServerUpdateParameters) error

RegisteredServersUpdateThenPoll performs RegisteredServersUpdate then polls until it's completed

func (RegisteredServerResourceClient) RegisteredServerstriggerRollover 

func (c RegisteredServerResourceClient) RegisteredServerstriggerRollover(ctx context.Context, id RegisteredServerId, input TriggerRolloverRequest) (result RegisteredServerstriggerRolloverOperationResponse, err error)

RegisteredServerstriggerRollover ...

func (RegisteredServerResourceClient) RegisteredServerstriggerRolloverThenPoll 

func (c RegisteredServerResourceClient) RegisteredServerstriggerRolloverThenPoll(ctx context.Context, id RegisteredServerId, input TriggerRolloverRequest) error

RegisteredServerstriggerRolloverThenPoll performs RegisteredServerstriggerRollover then polls until it's completed

type RegisteredServerUpdateParameters 

type RegisteredServerUpdateParameters struct {
	Id         *string                           `json:"id,omitempty"`
	Name       *string                           `json:"name,omitempty"`
	Properties *RegisteredServerUpdateProperties `json:"properties,omitempty"`
	SystemData *systemdata.SystemData            `json:"systemData,omitempty"`
	Type       *string                           `json:"type,omitempty"`
}

type RegisteredServerUpdateProperties 

type RegisteredServerUpdateProperties struct {
	Identity *bool `json:"identity,omitempty"`
}

type RegisteredServersCreateOperationResponse 

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

type RegisteredServersDeleteOperationResponse 

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

type RegisteredServersGetOperationResponse 

type RegisteredServersGetOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *RegisteredServer
}

type RegisteredServersListByStorageSyncServiceOperationResponse 

type RegisteredServersListByStorageSyncServiceOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *RegisteredServerArray
}

type RegisteredServersUpdateOperationResponse 

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

type RegisteredServerstriggerRolloverOperationResponse 

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

type ServerAuthType 

type ServerAuthType string
const (
	ServerAuthTypeCertificate     ServerAuthType = "Certificate"
	ServerAuthTypeManagedIdentity ServerAuthType = "ManagedIdentity"
)

func (*ServerAuthType) UnmarshalJSON 

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

type StorageSyncServiceId 

type StorageSyncServiceId struct {
	SubscriptionId         string
	ResourceGroupName      string
	StorageSyncServiceName string
}

StorageSyncServiceId is a struct representing the Resource ID for a Storage Sync Service

func NewStorageSyncServiceID 

func NewStorageSyncServiceID(subscriptionId string, resourceGroupName string, storageSyncServiceName string) StorageSyncServiceId

NewStorageSyncServiceID returns a new StorageSyncServiceId struct

func ParseStorageSyncServiceID 

func ParseStorageSyncServiceID(input string) (*StorageSyncServiceId, error)

ParseStorageSyncServiceID parses 'input' into a StorageSyncServiceId

func ParseStorageSyncServiceIDInsensitively 

func ParseStorageSyncServiceIDInsensitively(input string) (*StorageSyncServiceId, error)

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

func (*StorageSyncServiceId) FromParseResult added in v0.20231127.1171502 

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

func (StorageSyncServiceId) ID 

func (id StorageSyncServiceId) ID() string

ID returns the formatted Storage Sync Service ID

func (StorageSyncServiceId) Segments 

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

Segments returns a slice of Resource ID Segments which comprise this Storage Sync Service ID

func (StorageSyncServiceId) String 

func (id StorageSyncServiceId) String() string

String returns a human-readable description of this Storage Sync Service ID

type TriggerRolloverRequest 

type TriggerRolloverRequest struct {
	ServerCertificate *string `json:"serverCertificate,omitempty"`
}

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.