cloudendpointresource

package
v0.20240212.1141705 Latest Latest
Warning

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

 Go to latest Published: Feb 12, 2024 License: MPL-2.0 Imports: 11 Imported by: 3

README

github.com/hashicorp/go-azure-sdk/resource-manager/storagesync/2020-03-01/cloudendpointresource Documentation

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

Client Initialization

client := cloudendpointresource.NewCloudEndpointResourceClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: CloudEndpointResourceClient.CloudEndpointsCreate

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

payload := cloudendpointresource.CloudEndpointCreateParameters{
	// ...
}


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

Example Usage: CloudEndpointResourceClient.CloudEndpointsDelete

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

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

Example Usage: CloudEndpointResourceClient.CloudEndpointsGet

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

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

Example Usage: CloudEndpointResourceClient.CloudEndpointsListBySyncGroup

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

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

Example Usage: CloudEndpointResourceClient.CloudEndpointsPostBackup

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

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


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

Example Usage: CloudEndpointResourceClient.CloudEndpointsPostRestore

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

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


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

Example Usage: CloudEndpointResourceClient.CloudEndpointsPreBackup

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

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


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

Example Usage: CloudEndpointResourceClient.CloudEndpointsPreRestore

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

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


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

Example Usage: CloudEndpointResourceClient.CloudEndpointsTriggerChangeDetection

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

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


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

Example Usage: CloudEndpointResourceClient.CloudEndpointsrestoreheartbeat

ctx := context.TODO()
id := cloudendpointresource.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
}

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 ValidateSyncGroupID 

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

ValidateSyncGroupID checks that 'input' can be parsed as a Sync Group ID

Types

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 CloudEndpoint 

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

type CloudEndpointArray 

type CloudEndpointArray struct {
	Value *[]CloudEndpoint `json:"value,omitempty"`
}

type CloudEndpointCreateParameters 

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

type CloudEndpointCreateParametersProperties 

type CloudEndpointCreateParametersProperties struct {
	AzureFileShareName       *string `json:"azureFileShareName,omitempty"`
	FriendlyName             *string `json:"friendlyName,omitempty"`
	StorageAccountResourceId *string `json:"storageAccountResourceId,omitempty"`
	StorageAccountTenantId   *string `json:"storageAccountTenantId,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 CloudEndpointProperties 

type CloudEndpointProperties struct {
	AzureFileShareName       *string `json:"azureFileShareName,omitempty"`
	BackupEnabled            *string `json:"backupEnabled,omitempty"`
	FriendlyName             *string `json:"friendlyName,omitempty"`
	LastOperationName        *string `json:"lastOperationName,omitempty"`
	LastWorkflowId           *string `json:"lastWorkflowId,omitempty"`
	PartnershipId            *string `json:"partnershipId,omitempty"`
	ProvisioningState        *string `json:"provisioningState,omitempty"`
	StorageAccountResourceId *string `json:"storageAccountResourceId,omitempty"`
	StorageAccountTenantId   *string `json:"storageAccountTenantId,omitempty"`
}

type CloudEndpointResourceClient 

type CloudEndpointResourceClient struct {
	Client *resourcemanager.Client
}

func NewCloudEndpointResourceClientWithBaseURI 

func NewCloudEndpointResourceClientWithBaseURI(sdkApi sdkEnv.Api) (*CloudEndpointResourceClient, error)

func (CloudEndpointResourceClient) CloudEndpointsCreate 

func (c CloudEndpointResourceClient) CloudEndpointsCreate(ctx context.Context, id CloudEndpointId, input CloudEndpointCreateParameters) (result CloudEndpointsCreateOperationResponse, err error)

CloudEndpointsCreate ...

func (CloudEndpointResourceClient) CloudEndpointsCreateThenPoll 

func (c CloudEndpointResourceClient) CloudEndpointsCreateThenPoll(ctx context.Context, id CloudEndpointId, input CloudEndpointCreateParameters) error

CloudEndpointsCreateThenPoll performs CloudEndpointsCreate then polls until it's completed

func (CloudEndpointResourceClient) CloudEndpointsDelete 

func (c CloudEndpointResourceClient) CloudEndpointsDelete(ctx context.Context, id CloudEndpointId) (result CloudEndpointsDeleteOperationResponse, err error)

CloudEndpointsDelete ...

func (CloudEndpointResourceClient) CloudEndpointsDeleteThenPoll 

func (c CloudEndpointResourceClient) CloudEndpointsDeleteThenPoll(ctx context.Context, id CloudEndpointId) error

CloudEndpointsDeleteThenPoll performs CloudEndpointsDelete then polls until it's completed

func (CloudEndpointResourceClient) CloudEndpointsGet 

func (c CloudEndpointResourceClient) CloudEndpointsGet(ctx context.Context, id CloudEndpointId) (result CloudEndpointsGetOperationResponse, err error)

CloudEndpointsGet ...

func (CloudEndpointResourceClient) CloudEndpointsListBySyncGroup 

func (c CloudEndpointResourceClient) CloudEndpointsListBySyncGroup(ctx context.Context, id SyncGroupId) (result CloudEndpointsListBySyncGroupOperationResponse, err error)

CloudEndpointsListBySyncGroup ...

func (CloudEndpointResourceClient) CloudEndpointsPostBackup 

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

CloudEndpointsPostBackup ...

func (CloudEndpointResourceClient) CloudEndpointsPostBackupThenPoll 

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

CloudEndpointsPostBackupThenPoll performs CloudEndpointsPostBackup then polls until it's completed

func (CloudEndpointResourceClient) CloudEndpointsPostRestore 

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

CloudEndpointsPostRestore ...

func (CloudEndpointResourceClient) CloudEndpointsPostRestoreThenPoll 

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

CloudEndpointsPostRestoreThenPoll performs CloudEndpointsPostRestore then polls until it's completed

func (CloudEndpointResourceClient) CloudEndpointsPreBackup 

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

CloudEndpointsPreBackup ...

func (CloudEndpointResourceClient) CloudEndpointsPreBackupThenPoll 

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

CloudEndpointsPreBackupThenPoll performs CloudEndpointsPreBackup then polls until it's completed

func (CloudEndpointResourceClient) CloudEndpointsPreRestore 

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

CloudEndpointsPreRestore ...

func (CloudEndpointResourceClient) CloudEndpointsPreRestoreThenPoll 

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

CloudEndpointsPreRestoreThenPoll performs CloudEndpointsPreRestore then polls until it's completed

func (CloudEndpointResourceClient) CloudEndpointsTriggerChangeDetection 

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

CloudEndpointsTriggerChangeDetection ...

func (CloudEndpointResourceClient) CloudEndpointsTriggerChangeDetectionThenPoll 

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

CloudEndpointsTriggerChangeDetectionThenPoll performs CloudEndpointsTriggerChangeDetection then polls until it's completed

func (CloudEndpointResourceClient) CloudEndpointsrestoreheartbeat 

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

CloudEndpointsrestoreheartbeat ...

type CloudEndpointsCreateOperationResponse 

type CloudEndpointsCreateOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *CloudEndpoint
}

type CloudEndpointsDeleteOperationResponse 

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

type CloudEndpointsGetOperationResponse 

type CloudEndpointsGetOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *CloudEndpoint
}

type CloudEndpointsListBySyncGroupOperationResponse 

type CloudEndpointsListBySyncGroupOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *CloudEndpointArray
}

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 RestoreFileSpec 

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

type SyncGroupId 

type SyncGroupId struct {
	SubscriptionId         string
	ResourceGroupName      string
	StorageSyncServiceName string
	SyncGroupName          string
}

SyncGroupId is a struct representing the Resource ID for a Sync Group

func NewSyncGroupID 

func NewSyncGroupID(subscriptionId string, resourceGroupName string, storageSyncServiceName string, syncGroupName string) SyncGroupId

NewSyncGroupID returns a new SyncGroupId struct

func ParseSyncGroupID 

func ParseSyncGroupID(input string) (*SyncGroupId, error)

ParseSyncGroupID parses 'input' into a SyncGroupId

func ParseSyncGroupIDInsensitively 

func ParseSyncGroupIDInsensitively(input string) (*SyncGroupId, error)

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

func (*SyncGroupId) FromParseResult 

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

func (SyncGroupId) ID 

func (id SyncGroupId) ID() string

ID returns the formatted Sync Group ID

func (SyncGroupId) Segments 

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

Segments returns a slice of Resource ID Segments which comprise this Sync Group ID

func (SyncGroupId) String 

func (id SyncGroupId) String() string

String returns a human-readable description of this Sync Group ID

type TriggerChangeDetectionParameters 

type TriggerChangeDetectionParameters struct {
	ChangeDetectionMode *ChangeDetectionMode `json:"changeDetectionMode,omitempty"`
	DirectoryPath       *string              `json:"directoryPath,omitempty"`
	Paths               *[]string            `json:"paths,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.