actions

package
v0.20240126.1105227 Latest Latest
Warning

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

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

README

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

The actions 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/actions"

Client Initialization

client := actions.NewActionsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: ActionsClient.CloudEndpointsAfsShareMetadataCertificatePublicKeys

ctx := context.TODO()
id := actions.NewCloudEndpointID("12345678-1234-9876-4563-123456789012", "example-resource-group", "storageSyncServiceValue", "syncGroupValue", "cloudEndpointValue")

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

Example Usage: ActionsClient.CloudEndpointsPostBackup

ctx := context.TODO()
id := actions.NewCloudEndpointID("12345678-1234-9876-4563-123456789012", "example-resource-group", "storageSyncServiceValue", "syncGroupValue", "cloudEndpointValue")

payload := actions.BackupRequest{
	// ...
}


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

Example Usage: ActionsClient.CloudEndpointsPostRestore

ctx := context.TODO()
id := actions.NewCloudEndpointID("12345678-1234-9876-4563-123456789012", "example-resource-group", "storageSyncServiceValue", "syncGroupValue", "cloudEndpointValue")

payload := actions.PostRestoreRequest{
	// ...
}


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

Example Usage: ActionsClient.CloudEndpointsPreBackup

ctx := context.TODO()
id := actions.NewCloudEndpointID("12345678-1234-9876-4563-123456789012", "example-resource-group", "storageSyncServiceValue", "syncGroupValue", "cloudEndpointValue")

payload := actions.BackupRequest{
	// ...
}


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

Example Usage: ActionsClient.CloudEndpointsPreRestore

ctx := context.TODO()
id := actions.NewCloudEndpointID("12345678-1234-9876-4563-123456789012", "example-resource-group", "storageSyncServiceValue", "syncGroupValue", "cloudEndpointValue")

payload := actions.PreRestoreRequest{
	// ...
}


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

Example Usage: ActionsClient.CloudEndpointsTriggerChangeDetection

ctx := context.TODO()
id := actions.NewCloudEndpointID("12345678-1234-9876-4563-123456789012", "example-resource-group", "storageSyncServiceValue", "syncGroupValue", "cloudEndpointValue")

payload := actions.TriggerChangeDetectionParameters{
	// ...
}


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

Example Usage: ActionsClient.CloudEndpointsrestoreheartbeat

ctx := context.TODO()
id := actions.NewCloudEndpointID("12345678-1234-9876-4563-123456789012", "example-resource-group", "storageSyncServiceValue", "syncGroupValue", "cloudEndpointValue")

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

Example Usage: ActionsClient.RegisteredServerstriggerRollover

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

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


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

Example Usage: ActionsClient.ServerEndpointsrecallAction

ctx := context.TODO()
id := actions.NewServerEndpointID("12345678-1234-9876-4563-123456789012", "example-resource-group", "storageSyncServiceValue", "syncGroupValue", "serverEndpointValue")

payload := actions.RecallActionParameters{
	// ...
}


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

Example Usage: ActionsClient.WorkflowsAbort

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

read, err := client.WorkflowsAbort(ctx, id)
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 PossibleValuesForChangeDetectionMode 

func PossibleValuesForChangeDetectionMode() []string

func ValidateCloudEndpointID 

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

ValidateCloudEndpointID checks that 'input' can be parsed as a Cloud Endpoint ID

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 ValidateServerEndpointID 

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

ValidateServerEndpointID checks that 'input' can be parsed as a Server Endpoint ID

func ValidateWorkflowID 

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

ValidateWorkflowID checks that 'input' can be parsed as a Workflow ID

Types

type ActionsClient 

type ActionsClient struct {
	Client *resourcemanager.Client
}

func NewActionsClientWithBaseURI 

func NewActionsClientWithBaseURI(sdkApi sdkEnv.Api) (*ActionsClient, error)

func (ActionsClient) CloudEndpointsAfsShareMetadataCertificatePublicKeys 

func (c ActionsClient) CloudEndpointsAfsShareMetadataCertificatePublicKeys(ctx context.Context, id CloudEndpointId) (result CloudEndpointsAfsShareMetadataCertificatePublicKeysOperationResponse, err error)

CloudEndpointsAfsShareMetadataCertificatePublicKeys ...

func (ActionsClient) CloudEndpointsPostBackup 

func (c ActionsClient) CloudEndpointsPostBackup(ctx context.Context, id CloudEndpointId, input BackupRequest) (result CloudEndpointsPostBackupOperationResponse, err error)

CloudEndpointsPostBackup ...

func (ActionsClient) CloudEndpointsPostBackupThenPoll 

func (c ActionsClient) CloudEndpointsPostBackupThenPoll(ctx context.Context, id CloudEndpointId, input BackupRequest) error

CloudEndpointsPostBackupThenPoll performs CloudEndpointsPostBackup then polls until it's completed

func (ActionsClient) CloudEndpointsPostRestore 

func (c ActionsClient) CloudEndpointsPostRestore(ctx context.Context, id CloudEndpointId, input PostRestoreRequest) (result CloudEndpointsPostRestoreOperationResponse, err error)

CloudEndpointsPostRestore ...

func (ActionsClient) CloudEndpointsPostRestoreThenPoll 

func (c ActionsClient) CloudEndpointsPostRestoreThenPoll(ctx context.Context, id CloudEndpointId, input PostRestoreRequest) error

CloudEndpointsPostRestoreThenPoll performs CloudEndpointsPostRestore then polls until it's completed

func (ActionsClient) CloudEndpointsPreBackup 

func (c ActionsClient) CloudEndpointsPreBackup(ctx context.Context, id CloudEndpointId, input BackupRequest) (result CloudEndpointsPreBackupOperationResponse, err error)

CloudEndpointsPreBackup ...

func (ActionsClient) CloudEndpointsPreBackupThenPoll 

func (c ActionsClient) CloudEndpointsPreBackupThenPoll(ctx context.Context, id CloudEndpointId, input BackupRequest) error

CloudEndpointsPreBackupThenPoll performs CloudEndpointsPreBackup then polls until it's completed

func (ActionsClient) CloudEndpointsPreRestore 

func (c ActionsClient) CloudEndpointsPreRestore(ctx context.Context, id CloudEndpointId, input PreRestoreRequest) (result CloudEndpointsPreRestoreOperationResponse, err error)

CloudEndpointsPreRestore ...

func (ActionsClient) CloudEndpointsPreRestoreThenPoll 

func (c ActionsClient) CloudEndpointsPreRestoreThenPoll(ctx context.Context, id CloudEndpointId, input PreRestoreRequest) error

CloudEndpointsPreRestoreThenPoll performs CloudEndpointsPreRestore then polls until it's completed

func (ActionsClient) CloudEndpointsTriggerChangeDetection 

func (c ActionsClient) CloudEndpointsTriggerChangeDetection(ctx context.Context, id CloudEndpointId, input TriggerChangeDetectionParameters) (result CloudEndpointsTriggerChangeDetectionOperationResponse, err error)

CloudEndpointsTriggerChangeDetection ...

func (ActionsClient) CloudEndpointsTriggerChangeDetectionThenPoll 

func (c ActionsClient) CloudEndpointsTriggerChangeDetectionThenPoll(ctx context.Context, id CloudEndpointId, input TriggerChangeDetectionParameters) error

CloudEndpointsTriggerChangeDetectionThenPoll performs CloudEndpointsTriggerChangeDetection then polls until it's completed

func (ActionsClient) CloudEndpointsrestoreheartbeat 

func (c ActionsClient) CloudEndpointsrestoreheartbeat(ctx context.Context, id CloudEndpointId) (result CloudEndpointsrestoreheartbeatOperationResponse, err error)

CloudEndpointsrestoreheartbeat ...

func (ActionsClient) RegisteredServerstriggerRollover 

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

RegisteredServerstriggerRollover ...

func (ActionsClient) RegisteredServerstriggerRolloverThenPoll 

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

RegisteredServerstriggerRolloverThenPoll performs RegisteredServerstriggerRollover then polls until it's completed

func (ActionsClient) ServerEndpointsrecallAction 

func (c ActionsClient) ServerEndpointsrecallAction(ctx context.Context, id ServerEndpointId, input RecallActionParameters) (result ServerEndpointsrecallActionOperationResponse, err error)

ServerEndpointsrecallAction ...

func (ActionsClient) ServerEndpointsrecallActionThenPoll 

func (c ActionsClient) ServerEndpointsrecallActionThenPoll(ctx context.Context, id ServerEndpointId, input RecallActionParameters) error

ServerEndpointsrecallActionThenPoll performs ServerEndpointsrecallAction then polls until it's completed

func (ActionsClient) WorkflowsAbort 

func (c ActionsClient) WorkflowsAbort(ctx context.Context, id WorkflowId) (result WorkflowsAbortOperationResponse, err error)

WorkflowsAbort ...

type BackupRequest 

type BackupRequest struct {
	AzureFileShare *string `json:"azureFileShare,omitempty"`
}

type ChangeDetectionMode 

type ChangeDetectionMode string
const (
	ChangeDetectionModeDefault   ChangeDetectionMode = "Default"
	ChangeDetectionModeRecursive ChangeDetectionMode = "Recursive"
)

func (*ChangeDetectionMode) UnmarshalJSON 

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

type CloudEndpointAfsShareMetadataCertificatePublicKeys 

type CloudEndpointAfsShareMetadataCertificatePublicKeys struct {
	FirstKey  *string `json:"firstKey,omitempty"`
	SecondKey *string `json:"secondKey,omitempty"`
}

type CloudEndpointId 

type CloudEndpointId struct {
	SubscriptionId         string
	ResourceGroupName      string
	StorageSyncServiceName string
	SyncGroupName          string
	CloudEndpointName      string
}

CloudEndpointId is a struct representing the Resource ID for a Cloud Endpoint

func NewCloudEndpointID 

func NewCloudEndpointID(subscriptionId string, resourceGroupName string, storageSyncServiceName string, syncGroupName string, cloudEndpointName string) CloudEndpointId

NewCloudEndpointID returns a new CloudEndpointId struct

func ParseCloudEndpointID 

func ParseCloudEndpointID(input string) (*CloudEndpointId, error)

ParseCloudEndpointID parses 'input' into a CloudEndpointId

func ParseCloudEndpointIDInsensitively 

func ParseCloudEndpointIDInsensitively(input string) (*CloudEndpointId, error)

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

func (*CloudEndpointId) FromParseResult 

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

func (CloudEndpointId) ID 

func (id CloudEndpointId) ID() string

ID returns the formatted Cloud Endpoint ID

func (CloudEndpointId) Segments 

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

Segments returns a slice of Resource ID Segments which comprise this Cloud Endpoint ID

func (CloudEndpointId) String 

func (id CloudEndpointId) String() string

String returns a human-readable description of this Cloud Endpoint ID

type CloudEndpointsAfsShareMetadataCertificatePublicKeysOperationResponse 

type CloudEndpointsAfsShareMetadataCertificatePublicKeysOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *CloudEndpointAfsShareMetadataCertificatePublicKeys
}

type CloudEndpointsPostBackupOperationResponse 

type CloudEndpointsPostBackupOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *PostBackupResponse
}

type CloudEndpointsPostRestoreOperationResponse 

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

type CloudEndpointsPreBackupOperationResponse 

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

type CloudEndpointsPreRestoreOperationResponse 

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

type CloudEndpointsTriggerChangeDetectionOperationResponse 

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

type CloudEndpointsrestoreheartbeatOperationResponse 

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

type PostBackupResponse 

type PostBackupResponse struct {
	BackupMetadata *PostBackupResponseProperties `json:"backupMetadata,omitempty"`
}

type PostBackupResponseProperties 

type PostBackupResponseProperties struct {
	CloudEndpointName *string `json:"cloudEndpointName,omitempty"`
}

type PostRestoreRequest 

type PostRestoreRequest struct {
	AzureFileShareUri       *string            `json:"azureFileShareUri,omitempty"`
	FailedFileList          *string            `json:"failedFileList,omitempty"`
	Partition               *string            `json:"partition,omitempty"`
	ReplicaGroup            *string            `json:"replicaGroup,omitempty"`
	RequestId               *string            `json:"requestId,omitempty"`
	RestoreFileSpec         *[]RestoreFileSpec `json:"restoreFileSpec,omitempty"`
	SourceAzureFileShareUri *string            `json:"sourceAzureFileShareUri,omitempty"`
	Status                  *string            `json:"status,omitempty"`
}

type PreRestoreRequest 

type PreRestoreRequest struct {
	AzureFileShareUri                        *string            `json:"azureFileShareUri,omitempty"`
	BackupMetadataPropertyBag                *string            `json:"backupMetadataPropertyBag,omitempty"`
	Partition                                *string            `json:"partition,omitempty"`
	PauseWaitForSyncDrainTimePeriodInSeconds *int64             `json:"pauseWaitForSyncDrainTimePeriodInSeconds,omitempty"`
	ReplicaGroup                             *string            `json:"replicaGroup,omitempty"`
	RequestId                                *string            `json:"requestId,omitempty"`
	RestoreFileSpec                          *[]RestoreFileSpec `json:"restoreFileSpec,omitempty"`
	SourceAzureFileShareUri                  *string            `json:"sourceAzureFileShareUri,omitempty"`
	Status                                   *string            `json:"status,omitempty"`
}

type RecallActionParameters 

type RecallActionParameters struct {
	Pattern    *string `json:"pattern,omitempty"`
	RecallPath *string `json:"recallPath,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 

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 RegisteredServerstriggerRolloverOperationResponse 

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

type RestoreFileSpec 

type RestoreFileSpec struct {
	Isdir *bool   `json:"isdir,omitempty"`
	Path  *string `json:"path,omitempty"`
}

type ServerEndpointId 

type ServerEndpointId struct {
	SubscriptionId         string
	ResourceGroupName      string
	StorageSyncServiceName string
	SyncGroupName          string
	ServerEndpointName     string
}

ServerEndpointId is a struct representing the Resource ID for a Server Endpoint

func NewServerEndpointID 

func NewServerEndpointID(subscriptionId string, resourceGroupName string, storageSyncServiceName string, syncGroupName string, serverEndpointName string) ServerEndpointId

NewServerEndpointID returns a new ServerEndpointId struct

func ParseServerEndpointID 

func ParseServerEndpointID(input string) (*ServerEndpointId, error)

ParseServerEndpointID parses 'input' into a ServerEndpointId

func ParseServerEndpointIDInsensitively 

func ParseServerEndpointIDInsensitively(input string) (*ServerEndpointId, error)

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

func (*ServerEndpointId) FromParseResult 

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

func (ServerEndpointId) ID 

func (id ServerEndpointId) ID() string

ID returns the formatted Server Endpoint ID

func (ServerEndpointId) Segments 

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

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

func (ServerEndpointId) String 

func (id ServerEndpointId) String() string

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

type ServerEndpointsrecallActionOperationResponse 

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

type TriggerChangeDetectionParameters 

type TriggerChangeDetectionParameters struct {
	ChangeDetectionMode *ChangeDetectionMode `json:"changeDetectionMode,omitempty"`
	DirectoryPath       *string              `json:"directoryPath,omitempty"`
	Paths               *[]string            `json:"paths,omitempty"`
}

type TriggerRolloverRequest 

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

type WorkflowId 

type WorkflowId struct {
	SubscriptionId         string
	ResourceGroupName      string
	StorageSyncServiceName string
	WorkflowId             string
}

WorkflowId is a struct representing the Resource ID for a Workflow

func NewWorkflowID 

func NewWorkflowID(subscriptionId string, resourceGroupName string, storageSyncServiceName string, workflowId string) WorkflowId

NewWorkflowID returns a new WorkflowId struct

func ParseWorkflowID 

func ParseWorkflowID(input string) (*WorkflowId, error)

ParseWorkflowID parses 'input' into a WorkflowId

func ParseWorkflowIDInsensitively 

func ParseWorkflowIDInsensitively(input string) (*WorkflowId, error)

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

func (*WorkflowId) FromParseResult 

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

func (WorkflowId) ID 

func (id WorkflowId) ID() string

ID returns the formatted Workflow ID

func (WorkflowId) Segments 

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

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

func (WorkflowId) String 

func (id WorkflowId) String() string

String returns a human-readable description of this Workflow ID

type WorkflowsAbortOperationResponse 

type WorkflowsAbortOperationResponse struct {
	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.