storagesync

package
v61.6.0+incompatible Latest Latest
Warning

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

Go to latest
Published: Feb 21, 2022 License: MIT Imports: 9 Imported by: 0

Documentation

Overview

Package storagesync implements the Azure ARM Storagesync service API version 2018-04-02.

Microsoft Storage Sync Service API

Index

Constants

View Source
const (
	// DefaultBaseURI is the default URI used for the service Storagesync
	DefaultBaseURI = "https://management.azure.com"
)

Variables

This section is empty.

Functions

func UserAgent

func UserAgent() string

UserAgent returns the UserAgent string to use when sending http.Requests.

func Version

func Version() string

Version returns the semantic version (see http://semver.org) of the client.

Types

type APIError

type APIError struct {
	// Code - Error code of the given entry.
	Code *string `json:"code,omitempty"`
	// Message - Error message of the given entry.
	Message *string `json:"message,omitempty"`
	// Target - Target of the given error entry.
	Target *string `json:"target,omitempty"`
	// Details - Error details of the given entry.
	Details *ErrorDetails `json:"details,omitempty"`
}

APIError error type

type AzureEntityResource

type AzureEntityResource struct {
	// Etag - READ-ONLY; Resource Etag.
	Etag *string `json:"etag,omitempty"`
	// ID - READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string `json:"id,omitempty"`
	// Name - READ-ONLY; The name of the resource
	Name *string `json:"name,omitempty"`
	// Type - READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string `json:"type,omitempty"`
}

AzureEntityResource the resource model definition for an Azure Resource Manager resource with an etag.

func (AzureEntityResource) MarshalJSON

func (aer AzureEntityResource) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for AzureEntityResource.

type BackupRequest

type BackupRequest struct {
	// AzureFileShare - Azure File Share.
	AzureFileShare *string `json:"azureFileShare,omitempty"`
}

BackupRequest backup request

type BaseClient

type BaseClient struct {
	autorest.Client
	BaseURI        string
	SubscriptionID string
}

BaseClient is the base client for Storagesync.

func New

func New(subscriptionID string) BaseClient

New creates an instance of the BaseClient client.

func NewWithBaseURI

func NewWithBaseURI(baseURI string, subscriptionID string) BaseClient

NewWithBaseURI creates an instance of the BaseClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).

type CheckNameAvailabilityParameters

type CheckNameAvailabilityParameters struct {
	// Name - The name to check for availability
	Name *string `json:"name,omitempty"`
	// Type - The resource type. Must be set to Microsoft.StorageSync/storageSyncServices
	Type *string `json:"type,omitempty"`
}

CheckNameAvailabilityParameters parameters for a check name availability request.

type CheckNameAvailabilityResult

type CheckNameAvailabilityResult struct {
	autorest.Response `json:"-"`
	// NameAvailable - READ-ONLY; Gets a boolean value that indicates whether the name is available for you to use. If true, the name is available. If false, the name has already been taken or invalid and cannot be used.
	NameAvailable *bool `json:"nameAvailable,omitempty"`
	// Reason - READ-ONLY; Gets the reason that a Storage Sync Service name could not be used. The Reason element is only returned if NameAvailable is false. Possible values include: 'Invalid', 'AlreadyExists'
	Reason NameAvailabilityReason `json:"reason,omitempty"`
	// Message - READ-ONLY; Gets an error message explaining the Reason value in more detail.
	Message *string `json:"message,omitempty"`
}

CheckNameAvailabilityResult the CheckNameAvailability operation response.

func (CheckNameAvailabilityResult) MarshalJSON

func (cnar CheckNameAvailabilityResult) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for CheckNameAvailabilityResult.

type CloudEndpoint

type CloudEndpoint struct {
	autorest.Response `json:"-"`
	// CloudEndpointProperties - Cloud Endpoint properties.
	*CloudEndpointProperties `json:"properties,omitempty"`
	// ID - READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string `json:"id,omitempty"`
	// Name - READ-ONLY; The name of the resource
	Name *string `json:"name,omitempty"`
	// Type - READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string `json:"type,omitempty"`
}

CloudEndpoint cloud Endpoint object.

func (CloudEndpoint) MarshalJSON

func (ce CloudEndpoint) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for CloudEndpoint.

func (*CloudEndpoint) UnmarshalJSON

func (ce *CloudEndpoint) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for CloudEndpoint struct.

type CloudEndpointArray

type CloudEndpointArray struct {
	autorest.Response `json:"-"`
	// Value - Collection of CloudEndpoint.
	Value *[]CloudEndpoint `json:"value,omitempty"`
}

CloudEndpointArray array of CloudEndpoint

type CloudEndpointCreateParameters

type CloudEndpointCreateParameters struct {
	// Location - Required. Gets or sets the location of the resource. This will be one of the supported and registered Azure Geo Regions (e.g. West US, East US, Southeast Asia, etc.). The geo region of a resource cannot be changed once it is created, but if an identical geo region is specified on update, the request will succeed.
	Location *string `json:"location,omitempty"`
	// Tags - Gets or sets a list of key value pairs that describe the resource. These tags can be used for viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key with a length no greater than 128 characters and a value with a length no greater than 256 characters.
	Tags map[string]*string `json:"tags"`
	// CloudEndpointCreateParametersProperties - The parameters used to create the storage sync service.
	*CloudEndpointCreateParametersProperties `json:"properties,omitempty"`
}

CloudEndpointCreateParameters the parameters used when creating a storage sync service.

func (CloudEndpointCreateParameters) MarshalJSON

func (cecp CloudEndpointCreateParameters) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for CloudEndpointCreateParameters.

func (*CloudEndpointCreateParameters) UnmarshalJSON

func (cecp *CloudEndpointCreateParameters) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for CloudEndpointCreateParameters struct.

type CloudEndpointCreateParametersProperties

type CloudEndpointCreateParametersProperties struct {
	// StorageAccountResourceID - Storage Account Resource Id
	StorageAccountResourceID *string `json:"storageAccountResourceId,omitempty"`
	// StorageAccountShareName - Storage Account Share name
	StorageAccountShareName *string `json:"storageAccountShareName,omitempty"`
	// StorageAccountTenantID - Storage Account Tenant Id
	StorageAccountTenantID *string `json:"storageAccountTenantId,omitempty"`
}

CloudEndpointCreateParametersProperties cloudEndpoint Properties object.

type CloudEndpointProperties

type CloudEndpointProperties struct {
	// StorageAccountResourceID - Storage Account Resource Id
	StorageAccountResourceID *string `json:"storageAccountResourceId,omitempty"`
	// StorageAccountShareName - Storage Account Share name
	StorageAccountShareName *string `json:"storageAccountShareName,omitempty"`
	// StorageAccountTenantID - Storage Account Tenant Id
	StorageAccountTenantID *string `json:"storageAccountTenantId,omitempty"`
	// PartnershipID - Partnership Id
	PartnershipID *string `json:"partnershipId,omitempty"`
	// FriendlyName - Friendly Name
	FriendlyName *string `json:"friendlyName,omitempty"`
	// BackupEnabled - READ-ONLY; Backup Enabled
	BackupEnabled *bool `json:"backupEnabled,omitempty"`
	// ProvisioningState - CloudEndpoint Provisioning State
	ProvisioningState *string `json:"provisioningState,omitempty"`
	// LastWorkflowID - CloudEndpoint lastWorkflowId
	LastWorkflowID *string `json:"lastWorkflowId,omitempty"`
	// LastOperationName - Resource Last Operation Name
	LastOperationName *string `json:"lastOperationName,omitempty"`
}

CloudEndpointProperties cloudEndpoint Properties object.

func (CloudEndpointProperties) MarshalJSON

func (cep CloudEndpointProperties) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for CloudEndpointProperties.

type CloudEndpointsClient

type CloudEndpointsClient struct {
	BaseClient
}

CloudEndpointsClient is the microsoft Storage Sync Service API

func NewCloudEndpointsClient

func NewCloudEndpointsClient(subscriptionID string) CloudEndpointsClient

NewCloudEndpointsClient creates an instance of the CloudEndpointsClient client.

func NewCloudEndpointsClientWithBaseURI

func NewCloudEndpointsClientWithBaseURI(baseURI string, subscriptionID string) CloudEndpointsClient

NewCloudEndpointsClientWithBaseURI creates an instance of the CloudEndpointsClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).

func (CloudEndpointsClient) Create

func (client CloudEndpointsClient) Create(ctx context.Context, resourceGroupName string, storageSyncServiceName string, syncGroupName string, cloudEndpointName string, parameters CloudEndpointCreateParameters) (result CloudEndpointsCreateFuture, err error)

Create create a new CloudEndpoint. Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. storageSyncServiceName - name of Storage Sync Service resource. syncGroupName - name of Sync Group resource. cloudEndpointName - name of Cloud Endpoint object. parameters - body of Cloud Endpoint resource.

func (CloudEndpointsClient) CreatePreparer

func (client CloudEndpointsClient) CreatePreparer(ctx context.Context, resourceGroupName string, storageSyncServiceName string, syncGroupName string, cloudEndpointName string, parameters CloudEndpointCreateParameters) (*http.Request, error)

CreatePreparer prepares the Create request.

func (CloudEndpointsClient) CreateResponder

func (client CloudEndpointsClient) CreateResponder(resp *http.Response) (result CloudEndpoint, err error)

CreateResponder handles the response to the Create request. The method always closes the http.Response Body.

func (CloudEndpointsClient) CreateSender

func (client CloudEndpointsClient) CreateSender(req *http.Request) (future CloudEndpointsCreateFuture, err error)

CreateSender sends the Create request. The method will close the http.Response Body if it receives an error.

func (CloudEndpointsClient) Delete

func (client CloudEndpointsClient) Delete(ctx context.Context, resourceGroupName string, storageSyncServiceName string, syncGroupName string, cloudEndpointName string) (result CloudEndpointsDeleteFuture, err error)

Delete delete a given CloudEndpoint. Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. storageSyncServiceName - name of Storage Sync Service resource. syncGroupName - name of Sync Group resource. cloudEndpointName - name of Cloud Endpoint object.

func (CloudEndpointsClient) DeletePreparer

func (client CloudEndpointsClient) DeletePreparer(ctx context.Context, resourceGroupName string, storageSyncServiceName string, syncGroupName string, cloudEndpointName string) (*http.Request, error)

DeletePreparer prepares the Delete request.

func (CloudEndpointsClient) DeleteResponder

func (client CloudEndpointsClient) DeleteResponder(resp *http.Response) (result autorest.Response, err error)

DeleteResponder handles the response to the Delete request. The method always closes the http.Response Body.

func (CloudEndpointsClient) DeleteSender

func (client CloudEndpointsClient) DeleteSender(req *http.Request) (future CloudEndpointsDeleteFuture, err error)

DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.

func (CloudEndpointsClient) Get

func (client CloudEndpointsClient) Get(ctx context.Context, resourceGroupName string, storageSyncServiceName string, syncGroupName string, cloudEndpointName string) (result CloudEndpoint, err error)

Get get a given CloudEndpoint. Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. storageSyncServiceName - name of Storage Sync Service resource. syncGroupName - name of Sync Group resource. cloudEndpointName - name of Cloud Endpoint object.

func (CloudEndpointsClient) GetPreparer

func (client CloudEndpointsClient) GetPreparer(ctx context.Context, resourceGroupName string, storageSyncServiceName string, syncGroupName string, cloudEndpointName string) (*http.Request, error)

GetPreparer prepares the Get request.

func (CloudEndpointsClient) GetResponder

func (client CloudEndpointsClient) GetResponder(resp *http.Response) (result CloudEndpoint, err error)

GetResponder handles the response to the Get request. The method always closes the http.Response Body.

func (CloudEndpointsClient) GetSender

func (client CloudEndpointsClient) GetSender(req *http.Request) (*http.Response, error)

GetSender sends the Get request. The method will close the http.Response Body if it receives an error.

func (CloudEndpointsClient) ListBySyncGroup

func (client CloudEndpointsClient) ListBySyncGroup(ctx context.Context, resourceGroupName string, storageSyncServiceName string, syncGroupName string) (result CloudEndpointArray, err error)

ListBySyncGroup get a CloudEndpoint List. Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. storageSyncServiceName - name of Storage Sync Service resource. syncGroupName - name of Sync Group resource.

func (CloudEndpointsClient) ListBySyncGroupPreparer

func (client CloudEndpointsClient) ListBySyncGroupPreparer(ctx context.Context, resourceGroupName string, storageSyncServiceName string, syncGroupName string) (*http.Request, error)

ListBySyncGroupPreparer prepares the ListBySyncGroup request.

func (CloudEndpointsClient) ListBySyncGroupResponder

func (client CloudEndpointsClient) ListBySyncGroupResponder(resp *http.Response) (result CloudEndpointArray, err error)

ListBySyncGroupResponder handles the response to the ListBySyncGroup request. The method always closes the http.Response Body.

func (CloudEndpointsClient) ListBySyncGroupSender

func (client CloudEndpointsClient) ListBySyncGroupSender(req *http.Request) (*http.Response, error)

ListBySyncGroupSender sends the ListBySyncGroup request. The method will close the http.Response Body if it receives an error.

func (CloudEndpointsClient) PostBackup

func (client CloudEndpointsClient) PostBackup(ctx context.Context, resourceGroupName string, storageSyncServiceName string, syncGroupName string, cloudEndpointName string, parameters BackupRequest) (result CloudEndpointsPostBackupFuture, err error)

PostBackup post Backup a given CloudEndpoint. Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. storageSyncServiceName - name of Storage Sync Service resource. syncGroupName - name of Sync Group resource. cloudEndpointName - name of Cloud Endpoint object. parameters - body of Backup request.

func (CloudEndpointsClient) PostBackupPreparer

func (client CloudEndpointsClient) PostBackupPreparer(ctx context.Context, resourceGroupName string, storageSyncServiceName string, syncGroupName string, cloudEndpointName string, parameters BackupRequest) (*http.Request, error)

PostBackupPreparer prepares the PostBackup request.

func (CloudEndpointsClient) PostBackupResponder

func (client CloudEndpointsClient) PostBackupResponder(resp *http.Response) (result PostBackupResponse, err error)

PostBackupResponder handles the response to the PostBackup request. The method always closes the http.Response Body.

func (CloudEndpointsClient) PostBackupSender

func (client CloudEndpointsClient) PostBackupSender(req *http.Request) (future CloudEndpointsPostBackupFuture, err error)

PostBackupSender sends the PostBackup request. The method will close the http.Response Body if it receives an error.

func (CloudEndpointsClient) PostRestore

func (client CloudEndpointsClient) PostRestore(ctx context.Context, resourceGroupName string, storageSyncServiceName string, syncGroupName string, cloudEndpointName string, parameters PostRestoreRequest) (result CloudEndpointsPostRestoreFuture, err error)

PostRestore post Restore a given CloudEndpoint. Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. storageSyncServiceName - name of Storage Sync Service resource. syncGroupName - name of Sync Group resource. cloudEndpointName - name of Cloud Endpoint object. parameters - body of Cloud Endpoint object.

func (CloudEndpointsClient) PostRestorePreparer

func (client CloudEndpointsClient) PostRestorePreparer(ctx context.Context, resourceGroupName string, storageSyncServiceName string, syncGroupName string, cloudEndpointName string, parameters PostRestoreRequest) (*http.Request, error)

PostRestorePreparer prepares the PostRestore request.

func (CloudEndpointsClient) PostRestoreResponder

func (client CloudEndpointsClient) PostRestoreResponder(resp *http.Response) (result autorest.Response, err error)

PostRestoreResponder handles the response to the PostRestore request. The method always closes the http.Response Body.

func (CloudEndpointsClient) PostRestoreSender

func (client CloudEndpointsClient) PostRestoreSender(req *http.Request) (future CloudEndpointsPostRestoreFuture, err error)

PostRestoreSender sends the PostRestore request. The method will close the http.Response Body if it receives an error.

func (CloudEndpointsClient) PreBackup

func (client CloudEndpointsClient) PreBackup(ctx context.Context, resourceGroupName string, storageSyncServiceName string, syncGroupName string, cloudEndpointName string, parameters BackupRequest) (result CloudEndpointsPreBackupFuture, err error)

PreBackup pre Backup a given CloudEndpoint. Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. storageSyncServiceName - name of Storage Sync Service resource. syncGroupName - name of Sync Group resource. cloudEndpointName - name of Cloud Endpoint object. parameters - body of Backup request.

func (CloudEndpointsClient) PreBackupPreparer

func (client CloudEndpointsClient) PreBackupPreparer(ctx context.Context, resourceGroupName string, storageSyncServiceName string, syncGroupName string, cloudEndpointName string, parameters BackupRequest) (*http.Request, error)

PreBackupPreparer prepares the PreBackup request.

func (CloudEndpointsClient) PreBackupResponder

func (client CloudEndpointsClient) PreBackupResponder(resp *http.Response) (result autorest.Response, err error)

PreBackupResponder handles the response to the PreBackup request. The method always closes the http.Response Body.

func (CloudEndpointsClient) PreBackupSender

func (client CloudEndpointsClient) PreBackupSender(req *http.Request) (future CloudEndpointsPreBackupFuture, err error)

PreBackupSender sends the PreBackup request. The method will close the http.Response Body if it receives an error.

func (CloudEndpointsClient) PreRestore

func (client CloudEndpointsClient) PreRestore(ctx context.Context, resourceGroupName string, storageSyncServiceName string, syncGroupName string, cloudEndpointName string, parameters PreRestoreRequest) (result CloudEndpointsPreRestoreFuture, err error)

PreRestore pre Restore a given CloudEndpoint. Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. storageSyncServiceName - name of Storage Sync Service resource. syncGroupName - name of Sync Group resource. cloudEndpointName - name of Cloud Endpoint object. parameters - body of Cloud Endpoint object.

func (CloudEndpointsClient) PreRestorePreparer

func (client CloudEndpointsClient) PreRestorePreparer(ctx context.Context, resourceGroupName string, storageSyncServiceName string, syncGroupName string, cloudEndpointName string, parameters PreRestoreRequest) (*http.Request, error)

PreRestorePreparer prepares the PreRestore request.

func (CloudEndpointsClient) PreRestoreResponder

func (client CloudEndpointsClient) PreRestoreResponder(resp *http.Response) (result autorest.Response, err error)

PreRestoreResponder handles the response to the PreRestore request. The method always closes the http.Response Body.

func (CloudEndpointsClient) PreRestoreSender

func (client CloudEndpointsClient) PreRestoreSender(req *http.Request) (future CloudEndpointsPreRestoreFuture, err error)

PreRestoreSender sends the PreRestore request. The method will close the http.Response Body if it receives an error.

func (CloudEndpointsClient) Restoreheartbeat

func (client CloudEndpointsClient) Restoreheartbeat(ctx context.Context, resourceGroupName string, storageSyncServiceName string, syncGroupName string, cloudEndpointName string) (result autorest.Response, err error)

Restoreheartbeat restore Heartbeat a given CloudEndpoint. Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. storageSyncServiceName - name of Storage Sync Service resource. syncGroupName - name of Sync Group resource. cloudEndpointName - name of Cloud Endpoint object.

func (CloudEndpointsClient) RestoreheartbeatPreparer

func (client CloudEndpointsClient) RestoreheartbeatPreparer(ctx context.Context, resourceGroupName string, storageSyncServiceName string, syncGroupName string, cloudEndpointName string) (*http.Request, error)

RestoreheartbeatPreparer prepares the Restoreheartbeat request.

func (CloudEndpointsClient) RestoreheartbeatResponder

func (client CloudEndpointsClient) RestoreheartbeatResponder(resp *http.Response) (result autorest.Response, err error)

RestoreheartbeatResponder handles the response to the Restoreheartbeat request. The method always closes the http.Response Body.

func (CloudEndpointsClient) RestoreheartbeatSender

func (client CloudEndpointsClient) RestoreheartbeatSender(req *http.Request) (*http.Response, error)

RestoreheartbeatSender sends the Restoreheartbeat request. The method will close the http.Response Body if it receives an error.

type CloudEndpointsCreateFuture

type CloudEndpointsCreateFuture struct {
	azure.FutureAPI
	// Result returns the result of the asynchronous operation.
	// If the operation has not completed it will return an error.
	Result func(CloudEndpointsClient) (CloudEndpoint, error)
}

CloudEndpointsCreateFuture an abstraction for monitoring and retrieving the results of a long-running operation.

func (*CloudEndpointsCreateFuture) UnmarshalJSON

func (future *CloudEndpointsCreateFuture) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaller for CreateFuture.

type CloudEndpointsDeleteFuture

type CloudEndpointsDeleteFuture struct {
	azure.FutureAPI
	// Result returns the result of the asynchronous operation.
	// If the operation has not completed it will return an error.
	Result func(CloudEndpointsClient) (autorest.Response, error)
}

CloudEndpointsDeleteFuture an abstraction for monitoring and retrieving the results of a long-running operation.

func (*CloudEndpointsDeleteFuture) UnmarshalJSON

func (future *CloudEndpointsDeleteFuture) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaller for CreateFuture.

type CloudEndpointsPostBackupFuture

type CloudEndpointsPostBackupFuture struct {
	azure.FutureAPI
	// Result returns the result of the asynchronous operation.
	// If the operation has not completed it will return an error.
	Result func(CloudEndpointsClient) (PostBackupResponse, error)
}

CloudEndpointsPostBackupFuture an abstraction for monitoring and retrieving the results of a long-running operation.

func (*CloudEndpointsPostBackupFuture) UnmarshalJSON

func (future *CloudEndpointsPostBackupFuture) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaller for CreateFuture.

type CloudEndpointsPostRestoreFuture

type CloudEndpointsPostRestoreFuture struct {
	azure.FutureAPI
	// Result returns the result of the asynchronous operation.
	// If the operation has not completed it will return an error.
	Result func(CloudEndpointsClient) (autorest.Response, error)
}

CloudEndpointsPostRestoreFuture an abstraction for monitoring and retrieving the results of a long-running operation.

func (*CloudEndpointsPostRestoreFuture) UnmarshalJSON

func (future *CloudEndpointsPostRestoreFuture) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaller for CreateFuture.

type CloudEndpointsPreBackupFuture

type CloudEndpointsPreBackupFuture struct {
	azure.FutureAPI
	// Result returns the result of the asynchronous operation.
	// If the operation has not completed it will return an error.
	Result func(CloudEndpointsClient) (autorest.Response, error)
}

CloudEndpointsPreBackupFuture an abstraction for monitoring and retrieving the results of a long-running operation.

func (*CloudEndpointsPreBackupFuture) UnmarshalJSON

func (future *CloudEndpointsPreBackupFuture) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaller for CreateFuture.

type CloudEndpointsPreRestoreFuture

type CloudEndpointsPreRestoreFuture struct {
	azure.FutureAPI
	// Result returns the result of the asynchronous operation.
	// If the operation has not completed it will return an error.
	Result func(CloudEndpointsClient) (autorest.Response, error)
}

CloudEndpointsPreRestoreFuture an abstraction for monitoring and retrieving the results of a long-running operation.

func (*CloudEndpointsPreRestoreFuture) UnmarshalJSON

func (future *CloudEndpointsPreRestoreFuture) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaller for CreateFuture.

type CloudTiering

type CloudTiering string

CloudTiering enumerates the values for cloud tiering.

const (
	// Off ...
	Off CloudTiering = "off"
	// On ...
	On CloudTiering = "on"
)

func PossibleCloudTieringValues

func PossibleCloudTieringValues() []CloudTiering

PossibleCloudTieringValues returns an array of possible values for the CloudTiering const type.

type CloudTiering1

type CloudTiering1 string

CloudTiering1 enumerates the values for cloud tiering 1.

const (
	// CloudTiering1Off ...
	CloudTiering1Off CloudTiering1 = "off"
	// CloudTiering1On ...
	CloudTiering1On CloudTiering1 = "on"
)

func PossibleCloudTiering1Values

func PossibleCloudTiering1Values() []CloudTiering1

PossibleCloudTiering1Values returns an array of possible values for the CloudTiering1 const type.

type CloudTiering2

type CloudTiering2 string

CloudTiering2 enumerates the values for cloud tiering 2.

const (
	// CloudTiering2Off ...
	CloudTiering2Off CloudTiering2 = "off"
	// CloudTiering2On ...
	CloudTiering2On CloudTiering2 = "on"
)

func PossibleCloudTiering2Values

func PossibleCloudTiering2Values() []CloudTiering2

PossibleCloudTiering2Values returns an array of possible values for the CloudTiering2 const type.

type Error

type Error struct {
	// Error - Error details of the given entry.
	Error *APIError `json:"error,omitempty"`
	// Innererror - Error details of the given entry.
	Innererror *APIError `json:"innererror,omitempty"`
}

Error error type

type ErrorDetails

type ErrorDetails struct {
	// Code - Error code of the given entry.
	Code *string `json:"code,omitempty"`
	// Message - Error message of the given entry.
	Message *string `json:"message,omitempty"`
	// Target - Target of the given entry.
	Target *string `json:"target,omitempty"`
}

ErrorDetails error Details object.

type NameAvailabilityReason

type NameAvailabilityReason string

NameAvailabilityReason enumerates the values for name availability reason.

const (
	// AlreadyExists ...
	AlreadyExists NameAvailabilityReason = "AlreadyExists"
	// Invalid ...
	Invalid NameAvailabilityReason = "Invalid"
)

func PossibleNameAvailabilityReasonValues

func PossibleNameAvailabilityReasonValues() []NameAvailabilityReason

PossibleNameAvailabilityReasonValues returns an array of possible values for the NameAvailabilityReason const type.

type Operation

type Operation string

Operation enumerates the values for operation.

const (
	// Cancel ...
	Cancel Operation = "cancel"
	// Do ...
	Do Operation = "do"
	// Undo ...
	Undo Operation = "undo"
)

func PossibleOperationValues

func PossibleOperationValues() []Operation

PossibleOperationValues returns an array of possible values for the Operation const type.

type OperationDisplayInfo

type OperationDisplayInfo struct {
	// Description - The description of the operation.
	Description *string `json:"description,omitempty"`
	// Operation - The action that users can perform, based on their permission level.
	Operation *string `json:"operation,omitempty"`
	// Provider - Service provider: Microsoft StorageSync.
	Provider *string `json:"provider,omitempty"`
	// Resource - Resource on which the operation is performed.
	Resource *string `json:"resource,omitempty"`
}

OperationDisplayInfo the operation supported by storage sync.

type OperationDisplayResource

type OperationDisplayResource struct {
	// Provider - Operation Display Resource Provider.
	Provider *string `json:"provider,omitempty"`
	// Resource - Operation Display Resource.
	Resource *string `json:"resource,omitempty"`
	// Operation - Operation Display Resource Operation.
	Operation *string `json:"operation,omitempty"`
	// Description - Operation Display Resource Description.
	Description *string `json:"description,omitempty"`
}

OperationDisplayResource operation Display Resource object.

type OperationEntity

type OperationEntity struct {
	// Name - Operation name: {provider}/{resource}/{operation}.
	Name *string `json:"name,omitempty"`
	// Display - The operation supported by storage sync.
	Display *OperationDisplayInfo `json:"display,omitempty"`
	// Origin - The origin.
	Origin *string `json:"origin,omitempty"`
}

OperationEntity the operation supported by storage sync.

type OperationEntityListResult

type OperationEntityListResult struct {
	autorest.Response `json:"-"`
	// NextLink - The link used to get the next page of operations.
	NextLink *string `json:"nextLink,omitempty"`
	// Value - The list of operations.
	Value *[]OperationEntity `json:"value,omitempty"`
}

OperationEntityListResult the list of storage sync operations.

func (OperationEntityListResult) IsEmpty

func (oelr OperationEntityListResult) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type OperationEntityListResultIterator

type OperationEntityListResultIterator struct {
	// contains filtered or unexported fields
}

OperationEntityListResultIterator provides access to a complete listing of OperationEntity values.

func NewOperationEntityListResultIterator

func NewOperationEntityListResultIterator(page OperationEntityListResultPage) OperationEntityListResultIterator

Creates a new instance of the OperationEntityListResultIterator type.

func (*OperationEntityListResultIterator) Next

Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned. Deprecated: Use NextWithContext() instead.

func (*OperationEntityListResultIterator) NextWithContext

func (iter *OperationEntityListResultIterator) NextWithContext(ctx context.Context) (err error)

NextWithContext advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.

func (OperationEntityListResultIterator) NotDone

func (iter OperationEntityListResultIterator) NotDone() bool

NotDone returns true if the enumeration should be started or is not yet complete.

func (OperationEntityListResultIterator) Response

Response returns the raw server response from the last page request.

func (OperationEntityListResultIterator) Value

Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.

type OperationEntityListResultPage

type OperationEntityListResultPage struct {
	// contains filtered or unexported fields
}

OperationEntityListResultPage contains a page of OperationEntity values.

func NewOperationEntityListResultPage

Creates a new instance of the OperationEntityListResultPage type.

func (*OperationEntityListResultPage) Next

func (page *OperationEntityListResultPage) Next() error

Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned. Deprecated: Use NextWithContext() instead.

func (*OperationEntityListResultPage) NextWithContext

func (page *OperationEntityListResultPage) NextWithContext(ctx context.Context) (err error)

NextWithContext advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.

func (OperationEntityListResultPage) NotDone

func (page OperationEntityListResultPage) NotDone() bool

NotDone returns true if the page enumeration should be started or is not yet complete.

func (OperationEntityListResultPage) Response

Response returns the raw server response from the last page request.

func (OperationEntityListResultPage) Values

Values returns the slice of values for the current page or nil if there are no values.

type OperationsClient

type OperationsClient struct {
	BaseClient
}

OperationsClient is the microsoft Storage Sync Service API

func NewOperationsClient

func NewOperationsClient(subscriptionID string) OperationsClient

NewOperationsClient creates an instance of the OperationsClient client.

func NewOperationsClientWithBaseURI

func NewOperationsClientWithBaseURI(baseURI string, subscriptionID string) OperationsClient

NewOperationsClientWithBaseURI creates an instance of the OperationsClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).

func (OperationsClient) List

func (client OperationsClient) List(ctx context.Context) (result OperationEntityListResultPage, err error)

List lists all of the available Storage Sync Rest API operations.

func (OperationsClient) ListComplete

func (client OperationsClient) ListComplete(ctx context.Context) (result OperationEntityListResultIterator, err error)

ListComplete enumerates all values, automatically crossing page boundaries as required.

func (OperationsClient) ListPreparer

func (client OperationsClient) ListPreparer(ctx context.Context) (*http.Request, error)

ListPreparer prepares the List request.

func (OperationsClient) ListResponder

func (client OperationsClient) ListResponder(resp *http.Response) (result OperationEntityListResult, err error)

ListResponder handles the response to the List request. The method always closes the http.Response Body.

func (OperationsClient) ListSender

func (client OperationsClient) ListSender(req *http.Request) (*http.Response, error)

ListSender sends the List request. The method will close the http.Response Body if it receives an error.

type PostBackupResponse

type PostBackupResponse struct {
	autorest.Response `json:"-"`
	// PostBackupResponseProperties - Post Backup Response Properties
	*PostBackupResponseProperties `json:"backupMetadata,omitempty"`
}

PostBackupResponse post Backup Response

func (PostBackupResponse) MarshalJSON

func (pbr PostBackupResponse) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for PostBackupResponse.

func (*PostBackupResponse) UnmarshalJSON

func (pbr *PostBackupResponse) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for PostBackupResponse struct.

type PostBackupResponseProperties

type PostBackupResponseProperties struct {
	// CloudEndpointName - READ-ONLY; cloud endpoint Name.
	CloudEndpointName *string `json:"cloudEndpointName,omitempty"`
}

PostBackupResponseProperties post Backup Response Properties object.

func (PostBackupResponseProperties) MarshalJSON

func (pbrp PostBackupResponseProperties) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for PostBackupResponseProperties.

type PostRestoreRequest

type PostRestoreRequest struct {
	// Partition - Post Restore partition.
	Partition *string `json:"partition,omitempty"`
	// ReplicaGroup - Post Restore replica group.
	ReplicaGroup *string `json:"replicaGroup,omitempty"`
	// RequestID - Post Restore request id.
	RequestID *string `json:"requestId,omitempty"`
	// AzureFileShareURI - Post Restore Azure file share uri.
	AzureFileShareURI *string `json:"azureFileShareUri,omitempty"`
	// Status - Post Restore Azure status.
	Status *string `json:"status,omitempty"`
	// SourceAzureFileShareURI - Post Restore Azure source azure file share uri.
	SourceAzureFileShareURI *string `json:"sourceAzureFileShareUri,omitempty"`
	// FailedFileList - Post Restore Azure failed file list.
	FailedFileList *string `json:"failedFileList,omitempty"`
	// RestoreFileSpec - Post Restore restore file spec array.
	RestoreFileSpec *[]RestoreFileSpec `json:"restoreFileSpec,omitempty"`
}

PostRestoreRequest post Restore Request

type PreRestoreRequest

type PreRestoreRequest struct {
	// Partition - Pre Restore partition.
	Partition *string `json:"partition,omitempty"`
	// ReplicaGroup - Pre Restore replica group.
	ReplicaGroup *string `json:"replicaGroup,omitempty"`
	// RequestID - Pre Restore request id.
	RequestID *string `json:"requestId,omitempty"`
	// AzureFileShareURI - Pre Restore Azure file share uri.
	AzureFileShareURI *string `json:"azureFileShareUri,omitempty"`
	// Status - Pre Restore Azure status.
	Status *string `json:"status,omitempty"`
	// SourceAzureFileShareURI - Pre Restore Azure source azure file share uri.
	SourceAzureFileShareURI *string `json:"sourceAzureFileShareUri,omitempty"`
	// BackupMetadataPropertyBag - Pre Restore backup metadata property bag.
	BackupMetadataPropertyBag *string `json:"backupMetadataPropertyBag,omitempty"`
	// RestoreFileSpec - Pre Restore restore file spec array.
	RestoreFileSpec *[]RestoreFileSpec `json:"restoreFileSpec,omitempty"`
	// PauseWaitForSyncDrainTimePeriodInSeconds - Pre Restore pause wait for sync drain time period in seconds.
	PauseWaitForSyncDrainTimePeriodInSeconds *int32 `json:"pauseWaitForSyncDrainTimePeriodInSeconds,omitempty"`
}

PreRestoreRequest pre Restore request object.

type ProxyResource

type ProxyResource struct {
	// ID - READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string `json:"id,omitempty"`
	// Name - READ-ONLY; The name of the resource
	Name *string `json:"name,omitempty"`
	// Type - READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string `json:"type,omitempty"`
}

ProxyResource the resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location

func (ProxyResource) MarshalJSON

func (pr ProxyResource) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for ProxyResource.

type Reason

type Reason string

Reason enumerates the values for reason.

const (
	// Deleted ...
	Deleted Reason = "Deleted"
	// Registered ...
	Registered Reason = "Registered"
	// Suspended ...
	Suspended Reason = "Suspended"
	// Unregistered ...
	Unregistered Reason = "Unregistered"
	// Warned ...
	Warned Reason = "Warned"
)

func PossibleReasonValues

func PossibleReasonValues() []Reason

PossibleReasonValues returns an array of possible values for the Reason const type.

type RecallActionParameters

type RecallActionParameters struct {
	// Pattern - Pattern of the files.
	Pattern *string `json:"pattern,omitempty"`
	// RecallPath - Recall path.
	RecallPath *string `json:"recallPath,omitempty"`
}

RecallActionParameters the parameters used when calling recall action on server endpoint.

type RegisteredServer

type RegisteredServer struct {
	autorest.Response `json:"-"`
	// RegisteredServerProperties - RegisteredServer properties.
	*RegisteredServerProperties `json:"properties,omitempty"`
	// ID - READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string `json:"id,omitempty"`
	// Name - READ-ONLY; The name of the resource
	Name *string `json:"name,omitempty"`
	// Type - READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string `json:"type,omitempty"`
}

RegisteredServer registered Server resource.

func (RegisteredServer) MarshalJSON

func (rs RegisteredServer) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for RegisteredServer.

func (*RegisteredServer) UnmarshalJSON

func (rs *RegisteredServer) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for RegisteredServer struct.

type RegisteredServerArray

type RegisteredServerArray struct {
	autorest.Response `json:"-"`
	// Value - Collection of Registered Server.
	Value *[]RegisteredServer `json:"value,omitempty"`
}

RegisteredServerArray array of RegisteredServer

type RegisteredServerCreateParameters

type RegisteredServerCreateParameters struct {
	// Location - Required. Gets or sets the location of the resource. This will be one of the supported and registered Azure Geo Regions (e.g. West US, East US, Southeast Asia, etc.). The geo region of a resource cannot be changed once it is created, but if an identical geo region is specified on update, the request will succeed.
	Location *string `json:"location,omitempty"`
	// Tags - Gets or sets a list of key value pairs that describe the resource. These tags can be used for viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key with a length no greater than 128 characters and a value with a length no greater than 256 characters.
	Tags map[string]*string `json:"tags"`
	// RegisteredServerCreateParametersProperties - The parameters used to create the storage sync service.
	*RegisteredServerCreateParametersProperties `json:"properties,omitempty"`
}

RegisteredServerCreateParameters the parameters used when creating a storage sync service.

func (RegisteredServerCreateParameters) MarshalJSON

func (rscp RegisteredServerCreateParameters) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for RegisteredServerCreateParameters.

func (*RegisteredServerCreateParameters) UnmarshalJSON

func (rscp *RegisteredServerCreateParameters) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for RegisteredServerCreateParameters struct.

type RegisteredServerCreateParametersProperties

type RegisteredServerCreateParametersProperties struct {
	// ServerCertificate - Registered Server Certificate
	ServerCertificate *string `json:"serverCertificate,omitempty"`
	// AgentVersion - Registered Server Agent Version
	AgentVersion *string `json:"agentVersion,omitempty"`
	// ServerOSVersion - Registered Server OS Version
	ServerOSVersion *string `json:"serverOSVersion,omitempty"`
	// LastHeartBeat - Registered Server last heart beat
	LastHeartBeat *string `json:"lastHeartBeat,omitempty"`
	// ServerRole - Registered Server serverRole
	ServerRole *string `json:"serverRole,omitempty"`
	// ClusterID - Registered Server clusterId
	ClusterID *string `json:"clusterId,omitempty"`
	// ClusterName - Registered Server clusterName
	ClusterName *string `json:"clusterName,omitempty"`
	// ServerID - Registered Server serverId
	ServerID *string `json:"serverId,omitempty"`
	// FriendlyName - Friendly Name
	FriendlyName *string `json:"friendlyName,omitempty"`
}

RegisteredServerCreateParametersProperties registeredServer Properties object.

type RegisteredServerProperties

type RegisteredServerProperties struct {
	// ServerCertificate - Registered Server Certificate
	ServerCertificate *string `json:"serverCertificate,omitempty"`
	// AgentVersion - Registered Server Agent Version
	AgentVersion *string `json:"agentVersion,omitempty"`
	// ServerOSVersion - Registered Server OS Version
	ServerOSVersion *string `json:"serverOSVersion,omitempty"`
	// ServerManagementtErrorCode - Registered Server Management Error Code
	ServerManagementtErrorCode *int32 `json:"serverManagementtErrorCode,omitempty"`
	// LastHeartBeat - Registered Server last heart beat
	LastHeartBeat *string `json:"lastHeartBeat,omitempty"`
	// ProvisioningState - Registered Server Provisioning State
	ProvisioningState *string `json:"provisioningState,omitempty"`
	// ServerRole - Registered Server serverRole
	ServerRole *string `json:"serverRole,omitempty"`
	// ClusterID - Registered Server clusterId
	ClusterID *string `json:"clusterId,omitempty"`
	// ClusterName - Registered Server clusterName
	ClusterName *string `json:"clusterName,omitempty"`
	// ServerID - Registered Server serverId
	ServerID *string `json:"serverId,omitempty"`
	// StorageSyncServiceUID - Registered Server storageSyncServiceUid
	StorageSyncServiceUID *string `json:"storageSyncServiceUid,omitempty"`
	// LastWorkflowID - Registered Server lastWorkflowId
	LastWorkflowID *string `json:"lastWorkflowId,omitempty"`
	// LastOperationName - Resource Last Operation Name
	LastOperationName *string `json:"lastOperationName,omitempty"`
	// DiscoveryEndpointURI - Resource discoveryEndpointUri
	DiscoveryEndpointURI *string `json:"discoveryEndpointUri,omitempty"`
	// ResourceLocation - Resource Location
	ResourceLocation *string `json:"resourceLocation,omitempty"`
	// ServiceLocation - Service Location
	ServiceLocation *string `json:"serviceLocation,omitempty"`
	// FriendlyName - Friendly Name
	FriendlyName *string `json:"friendlyName,omitempty"`
	// ManagementEndpointURI - Management Endpoint Uri
	ManagementEndpointURI *string `json:"managementEndpointUri,omitempty"`
}

RegisteredServerProperties registeredServer Properties object.

type RegisteredServersClient

type RegisteredServersClient struct {
	BaseClient
}

RegisteredServersClient is the microsoft Storage Sync Service API

func NewRegisteredServersClient

func NewRegisteredServersClient(subscriptionID string) RegisteredServersClient

NewRegisteredServersClient creates an instance of the RegisteredServersClient client.

func NewRegisteredServersClientWithBaseURI

func NewRegisteredServersClientWithBaseURI(baseURI string, subscriptionID string) RegisteredServersClient

NewRegisteredServersClientWithBaseURI creates an instance of the RegisteredServersClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).

func (RegisteredServersClient) Create

func (client RegisteredServersClient) Create(ctx context.Context, resourceGroupName string, storageSyncServiceName string, serverID string, parameters RegisteredServerCreateParameters) (result RegisteredServersCreateFuture, err error)

Create add a new registered server. Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. storageSyncServiceName - name of Storage Sync Service resource. serverID - GUID identifying the on-premises server. parameters - body of Registered Server object.

func (RegisteredServersClient) CreatePreparer

func (client RegisteredServersClient) CreatePreparer(ctx context.Context, resourceGroupName string, storageSyncServiceName string, serverID string, parameters RegisteredServerCreateParameters) (*http.Request, error)

CreatePreparer prepares the Create request.

func (RegisteredServersClient) CreateResponder

func (client RegisteredServersClient) CreateResponder(resp *http.Response) (result RegisteredServer, err error)

CreateResponder handles the response to the Create request. The method always closes the http.Response Body.

func (RegisteredServersClient) CreateSender

func (client RegisteredServersClient) CreateSender(req *http.Request) (future RegisteredServersCreateFuture, err error)

CreateSender sends the Create request. The method will close the http.Response Body if it receives an error.

func (RegisteredServersClient) Delete

func (client RegisteredServersClient) Delete(ctx context.Context, resourceGroupName string, storageSyncServiceName string, serverID string) (result RegisteredServersDeleteFuture, err error)

Delete delete the given registered server. Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. storageSyncServiceName - name of Storage Sync Service resource. serverID - GUID identifying the on-premises server.

func (RegisteredServersClient) DeletePreparer

func (client RegisteredServersClient) DeletePreparer(ctx context.Context, resourceGroupName string, storageSyncServiceName string, serverID string) (*http.Request, error)

DeletePreparer prepares the Delete request.

func (RegisteredServersClient) DeleteResponder

func (client RegisteredServersClient) DeleteResponder(resp *http.Response) (result autorest.Response, err error)

DeleteResponder handles the response to the Delete request. The method always closes the http.Response Body.

func (RegisteredServersClient) DeleteSender

func (client RegisteredServersClient) DeleteSender(req *http.Request) (future RegisteredServersDeleteFuture, err error)

DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.

func (RegisteredServersClient) Get

func (client RegisteredServersClient) Get(ctx context.Context, resourceGroupName string, storageSyncServiceName string, serverID string) (result RegisteredServer, err error)

Get get a given registered server. Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. storageSyncServiceName - name of Storage Sync Service resource. serverID - GUID identifying the on-premises server.

func (RegisteredServersClient) GetPreparer

func (client RegisteredServersClient) GetPreparer(ctx context.Context, resourceGroupName string, storageSyncServiceName string, serverID string) (*http.Request, error)

GetPreparer prepares the Get request.

func (RegisteredServersClient) GetResponder

func (client RegisteredServersClient) GetResponder(resp *http.Response) (result RegisteredServer, err error)

GetResponder handles the response to the Get request. The method always closes the http.Response Body.

func (RegisteredServersClient) GetSender

func (client RegisteredServersClient) GetSender(req *http.Request) (*http.Response, error)

GetSender sends the Get request. The method will close the http.Response Body if it receives an error.

func (RegisteredServersClient) ListByStorageSyncService

func (client RegisteredServersClient) ListByStorageSyncService(ctx context.Context, resourceGroupName string, storageSyncServiceName string) (result RegisteredServerArray, err error)

ListByStorageSyncService get a given registered server list. Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. storageSyncServiceName - name of Storage Sync Service resource.

func (RegisteredServersClient) ListByStorageSyncServicePreparer

func (client RegisteredServersClient) ListByStorageSyncServicePreparer(ctx context.Context, resourceGroupName string, storageSyncServiceName string) (*http.Request, error)

ListByStorageSyncServicePreparer prepares the ListByStorageSyncService request.

func (RegisteredServersClient) ListByStorageSyncServiceResponder

func (client RegisteredServersClient) ListByStorageSyncServiceResponder(resp *http.Response) (result RegisteredServerArray, err error)

ListByStorageSyncServiceResponder handles the response to the ListByStorageSyncService request. The method always closes the http.Response Body.

func (RegisteredServersClient) ListByStorageSyncServiceSender

func (client RegisteredServersClient) ListByStorageSyncServiceSender(req *http.Request) (*http.Response, error)

ListByStorageSyncServiceSender sends the ListByStorageSyncService request. The method will close the http.Response Body if it receives an error.

type RegisteredServersCreateFuture

type RegisteredServersCreateFuture struct {
	azure.FutureAPI
	// Result returns the result of the asynchronous operation.
	// If the operation has not completed it will return an error.
	Result func(RegisteredServersClient) (RegisteredServer, error)
}

RegisteredServersCreateFuture an abstraction for monitoring and retrieving the results of a long-running operation.

func (*RegisteredServersCreateFuture) UnmarshalJSON

func (future *RegisteredServersCreateFuture) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaller for CreateFuture.

type RegisteredServersDeleteFuture

type RegisteredServersDeleteFuture struct {
	azure.FutureAPI
	// Result returns the result of the asynchronous operation.
	// If the operation has not completed it will return an error.
	Result func(RegisteredServersClient) (autorest.Response, error)
}

RegisteredServersDeleteFuture an abstraction for monitoring and retrieving the results of a long-running operation.

func (*RegisteredServersDeleteFuture) UnmarshalJSON

func (future *RegisteredServersDeleteFuture) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaller for CreateFuture.

type Resource

type Resource struct {
	// ID - READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string `json:"id,omitempty"`
	// Name - READ-ONLY; The name of the resource
	Name *string `json:"name,omitempty"`
	// Type - READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string `json:"type,omitempty"`
}

Resource common fields that are returned in the response for all Azure Resource Manager resources

func (Resource) MarshalJSON

func (r Resource) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for Resource.

type ResourcesMoveInfo

type ResourcesMoveInfo struct {
	// TargetResourceGroup - Target resource group.
	TargetResourceGroup *string `json:"targetResourceGroup,omitempty"`
	// Resources - Collection of Resources.
	Resources *[]string `json:"resources,omitempty"`
}

ResourcesMoveInfo resource Move Info.

type RestoreFileSpec

type RestoreFileSpec struct {
	// Path - Restore file spec path
	Path *string `json:"path,omitempty"`
	// Isdir - READ-ONLY; Restore file spec isdir
	Isdir *bool `json:"isdir,omitempty"`
}

RestoreFileSpec restore file spec.

func (RestoreFileSpec) MarshalJSON

func (rfs RestoreFileSpec) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for RestoreFileSpec.

type ServerEndpoint

type ServerEndpoint struct {
	autorest.Response `json:"-"`
	// ServerEndpointProperties - Server Endpoint properties.
	*ServerEndpointProperties `json:"properties,omitempty"`
	// ID - READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string `json:"id,omitempty"`
	// Name - READ-ONLY; The name of the resource
	Name *string `json:"name,omitempty"`
	// Type - READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string `json:"type,omitempty"`
}

ServerEndpoint server Endpoint object.

func (ServerEndpoint) MarshalJSON

func (se ServerEndpoint) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for ServerEndpoint.

func (*ServerEndpoint) UnmarshalJSON

func (se *ServerEndpoint) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for ServerEndpoint struct.

type ServerEndpointArray

type ServerEndpointArray struct {
	autorest.Response `json:"-"`
	// Value - Collection of ServerEndpoint.
	Value *[]ServerEndpoint `json:"value,omitempty"`
}

ServerEndpointArray array of ServerEndpoint

type ServerEndpointCreateParameters

type ServerEndpointCreateParameters struct {
	// Location - Required. Gets or sets the location of the resource. This will be one of the supported and registered Azure Geo Regions (e.g. West US, East US, Southeast Asia, etc.). The geo region of a resource cannot be changed once it is created, but if an identical geo region is specified on update, the request will succeed.
	Location *string `json:"location,omitempty"`
	// Tags - Gets or sets a list of key value pairs that describe the resource. These tags can be used for viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key with a length no greater than 128 characters and a value with a length no greater than 256 characters.
	Tags map[string]*string `json:"tags"`
	// ServerEndpointCreateParametersProperties - The parameters used to create the storage sync service.
	*ServerEndpointCreateParametersProperties `json:"properties,omitempty"`
}

ServerEndpointCreateParameters the parameters used when creating a storage sync service.

func (ServerEndpointCreateParameters) MarshalJSON

func (secp ServerEndpointCreateParameters) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for ServerEndpointCreateParameters.

func (*ServerEndpointCreateParameters) UnmarshalJSON

func (secp *ServerEndpointCreateParameters) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for ServerEndpointCreateParameters struct.

type ServerEndpointCreateParametersProperties

type ServerEndpointCreateParametersProperties struct {
	// ServerLocalPath - Server Local path.
	ServerLocalPath *string `json:"serverLocalPath,omitempty"`
	// CloudTiering - Cloud Tiering. Possible values include: 'On', 'Off'
	CloudTiering CloudTiering `json:"cloudTiering,omitempty"`
	// VolumeFreeSpacePercent - Level of free space to be maintained by Cloud Tiering if it is enabled.
	VolumeFreeSpacePercent *int32 `json:"volumeFreeSpacePercent,omitempty"`
	// FriendlyName - Friendly Name
	FriendlyName *string `json:"friendlyName,omitempty"`
	// ServerResourceID - Server Resource Id.
	ServerResourceID *string `json:"serverResourceId,omitempty"`
}

ServerEndpointCreateParametersProperties serverEndpoint Properties object.

type ServerEndpointProperties

type ServerEndpointProperties struct {
	// ServerLocalPath - Server Local path.
	ServerLocalPath *string `json:"serverLocalPath,omitempty"`
	// CloudTiering - Cloud Tiering. Possible values include: 'CloudTiering2On', 'CloudTiering2Off'
	CloudTiering CloudTiering2 `json:"cloudTiering,omitempty"`
	// VolumeFreeSpacePercent - Level of free space to be maintained by Cloud Tiering if it is enabled.
	VolumeFreeSpacePercent *int32 `json:"volumeFreeSpacePercent,omitempty"`
	// FriendlyName - Friendly Name
	FriendlyName *string `json:"friendlyName,omitempty"`
	// ServerResourceID - Server Resource Id.
	ServerResourceID *string `json:"serverResourceId,omitempty"`
	// ProvisioningState - ServerEndpoint Provisioning State
	ProvisioningState *string `json:"provisioningState,omitempty"`
	// LastWorkflowID - ServerEndpoint lastWorkflowId
	LastWorkflowID *string `json:"lastWorkflowId,omitempty"`
	// LastOperationName - Resource Last Operation Name
	LastOperationName *string `json:"lastOperationName,omitempty"`
	// SyncStatus - Sync Health Status
	SyncStatus interface{} `json:"syncStatus,omitempty"`
}

ServerEndpointProperties serverEndpoint Properties object.

type ServerEndpointUpdateParameters

type ServerEndpointUpdateParameters struct {
	// Tags - The user-specified tags associated with the server endpoint.
	Tags map[string]*string `json:"tags"`
	// ServerEndpointUpdateProperties - The properties of the server endpoint.
	*ServerEndpointUpdateProperties `json:"properties,omitempty"`
}

ServerEndpointUpdateParameters parameters for updating an Server Endpoint.

func (ServerEndpointUpdateParameters) MarshalJSON

func (seup ServerEndpointUpdateParameters) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for ServerEndpointUpdateParameters.

func (*ServerEndpointUpdateParameters) UnmarshalJSON

func (seup *ServerEndpointUpdateParameters) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for ServerEndpointUpdateParameters struct.

type ServerEndpointUpdateProperties

type ServerEndpointUpdateProperties struct {
	// CloudTiering - Cloud Tiering. Possible values include: 'CloudTiering1On', 'CloudTiering1Off'
	CloudTiering CloudTiering1 `json:"cloudTiering,omitempty"`
	// VolumeFreeSpacePercent - Level of free space to be maintained by Cloud Tiering if it is enabled.
	VolumeFreeSpacePercent *int32 `json:"volumeFreeSpacePercent,omitempty"`
}

ServerEndpointUpdateProperties serverEndpoint Update Properties object.

type ServerEndpointsClient

type ServerEndpointsClient struct {
	BaseClient
}

ServerEndpointsClient is the microsoft Storage Sync Service API

func NewServerEndpointsClient

func NewServerEndpointsClient(subscriptionID string) ServerEndpointsClient

NewServerEndpointsClient creates an instance of the ServerEndpointsClient client.

func NewServerEndpointsClientWithBaseURI

func NewServerEndpointsClientWithBaseURI(baseURI string, subscriptionID string) ServerEndpointsClient

NewServerEndpointsClientWithBaseURI creates an instance of the ServerEndpointsClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).

func (ServerEndpointsClient) Create

func (client ServerEndpointsClient) Create(ctx context.Context, resourceGroupName string, storageSyncServiceName string, syncGroupName string, serverEndpointName string, parameters ServerEndpointCreateParameters) (result ServerEndpointsCreateFuture, err error)

Create create a new ServerEndpoint. Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. storageSyncServiceName - name of Storage Sync Service resource. syncGroupName - name of Sync Group resource. serverEndpointName - name of Server Endpoint object. parameters - body of Server Endpoint object.

func (ServerEndpointsClient) CreatePreparer

func (client ServerEndpointsClient) CreatePreparer(ctx context.Context, resourceGroupName string, storageSyncServiceName string, syncGroupName string, serverEndpointName string, parameters ServerEndpointCreateParameters) (*http.Request, error)

CreatePreparer prepares the Create request.

func (ServerEndpointsClient) CreateResponder

func (client ServerEndpointsClient) CreateResponder(resp *http.Response) (result ServerEndpoint, err error)

CreateResponder handles the response to the Create request. The method always closes the http.Response Body.

func (ServerEndpointsClient) CreateSender

func (client ServerEndpointsClient) CreateSender(req *http.Request) (future ServerEndpointsCreateFuture, err error)

CreateSender sends the Create request. The method will close the http.Response Body if it receives an error.

func (ServerEndpointsClient) Delete

func (client ServerEndpointsClient) Delete(ctx context.Context, resourceGroupName string, storageSyncServiceName string, syncGroupName string, serverEndpointName string) (result ServerEndpointsDeleteFuture, err error)

Delete delete a given ServerEndpoint. Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. storageSyncServiceName - name of Storage Sync Service resource. syncGroupName - name of Sync Group resource. serverEndpointName - name of Server Endpoint object.

func (ServerEndpointsClient) DeletePreparer

func (client ServerEndpointsClient) DeletePreparer(ctx context.Context, resourceGroupName string, storageSyncServiceName string, syncGroupName string, serverEndpointName string) (*http.Request, error)

DeletePreparer prepares the Delete request.

func (ServerEndpointsClient) DeleteResponder

func (client ServerEndpointsClient) DeleteResponder(resp *http.Response) (result autorest.Response, err error)

DeleteResponder handles the response to the Delete request. The method always closes the http.Response Body.

func (ServerEndpointsClient) DeleteSender

func (client ServerEndpointsClient) DeleteSender(req *http.Request) (future ServerEndpointsDeleteFuture, err error)

DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.

func (ServerEndpointsClient) Get

func (client ServerEndpointsClient) Get(ctx context.Context, resourceGroupName string, storageSyncServiceName string, syncGroupName string, serverEndpointName string) (result ServerEndpoint, err error)

Get get a ServerEndpoint. Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. storageSyncServiceName - name of Storage Sync Service resource. syncGroupName - name of Sync Group resource. serverEndpointName - name of Server Endpoint object.

func (ServerEndpointsClient) GetPreparer

func (client ServerEndpointsClient) GetPreparer(ctx context.Context, resourceGroupName string, storageSyncServiceName string, syncGroupName string, serverEndpointName string) (*http.Request, error)

GetPreparer prepares the Get request.

func (ServerEndpointsClient) GetResponder

func (client ServerEndpointsClient) GetResponder(resp *http.Response) (result ServerEndpoint, err error)

GetResponder handles the response to the Get request. The method always closes the http.Response Body.

func (ServerEndpointsClient) GetSender

func (client ServerEndpointsClient) GetSender(req *http.Request) (*http.Response, error)

GetSender sends the Get request. The method will close the http.Response Body if it receives an error.

func (ServerEndpointsClient) ListBySyncGroup

func (client ServerEndpointsClient) ListBySyncGroup(ctx context.Context, resourceGroupName string, storageSyncServiceName string, syncGroupName string) (result ServerEndpointArray, err error)

ListBySyncGroup get a ServerEndpoint list. Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. storageSyncServiceName - name of Storage Sync Service resource. syncGroupName - name of Sync Group resource.

func (ServerEndpointsClient) ListBySyncGroupPreparer

func (client ServerEndpointsClient) ListBySyncGroupPreparer(ctx context.Context, resourceGroupName string, storageSyncServiceName string, syncGroupName string) (*http.Request, error)

ListBySyncGroupPreparer prepares the ListBySyncGroup request.

func (ServerEndpointsClient) ListBySyncGroupResponder

func (client ServerEndpointsClient) ListBySyncGroupResponder(resp *http.Response) (result ServerEndpointArray, err error)

ListBySyncGroupResponder handles the response to the ListBySyncGroup request. The method always closes the http.Response Body.

func (ServerEndpointsClient) ListBySyncGroupSender

func (client ServerEndpointsClient) ListBySyncGroupSender(req *http.Request) (*http.Response, error)

ListBySyncGroupSender sends the ListBySyncGroup request. The method will close the http.Response Body if it receives an error.

func (ServerEndpointsClient) RecallAction

func (client ServerEndpointsClient) RecallAction(ctx context.Context, resourceGroupName string, storageSyncServiceName string, syncGroupName string, serverEndpointName string, parameters RecallActionParameters) (result ServerEndpointsRecallActionFuture, err error)

RecallAction recall a server endpoint. Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. storageSyncServiceName - name of Storage Sync Service resource. syncGroupName - name of Sync Group resource. serverEndpointName - name of Server Endpoint object. parameters - body of Recall Action object.

func (ServerEndpointsClient) RecallActionPreparer

func (client ServerEndpointsClient) RecallActionPreparer(ctx context.Context, resourceGroupName string, storageSyncServiceName string, syncGroupName string, serverEndpointName string, parameters RecallActionParameters) (*http.Request, error)

RecallActionPreparer prepares the RecallAction request.

func (ServerEndpointsClient) RecallActionResponder

func (client ServerEndpointsClient) RecallActionResponder(resp *http.Response) (result autorest.Response, err error)

RecallActionResponder handles the response to the RecallAction request. The method always closes the http.Response Body.

func (ServerEndpointsClient) RecallActionSender

func (client ServerEndpointsClient) RecallActionSender(req *http.Request) (future ServerEndpointsRecallActionFuture, err error)

RecallActionSender sends the RecallAction request. The method will close the http.Response Body if it receives an error.

func (ServerEndpointsClient) Update

func (client ServerEndpointsClient) Update(ctx context.Context, resourceGroupName string, storageSyncServiceName string, syncGroupName string, serverEndpointName string, parameters *ServerEndpointUpdateParameters) (result ServerEndpointsUpdateFuture, err error)

Update patch a given ServerEndpoint. Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. storageSyncServiceName - name of Storage Sync Service resource. syncGroupName - name of Sync Group resource. serverEndpointName - name of Server Endpoint object. parameters - any of the properties applicable in PUT request.

func (ServerEndpointsClient) UpdatePreparer

func (client ServerEndpointsClient) UpdatePreparer(ctx context.Context, resourceGroupName string, storageSyncServiceName string, syncGroupName string, serverEndpointName string, parameters *ServerEndpointUpdateParameters) (*http.Request, error)

UpdatePreparer prepares the Update request.

func (ServerEndpointsClient) UpdateResponder

func (client ServerEndpointsClient) UpdateResponder(resp *http.Response) (result ServerEndpoint, err error)

UpdateResponder handles the response to the Update request. The method always closes the http.Response Body.

func (ServerEndpointsClient) UpdateSender

func (client ServerEndpointsClient) UpdateSender(req *http.Request) (future ServerEndpointsUpdateFuture, err error)

UpdateSender sends the Update request. The method will close the http.Response Body if it receives an error.

type ServerEndpointsCreateFuture

type ServerEndpointsCreateFuture struct {
	azure.FutureAPI
	// Result returns the result of the asynchronous operation.
	// If the operation has not completed it will return an error.
	Result func(ServerEndpointsClient) (ServerEndpoint, error)
}

ServerEndpointsCreateFuture an abstraction for monitoring and retrieving the results of a long-running operation.

func (*ServerEndpointsCreateFuture) UnmarshalJSON

func (future *ServerEndpointsCreateFuture) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaller for CreateFuture.

type ServerEndpointsDeleteFuture

type ServerEndpointsDeleteFuture struct {
	azure.FutureAPI
	// Result returns the result of the asynchronous operation.
	// If the operation has not completed it will return an error.
	Result func(ServerEndpointsClient) (autorest.Response, error)
}

ServerEndpointsDeleteFuture an abstraction for monitoring and retrieving the results of a long-running operation.

func (*ServerEndpointsDeleteFuture) UnmarshalJSON

func (future *ServerEndpointsDeleteFuture) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaller for CreateFuture.

type ServerEndpointsRecallActionFuture

type ServerEndpointsRecallActionFuture struct {
	azure.FutureAPI
	// Result returns the result of the asynchronous operation.
	// If the operation has not completed it will return an error.
	Result func(ServerEndpointsClient) (autorest.Response, error)
}

ServerEndpointsRecallActionFuture an abstraction for monitoring and retrieving the results of a long-running operation.

func (*ServerEndpointsRecallActionFuture) UnmarshalJSON

func (future *ServerEndpointsRecallActionFuture) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaller for CreateFuture.

type ServerEndpointsUpdateFuture

type ServerEndpointsUpdateFuture struct {
	azure.FutureAPI
	// Result returns the result of the asynchronous operation.
	// If the operation has not completed it will return an error.
	Result func(ServerEndpointsClient) (ServerEndpoint, error)
}

ServerEndpointsUpdateFuture an abstraction for monitoring and retrieving the results of a long-running operation.

func (*ServerEndpointsUpdateFuture) UnmarshalJSON

func (future *ServerEndpointsUpdateFuture) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaller for CreateFuture.

type Service

type Service struct {
	autorest.Response `json:"-"`
	// ServiceProperties - Storage Sync Service properties.
	*ServiceProperties `json:"properties,omitempty"`
	// Tags - Resource tags.
	Tags map[string]*string `json:"tags"`
	// Location - The geo-location where the resource lives
	Location *string `json:"location,omitempty"`
	// ID - READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string `json:"id,omitempty"`
	// Name - READ-ONLY; The name of the resource
	Name *string `json:"name,omitempty"`
	// Type - READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string `json:"type,omitempty"`
}

Service storage Sync Service object.

func (Service) MarshalJSON

func (s Service) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for Service.

func (*Service) UnmarshalJSON

func (s *Service) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for Service struct.

type ServiceArray

type ServiceArray struct {
	autorest.Response `json:"-"`
	// Value - Collection of StorageSyncServices.
	Value *[]Service `json:"value,omitempty"`
}

ServiceArray array of StorageSyncServices

type ServiceCreateParameters

type ServiceCreateParameters struct {
	// Location - Required. Gets or sets the location of the resource. This will be one of the supported and registered Azure Geo Regions (e.g. West US, East US, Southeast Asia, etc.). The geo region of a resource cannot be changed once it is created, but if an identical geo region is specified on update, the request will succeed.
	Location *string `json:"location,omitempty"`
	// Tags - Gets or sets a list of key value pairs that describe the resource. These tags can be used for viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key with a length no greater than 128 characters and a value with a length no greater than 256 characters.
	Tags map[string]*string `json:"tags"`
}

ServiceCreateParameters the parameters used when creating a storage sync service.

func (ServiceCreateParameters) MarshalJSON

func (scp ServiceCreateParameters) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for ServiceCreateParameters.

type ServiceProperties

type ServiceProperties struct {
	// StorageSyncServiceStatus - READ-ONLY; Storage Sync service status.
	StorageSyncServiceStatus *int32 `json:"storageSyncServiceStatus,omitempty"`
	// StorageSyncServiceUID - READ-ONLY; Storage Sync service Uid
	StorageSyncServiceUID *string `json:"storageSyncServiceUid,omitempty"`
}

ServiceProperties storage Sync Service Properties object.

func (ServiceProperties) MarshalJSON

func (sp ServiceProperties) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for ServiceProperties.

type ServiceUpdateParameters

type ServiceUpdateParameters struct {
	// Tags - The user-specified tags associated with the storage sync service.
	Tags map[string]*string `json:"tags"`
	// Properties - The properties of the storage sync service.
	Properties interface{} `json:"properties,omitempty"`
}

ServiceUpdateParameters parameters for updating an Storage sync service.

func (ServiceUpdateParameters) MarshalJSON

func (sup ServiceUpdateParameters) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for ServiceUpdateParameters.

type ServicesClient

type ServicesClient struct {
	BaseClient
}

ServicesClient is the microsoft Storage Sync Service API

func NewServicesClient

func NewServicesClient(subscriptionID string) ServicesClient

NewServicesClient creates an instance of the ServicesClient client.

func NewServicesClientWithBaseURI

func NewServicesClientWithBaseURI(baseURI string, subscriptionID string) ServicesClient

NewServicesClientWithBaseURI creates an instance of the ServicesClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).

func (ServicesClient) CheckNameAvailability

func (client ServicesClient) CheckNameAvailability(ctx context.Context, locationName string, parameters CheckNameAvailabilityParameters) (result CheckNameAvailabilityResult, err error)

CheckNameAvailability check the give namespace name availability. Parameters: locationName - the desired region for the name check. parameters - parameters to check availability of the given namespace name

func (ServicesClient) CheckNameAvailabilityPreparer

func (client ServicesClient) CheckNameAvailabilityPreparer(ctx context.Context, locationName string, parameters CheckNameAvailabilityParameters) (*http.Request, error)

CheckNameAvailabilityPreparer prepares the CheckNameAvailability request.

func (ServicesClient) CheckNameAvailabilityResponder

func (client ServicesClient) CheckNameAvailabilityResponder(resp *http.Response) (result CheckNameAvailabilityResult, err error)

CheckNameAvailabilityResponder handles the response to the CheckNameAvailability request. The method always closes the http.Response Body.

func (ServicesClient) CheckNameAvailabilitySender

func (client ServicesClient) CheckNameAvailabilitySender(req *http.Request) (*http.Response, error)

CheckNameAvailabilitySender sends the CheckNameAvailability request. The method will close the http.Response Body if it receives an error.

func (ServicesClient) Create

func (client ServicesClient) Create(ctx context.Context, resourceGroupName string, storageSyncServiceName string, parameters ServiceCreateParameters) (result Service, err error)

Create create a new StorageSyncService. Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. storageSyncServiceName - name of Storage Sync Service resource. parameters - storage Sync Service resource name.

func (ServicesClient) CreatePreparer

func (client ServicesClient) CreatePreparer(ctx context.Context, resourceGroupName string, storageSyncServiceName string, parameters ServiceCreateParameters) (*http.Request, error)

CreatePreparer prepares the Create request.

func (ServicesClient) CreateResponder

func (client ServicesClient) CreateResponder(resp *http.Response) (result Service, err error)

CreateResponder handles the response to the Create request. The method always closes the http.Response Body.

func (ServicesClient) CreateSender

func (client ServicesClient) CreateSender(req *http.Request) (*http.Response, error)

CreateSender sends the Create request. The method will close the http.Response Body if it receives an error.

func (ServicesClient) Delete

func (client ServicesClient) Delete(ctx context.Context, resourceGroupName string, storageSyncServiceName string) (result autorest.Response, err error)

Delete delete a given StorageSyncService. Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. storageSyncServiceName - name of Storage Sync Service resource.

func (ServicesClient) DeletePreparer

func (client ServicesClient) DeletePreparer(ctx context.Context, resourceGroupName string, storageSyncServiceName string) (*http.Request, error)

DeletePreparer prepares the Delete request.

func (ServicesClient) DeleteResponder

func (client ServicesClient) DeleteResponder(resp *http.Response) (result autorest.Response, err error)

DeleteResponder handles the response to the Delete request. The method always closes the http.Response Body.

func (ServicesClient) DeleteSender

func (client ServicesClient) DeleteSender(req *http.Request) (*http.Response, error)

DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.

func (ServicesClient) Get

func (client ServicesClient) Get(ctx context.Context, resourceGroupName string, storageSyncServiceName string) (result Service, err error)

Get get a given StorageSyncService. Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. storageSyncServiceName - name of Storage Sync Service resource.

func (ServicesClient) GetPreparer

func (client ServicesClient) GetPreparer(ctx context.Context, resourceGroupName string, storageSyncServiceName string) (*http.Request, error)

GetPreparer prepares the Get request.

func (ServicesClient) GetResponder

func (client ServicesClient) GetResponder(resp *http.Response) (result Service, err error)

GetResponder handles the response to the Get request. The method always closes the http.Response Body.

func (ServicesClient) GetSender

func (client ServicesClient) GetSender(req *http.Request) (*http.Response, error)

GetSender sends the Get request. The method will close the http.Response Body if it receives an error.

func (ServicesClient) ListByResourceGroup

func (client ServicesClient) ListByResourceGroup(ctx context.Context, resourceGroupName string) (result ServiceArray, err error)

ListByResourceGroup get a StorageSyncService list by Resource group name. Parameters: resourceGroupName - the name of the resource group. The name is case insensitive.

func (ServicesClient) ListByResourceGroupPreparer

func (client ServicesClient) ListByResourceGroupPreparer(ctx context.Context, resourceGroupName string) (*http.Request, error)

ListByResourceGroupPreparer prepares the ListByResourceGroup request.

func (ServicesClient) ListByResourceGroupResponder

func (client ServicesClient) ListByResourceGroupResponder(resp *http.Response) (result ServiceArray, err error)

ListByResourceGroupResponder handles the response to the ListByResourceGroup request. The method always closes the http.Response Body.

func (ServicesClient) ListByResourceGroupSender

func (client ServicesClient) ListByResourceGroupSender(req *http.Request) (*http.Response, error)

ListByResourceGroupSender sends the ListByResourceGroup request. The method will close the http.Response Body if it receives an error.

func (ServicesClient) ListBySubscription

func (client ServicesClient) ListBySubscription(ctx context.Context) (result ServiceArray, err error)

ListBySubscription get a StorageSyncService list by subscription.

func (ServicesClient) ListBySubscriptionPreparer

func (client ServicesClient) ListBySubscriptionPreparer(ctx context.Context) (*http.Request, error)

ListBySubscriptionPreparer prepares the ListBySubscription request.

func (ServicesClient) ListBySubscriptionResponder

func (client ServicesClient) ListBySubscriptionResponder(resp *http.Response) (result ServiceArray, err error)

ListBySubscriptionResponder handles the response to the ListBySubscription request. The method always closes the http.Response Body.

func (ServicesClient) ListBySubscriptionSender

func (client ServicesClient) ListBySubscriptionSender(req *http.Request) (*http.Response, error)

ListBySubscriptionSender sends the ListBySubscription request. The method will close the http.Response Body if it receives an error.

func (ServicesClient) Update

func (client ServicesClient) Update(ctx context.Context, resourceGroupName string, storageSyncServiceName string, parameters *ServiceUpdateParameters) (result Service, err error)

Update patch a given StorageSyncService. Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. storageSyncServiceName - name of Storage Sync Service resource. parameters - storage Sync Service resource.

func (ServicesClient) UpdatePreparer

func (client ServicesClient) UpdatePreparer(ctx context.Context, resourceGroupName string, storageSyncServiceName string, parameters *ServiceUpdateParameters) (*http.Request, error)

UpdatePreparer prepares the Update request.

func (ServicesClient) UpdateResponder

func (client ServicesClient) UpdateResponder(resp *http.Response) (result Service, err error)

UpdateResponder handles the response to the Update request. The method always closes the http.Response Body.

func (ServicesClient) UpdateSender

func (client ServicesClient) UpdateSender(req *http.Request) (*http.Response, error)

UpdateSender sends the Update request. The method will close the http.Response Body if it receives an error.

type Status

type Status string

Status enumerates the values for status.

const (
	// Aborted ...
	Aborted Status = "aborted"
	// Active ...
	Active Status = "active"
	// Expired ...
	Expired Status = "expired"
	// Failed ...
	Failed Status = "failed"
	// Succeeded ...
	Succeeded Status = "succeeded"
)

func PossibleStatusValues

func PossibleStatusValues() []Status

PossibleStatusValues returns an array of possible values for the Status const type.

type SubscriptionState

type SubscriptionState struct {
	// State - State of Azure Subscription. Possible values include: 'Registered', 'Unregistered', 'Warned', 'Suspended', 'Deleted'
	State Reason `json:"state,omitempty"`
	// Istransitioning - READ-ONLY; Is Transitioning
	Istransitioning *bool `json:"istransitioning,omitempty"`
	// Properties - Subscription state properties.
	Properties interface{} `json:"properties,omitempty"`
}

SubscriptionState subscription State object.

func (SubscriptionState) MarshalJSON

func (ss SubscriptionState) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for SubscriptionState.

type SyncGroup

type SyncGroup struct {
	autorest.Response `json:"-"`
	// SyncGroupProperties - SyncGroup properties.
	*SyncGroupProperties `json:"properties,omitempty"`
	// ID - READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string `json:"id,omitempty"`
	// Name - READ-ONLY; The name of the resource
	Name *string `json:"name,omitempty"`
	// Type - READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string `json:"type,omitempty"`
}

SyncGroup sync Group object.

func (SyncGroup) MarshalJSON

func (sg SyncGroup) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for SyncGroup.

func (*SyncGroup) UnmarshalJSON

func (sg *SyncGroup) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for SyncGroup struct.

type SyncGroupArray

type SyncGroupArray struct {
	autorest.Response `json:"-"`
	// Value - Collection of SyncGroup.
	Value *[]SyncGroup `json:"value,omitempty"`
}

SyncGroupArray array of SyncGroup

type SyncGroupCreateParameters

type SyncGroupCreateParameters struct {
	// Location - Required. Gets or sets the location of the resource. This will be one of the supported and registered Azure Geo Regions (e.g. West US, East US, Southeast Asia, etc.). The geo region of a resource cannot be changed once it is created, but if an identical geo region is specified on update, the request will succeed.
	Location *string `json:"location,omitempty"`
	// Tags - Gets or sets a list of key value pairs that describe the resource. These tags can be used for viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key with a length no greater than 128 characters and a value with a length no greater than 256 characters.
	Tags map[string]*string `json:"tags"`
	// Properties - The parameters used to create the sync group
	Properties interface{} `json:"properties,omitempty"`
}

SyncGroupCreateParameters the parameters used when creating a sync group.

func (SyncGroupCreateParameters) MarshalJSON

func (sgcp SyncGroupCreateParameters) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for SyncGroupCreateParameters.

type SyncGroupProperties

type SyncGroupProperties struct {
	// UniqueID - Unique Id
	UniqueID *string `json:"uniqueId,omitempty"`
	// SyncGroupStatus - READ-ONLY; Sync group status
	SyncGroupStatus *string `json:"syncGroupStatus,omitempty"`
}

SyncGroupProperties syncGroup Properties object.

func (SyncGroupProperties) MarshalJSON

func (sgp SyncGroupProperties) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for SyncGroupProperties.

type SyncGroupsClient

type SyncGroupsClient struct {
	BaseClient
}

SyncGroupsClient is the microsoft Storage Sync Service API

func NewSyncGroupsClient

func NewSyncGroupsClient(subscriptionID string) SyncGroupsClient

NewSyncGroupsClient creates an instance of the SyncGroupsClient client.

func NewSyncGroupsClientWithBaseURI

func NewSyncGroupsClientWithBaseURI(baseURI string, subscriptionID string) SyncGroupsClient

NewSyncGroupsClientWithBaseURI creates an instance of the SyncGroupsClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).

func (SyncGroupsClient) Create

func (client SyncGroupsClient) Create(ctx context.Context, resourceGroupName string, storageSyncServiceName string, syncGroupName string, parameters SyncGroupCreateParameters) (result SyncGroup, err error)

Create create a new SyncGroup. Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. storageSyncServiceName - name of Storage Sync Service resource. syncGroupName - name of Sync Group resource. parameters - sync Group Body

func (SyncGroupsClient) CreatePreparer

func (client SyncGroupsClient) CreatePreparer(ctx context.Context, resourceGroupName string, storageSyncServiceName string, syncGroupName string, parameters SyncGroupCreateParameters) (*http.Request, error)

CreatePreparer prepares the Create request.

func (SyncGroupsClient) CreateResponder

func (client SyncGroupsClient) CreateResponder(resp *http.Response) (result SyncGroup, err error)

CreateResponder handles the response to the Create request. The method always closes the http.Response Body.

func (SyncGroupsClient) CreateSender

func (client SyncGroupsClient) CreateSender(req *http.Request) (*http.Response, error)

CreateSender sends the Create request. The method will close the http.Response Body if it receives an error.

func (SyncGroupsClient) Delete

func (client SyncGroupsClient) Delete(ctx context.Context, resourceGroupName string, storageSyncServiceName string, syncGroupName string) (result autorest.Response, err error)

Delete delete a given SyncGroup. Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. storageSyncServiceName - name of Storage Sync Service resource. syncGroupName - name of Sync Group resource.

func (SyncGroupsClient) DeletePreparer

func (client SyncGroupsClient) DeletePreparer(ctx context.Context, resourceGroupName string, storageSyncServiceName string, syncGroupName string) (*http.Request, error)

DeletePreparer prepares the Delete request.

func (SyncGroupsClient) DeleteResponder

func (client SyncGroupsClient) DeleteResponder(resp *http.Response) (result autorest.Response, err error)

DeleteResponder handles the response to the Delete request. The method always closes the http.Response Body.

func (SyncGroupsClient) DeleteSender

func (client SyncGroupsClient) DeleteSender(req *http.Request) (*http.Response, error)

DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.

func (SyncGroupsClient) Get

func (client SyncGroupsClient) Get(ctx context.Context, resourceGroupName string, storageSyncServiceName string, syncGroupName string) (result SyncGroup, err error)

Get get a given SyncGroup. Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. storageSyncServiceName - name of Storage Sync Service resource. syncGroupName - name of Sync Group resource.

func (SyncGroupsClient) GetPreparer

func (client SyncGroupsClient) GetPreparer(ctx context.Context, resourceGroupName string, storageSyncServiceName string, syncGroupName string) (*http.Request, error)

GetPreparer prepares the Get request.

func (SyncGroupsClient) GetResponder

func (client SyncGroupsClient) GetResponder(resp *http.Response) (result SyncGroup, err error)

GetResponder handles the response to the Get request. The method always closes the http.Response Body.

func (SyncGroupsClient) GetSender

func (client SyncGroupsClient) GetSender(req *http.Request) (*http.Response, error)

GetSender sends the Get request. The method will close the http.Response Body if it receives an error.

func (SyncGroupsClient) ListByStorageSyncService

func (client SyncGroupsClient) ListByStorageSyncService(ctx context.Context, resourceGroupName string, storageSyncServiceName string) (result SyncGroupArray, err error)

ListByStorageSyncService get a SyncGroup List. Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. storageSyncServiceName - name of Storage Sync Service resource.

func (SyncGroupsClient) ListByStorageSyncServicePreparer

func (client SyncGroupsClient) ListByStorageSyncServicePreparer(ctx context.Context, resourceGroupName string, storageSyncServiceName string) (*http.Request, error)

ListByStorageSyncServicePreparer prepares the ListByStorageSyncService request.

func (SyncGroupsClient) ListByStorageSyncServiceResponder

func (client SyncGroupsClient) ListByStorageSyncServiceResponder(resp *http.Response) (result SyncGroupArray, err error)

ListByStorageSyncServiceResponder handles the response to the ListByStorageSyncService request. The method always closes the http.Response Body.

func (SyncGroupsClient) ListByStorageSyncServiceSender

func (client SyncGroupsClient) ListByStorageSyncServiceSender(req *http.Request) (*http.Response, error)

ListByStorageSyncServiceSender sends the ListByStorageSyncService request. The method will close the http.Response Body if it receives an error.

type TrackedResource

type TrackedResource struct {
	// Tags - Resource tags.
	Tags map[string]*string `json:"tags"`
	// Location - The geo-location where the resource lives
	Location *string `json:"location,omitempty"`
	// ID - READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string `json:"id,omitempty"`
	// Name - READ-ONLY; The name of the resource
	Name *string `json:"name,omitempty"`
	// Type - READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string `json:"type,omitempty"`
}

TrackedResource the resource model definition for an Azure Resource Manager tracked top level resource which has 'tags' and a 'location'

func (TrackedResource) MarshalJSON

func (tr TrackedResource) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for TrackedResource.

type Workflow

type Workflow struct {
	autorest.Response `json:"-"`
	// WorkflowProperties - Workflow properties.
	*WorkflowProperties `json:"properties,omitempty"`
	// ID - READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string `json:"id,omitempty"`
	// Name - READ-ONLY; The name of the resource
	Name *string `json:"name,omitempty"`
	// Type - READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string `json:"type,omitempty"`
}

Workflow workflow resource.

func (Workflow) MarshalJSON

func (w Workflow) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for Workflow.

func (*Workflow) UnmarshalJSON

func (w *Workflow) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for Workflow struct.

type WorkflowArray

type WorkflowArray struct {
	// Value - Collection of workflow items.
	Value *[]Workflow `json:"value,omitempty"`
}

WorkflowArray array of Workflow

type WorkflowProperties

type WorkflowProperties struct {
	// LastStepName - last step name
	LastStepName *string `json:"lastStepName,omitempty"`
	// Status - workflow status. Possible values include: 'Active', 'Expired', 'Succeeded', 'Aborted', 'Failed'
	Status Status `json:"status,omitempty"`
	// Operation - operation direction. Possible values include: 'Do', 'Undo', 'Cancel'
	Operation Operation `json:"operation,omitempty"`
	// Steps - workflow steps
	Steps *string `json:"steps,omitempty"`
	// LastOperationID - workflow last operation identifier.
	LastOperationID *string `json:"lastOperationId,omitempty"`
}

WorkflowProperties workflow Properties object.

type WorkflowsClient

type WorkflowsClient struct {
	BaseClient
}

WorkflowsClient is the microsoft Storage Sync Service API

func NewWorkflowsClient

func NewWorkflowsClient(subscriptionID string) WorkflowsClient

NewWorkflowsClient creates an instance of the WorkflowsClient client.

func NewWorkflowsClientWithBaseURI

func NewWorkflowsClientWithBaseURI(baseURI string, subscriptionID string) WorkflowsClient

NewWorkflowsClientWithBaseURI creates an instance of the WorkflowsClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).

func (WorkflowsClient) Abort

func (client WorkflowsClient) Abort(ctx context.Context, resourceGroupName string, storageSyncServiceName string, workflowID string) (result autorest.Response, err error)

Abort abort the given workflow. Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. storageSyncServiceName - name of Storage Sync Service resource. workflowID - workflow Id

func (WorkflowsClient) AbortPreparer

func (client WorkflowsClient) AbortPreparer(ctx context.Context, resourceGroupName string, storageSyncServiceName string, workflowID string) (*http.Request, error)

AbortPreparer prepares the Abort request.

func (WorkflowsClient) AbortResponder

func (client WorkflowsClient) AbortResponder(resp *http.Response) (result autorest.Response, err error)

AbortResponder handles the response to the Abort request. The method always closes the http.Response Body.

func (WorkflowsClient) AbortSender

func (client WorkflowsClient) AbortSender(req *http.Request) (*http.Response, error)

AbortSender sends the Abort request. The method will close the http.Response Body if it receives an error.

func (WorkflowsClient) Get

func (client WorkflowsClient) Get(ctx context.Context, resourceGroupName string, storageSyncServiceName string, workflowID string) (result Workflow, err error)

Get get Workflows resource Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. storageSyncServiceName - name of Storage Sync Service resource. workflowID - workflow Id

func (WorkflowsClient) GetPreparer

func (client WorkflowsClient) GetPreparer(ctx context.Context, resourceGroupName string, storageSyncServiceName string, workflowID string) (*http.Request, error)

GetPreparer prepares the Get request.

func (WorkflowsClient) GetResponder

func (client WorkflowsClient) GetResponder(resp *http.Response) (result Workflow, err error)

GetResponder handles the response to the Get request. The method always closes the http.Response Body.

func (WorkflowsClient) GetSender

func (client WorkflowsClient) GetSender(req *http.Request) (*http.Response, error)

GetSender sends the Get request. The method will close the http.Response Body if it receives an error.

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL