import "github.com/Azure/azure-sdk-for-go/services/storagesync/mgmt/2020-03-01/storagesync"
Package storagesync implements the Azure ARM Storagesync service API version 2020-03-01.
Microsoft Storage Sync Service API
client.go cloudendpoints.go enums.go models.go operations.go operationstatus.go privateendpointconnections.go privatelinkresources.go registeredservers.go serverendpoints.go services.go syncgroups.go version.go workflows.go
const (
// DefaultBaseURI is the default URI used for the service Storagesync
DefaultBaseURI = "https://management.azure.com"
)UserAgent returns the UserAgent string to use when sending http.Requests.
Version returns the semantic version (see http://semver.org) of the client.
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 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.
type BackupRequest struct {
// AzureFileShare - Azure File Share.
*string `json:"azureFileShare,omitempty"`
}BackupRequest backup request
BaseClient is the base client for Storagesync.
func New(subscriptionID string) BaseClient
New creates an instance of the BaseClient client.
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).
ChangeDetectionMode enumerates the values for change detection mode.
const (
// Default ...
Default ChangeDetectionMode = "Default"
// Recursive ...
Recursive ChangeDetectionMode = "Recursive"
)func PossibleChangeDetectionModeValues() []ChangeDetectionMode
PossibleChangeDetectionModeValues returns an array of possible values for the ChangeDetectionMode const type.
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 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.
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 (ce CloudEndpoint) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for CloudEndpoint.
func (ce *CloudEndpoint) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for CloudEndpoint struct.
type CloudEndpointArray struct {
autorest.Response `json:"-"`
// Value - Collection of CloudEndpoint.
Value *[]CloudEndpoint `json:"value,omitempty"`
}CloudEndpointArray array of CloudEndpoint
type CloudEndpointCreateParameters struct {
// CloudEndpointCreateParametersProperties - The parameters used to create the cloud endpoint.
*CloudEndpointCreateParametersProperties `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"`
}CloudEndpointCreateParameters the parameters used when creating a cloud endpoint.
func (cecp CloudEndpointCreateParameters) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for CloudEndpointCreateParameters.
func (cecp *CloudEndpointCreateParameters) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for CloudEndpointCreateParameters struct.
type CloudEndpointCreateParametersProperties struct {
// StorageAccountResourceID - Storage Account Resource Id
StorageAccountResourceID *string `json:"storageAccountResourceId,omitempty"`
// AzureFileShareName - Azure file share name
*string `json:"azureFileShareName,omitempty"`
// StorageAccountTenantID - Storage Account Tenant Id
StorageAccountTenantID *string `json:"storageAccountTenantId,omitempty"`
// FriendlyName - Friendly Name
FriendlyName *string `json:"friendlyName,omitempty"`
}CloudEndpointCreateParametersProperties cloudEndpoint Properties object.
type CloudEndpointProperties struct {
// StorageAccountResourceID - Storage Account Resource Id
StorageAccountResourceID *string `json:"storageAccountResourceId,omitempty"`
// AzureFileShareName - Azure file share name
*string `json:"azureFileShareName,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 *string `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 (cep CloudEndpointProperties) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for CloudEndpointProperties.
type CloudEndpointsClient struct {
BaseClient
}CloudEndpointsClient is the microsoft Storage Sync Service API
func NewCloudEndpointsClient(subscriptionID string) CloudEndpointsClient
NewCloudEndpointsClient creates an instance of the CloudEndpointsClient client.
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 (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 (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 (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 (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 (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 (client CloudEndpointsClient) DeletePreparer(ctx context.Context, resourceGroupName string, storageSyncServiceName string, syncGroupName string, cloudEndpointName string) (*http.Request, error)
DeletePreparer prepares the Delete request.
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 (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 (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 (client CloudEndpointsClient) GetPreparer(ctx context.Context, resourceGroupName string, storageSyncServiceName string, syncGroupName string, cloudEndpointName string) (*http.Request, error)
GetPreparer prepares the Get request.
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.
GetSender sends the Get request. The method will close the http.Response Body if it receives an error.
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 (client CloudEndpointsClient) ListBySyncGroupPreparer(ctx context.Context, resourceGroupName string, storageSyncServiceName string, syncGroupName string) (*http.Request, error)
ListBySyncGroupPreparer prepares the ListBySyncGroup request.
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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (client CloudEndpointsClient) RestoreheartbeatPreparer(ctx context.Context, resourceGroupName string, storageSyncServiceName string, syncGroupName string, cloudEndpointName string) (*http.Request, error)
RestoreheartbeatPreparer prepares the Restoreheartbeat request.
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 (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.
func (client CloudEndpointsClient) TriggerChangeDetection(ctx context.Context, resourceGroupName string, storageSyncServiceName string, syncGroupName string, cloudEndpointName string, parameters TriggerChangeDetectionParameters) (result CloudEndpointsTriggerChangeDetectionFuture, err error)
TriggerChangeDetection triggers detection of changes performed on Azure File share connected to the specified Azure File Sync Cloud 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. cloudEndpointName - name of Cloud Endpoint object. parameters - trigger Change Detection Action parameters.
func (client CloudEndpointsClient) TriggerChangeDetectionPreparer(ctx context.Context, resourceGroupName string, storageSyncServiceName string, syncGroupName string, cloudEndpointName string, parameters TriggerChangeDetectionParameters) (*http.Request, error)
TriggerChangeDetectionPreparer prepares the TriggerChangeDetection request.
func (client CloudEndpointsClient) TriggerChangeDetectionResponder(resp *http.Response) (result autorest.Response, err error)
TriggerChangeDetectionResponder handles the response to the TriggerChangeDetection request. The method always closes the http.Response Body.
func (client CloudEndpointsClient) TriggerChangeDetectionSender(req *http.Request) (future CloudEndpointsTriggerChangeDetectionFuture, err error)
TriggerChangeDetectionSender sends the TriggerChangeDetection request. The method will close the http.Response Body if it receives an error.
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.
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.
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.
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.
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.
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.
type CloudEndpointsTriggerChangeDetectionFuture 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)
}CloudEndpointsTriggerChangeDetectionFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type CloudTieringCachePerformance struct {
// LastUpdatedTimestamp - READ-ONLY; Last updated timestamp
LastUpdatedTimestamp *date.Time `json:"lastUpdatedTimestamp,omitempty"`
// CacheHitBytes - READ-ONLY; Count of bytes that were served from the local server
CacheHitBytes *int64 `json:"cacheHitBytes,omitempty"`
// CacheMissBytes - READ-ONLY; Count of bytes that were served from the cloud
CacheMissBytes *int64 `json:"cacheMissBytes,omitempty"`
// CacheHitBytesPercent - READ-ONLY; Percentage of total bytes (hit + miss) that were served from the local server
CacheHitBytesPercent *int32 `json:"cacheHitBytesPercent,omitempty"`
}CloudTieringCachePerformance server endpoint cloud tiering status object.
type CloudTieringDatePolicyStatus struct {
// LastUpdatedTimestamp - READ-ONLY; Last updated timestamp
LastUpdatedTimestamp *date.Time `json:"lastUpdatedTimestamp,omitempty"`
// TieredFilesMostRecentAccessTimestamp - READ-ONLY; Most recent access time of tiered files
TieredFilesMostRecentAccessTimestamp *date.Time `json:"tieredFilesMostRecentAccessTimestamp,omitempty"`
}CloudTieringDatePolicyStatus status of the date policy
type CloudTieringFilesNotTiering struct {
// LastUpdatedTimestamp - READ-ONLY; Last updated timestamp
LastUpdatedTimestamp *date.Time `json:"lastUpdatedTimestamp,omitempty"`
// TotalFileCount - READ-ONLY; Last cloud tiering result (HResult)
TotalFileCount *int64 `json:"totalFileCount,omitempty"`
// Errors - READ-ONLY; Array of tiering errors
Errors *[]FilesNotTieringError `json:"errors,omitempty"`
}CloudTieringFilesNotTiering server endpoint cloud tiering status object.
type CloudTieringSpaceSavings struct {
// LastUpdatedTimestamp - READ-ONLY; Last updated timestamp
LastUpdatedTimestamp *date.Time `json:"lastUpdatedTimestamp,omitempty"`
// VolumeSizeBytes - READ-ONLY; Volume size
VolumeSizeBytes *int64 `json:"volumeSizeBytes,omitempty"`
// TotalSizeCloudBytes - READ-ONLY; Total size of content in the azure file share
TotalSizeCloudBytes *int64 `json:"totalSizeCloudBytes,omitempty"`
// CachedSizeBytes - READ-ONLY; Cached content size on the server
CachedSizeBytes *int64 `json:"cachedSizeBytes,omitempty"`
// SpaceSavingsPercent - READ-ONLY; Percentage of cached size over total size
SpaceSavingsPercent *int32 `json:"spaceSavingsPercent,omitempty"`
// SpaceSavingsBytes - READ-ONLY; Count of bytes saved on the server
SpaceSavingsBytes *int64 `json:"spaceSavingsBytes,omitempty"`
}CloudTieringSpaceSavings server endpoint cloud tiering status object.
type CloudTieringVolumeFreeSpacePolicyStatus struct {
// LastUpdatedTimestamp - READ-ONLY; Last updated timestamp
LastUpdatedTimestamp *date.Time `json:"lastUpdatedTimestamp,omitempty"`
// EffectiveVolumeFreeSpacePolicy - READ-ONLY; In the case where multiple server endpoints are present in a volume, an effective free space policy is applied.
EffectiveVolumeFreeSpacePolicy *int32 `json:"effectiveVolumeFreeSpacePolicy,omitempty"`
// CurrentVolumeFreeSpacePercent - READ-ONLY; Current volume free space percentage.
CurrentVolumeFreeSpacePercent *int32 `json:"currentVolumeFreeSpacePercent,omitempty"`
}CloudTieringVolumeFreeSpacePolicyStatus status of the volume free space policy
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 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.
FeatureStatus enumerates the values for feature status.
const (
// Off ...
Off FeatureStatus = "off"
// On ...
On FeatureStatus = "on"
)func PossibleFeatureStatusValues() []FeatureStatus
PossibleFeatureStatusValues returns an array of possible values for the FeatureStatus const type.
type FilesNotTieringError struct {
// ErrorCode - READ-ONLY; Error code (HResult)
ErrorCode *int32 `json:"errorCode,omitempty"`
// FileCount - READ-ONLY; Count of files with this error
FileCount *int64 `json:"fileCount,omitempty"`
}FilesNotTieringError files not tiering error object
IncomingTrafficPolicy enumerates the values for incoming traffic policy.
const (
// AllowAllTraffic ...
AllowAllTraffic IncomingTrafficPolicy = "AllowAllTraffic"
// AllowVirtualNetworksOnly ...
AllowVirtualNetworksOnly IncomingTrafficPolicy = "AllowVirtualNetworksOnly"
)func PossibleIncomingTrafficPolicyValues() []IncomingTrafficPolicy
PossibleIncomingTrafficPolicyValues returns an array of possible values for the IncomingTrafficPolicy const type.
InitialDownloadPolicy enumerates the values for initial download policy.
const (
// AvoidTieredFiles ...
AvoidTieredFiles InitialDownloadPolicy = "AvoidTieredFiles"
// NamespaceOnly ...
NamespaceOnly InitialDownloadPolicy = "NamespaceOnly"
// NamespaceThenModifiedFiles ...
NamespaceThenModifiedFiles InitialDownloadPolicy = "NamespaceThenModifiedFiles"
)func PossibleInitialDownloadPolicyValues() []InitialDownloadPolicy
PossibleInitialDownloadPolicyValues returns an array of possible values for the InitialDownloadPolicy const type.
LocalCacheMode enumerates the values for local cache mode.
const (
// DownloadNewAndModifiedFiles ...
DownloadNewAndModifiedFiles LocalCacheMode = "DownloadNewAndModifiedFiles"
// UpdateLocallyCachedFiles ...
UpdateLocallyCachedFiles LocalCacheMode = "UpdateLocallyCachedFiles"
)func PossibleLocalCacheModeValues() []LocalCacheMode
PossibleLocalCacheModeValues returns an array of possible values for the LocalCacheMode const type.
NameAvailabilityReason enumerates the values for name availability reason.
const (
// AlreadyExists ...
AlreadyExists NameAvailabilityReason = "AlreadyExists"
// Invalid ...
Invalid NameAvailabilityReason = "Invalid"
)func PossibleNameAvailabilityReasonValues() []NameAvailabilityReason
PossibleNameAvailabilityReasonValues returns an array of possible values for the NameAvailabilityReason const type.
OperationDirection enumerates the values for operation direction.
const (
// Cancel ...
Cancel OperationDirection = "cancel"
// Do ...
Do OperationDirection = "do"
// Undo ...
Undo OperationDirection = "undo"
)func PossibleOperationDirectionValues() []OperationDirection
PossibleOperationDirectionValues returns an array of possible values for the OperationDirection const type.
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 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 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 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 (oelr OperationEntityListResult) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
type OperationEntityListResultIterator struct {
// contains filtered or unexported fields
}OperationEntityListResultIterator provides access to a complete listing of OperationEntity values.
func NewOperationEntityListResultIterator(page OperationEntityListResultPage) OperationEntityListResultIterator
Creates a new instance of the OperationEntityListResultIterator type.
func (iter *OperationEntityListResultIterator) Next() error
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 (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 (iter OperationEntityListResultIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter OperationEntityListResultIterator) Response() OperationEntityListResult
Response returns the raw server response from the last page request.
func (iter OperationEntityListResultIterator) Value() OperationEntity
Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.
type OperationEntityListResultPage struct {
// contains filtered or unexported fields
}OperationEntityListResultPage contains a page of OperationEntity values.
func NewOperationEntityListResultPage(cur OperationEntityListResult, getNextPage func(context.Context, OperationEntityListResult) (OperationEntityListResult, error)) OperationEntityListResultPage
Creates a new instance of the OperationEntityListResultPage type.
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 (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 (page OperationEntityListResultPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page OperationEntityListResultPage) Response() OperationEntityListResult
Response returns the raw server response from the last page request.
func (page OperationEntityListResultPage) Values() []OperationEntity
Values returns the slice of values for the current page or nil if there are no values.
type OperationStatus struct {
autorest.Response `json:"-"`
// Name - READ-ONLY; Operation Id
Name *string `json:"name,omitempty"`
// Status - READ-ONLY; Operation status
Status *string `json:"status,omitempty"`
// StartTime - READ-ONLY; Start time of the operation
StartTime *date.Time `json:"startTime,omitempty"`
// EndTime - READ-ONLY; End time of the operation
EndTime *date.Time `json:"endTime,omitempty"`
// Error - READ-ONLY; Error details.
Error *APIError `json:"error,omitempty"`
}OperationStatus operation status object
type OperationStatusClient struct {
BaseClient
}OperationStatusClient is the microsoft Storage Sync Service API
func NewOperationStatusClient(subscriptionID string) OperationStatusClient
NewOperationStatusClient creates an instance of the OperationStatusClient client.
func NewOperationStatusClientWithBaseURI(baseURI string, subscriptionID string) OperationStatusClient
NewOperationStatusClientWithBaseURI creates an instance of the OperationStatusClient 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 (client OperationStatusClient) Get(ctx context.Context, resourceGroupName string, locationName string, workflowID string, operationID string) (result OperationStatus, err error)
Get get Operation status Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. locationName - the desired region to obtain information from. workflowID - workflow Id operationID - operation Id
func (client OperationStatusClient) GetPreparer(ctx context.Context, resourceGroupName string, locationName string, workflowID string, operationID string) (*http.Request, error)
GetPreparer prepares the Get request.
func (client OperationStatusClient) GetResponder(resp *http.Response) (result OperationStatus, err error)
GetResponder handles the response to the Get request. The method always closes the http.Response Body.
GetSender sends the Get request. The method will close the http.Response Body if it receives an error.
type OperationsClient struct {
BaseClient
}OperationsClient is the microsoft Storage Sync Service API
func NewOperationsClient(subscriptionID string) OperationsClient
NewOperationsClient creates an instance of the OperationsClient client.
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 (client OperationsClient) List(ctx context.Context) (result OperationEntityListResultPage, err error)
List lists all of the available Storage Sync Rest API operations.
func (client OperationsClient) ListComplete(ctx context.Context) (result OperationEntityListResultIterator, err error)
ListComplete enumerates all values, automatically crossing page boundaries as required.
ListPreparer prepares the List request.
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.
ListSender sends the List request. The method will close the http.Response Body if it receives an error.
type PostBackupResponse struct {
autorest.Response `json:"-"`
// PostBackupResponseProperties - Post Backup Response Properties
*PostBackupResponseProperties `json:"backupMetadata,omitempty"`
}PostBackupResponse post Backup Response
func (pbr PostBackupResponse) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for PostBackupResponse.
func (pbr *PostBackupResponse) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for PostBackupResponse struct.
type PostBackupResponseProperties struct {
// CloudEndpointName - READ-ONLY; cloud endpoint Name.
CloudEndpointName *string `json:"cloudEndpointName,omitempty"`
}PostBackupResponseProperties post Backup Response Properties object.
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.
*string `json:"azureFileShareUri,omitempty"`
// Status - Post Restore Azure status.
Status *string `json:"status,omitempty"`
// SourceAzureFileShareURI - Post Restore Azure source azure file share uri.
*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 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.
*string `json:"azureFileShareUri,omitempty"`
// Status - Pre Restore Azure status.
Status *string `json:"status,omitempty"`
// SourceAzureFileShareURI - Pre Restore Azure source azure file share uri.
*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 PrivateEndpoint struct {
// ID - READ-ONLY; The ARM identifier for Private Endpoint
ID *string `json:"id,omitempty"`
}PrivateEndpoint the Private Endpoint resource.
type PrivateEndpointConnection struct {
autorest.Response `json:"-"`
// PrivateEndpointConnectionProperties - Resource properties.
*PrivateEndpointConnectionProperties `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"`
}PrivateEndpointConnection the Private Endpoint Connection resource.
func (pec PrivateEndpointConnection) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for PrivateEndpointConnection.
func (pec *PrivateEndpointConnection) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for PrivateEndpointConnection struct.
type PrivateEndpointConnectionListResult struct {
autorest.Response `json:"-"`
// Value - Array of private endpoint connections
Value *[]PrivateEndpointConnection `json:"value,omitempty"`
}PrivateEndpointConnectionListResult list of private endpoint connection associated with the specified storage account
type PrivateEndpointConnectionProperties struct {
// PrivateEndpoint - The resource of private end point.
PrivateEndpoint *PrivateEndpoint `json:"privateEndpoint,omitempty"`
// PrivateLinkServiceConnectionState - A collection of information about the state of the connection between service consumer and provider.
PrivateLinkServiceConnectionState *PrivateLinkServiceConnectionState `json:"privateLinkServiceConnectionState,omitempty"`
// ProvisioningState - The provisioning state of the private endpoint connection resource. Possible values include: 'Succeeded', 'Creating', 'Deleting', 'Failed'
ProvisioningState PrivateEndpointConnectionProvisioningState `json:"provisioningState,omitempty"`
}PrivateEndpointConnectionProperties properties of the PrivateEndpointConnectProperties.
PrivateEndpointConnectionProvisioningState enumerates the values for private endpoint connection provisioning state.
const (
// Creating ...
Creating PrivateEndpointConnectionProvisioningState = "Creating"
// Deleting ...
Deleting PrivateEndpointConnectionProvisioningState = "Deleting"
// Failed ...
Failed PrivateEndpointConnectionProvisioningState = "Failed"
// Succeeded ...
Succeeded PrivateEndpointConnectionProvisioningState = "Succeeded"
)func PossiblePrivateEndpointConnectionProvisioningStateValues() []PrivateEndpointConnectionProvisioningState
PossiblePrivateEndpointConnectionProvisioningStateValues returns an array of possible values for the PrivateEndpointConnectionProvisioningState const type.
type PrivateEndpointConnectionsClient struct {
BaseClient
}PrivateEndpointConnectionsClient is the microsoft Storage Sync Service API
func NewPrivateEndpointConnectionsClient(subscriptionID string) PrivateEndpointConnectionsClient
NewPrivateEndpointConnectionsClient creates an instance of the PrivateEndpointConnectionsClient client.
func NewPrivateEndpointConnectionsClientWithBaseURI(baseURI string, subscriptionID string) PrivateEndpointConnectionsClient
NewPrivateEndpointConnectionsClientWithBaseURI creates an instance of the PrivateEndpointConnectionsClient 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 (client PrivateEndpointConnectionsClient) Create(ctx context.Context, resourceGroupName string, storageSyncServiceName string, privateEndpointConnectionName string, properties PrivateEndpointConnection) (result PrivateEndpointConnectionsCreateFuture, err error)
Create update the state of specified private endpoint connection associated with the storage sync service. Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. storageSyncServiceName - the name of the storage sync service name within the specified resource group. privateEndpointConnectionName - the name of the private endpoint connection associated with the Azure resource properties - the private endpoint connection properties.
func (client PrivateEndpointConnectionsClient) CreatePreparer(ctx context.Context, resourceGroupName string, storageSyncServiceName string, privateEndpointConnectionName string, properties PrivateEndpointConnection) (*http.Request, error)
CreatePreparer prepares the Create request.
func (client PrivateEndpointConnectionsClient) CreateResponder(resp *http.Response) (result PrivateEndpointConnection, err error)
CreateResponder handles the response to the Create request. The method always closes the http.Response Body.
func (client PrivateEndpointConnectionsClient) CreateSender(req *http.Request) (future PrivateEndpointConnectionsCreateFuture, err error)
CreateSender sends the Create request. The method will close the http.Response Body if it receives an error.
func (client PrivateEndpointConnectionsClient) Delete(ctx context.Context, resourceGroupName string, storageSyncServiceName string, privateEndpointConnectionName string) (result PrivateEndpointConnectionsDeleteFuture, err error)
Delete deletes the specified private endpoint connection associated with the storage sync service. Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. storageSyncServiceName - the name of the storage sync service name within the specified resource group. privateEndpointConnectionName - the name of the private endpoint connection associated with the Azure resource
func (client PrivateEndpointConnectionsClient) DeletePreparer(ctx context.Context, resourceGroupName string, storageSyncServiceName string, privateEndpointConnectionName string) (*http.Request, error)
DeletePreparer prepares the Delete request.
func (client PrivateEndpointConnectionsClient) 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 (client PrivateEndpointConnectionsClient) DeleteSender(req *http.Request) (future PrivateEndpointConnectionsDeleteFuture, err error)
DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.
func (client PrivateEndpointConnectionsClient) Get(ctx context.Context, resourceGroupName string, storageSyncServiceName string, privateEndpointConnectionName string) (result PrivateEndpointConnection, err error)
Get gets the specified private endpoint connection associated with the storage sync service. Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. storageSyncServiceName - the name of the storage sync service name within the specified resource group. privateEndpointConnectionName - the name of the private endpoint connection associated with the Azure resource
func (client PrivateEndpointConnectionsClient) GetPreparer(ctx context.Context, resourceGroupName string, storageSyncServiceName string, privateEndpointConnectionName string) (*http.Request, error)
GetPreparer prepares the Get request.
func (client PrivateEndpointConnectionsClient) GetResponder(resp *http.Response) (result PrivateEndpointConnection, err error)
GetResponder handles the response to the Get request. The method always closes the http.Response Body.
func (client PrivateEndpointConnectionsClient) 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 (client PrivateEndpointConnectionsClient) ListByStorageSyncService(ctx context.Context, resourceGroupName string, storageSyncServiceName string) (result PrivateEndpointConnectionListResult, err error)
ListByStorageSyncService get a PrivateEndpointConnection List. Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. storageSyncServiceName - name of Storage Sync Service resource.
func (client PrivateEndpointConnectionsClient) ListByStorageSyncServicePreparer(ctx context.Context, resourceGroupName string, storageSyncServiceName string) (*http.Request, error)
ListByStorageSyncServicePreparer prepares the ListByStorageSyncService request.
func (client PrivateEndpointConnectionsClient) ListByStorageSyncServiceResponder(resp *http.Response) (result PrivateEndpointConnectionListResult, err error)
ListByStorageSyncServiceResponder handles the response to the ListByStorageSyncService request. The method always closes the http.Response Body.
func (client PrivateEndpointConnectionsClient) 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 PrivateEndpointConnectionsCreateFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(PrivateEndpointConnectionsClient) (PrivateEndpointConnection, error)
}PrivateEndpointConnectionsCreateFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type PrivateEndpointConnectionsDeleteFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(PrivateEndpointConnectionsClient) (autorest.Response, error)
}PrivateEndpointConnectionsDeleteFuture an abstraction for monitoring and retrieving the results of a long-running operation.
PrivateEndpointServiceConnectionStatus enumerates the values for private endpoint service connection status.
const (
// Approved ...
Approved PrivateEndpointServiceConnectionStatus = "Approved"
// Pending ...
Pending PrivateEndpointServiceConnectionStatus = "Pending"
// Rejected ...
Rejected PrivateEndpointServiceConnectionStatus = "Rejected"
)func PossiblePrivateEndpointServiceConnectionStatusValues() []PrivateEndpointServiceConnectionStatus
PossiblePrivateEndpointServiceConnectionStatusValues returns an array of possible values for the PrivateEndpointServiceConnectionStatus const type.
type PrivateLinkResource struct {
// PrivateLinkResourceProperties - Resource properties.
*PrivateLinkResourceProperties `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"`
}PrivateLinkResource a private link resource
func (plr PrivateLinkResource) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for PrivateLinkResource.
func (plr *PrivateLinkResource) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for PrivateLinkResource struct.
type PrivateLinkResourceListResult struct {
autorest.Response `json:"-"`
// Value - Array of private link resources
Value *[]PrivateLinkResource `json:"value,omitempty"`
}PrivateLinkResourceListResult a list of private link resources
type PrivateLinkResourceProperties struct {
// GroupID - READ-ONLY; The private link resource group id.
GroupID *string `json:"groupId,omitempty"`
// RequiredMembers - READ-ONLY; The private link resource required member names.
RequiredMembers *[]string `json:"requiredMembers,omitempty"`
// RequiredZoneNames - The private link resource Private link DNS zone name.
RequiredZoneNames *[]string `json:"requiredZoneNames,omitempty"`
}PrivateLinkResourceProperties properties of a private link resource.
func (plrp PrivateLinkResourceProperties) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for PrivateLinkResourceProperties.
type PrivateLinkResourcesClient struct {
BaseClient
}PrivateLinkResourcesClient is the microsoft Storage Sync Service API
func NewPrivateLinkResourcesClient(subscriptionID string) PrivateLinkResourcesClient
NewPrivateLinkResourcesClient creates an instance of the PrivateLinkResourcesClient client.
func NewPrivateLinkResourcesClientWithBaseURI(baseURI string, subscriptionID string) PrivateLinkResourcesClient
NewPrivateLinkResourcesClientWithBaseURI creates an instance of the PrivateLinkResourcesClient 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 (client PrivateLinkResourcesClient) ListByStorageSyncService(ctx context.Context, resourceGroupName string, storageSyncServiceName string) (result PrivateLinkResourceListResult, err error)
ListByStorageSyncService gets the private link resources that need to be created for a storage sync service. Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. storageSyncServiceName - the name of the storage sync service name within the specified resource group.
func (client PrivateLinkResourcesClient) ListByStorageSyncServicePreparer(ctx context.Context, resourceGroupName string, storageSyncServiceName string) (*http.Request, error)
ListByStorageSyncServicePreparer prepares the ListByStorageSyncService request.
func (client PrivateLinkResourcesClient) ListByStorageSyncServiceResponder(resp *http.Response) (result PrivateLinkResourceListResult, err error)
ListByStorageSyncServiceResponder handles the response to the ListByStorageSyncService request. The method always closes the http.Response Body.
func (client PrivateLinkResourcesClient) 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 PrivateLinkServiceConnectionState struct {
// Status - Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. Possible values include: 'Pending', 'Approved', 'Rejected'
Status PrivateEndpointServiceConnectionStatus `json:"status,omitempty"`
// Description - The reason for approval/rejection of the connection.
Description *string `json:"description,omitempty"`
// ActionsRequired - A message indicating if changes on the service provider require any updates on the consumer.
ActionsRequired *string `json:"actionsRequired,omitempty"`
}PrivateLinkServiceConnectionState a collection of information about the state of the connection between service consumer and provider.
ProgressType enumerates the values for progress type.
const (
// Download ...
Download ProgressType = "download"
// Initialize ...
Initialize ProgressType = "initialize"
// None ...
None ProgressType = "none"
// Recall ...
Recall ProgressType = "recall"
// Upload ...
Upload ProgressType = "upload"
)func PossibleProgressTypeValues() []ProgressType
PossibleProgressTypeValues returns an array of possible values for the ProgressType const type.
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
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"
)PossibleReasonValues returns an array of possible values for the Reason const type.
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 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 (rs RegisteredServer) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for RegisteredServer.
func (rs *RegisteredServer) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for RegisteredServer struct.
type RegisteredServerArray struct {
autorest.Response `json:"-"`
// Value - Collection of Registered Server.
Value *[]RegisteredServer `json:"value,omitempty"`
}RegisteredServerArray array of RegisteredServer
type RegisteredServerCreateParameters struct {
// RegisteredServerCreateParametersProperties - The parameters used to create the registered server.
*RegisteredServerCreateParametersProperties `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"`
}RegisteredServerCreateParameters the parameters used when creating a registered server.
func (rscp RegisteredServerCreateParameters) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for RegisteredServerCreateParameters.
func (rscp *RegisteredServerCreateParameters) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for RegisteredServerCreateParameters struct.
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 Create Properties object.
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"`
// ServerManagementErrorCode - Registered Server Management Error Code
ServerManagementErrorCode *int32 `json:"serverManagementErrorCode,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"`
// MonitoringEndpointURI - Telemetry Endpoint Uri
MonitoringEndpointURI *string `json:"monitoringEndpointUri,omitempty"`
// MonitoringConfiguration - Monitoring Configuration
MonitoringConfiguration *string `json:"monitoringConfiguration,omitempty"`
}RegisteredServerProperties registeredServer Properties object.
type RegisteredServersClient struct {
BaseClient
}RegisteredServersClient is the microsoft Storage Sync Service API
func NewRegisteredServersClient(subscriptionID string) RegisteredServersClient
NewRegisteredServersClient creates an instance of the RegisteredServersClient client.
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 (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 (client RegisteredServersClient) CreatePreparer(ctx context.Context, resourceGroupName string, storageSyncServiceName string, serverID string, parameters RegisteredServerCreateParameters) (*http.Request, error)
CreatePreparer prepares the Create request.
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 (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 (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 (client RegisteredServersClient) DeletePreparer(ctx context.Context, resourceGroupName string, storageSyncServiceName string, serverID string) (*http.Request, error)
DeletePreparer prepares the Delete request.
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 (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 (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 (client RegisteredServersClient) GetPreparer(ctx context.Context, resourceGroupName string, storageSyncServiceName string, serverID string) (*http.Request, error)
GetPreparer prepares the Get request.
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.
GetSender sends the Get request. The method will close the http.Response Body if it receives an error.
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 (client RegisteredServersClient) ListByStorageSyncServicePreparer(ctx context.Context, resourceGroupName string, storageSyncServiceName string) (*http.Request, error)
ListByStorageSyncServicePreparer prepares the ListByStorageSyncService request.
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 (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.
func (client RegisteredServersClient) TriggerRollover(ctx context.Context, resourceGroupName string, storageSyncServiceName string, serverID string, parameters TriggerRolloverRequest) (result RegisteredServersTriggerRolloverFuture, err error)
TriggerRollover triggers Server certificate rollover. Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. storageSyncServiceName - name of Storage Sync Service resource. serverID - server Id parameters - body of Trigger Rollover request.
func (client RegisteredServersClient) TriggerRolloverPreparer(ctx context.Context, resourceGroupName string, storageSyncServiceName string, serverID string, parameters TriggerRolloverRequest) (*http.Request, error)
TriggerRolloverPreparer prepares the TriggerRollover request.
func (client RegisteredServersClient) TriggerRolloverResponder(resp *http.Response) (result autorest.Response, err error)
TriggerRolloverResponder handles the response to the TriggerRollover request. The method always closes the http.Response Body.
func (client RegisteredServersClient) TriggerRolloverSender(req *http.Request) (future RegisteredServersTriggerRolloverFuture, err error)
TriggerRolloverSender sends the TriggerRollover request. The method will close the http.Response Body if it receives an error.
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.
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.
type RegisteredServersTriggerRolloverFuture 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)
}RegisteredServersTriggerRolloverFuture an abstraction for monitoring and retrieving the results of a long-running operation.
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
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 struct {
// Path - Restore file spec path
Path *string `json:"path,omitempty"`
// Isdir - Restore file spec isdir
Isdir *bool `json:"isdir,omitempty"`
}RestoreFileSpec restore file spec.
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 (se ServerEndpoint) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for ServerEndpoint.
func (se *ServerEndpoint) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for ServerEndpoint struct.
type ServerEndpointArray struct {
autorest.Response `json:"-"`
// Value - Collection of ServerEndpoint.
Value *[]ServerEndpoint `json:"value,omitempty"`
}ServerEndpointArray array of ServerEndpoint
ServerEndpointCloudTieringHealthState enumerates the values for server endpoint cloud tiering health state.
const (
// ServerEndpointCloudTieringHealthStateError ...
ServerEndpointCloudTieringHealthStateError ServerEndpointCloudTieringHealthState = "Error"
// ServerEndpointCloudTieringHealthStateHealthy ...
ServerEndpointCloudTieringHealthStateHealthy ServerEndpointCloudTieringHealthState = "Healthy"
)func PossibleServerEndpointCloudTieringHealthStateValues() []ServerEndpointCloudTieringHealthState
PossibleServerEndpointCloudTieringHealthStateValues returns an array of possible values for the ServerEndpointCloudTieringHealthState const type.
type ServerEndpointCloudTieringStatus struct {
// LastUpdatedTimestamp - READ-ONLY; Last updated timestamp
LastUpdatedTimestamp *date.Time `json:"lastUpdatedTimestamp,omitempty"`
// Health - READ-ONLY; Cloud tiering health state. Possible values include: 'ServerEndpointCloudTieringHealthStateHealthy', 'ServerEndpointCloudTieringHealthStateError'
Health ServerEndpointCloudTieringHealthState `json:"health,omitempty"`
// HealthLastUpdatedTimestamp - READ-ONLY; The last updated timestamp of health state
HealthLastUpdatedTimestamp *date.Time `json:"healthLastUpdatedTimestamp,omitempty"`
// LastCloudTieringResult - READ-ONLY; Last cloud tiering result (HResult)
LastCloudTieringResult *int32 `json:"lastCloudTieringResult,omitempty"`
// LastSuccessTimestamp - READ-ONLY; Last cloud tiering success timestamp
LastSuccessTimestamp *date.Time `json:"lastSuccessTimestamp,omitempty"`
// SpaceSavings - READ-ONLY; Information regarding how much local space cloud tiering is saving.
SpaceSavings *CloudTieringSpaceSavings `json:"spaceSavings,omitempty"`
// CachePerformance - READ-ONLY; Information regarding how well the local cache on the server is performing.
CachePerformance *CloudTieringCachePerformance `json:"cachePerformance,omitempty"`
// FilesNotTiering - READ-ONLY; Information regarding files that failed to be tiered
FilesNotTiering *CloudTieringFilesNotTiering `json:"filesNotTiering,omitempty"`
// VolumeFreeSpacePolicyStatus - READ-ONLY; Status of the volume free space policy
VolumeFreeSpacePolicyStatus *CloudTieringVolumeFreeSpacePolicyStatus `json:"volumeFreeSpacePolicyStatus,omitempty"`
// DatePolicyStatus - READ-ONLY; Status of the date policy
DatePolicyStatus *CloudTieringDatePolicyStatus `json:"datePolicyStatus,omitempty"`
}ServerEndpointCloudTieringStatus server endpoint cloud tiering status object.
type ServerEndpointCreateParameters struct {
// ServerEndpointCreateParametersProperties - The parameters used to create the server endpoint.
*ServerEndpointCreateParametersProperties `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"`
}ServerEndpointCreateParameters the parameters used when creating a server endpoint.
func (secp ServerEndpointCreateParameters) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for ServerEndpointCreateParameters.
func (secp *ServerEndpointCreateParameters) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for ServerEndpointCreateParameters struct.
type ServerEndpointCreateParametersProperties struct {
// ServerLocalPath - Server Local path.
ServerLocalPath *string `json:"serverLocalPath,omitempty"`
// CloudTiering - Cloud Tiering. Possible values include: 'On', 'Off'
CloudTiering FeatureStatus `json:"cloudTiering,omitempty"`
// VolumeFreeSpacePercent - Level of free space to be maintained by Cloud Tiering if it is enabled.
VolumeFreeSpacePercent *int32 `json:"volumeFreeSpacePercent,omitempty"`
// TierFilesOlderThanDays - Tier files older than days.
TierFilesOlderThanDays *int32 `json:"tierFilesOlderThanDays,omitempty"`
// FriendlyName - Friendly Name
FriendlyName *string `json:"friendlyName,omitempty"`
// ServerResourceID - Server Resource Id.
ServerResourceID *string `json:"serverResourceId,omitempty"`
// OfflineDataTransfer - Offline data transfer. Possible values include: 'On', 'Off'
OfflineDataTransfer FeatureStatus `json:"offlineDataTransfer,omitempty"`
// OfflineDataTransferShareName - Offline data transfer share name
*string `json:"offlineDataTransferShareName,omitempty"`
// InitialDownloadPolicy - Policy for how namespace and files are recalled during FastDr. Possible values include: 'NamespaceOnly', 'NamespaceThenModifiedFiles', 'AvoidTieredFiles'
InitialDownloadPolicy InitialDownloadPolicy `json:"initialDownloadPolicy,omitempty"`
// LocalCacheMode - Policy for enabling follow-the-sun business models: link local cache to cloud behavior to pre-populate before local access. Possible values include: 'DownloadNewAndModifiedFiles', 'UpdateLocallyCachedFiles'
LocalCacheMode LocalCacheMode `json:"localCacheMode,omitempty"`
}ServerEndpointCreateParametersProperties serverEndpoint Properties object.
type ServerEndpointFilesNotSyncingError struct {
// ErrorCode - READ-ONLY; Error code (HResult)
ErrorCode *int32 `json:"errorCode,omitempty"`
// PersistentCount - READ-ONLY; Count of persistent files not syncing with the specified error code
PersistentCount *int64 `json:"persistentCount,omitempty"`
// TransientCount - READ-ONLY; Count of transient files not syncing with the specified error code
TransientCount *int64 `json:"transientCount,omitempty"`
}ServerEndpointFilesNotSyncingError files not syncing error object
ServerEndpointOfflineDataTransferState enumerates the values for server endpoint offline data transfer state.
const (
// Complete ...
Complete ServerEndpointOfflineDataTransferState = "Complete"
// InProgress ...
InProgress ServerEndpointOfflineDataTransferState = "InProgress"
// NotRunning ...
NotRunning ServerEndpointOfflineDataTransferState = "NotRunning"
// Stopping ...
Stopping ServerEndpointOfflineDataTransferState = "Stopping"
)func PossibleServerEndpointOfflineDataTransferStateValues() []ServerEndpointOfflineDataTransferState
PossibleServerEndpointOfflineDataTransferStateValues returns an array of possible values for the ServerEndpointOfflineDataTransferState const type.
type ServerEndpointProperties struct {
// ServerLocalPath - Server Local path.
ServerLocalPath *string `json:"serverLocalPath,omitempty"`
// CloudTiering - Cloud Tiering. Possible values include: 'On', 'Off'
CloudTiering FeatureStatus `json:"cloudTiering,omitempty"`
// VolumeFreeSpacePercent - Level of free space to be maintained by Cloud Tiering if it is enabled.
VolumeFreeSpacePercent *int32 `json:"volumeFreeSpacePercent,omitempty"`
// TierFilesOlderThanDays - Tier files older than days.
TierFilesOlderThanDays *int32 `json:"tierFilesOlderThanDays,omitempty"`
// FriendlyName - Friendly Name
FriendlyName *string `json:"friendlyName,omitempty"`
// ServerResourceID - Server Resource Id.
ServerResourceID *string `json:"serverResourceId,omitempty"`
// ProvisioningState - READ-ONLY; ServerEndpoint Provisioning State
ProvisioningState *string `json:"provisioningState,omitempty"`
// LastWorkflowID - READ-ONLY; ServerEndpoint lastWorkflowId
LastWorkflowID *string `json:"lastWorkflowId,omitempty"`
// LastOperationName - READ-ONLY; Resource Last Operation Name
LastOperationName *string `json:"lastOperationName,omitempty"`
// SyncStatus - READ-ONLY; Server Endpoint sync status
SyncStatus *ServerEndpointSyncStatus `json:"syncStatus,omitempty"`
// OfflineDataTransfer - Offline data transfer. Possible values include: 'On', 'Off'
OfflineDataTransfer FeatureStatus `json:"offlineDataTransfer,omitempty"`
// OfflineDataTransferStorageAccountResourceID - READ-ONLY; Offline data transfer storage account resource ID
OfflineDataTransferStorageAccountResourceID *string `json:"offlineDataTransferStorageAccountResourceId,omitempty"`
// OfflineDataTransferStorageAccountTenantID - READ-ONLY; Offline data transfer storage account tenant ID
OfflineDataTransferStorageAccountTenantID *string `json:"offlineDataTransferStorageAccountTenantId,omitempty"`
// OfflineDataTransferShareName - Offline data transfer share name
*string `json:"offlineDataTransferShareName,omitempty"`
// CloudTieringStatus - READ-ONLY; Cloud tiering status. Only populated if cloud tiering is enabled.
CloudTieringStatus *ServerEndpointCloudTieringStatus `json:"cloudTieringStatus,omitempty"`
// RecallStatus - READ-ONLY; Recall status. Only populated if cloud tiering is enabled.
RecallStatus *ServerEndpointRecallStatus `json:"recallStatus,omitempty"`
// InitialDownloadPolicy - Policy for how namespace and files are recalled during FastDr. Possible values include: 'NamespaceOnly', 'NamespaceThenModifiedFiles', 'AvoidTieredFiles'
InitialDownloadPolicy InitialDownloadPolicy `json:"initialDownloadPolicy,omitempty"`
// LocalCacheMode - Policy for enabling follow-the-sun business models: link local cache to cloud behavior to pre-populate before local access. Possible values include: 'DownloadNewAndModifiedFiles', 'UpdateLocallyCachedFiles'
LocalCacheMode LocalCacheMode `json:"localCacheMode,omitempty"`
}ServerEndpointProperties serverEndpoint Properties object.
func (sep ServerEndpointProperties) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for ServerEndpointProperties.
type ServerEndpointRecallError struct {
// ErrorCode - READ-ONLY; Error code (HResult)
ErrorCode *int32 `json:"errorCode,omitempty"`
// Count - READ-ONLY; Count of occurences of the error
Count *int64 `json:"count,omitempty"`
}ServerEndpointRecallError server endpoint recall error object
type ServerEndpointRecallStatus struct {
// LastUpdatedTimestamp - READ-ONLY; Last updated timestamp
LastUpdatedTimestamp *date.Time `json:"lastUpdatedTimestamp,omitempty"`
// TotalRecallErrorsCount - READ-ONLY; Total count of recall errors.
TotalRecallErrorsCount *int64 `json:"totalRecallErrorsCount,omitempty"`
// RecallErrors - READ-ONLY; Array of recall errors
RecallErrors *[]ServerEndpointRecallError `json:"recallErrors,omitempty"`
}ServerEndpointRecallStatus server endpoint recall status object.
ServerEndpointSyncActivityState enumerates the values for server endpoint sync activity state.
const (
// ServerEndpointSyncActivityStateDownload ...
ServerEndpointSyncActivityStateDownload ServerEndpointSyncActivityState = "Download"
// ServerEndpointSyncActivityStateUpload ...
ServerEndpointSyncActivityStateUpload ServerEndpointSyncActivityState = "Upload"
// ServerEndpointSyncActivityStateUploadAndDownload ...
ServerEndpointSyncActivityStateUploadAndDownload ServerEndpointSyncActivityState = "UploadAndDownload"
)func PossibleServerEndpointSyncActivityStateValues() []ServerEndpointSyncActivityState
PossibleServerEndpointSyncActivityStateValues returns an array of possible values for the ServerEndpointSyncActivityState const type.
type ServerEndpointSyncActivityStatus struct {
// Timestamp - READ-ONLY; Timestamp when properties were updated
Timestamp *date.Time `json:"timestamp,omitempty"`
// PerItemErrorCount - READ-ONLY; Per item error count
PerItemErrorCount *int64 `json:"perItemErrorCount,omitempty"`
// AppliedItemCount - READ-ONLY; Applied item count.
AppliedItemCount *int64 `json:"appliedItemCount,omitempty"`
// TotalItemCount - READ-ONLY; Total item count (if available)
TotalItemCount *int64 `json:"totalItemCount,omitempty"`
// AppliedBytes - READ-ONLY; Applied bytes
AppliedBytes *int64 `json:"appliedBytes,omitempty"`
// TotalBytes - READ-ONLY; Total bytes (if available)
TotalBytes *int64 `json:"totalBytes,omitempty"`
}ServerEndpointSyncActivityStatus sync Session status object.
ServerEndpointSyncHealthState enumerates the values for server endpoint sync health state.
const (
// ServerEndpointSyncHealthStateError ...
ServerEndpointSyncHealthStateError ServerEndpointSyncHealthState = "Error"
// ServerEndpointSyncHealthStateHealthy ...
ServerEndpointSyncHealthStateHealthy ServerEndpointSyncHealthState = "Healthy"
// ServerEndpointSyncHealthStateNoActivity ...
ServerEndpointSyncHealthStateNoActivity ServerEndpointSyncHealthState = "NoActivity"
// ServerEndpointSyncHealthStateSyncBlockedForChangeDetectionPostRestore ...
ServerEndpointSyncHealthStateSyncBlockedForChangeDetectionPostRestore ServerEndpointSyncHealthState = "SyncBlockedForChangeDetectionPostRestore"
// ServerEndpointSyncHealthStateSyncBlockedForRestore ...
ServerEndpointSyncHealthStateSyncBlockedForRestore ServerEndpointSyncHealthState = "SyncBlockedForRestore"
)func PossibleServerEndpointSyncHealthStateValues() []ServerEndpointSyncHealthState
PossibleServerEndpointSyncHealthStateValues returns an array of possible values for the ServerEndpointSyncHealthState const type.
type ServerEndpointSyncSessionStatus struct {
// LastSyncResult - READ-ONLY; Last sync result (HResult)
LastSyncResult *int32 `json:"lastSyncResult,omitempty"`
// LastSyncTimestamp - READ-ONLY; Last sync timestamp
LastSyncTimestamp *date.Time `json:"lastSyncTimestamp,omitempty"`
// LastSyncSuccessTimestamp - READ-ONLY; Last sync success timestamp
LastSyncSuccessTimestamp *date.Time `json:"lastSyncSuccessTimestamp,omitempty"`
// LastSyncPerItemErrorCount - READ-ONLY; Last sync per item error count.
LastSyncPerItemErrorCount *int64 `json:"lastSyncPerItemErrorCount,omitempty"`
// PersistentFilesNotSyncingCount - READ-ONLY; Count of persistent files not syncing.
PersistentFilesNotSyncingCount *int64 `json:"persistentFilesNotSyncingCount,omitempty"`
// TransientFilesNotSyncingCount - READ-ONLY; Count of transient files not syncing.
TransientFilesNotSyncingCount *int64 `json:"transientFilesNotSyncingCount,omitempty"`
// FilesNotSyncingErrors - READ-ONLY; Array of per-item errors coming from the last sync session.
FilesNotSyncingErrors *[]ServerEndpointFilesNotSyncingError `json:"filesNotSyncingErrors,omitempty"`
}ServerEndpointSyncSessionStatus sync Session status object.
type ServerEndpointSyncStatus struct {
// DownloadHealth - READ-ONLY; Download Health Status. Possible values include: 'ServerEndpointSyncHealthStateHealthy', 'ServerEndpointSyncHealthStateError', 'ServerEndpointSyncHealthStateSyncBlockedForRestore', 'ServerEndpointSyncHealthStateSyncBlockedForChangeDetectionPostRestore', 'ServerEndpointSyncHealthStateNoActivity'
DownloadHealth ServerEndpointSyncHealthState `json:"downloadHealth,omitempty"`
// UploadHealth - READ-ONLY; Upload Health Status. Possible values include: 'ServerEndpointSyncHealthStateHealthy', 'ServerEndpointSyncHealthStateError', 'ServerEndpointSyncHealthStateSyncBlockedForRestore', 'ServerEndpointSyncHealthStateSyncBlockedForChangeDetectionPostRestore', 'ServerEndpointSyncHealthStateNoActivity'
UploadHealth ServerEndpointSyncHealthState `json:"uploadHealth,omitempty"`
// CombinedHealth - READ-ONLY; Combined Health Status. Possible values include: 'ServerEndpointSyncHealthStateHealthy', 'ServerEndpointSyncHealthStateError', 'ServerEndpointSyncHealthStateSyncBlockedForRestore', 'ServerEndpointSyncHealthStateSyncBlockedForChangeDetectionPostRestore', 'ServerEndpointSyncHealthStateNoActivity'
CombinedHealth ServerEndpointSyncHealthState `json:"combinedHealth,omitempty"`
// SyncActivity - READ-ONLY; Sync activity. Possible values include: 'ServerEndpointSyncActivityStateUpload', 'ServerEndpointSyncActivityStateDownload', 'ServerEndpointSyncActivityStateUploadAndDownload'
SyncActivity ServerEndpointSyncActivityState `json:"syncActivity,omitempty"`
// TotalPersistentFilesNotSyncingCount - READ-ONLY; Total count of persistent files not syncing (combined upload + download).
TotalPersistentFilesNotSyncingCount *int64 `json:"totalPersistentFilesNotSyncingCount,omitempty"`
// LastUpdatedTimestamp - READ-ONLY; Last Updated Timestamp
LastUpdatedTimestamp *date.Time `json:"lastUpdatedTimestamp,omitempty"`
// UploadStatus - READ-ONLY; Upload Status
UploadStatus *ServerEndpointSyncSessionStatus `json:"uploadStatus,omitempty"`
// DownloadStatus - READ-ONLY; Download Status
DownloadStatus *ServerEndpointSyncSessionStatus `json:"downloadStatus,omitempty"`
// UploadActivity - READ-ONLY; Upload sync activity
UploadActivity *ServerEndpointSyncActivityStatus `json:"uploadActivity,omitempty"`
// DownloadActivity - READ-ONLY; Download sync activity
DownloadActivity *ServerEndpointSyncActivityStatus `json:"downloadActivity,omitempty"`
// OfflineDataTransferStatus - READ-ONLY; Offline Data Transfer State. Possible values include: 'InProgress', 'Stopping', 'NotRunning', 'Complete'
OfflineDataTransferStatus ServerEndpointOfflineDataTransferState `json:"offlineDataTransferStatus,omitempty"`
}ServerEndpointSyncStatus server Endpoint sync status
type ServerEndpointUpdateParameters struct {
// ServerEndpointUpdateProperties - The properties of the server endpoint.
*ServerEndpointUpdateProperties `json:"properties,omitempty"`
}ServerEndpointUpdateParameters parameters for updating an Server Endpoint.
func (seup ServerEndpointUpdateParameters) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for ServerEndpointUpdateParameters.
func (seup *ServerEndpointUpdateParameters) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for ServerEndpointUpdateParameters struct.
type ServerEndpointUpdateProperties struct {
// CloudTiering - Cloud Tiering. Possible values include: 'On', 'Off'
CloudTiering FeatureStatus `json:"cloudTiering,omitempty"`
// VolumeFreeSpacePercent - Level of free space to be maintained by Cloud Tiering if it is enabled.
VolumeFreeSpacePercent *int32 `json:"volumeFreeSpacePercent,omitempty"`
// TierFilesOlderThanDays - Tier files older than days.
TierFilesOlderThanDays *int32 `json:"tierFilesOlderThanDays,omitempty"`
// OfflineDataTransfer - Offline data transfer. Possible values include: 'On', 'Off'
OfflineDataTransfer FeatureStatus `json:"offlineDataTransfer,omitempty"`
// OfflineDataTransferShareName - Offline data transfer share name
*string `json:"offlineDataTransferShareName,omitempty"`
// LocalCacheMode - Policy for enabling follow-the-sun business models: link local cache to cloud behavior to pre-populate before local access. Possible values include: 'DownloadNewAndModifiedFiles', 'UpdateLocallyCachedFiles'
LocalCacheMode LocalCacheMode `json:"localCacheMode,omitempty"`
}ServerEndpointUpdateProperties serverEndpoint Update Properties object.
type ServerEndpointsClient struct {
BaseClient
}ServerEndpointsClient is the microsoft Storage Sync Service API
func NewServerEndpointsClient(subscriptionID string) ServerEndpointsClient
NewServerEndpointsClient creates an instance of the ServerEndpointsClient client.
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 (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 (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 (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 (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 (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 (client ServerEndpointsClient) DeletePreparer(ctx context.Context, resourceGroupName string, storageSyncServiceName string, syncGroupName string, serverEndpointName string) (*http.Request, error)
DeletePreparer prepares the Delete request.
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 (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 (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 (client ServerEndpointsClient) GetPreparer(ctx context.Context, resourceGroupName string, storageSyncServiceName string, syncGroupName string, serverEndpointName string) (*http.Request, error)
GetPreparer prepares the Get request.
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.
GetSender sends the Get request. The method will close the http.Response Body if it receives an error.
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 (client ServerEndpointsClient) ListBySyncGroupPreparer(ctx context.Context, resourceGroupName string, storageSyncServiceName string, syncGroupName string) (*http.Request, error)
ListBySyncGroupPreparer prepares the ListBySyncGroup request.
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 (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 (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 (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 (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 (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 (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 (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 (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 (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 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.
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.
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.
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.
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.
MarshalJSON is the custom marshaler for Service.
UnmarshalJSON is the custom unmarshaler for Service struct.
type ServiceArray struct {
autorest.Response `json:"-"`
// Value - Collection of StorageSyncServices.
Value *[]Service `json:"value,omitempty"`
}ServiceArray array of StorageSyncServices
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"`
// ServiceCreateParametersProperties - The parameters used to create the storage sync service.
*ServiceCreateParametersProperties `json:"properties,omitempty"`
}ServiceCreateParameters the parameters used when creating a storage sync service.
func (scp ServiceCreateParameters) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for ServiceCreateParameters.
func (scp *ServiceCreateParameters) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for ServiceCreateParameters struct.
type ServiceCreateParametersProperties struct {
// IncomingTrafficPolicy - Incoming Traffic Policy. Possible values include: 'AllowAllTraffic', 'AllowVirtualNetworksOnly'
IncomingTrafficPolicy IncomingTrafficPolicy `json:"incomingTrafficPolicy,omitempty"`
}ServiceCreateParametersProperties storageSyncService Properties object.
type ServiceProperties struct {
// IncomingTrafficPolicy - Incoming Traffic Policy. Possible values include: 'AllowAllTraffic', 'AllowVirtualNetworksOnly'
IncomingTrafficPolicy IncomingTrafficPolicy `json:"incomingTrafficPolicy,omitempty"`
// StorageSyncServiceStatus - READ-ONLY; Storage Sync service status.
StorageSyncServiceStatus *int32 `json:"storageSyncServiceStatus,omitempty"`
// StorageSyncServiceUID - READ-ONLY; Storage Sync service Uid
StorageSyncServiceUID *string `json:"storageSyncServiceUid,omitempty"`
// ProvisioningState - READ-ONLY; StorageSyncService Provisioning State
ProvisioningState *string `json:"provisioningState,omitempty"`
// LastWorkflowID - READ-ONLY; StorageSyncService lastWorkflowId
LastWorkflowID *string `json:"lastWorkflowId,omitempty"`
// LastOperationName - READ-ONLY; Resource Last Operation Name
LastOperationName *string `json:"lastOperationName,omitempty"`
// PrivateEndpointConnections - READ-ONLY; List of private endpoint connection associated with the specified storage sync service
PrivateEndpointConnections *[]PrivateEndpointConnection `json:"privateEndpointConnections,omitempty"`
}ServiceProperties storage Sync Service Properties object.
func (sp ServiceProperties) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for ServiceProperties.
type ServiceUpdateParameters struct {
// Tags - The user-specified tags associated with the storage sync service.
Tags map[string]*string `json:"tags"`
// ServiceUpdateProperties - The properties of the server endpoint.
*ServiceUpdateProperties `json:"properties,omitempty"`
}ServiceUpdateParameters parameters for updating an Storage sync service.
func (sup ServiceUpdateParameters) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for ServiceUpdateParameters.
func (sup *ServiceUpdateParameters) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for ServiceUpdateParameters struct.
type ServiceUpdateProperties struct {
// IncomingTrafficPolicy - Incoming Traffic Policy. Possible values include: 'AllowAllTraffic', 'AllowVirtualNetworksOnly'
IncomingTrafficPolicy IncomingTrafficPolicy `json:"incomingTrafficPolicy,omitempty"`
}ServiceUpdateProperties storageSyncService Properties object.
type ServicesClient struct {
BaseClient
}ServicesClient is the microsoft Storage Sync Service API
func NewServicesClient(subscriptionID string) ServicesClient
NewServicesClient creates an instance of the ServicesClient client.
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 (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 (client ServicesClient) CheckNameAvailabilityPreparer(ctx context.Context, locationName string, parameters CheckNameAvailabilityParameters) (*http.Request, error)
CheckNameAvailabilityPreparer prepares the CheckNameAvailability request.
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 (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 (client ServicesClient) Create(ctx context.Context, resourceGroupName string, storageSyncServiceName string, parameters ServiceCreateParameters) (result ServicesCreateFuture, 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 (client ServicesClient) CreatePreparer(ctx context.Context, resourceGroupName string, storageSyncServiceName string, parameters ServiceCreateParameters) (*http.Request, error)
CreatePreparer prepares the Create request.
CreateResponder handles the response to the Create request. The method always closes the http.Response Body.
func (client ServicesClient) CreateSender(req *http.Request) (future ServicesCreateFuture, err error)
CreateSender sends the Create request. The method will close the http.Response Body if it receives an error.
func (client ServicesClient) Delete(ctx context.Context, resourceGroupName string, storageSyncServiceName string) (result ServicesDeleteFuture, 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 (client ServicesClient) DeletePreparer(ctx context.Context, resourceGroupName string, storageSyncServiceName string) (*http.Request, error)
DeletePreparer prepares the Delete request.
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 (client ServicesClient) DeleteSender(req *http.Request) (future ServicesDeleteFuture, err error)
DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.
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 (client ServicesClient) GetPreparer(ctx context.Context, resourceGroupName string, storageSyncServiceName string) (*http.Request, error)
GetPreparer prepares the Get request.
GetResponder handles the response to the Get request. The method always closes the http.Response Body.
GetSender sends the Get request. The method will close the http.Response Body if it receives an error.
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 (client ServicesClient) ListByResourceGroupPreparer(ctx context.Context, resourceGroupName string) (*http.Request, error)
ListByResourceGroupPreparer prepares the ListByResourceGroup request.
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.
ListByResourceGroupSender sends the ListByResourceGroup request. The method will close the http.Response Body if it receives an error.
func (client ServicesClient) ListBySubscription(ctx context.Context) (result ServiceArray, err error)
ListBySubscription get a StorageSyncService list by subscription.
func (client ServicesClient) ListBySubscriptionPreparer(ctx context.Context) (*http.Request, error)
ListBySubscriptionPreparer prepares the ListBySubscription request.
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.
ListBySubscriptionSender sends the ListBySubscription request. The method will close the http.Response Body if it receives an error.
func (client ServicesClient) Update(ctx context.Context, resourceGroupName string, storageSyncServiceName string, parameters *ServiceUpdateParameters) (result ServicesUpdateFuture, 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 (client ServicesClient) UpdatePreparer(ctx context.Context, resourceGroupName string, storageSyncServiceName string, parameters *ServiceUpdateParameters) (*http.Request, error)
UpdatePreparer prepares the Update request.
UpdateResponder handles the response to the Update request. The method always closes the http.Response Body.
func (client ServicesClient) UpdateSender(req *http.Request) (future ServicesUpdateFuture, err error)
UpdateSender sends the Update request. The method will close the http.Response Body if it receives an error.
type ServicesCreateFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(ServicesClient) (Service, error)
}ServicesCreateFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type ServicesDeleteFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(ServicesClient) (autorest.Response, error)
}ServicesDeleteFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type ServicesUpdateFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(ServicesClient) (Service, error)
}ServicesUpdateFuture an abstraction for monitoring and retrieving the results of a long-running operation.
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 (ss SubscriptionState) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for SubscriptionState.
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.
MarshalJSON is the custom marshaler for SyncGroup.
UnmarshalJSON is the custom unmarshaler for SyncGroup struct.
type SyncGroupArray struct {
autorest.Response `json:"-"`
// Value - Collection of SyncGroup.
Value *[]SyncGroup `json:"value,omitempty"`
}SyncGroupArray array of SyncGroup
type SyncGroupCreateParameters struct {
// Properties - The parameters used to create the sync group
Properties interface{} `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"`
}SyncGroupCreateParameters the parameters used when creating a sync group.
func (sgcp SyncGroupCreateParameters) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for SyncGroupCreateParameters.
type SyncGroupProperties struct {
// UniqueID - READ-ONLY; Unique Id
UniqueID *string `json:"uniqueId,omitempty"`
// SyncGroupStatus - READ-ONLY; Sync group status
SyncGroupStatus *string `json:"syncGroupStatus,omitempty"`
}SyncGroupProperties syncGroup Properties object.
type SyncGroupsClient struct {
BaseClient
}SyncGroupsClient is the microsoft Storage Sync Service API
func NewSyncGroupsClient(subscriptionID string) SyncGroupsClient
NewSyncGroupsClient creates an instance of the SyncGroupsClient client.
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 (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 (client SyncGroupsClient) CreatePreparer(ctx context.Context, resourceGroupName string, storageSyncServiceName string, syncGroupName string, parameters SyncGroupCreateParameters) (*http.Request, error)
CreatePreparer prepares the Create request.
CreateResponder handles the response to the Create request. The method always closes the http.Response Body.
CreateSender sends the Create request. The method will close the http.Response Body if it receives an error.
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 (client SyncGroupsClient) DeletePreparer(ctx context.Context, resourceGroupName string, storageSyncServiceName string, syncGroupName string) (*http.Request, error)
DeletePreparer prepares the Delete request.
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.
DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.
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 (client SyncGroupsClient) GetPreparer(ctx context.Context, resourceGroupName string, storageSyncServiceName string, syncGroupName string) (*http.Request, error)
GetPreparer prepares the Get request.
GetResponder handles the response to the Get request. The method always closes the http.Response Body.
GetSender sends the Get request. The method will close the http.Response Body if it receives an error.
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 (client SyncGroupsClient) ListByStorageSyncServicePreparer(ctx context.Context, resourceGroupName string, storageSyncServiceName string) (*http.Request, error)
ListByStorageSyncServicePreparer prepares the ListByStorageSyncService request.
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 (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 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 (tr TrackedResource) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for TrackedResource.
type TriggerChangeDetectionParameters struct {
// DirectoryPath - Relative path to a directory Azure File share for which change detection is to be performed.
DirectoryPath *string `json:"directoryPath,omitempty"`
// ChangeDetectionMode - Change Detection Mode. Applies to a directory specified in directoryPath parameter. Possible values include: 'Default', 'Recursive'
ChangeDetectionMode ChangeDetectionMode `json:"changeDetectionMode,omitempty"`
// Paths - Array of relative paths on the Azure File share to be included in the change detection. Can be files and directories.
Paths *[]string `json:"paths,omitempty"`
}TriggerChangeDetectionParameters the parameters used when calling trigger change detection action on cloud endpoint.
type TriggerRolloverRequest struct {
// ServerCertificate - Certificate Data
ServerCertificate *string `json:"serverCertificate,omitempty"`
}TriggerRolloverRequest trigger Rollover Request.
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.
MarshalJSON is the custom marshaler for Workflow.
UnmarshalJSON is the custom unmarshaler for Workflow struct.
type WorkflowArray struct {
autorest.Response `json:"-"`
// Value - Collection of workflow items.
Value *[]Workflow `json:"value,omitempty"`
}WorkflowArray array of Workflow
type WorkflowProperties struct {
// LastStepName - last step name
LastStepName *string `json:"lastStepName,omitempty"`
// Status - workflow status. Possible values include: 'WorkflowStatusActive', 'WorkflowStatusExpired', 'WorkflowStatusSucceeded', 'WorkflowStatusAborted', 'WorkflowStatusFailed'
Status WorkflowStatus `json:"status,omitempty"`
// Operation - operation direction. Possible values include: 'Do', 'Undo', 'Cancel'
Operation OperationDirection `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.
WorkflowStatus enumerates the values for workflow status.
const (
// WorkflowStatusAborted ...
WorkflowStatusAborted WorkflowStatus = "aborted"
// WorkflowStatusActive ...
WorkflowStatusActive WorkflowStatus = "active"
// WorkflowStatusExpired ...
WorkflowStatusExpired WorkflowStatus = "expired"
// WorkflowStatusFailed ...
WorkflowStatusFailed WorkflowStatus = "failed"
// WorkflowStatusSucceeded ...
WorkflowStatusSucceeded WorkflowStatus = "succeeded"
)func PossibleWorkflowStatusValues() []WorkflowStatus
PossibleWorkflowStatusValues returns an array of possible values for the WorkflowStatus const type.
type WorkflowsClient struct {
BaseClient
}WorkflowsClient is the microsoft Storage Sync Service API
func NewWorkflowsClient(subscriptionID string) WorkflowsClient
NewWorkflowsClient creates an instance of the WorkflowsClient client.
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 (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 (client WorkflowsClient) AbortPreparer(ctx context.Context, resourceGroupName string, storageSyncServiceName string, workflowID string) (*http.Request, error)
AbortPreparer prepares the Abort request.
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.
AbortSender sends the Abort request. The method will close the http.Response Body if it receives an error.
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 (client WorkflowsClient) GetPreparer(ctx context.Context, resourceGroupName string, storageSyncServiceName string, workflowID string) (*http.Request, error)
GetPreparer prepares the Get request.
GetResponder handles the response to the Get request. The method always closes the http.Response Body.
GetSender sends the Get request. The method will close the http.Response Body if it receives an error.
func (client WorkflowsClient) ListByStorageSyncService(ctx context.Context, resourceGroupName string, storageSyncServiceName string) (result WorkflowArray, err error)
ListByStorageSyncService get a Workflow List Parameters: resourceGroupName - the name of the resource group. The name is case insensitive. storageSyncServiceName - name of Storage Sync Service resource.
func (client WorkflowsClient) ListByStorageSyncServicePreparer(ctx context.Context, resourceGroupName string, storageSyncServiceName string) (*http.Request, error)
ListByStorageSyncServicePreparer prepares the ListByStorageSyncService request.
func (client WorkflowsClient) ListByStorageSyncServiceResponder(resp *http.Response) (result WorkflowArray, err error)
ListByStorageSyncServiceResponder handles the response to the ListByStorageSyncService request. The method always closes the http.Response Body.
func (client WorkflowsClient) 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.
| Path | Synopsis |
|---|---|
| storagesyncapi |
Package storagesync imports 10 packages (graph) and is imported by 1 packages. Updated 2021-01-28. Refresh now. Tools for package owners.