changedetection

README

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

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

Client Initialization

client := changedetection.NewChangeDetectionClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: ChangeDetectionClient.CloudEndpointsTriggerChangeDetection

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

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


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

Documentation

Index

• func PossibleValuesForChangeDetectionMode() []string
• func ValidateCloudEndpointID(input interface{}, key string) (warnings []string, errors []error)
• type ChangeDetectionClient
  • func NewChangeDetectionClientWithBaseURI(api environments.Api) (*ChangeDetectionClient, error)
  • func (c ChangeDetectionClient) CloudEndpointsTriggerChangeDetection(ctx context.Context, id CloudEndpointId, ...) (result CloudEndpointsTriggerChangeDetectionOperationResponse, err error)
  • func (c ChangeDetectionClient) CloudEndpointsTriggerChangeDetectionThenPoll(ctx context.Context, id CloudEndpointId, ...) error
• type ChangeDetectionMode
  • func (s *ChangeDetectionMode) UnmarshalJSON(bytes []byte) error
• type CloudEndpointId
  • func NewCloudEndpointID(subscriptionId string, resourceGroupName string, storageSyncServiceName string, ...) CloudEndpointId
  • func ParseCloudEndpointID(input string) (*CloudEndpointId, error)
  • func ParseCloudEndpointIDInsensitively(input string) (*CloudEndpointId, error)
  • func (id CloudEndpointId) ID() string
  • func (id CloudEndpointId) Segments() []resourceids.Segment
  • func (id CloudEndpointId) String() string
• type CloudEndpointsTriggerChangeDetectionOperationResponse
• type TriggerChangeDetectionParameters

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

Types

type ChangeDetectionClient

type ChangeDetectionClient struct {
	Client *resourcemanager.Client
}

func NewChangeDetectionClientWithBaseURI

func NewChangeDetectionClientWithBaseURI(api environments.Api) (*ChangeDetectionClient, error)

func (ChangeDetectionClient) CloudEndpointsTriggerChangeDetection

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

CloudEndpointsTriggerChangeDetection ...

func (ChangeDetectionClient) CloudEndpointsTriggerChangeDetectionThenPoll

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

CloudEndpointsTriggerChangeDetectionThenPoll performs CloudEndpointsTriggerChangeDetection then polls until it's completed

type ChangeDetectionMode

type ChangeDetectionMode string

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

func (*ChangeDetectionMode) UnmarshalJSON

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

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) 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 CloudEndpointsTriggerChangeDetectionOperationResponse

type CloudEndpointsTriggerChangeDetectionOperationResponse 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"`
}