armstoragesync

package module
v0.2.0 Latest Latest
Warning

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

 Go to latest Published: Jan 13, 2022 License: MIT Imports: 14 Imported by: 6

README

Azure Storage Sync Module for Go

PkgGoDev

The armstoragesync module provides operations for working with Azure Storage Sync.

Source code

Getting started

Prerequisites

Install the package

This project uses Go modules for versioning and dependency management.

Install the Azure Storage Sync module:

go get github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/storagesync/armstoragesync

Authorization

When creating a client, you will need to provide a credential for authenticating with Azure Storage Sync. The azidentity module provides facilities for various ways of authenticating with Azure including client/secret, certificate, managed identity, and more.

cred, err := azidentity.NewDefaultAzureCredential(nil)

For more information on authentication, please see the documentation for azidentity at pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/azidentity.

Clients

Azure Storage Sync modules consist of one or more clients. A client groups a set of related APIs, providing access to its functionality within the specified subscription. Create one or more clients to access the APIs you require using your credential.

client := armstoragesync.NewStorageSyncServicesClient(<subscription ID>, cred, nil)

You can use ClientOptions in package github.com/Azure/azure-sdk-for-go/sdk/azcore/arm to set endpoint to connect with public and sovereign clouds as well as Azure Stack. For more information, please see the documentation for azcore at pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/azcore.

options = arm.ClientOptions{
    Host: arm.AzureChina,
}
client := armstoragesync.NewStorageSyncServicesClient(<subscription ID>, cred, &options)

Provide Feedback

If you encounter bugs or have suggestions, please open an issue and assign the Storage Sync label.

Contributing

This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.microsoft.com.

When you submit a pull request, a CLA-bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.

This project has adopted the Microsoft Open Source Code of Conduct. For more information, see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.

Documentation

Index

Examples

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type APIError added in v0.2.0 

type APIError struct {
	// Error code of the given entry.
	Code *string `json:"code,omitempty"`

	// Error details of the given entry.
	Details *ErrorDetails `json:"details,omitempty"`

	// Inner error details of the given entry.
	InnerError *InnerErrorDetails `json:"innerError,omitempty"`

	// Error message of the given entry.
	Message *string `json:"message,omitempty"`

	// Target of the given error entry.
	Target *string `json:"target,omitempty"`
}

APIError - Error type

type BackupRequest 

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

BackupRequest - Backup request

type ChangeDetectionMode 

type ChangeDetectionMode string

ChangeDetectionMode - Change Detection Mode. Applies to a directory specified in directoryPath parameter. 

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

func PossibleChangeDetectionModeValues 

func PossibleChangeDetectionModeValues() []ChangeDetectionMode

PossibleChangeDetectionModeValues returns the possible values for the ChangeDetectionMode const type.

func (ChangeDetectionMode) ToPtr 

func (c ChangeDetectionMode) ToPtr() *ChangeDetectionMode

ToPtr returns a *ChangeDetectionMode pointing to the current value.

type CheckNameAvailabilityParameters 

type CheckNameAvailabilityParameters struct {
	// REQUIRED; The name to check for availability
	Name *string `json:"name,omitempty"`

	// REQUIRED; The resource type. Must be set to Microsoft.StorageSync/storageSyncServices
	Type *string `json:"type,omitempty"`
}

CheckNameAvailabilityParameters - Parameters for a check name availability request.

type CheckNameAvailabilityResult 

type CheckNameAvailabilityResult struct {
	// READ-ONLY; Gets an error message explaining the Reason value in more detail.
	Message *string `json:"message,omitempty" azure:"ro"`

	// 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" azure:"ro"`

	// 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.
	Reason *NameAvailabilityReason `json:"reason,omitempty" azure:"ro"`
}

CheckNameAvailabilityResult - The CheckNameAvailability operation response.

type CloudEndpoint 

type CloudEndpoint struct {
	// Cloud Endpoint properties.
	Properties *CloudEndpointProperties `json:"properties,omitempty"`

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; The name of the resource
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string `json:"type,omitempty" azure:"ro"`
}

CloudEndpoint - Cloud Endpoint object.

type CloudEndpointArray 

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

CloudEndpointArray - Array of CloudEndpoint

func (CloudEndpointArray) MarshalJSON 

func (c CloudEndpointArray) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type CloudEndpointArray.

type CloudEndpointChangeEnumerationActivity 

type CloudEndpointChangeEnumerationActivity struct {
	// READ-ONLY; Progress percentage for processing deletes. This is done separately from the rest of the enumeration run
	DeletesProgressPercent *int32 `json:"deletesProgressPercent,omitempty" azure:"ro"`

	// READ-ONLY; Last updated timestamp
	LastUpdatedTimestamp *time.Time `json:"lastUpdatedTimestamp,omitempty" azure:"ro"`

	// READ-ONLY; Estimate of time remaining for the enumeration run
	MinutesRemaining *int32 `json:"minutesRemaining,omitempty" azure:"ro"`

	// READ-ONLY; Change enumeration operation state
	OperationState *CloudEndpointChangeEnumerationActivityState `json:"operationState,omitempty" azure:"ro"`

	// READ-ONLY; Count of directories processed
	ProcessedDirectoriesCount *int64 `json:"processedDirectoriesCount,omitempty" azure:"ro"`

	// READ-ONLY; Count of files processed
	ProcessedFilesCount *int64 `json:"processedFilesCount,omitempty" azure:"ro"`

	// READ-ONLY; Progress percentage for change enumeration run, excluding processing of deletes
	ProgressPercent *int32 `json:"progressPercent,omitempty" azure:"ro"`

	// READ-ONLY; Timestamp when change enumeration started
	StartedTimestamp *time.Time `json:"startedTimestamp,omitempty" azure:"ro"`

	// READ-ONLY; When non-zero, indicates an issue that is delaying change enumeration
	StatusCode *int32 `json:"statusCode,omitempty" azure:"ro"`

	// READ-ONLY; Change enumeration total counts state
	TotalCountsState *CloudEndpointChangeEnumerationTotalCountsState `json:"totalCountsState,omitempty" azure:"ro"`

	// READ-ONLY; Total count of directories enumerated
	TotalDirectoriesCount *int64 `json:"totalDirectoriesCount,omitempty" azure:"ro"`

	// READ-ONLY; Total count of files enumerated
	TotalFilesCount *int64 `json:"totalFilesCount,omitempty" azure:"ro"`

	// READ-ONLY; Total enumerated size in bytes
	TotalSizeBytes *int64 `json:"totalSizeBytes,omitempty" azure:"ro"`
}

CloudEndpointChangeEnumerationActivity - Cloud endpoint change enumeration activity object

func (CloudEndpointChangeEnumerationActivity) MarshalJSON 

func (c CloudEndpointChangeEnumerationActivity) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type CloudEndpointChangeEnumerationActivity.

func (*CloudEndpointChangeEnumerationActivity) UnmarshalJSON 

func (c *CloudEndpointChangeEnumerationActivity) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type CloudEndpointChangeEnumerationActivity.

type CloudEndpointChangeEnumerationActivityState 

type CloudEndpointChangeEnumerationActivityState string

CloudEndpointChangeEnumerationActivityState - State of change enumeration activity 

const (
	CloudEndpointChangeEnumerationActivityStateEnumerationInProgress        CloudEndpointChangeEnumerationActivityState = "EnumerationInProgress"
	CloudEndpointChangeEnumerationActivityStateInitialEnumerationInProgress CloudEndpointChangeEnumerationActivityState = "InitialEnumerationInProgress"
)

func PossibleCloudEndpointChangeEnumerationActivityStateValues 

func PossibleCloudEndpointChangeEnumerationActivityStateValues() []CloudEndpointChangeEnumerationActivityState

PossibleCloudEndpointChangeEnumerationActivityStateValues returns the possible values for the CloudEndpointChangeEnumerationActivityState const type.

func (CloudEndpointChangeEnumerationActivityState) ToPtr 

func (c CloudEndpointChangeEnumerationActivityState) ToPtr() *CloudEndpointChangeEnumerationActivityState

ToPtr returns a *CloudEndpointChangeEnumerationActivityState pointing to the current value.

type CloudEndpointChangeEnumerationStatus 

type CloudEndpointChangeEnumerationStatus struct {
	// READ-ONLY; Change enumeration activity
	Activity *CloudEndpointChangeEnumerationActivity `json:"activity,omitempty" azure:"ro"`

	// READ-ONLY; Status of last completed change enumeration
	LastEnumerationStatus *CloudEndpointLastChangeEnumerationStatus `json:"lastEnumerationStatus,omitempty" azure:"ro"`

	// READ-ONLY; Last updated timestamp
	LastUpdatedTimestamp *time.Time `json:"lastUpdatedTimestamp,omitempty" azure:"ro"`
}

CloudEndpointChangeEnumerationStatus - Cloud endpoint change enumeration status object

func (CloudEndpointChangeEnumerationStatus) MarshalJSON 

func (c CloudEndpointChangeEnumerationStatus) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type CloudEndpointChangeEnumerationStatus.

func (*CloudEndpointChangeEnumerationStatus) UnmarshalJSON 

func (c *CloudEndpointChangeEnumerationStatus) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type CloudEndpointChangeEnumerationStatus.

type CloudEndpointChangeEnumerationTotalCountsState 

type CloudEndpointChangeEnumerationTotalCountsState string

CloudEndpointChangeEnumerationTotalCountsState - State of the total counts of change enumeration activity 

const (
	CloudEndpointChangeEnumerationTotalCountsStateCalculating CloudEndpointChangeEnumerationTotalCountsState = "Calculating"
	CloudEndpointChangeEnumerationTotalCountsStateFinal       CloudEndpointChangeEnumerationTotalCountsState = "Final"
)

func PossibleCloudEndpointChangeEnumerationTotalCountsStateValues 

func PossibleCloudEndpointChangeEnumerationTotalCountsStateValues() []CloudEndpointChangeEnumerationTotalCountsState

PossibleCloudEndpointChangeEnumerationTotalCountsStateValues returns the possible values for the CloudEndpointChangeEnumerationTotalCountsState const type.

func (CloudEndpointChangeEnumerationTotalCountsState) ToPtr 

func (c CloudEndpointChangeEnumerationTotalCountsState) ToPtr() *CloudEndpointChangeEnumerationTotalCountsState

ToPtr returns a *CloudEndpointChangeEnumerationTotalCountsState pointing to the current value.

type CloudEndpointCreateParameters 

type CloudEndpointCreateParameters struct {
	// The parameters used to create the cloud endpoint.
	Properties *CloudEndpointCreateParametersProperties `json:"properties,omitempty"`

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; The name of the resource
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string `json:"type,omitempty" azure:"ro"`
}

CloudEndpointCreateParameters - The parameters used when creating a cloud endpoint.

type CloudEndpointCreateParametersProperties 

type CloudEndpointCreateParametersProperties struct {
	// Azure file share name
	AzureFileShareName *string `json:"azureFileShareName,omitempty"`

	// Friendly Name
	FriendlyName *string `json:"friendlyName,omitempty"`

	// Storage Account Resource Id
	StorageAccountResourceID *string `json:"storageAccountResourceId,omitempty"`

	// Storage Account Tenant Id
	StorageAccountTenantID *string `json:"storageAccountTenantId,omitempty"`
}

CloudEndpointCreateParametersProperties - CloudEndpoint Properties object.

type CloudEndpointLastChangeEnumerationStatus 

type CloudEndpointLastChangeEnumerationStatus struct {
	// READ-ONLY; Timestamp when change enumeration completed
	CompletedTimestamp *time.Time `json:"completedTimestamp,omitempty" azure:"ro"`

	// READ-ONLY; Count of directories in the namespace
	NamespaceDirectoriesCount *int64 `json:"namespaceDirectoriesCount,omitempty" azure:"ro"`

	// READ-ONLY; Count of files in the namespace
	NamespaceFilesCount *int64 `json:"namespaceFilesCount,omitempty" azure:"ro"`

	// READ-ONLY; Namespace size in bytes
	NamespaceSizeBytes *int64 `json:"namespaceSizeBytes,omitempty" azure:"ro"`

	// READ-ONLY; Timestamp of when change enumeration is expected to run again
	NextRunTimestamp *time.Time `json:"nextRunTimestamp,omitempty" azure:"ro"`

	// READ-ONLY; Timestamp when change enumeration started
	StartedTimestamp *time.Time `json:"startedTimestamp,omitempty" azure:"ro"`
}

CloudEndpointLastChangeEnumerationStatus - Cloud endpoint change enumeration status object

func (CloudEndpointLastChangeEnumerationStatus) MarshalJSON 

func (c CloudEndpointLastChangeEnumerationStatus) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type CloudEndpointLastChangeEnumerationStatus.

func (*CloudEndpointLastChangeEnumerationStatus) UnmarshalJSON 

func (c *CloudEndpointLastChangeEnumerationStatus) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type CloudEndpointLastChangeEnumerationStatus.

type CloudEndpointProperties 

type CloudEndpointProperties struct {
	// Azure file share name
	AzureFileShareName *string `json:"azureFileShareName,omitempty"`

	// Friendly Name
	FriendlyName *string `json:"friendlyName,omitempty"`

	// Resource Last Operation Name
	LastOperationName *string `json:"lastOperationName,omitempty"`

	// CloudEndpoint lastWorkflowId
	LastWorkflowID *string `json:"lastWorkflowId,omitempty"`

	// Partnership Id
	PartnershipID *string `json:"partnershipId,omitempty"`

	// CloudEndpoint Provisioning State
	ProvisioningState *string `json:"provisioningState,omitempty"`

	// Storage Account Resource Id
	StorageAccountResourceID *string `json:"storageAccountResourceId,omitempty"`

	// Storage Account Tenant Id
	StorageAccountTenantID *string `json:"storageAccountTenantId,omitempty"`

	// READ-ONLY; Backup Enabled
	BackupEnabled *string `json:"backupEnabled,omitempty" azure:"ro"`

	// READ-ONLY; Cloud endpoint change enumeration status
	ChangeEnumerationStatus *CloudEndpointChangeEnumerationStatus `json:"changeEnumerationStatus,omitempty" azure:"ro"`
}

CloudEndpointProperties - CloudEndpoint Properties object.

type CloudEndpointsClient 

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

CloudEndpointsClient contains the methods for the CloudEndpoints group. Don't use this type directly, use NewCloudEndpointsClient() instead.

func NewCloudEndpointsClient 

func NewCloudEndpointsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *CloudEndpointsClient

NewCloudEndpointsClient creates a new instance of CloudEndpointsClient with the specified values. subscriptionID - The ID of the target subscription. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*CloudEndpointsClient) BeginCreate 

func (client *CloudEndpointsClient) BeginCreate(ctx context.Context, resourceGroupName string, storageSyncServiceName string, syncGroupName string, cloudEndpointName string, parameters CloudEndpointCreateParameters, options *CloudEndpointsClientBeginCreateOptions) (CloudEndpointsClientCreatePollerResponse, error)

BeginCreate - Create a new CloudEndpoint. If the operation fails it returns an *azcore.ResponseError type. 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. options - CloudEndpointsClientBeginCreateOptions contains the optional parameters for the CloudEndpointsClient.BeginCreate method.

Example

x-ms-original-file: specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2020-09-01/examples/CloudEndpoints_Create.json 

package main

import (
	"context"
	"log"

	"time"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/storagesync/armstoragesync"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armstoragesync.NewCloudEndpointsClient("<subscription-id>", cred, nil)
	poller, err := client.BeginCreate(ctx,
		"<resource-group-name>",
		"<storage-sync-service-name>",
		"<sync-group-name>",
		"<cloud-endpoint-name>",
		armstoragesync.CloudEndpointCreateParameters{
			Properties: &armstoragesync.CloudEndpointCreateParametersProperties{
				AzureFileShareName:       to.StringPtr("<azure-file-share-name>"),
				FriendlyName:             to.StringPtr("<friendly-name>"),
				StorageAccountResourceID: to.StringPtr("<storage-account-resource-id>"),
				StorageAccountTenantID:   to.StringPtr("<storage-account-tenant-id>"),
			},
		},
		nil)
	if err != nil {
		log.Fatal(err)
	}
	res, err := poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.CloudEndpointsClientCreateResult)
}

Output:

func (*CloudEndpointsClient) BeginDelete 

func (client *CloudEndpointsClient) BeginDelete(ctx context.Context, resourceGroupName string, storageSyncServiceName string, syncGroupName string, cloudEndpointName string, options *CloudEndpointsClientBeginDeleteOptions) (CloudEndpointsClientDeletePollerResponse, error)

BeginDelete - Delete a given CloudEndpoint. If the operation fails it returns an *azcore.ResponseError type. 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. options - CloudEndpointsClientBeginDeleteOptions contains the optional parameters for the CloudEndpointsClient.BeginDelete method.

Example

x-ms-original-file: specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2020-09-01/examples/CloudEndpoints_Delete.json 

package main

import (
	"context"
	"log"

	"time"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/storagesync/armstoragesync"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armstoragesync.NewCloudEndpointsClient("<subscription-id>", cred, nil)
	poller, err := client.BeginDelete(ctx,
		"<resource-group-name>",
		"<storage-sync-service-name>",
		"<sync-group-name>",
		"<cloud-endpoint-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	_, err = poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
}

Output:

func (*CloudEndpointsClient) BeginPostBackup 

func (client *CloudEndpointsClient) BeginPostBackup(ctx context.Context, resourceGroupName string, storageSyncServiceName string, syncGroupName string, cloudEndpointName string, parameters BackupRequest, options *CloudEndpointsClientBeginPostBackupOptions) (CloudEndpointsClientPostBackupPollerResponse, error)

BeginPostBackup - Post Backup a given CloudEndpoint. If the operation fails it returns an *azcore.ResponseError type. 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. options - CloudEndpointsClientBeginPostBackupOptions contains the optional parameters for the CloudEndpointsClient.BeginPostBackup method.

Example

x-ms-original-file: specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2020-09-01/examples/CloudEndpoints_PostBackup.json 

package main

import (
	"context"
	"log"

	"time"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/storagesync/armstoragesync"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armstoragesync.NewCloudEndpointsClient("<subscription-id>", cred, nil)
	poller, err := client.BeginPostBackup(ctx,
		"<resource-group-name>",
		"<storage-sync-service-name>",
		"<sync-group-name>",
		"<cloud-endpoint-name>",
		armstoragesync.BackupRequest{
			AzureFileShare: to.StringPtr("<azure-file-share>"),
		},
		nil)
	if err != nil {
		log.Fatal(err)
	}
	res, err := poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.CloudEndpointsClientPostBackupResult)
}

Output:

func (*CloudEndpointsClient) BeginPostRestore 

func (client *CloudEndpointsClient) BeginPostRestore(ctx context.Context, resourceGroupName string, storageSyncServiceName string, syncGroupName string, cloudEndpointName string, parameters PostRestoreRequest, options *CloudEndpointsClientBeginPostRestoreOptions) (CloudEndpointsClientPostRestorePollerResponse, error)

BeginPostRestore - Post Restore a given CloudEndpoint. If the operation fails it returns an *azcore.ResponseError type. 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. options - CloudEndpointsClientBeginPostRestoreOptions contains the optional parameters for the CloudEndpointsClient.BeginPostRestore method.

Example

x-ms-original-file: specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2020-09-01/examples/CloudEndpoints_PostRestore.json 

package main

import (
	"context"
	"log"

	"time"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/storagesync/armstoragesync"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armstoragesync.NewCloudEndpointsClient("<subscription-id>", cred, nil)
	poller, err := client.BeginPostRestore(ctx,
		"<resource-group-name>",
		"<storage-sync-service-name>",
		"<sync-group-name>",
		"<cloud-endpoint-name>",
		armstoragesync.PostRestoreRequest{
			AzureFileShareURI: to.StringPtr("<azure-file-share-uri>"),
			RestoreFileSpec: []*armstoragesync.RestoreFileSpec{
				{
					Path:  to.StringPtr("<path>"),
					Isdir: to.BoolPtr(false),
				},
				{
					Path:  to.StringPtr("<path>"),
					Isdir: to.BoolPtr(true),
				},
				{
					Path:  to.StringPtr("<path>"),
					Isdir: to.BoolPtr(false),
				},
				{
					Path:  to.StringPtr("<path>"),
					Isdir: to.BoolPtr(false),
				}},
			SourceAzureFileShareURI: to.StringPtr("<source-azure-file-share-uri>"),
			Status:                  to.StringPtr("<status>"),
		},
		nil)
	if err != nil {
		log.Fatal(err)
	}
	_, err = poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
}

Output:

func (*CloudEndpointsClient) BeginPreBackup 

func (client *CloudEndpointsClient) BeginPreBackup(ctx context.Context, resourceGroupName string, storageSyncServiceName string, syncGroupName string, cloudEndpointName string, parameters BackupRequest, options *CloudEndpointsClientBeginPreBackupOptions) (CloudEndpointsClientPreBackupPollerResponse, error)

BeginPreBackup - Pre Backup a given CloudEndpoint. If the operation fails it returns an *azcore.ResponseError type. 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. options - CloudEndpointsClientBeginPreBackupOptions contains the optional parameters for the CloudEndpointsClient.BeginPreBackup method.

Example

x-ms-original-file: specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2020-09-01/examples/CloudEndpoints_PreBackup.json 

package main

import (
	"context"
	"log"

	"time"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/storagesync/armstoragesync"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armstoragesync.NewCloudEndpointsClient("<subscription-id>", cred, nil)
	poller, err := client.BeginPreBackup(ctx,
		"<resource-group-name>",
		"<storage-sync-service-name>",
		"<sync-group-name>",
		"<cloud-endpoint-name>",
		armstoragesync.BackupRequest{
			AzureFileShare: to.StringPtr("<azure-file-share>"),
		},
		nil)
	if err != nil {
		log.Fatal(err)
	}
	_, err = poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
}

Output:

func (*CloudEndpointsClient) BeginPreRestore 

func (client *CloudEndpointsClient) BeginPreRestore(ctx context.Context, resourceGroupName string, storageSyncServiceName string, syncGroupName string, cloudEndpointName string, parameters PreRestoreRequest, options *CloudEndpointsClientBeginPreRestoreOptions) (CloudEndpointsClientPreRestorePollerResponse, error)

BeginPreRestore - Pre Restore a given CloudEndpoint. If the operation fails it returns an *azcore.ResponseError type. 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. options - CloudEndpointsClientBeginPreRestoreOptions contains the optional parameters for the CloudEndpointsClient.BeginPreRestore method.

Example

x-ms-original-file: specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2020-09-01/examples/CloudEndpoints_PreRestore.json 

package main

import (
	"context"
	"log"

	"time"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/storagesync/armstoragesync"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armstoragesync.NewCloudEndpointsClient("<subscription-id>", cred, nil)
	poller, err := client.BeginPreRestore(ctx,
		"<resource-group-name>",
		"<storage-sync-service-name>",
		"<sync-group-name>",
		"<cloud-endpoint-name>",
		armstoragesync.PreRestoreRequest{
			AzureFileShareURI: to.StringPtr("<azure-file-share-uri>"),
			RestoreFileSpec: []*armstoragesync.RestoreFileSpec{
				{
					Path:  to.StringPtr("<path>"),
					Isdir: to.BoolPtr(false),
				},
				{
					Path:  to.StringPtr("<path>"),
					Isdir: to.BoolPtr(true),
				},
				{
					Path:  to.StringPtr("<path>"),
					Isdir: to.BoolPtr(false),
				},
				{
					Path:  to.StringPtr("<path>"),
					Isdir: to.BoolPtr(false),
				}},
		},
		nil)
	if err != nil {
		log.Fatal(err)
	}
	_, err = poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
}

Output:

func (*CloudEndpointsClient) BeginTriggerChangeDetection 

func (client *CloudEndpointsClient) BeginTriggerChangeDetection(ctx context.Context, resourceGroupName string, storageSyncServiceName string, syncGroupName string, cloudEndpointName string, parameters TriggerChangeDetectionParameters, options *CloudEndpointsClientBeginTriggerChangeDetectionOptions) (CloudEndpointsClientTriggerChangeDetectionPollerResponse, error)

BeginTriggerChangeDetection - Triggers detection of changes performed on Azure File share connected to the specified Azure File Sync Cloud Endpoint. If the operation fails it returns an *azcore.ResponseError type. 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. options - CloudEndpointsClientBeginTriggerChangeDetectionOptions contains the optional parameters for the CloudEndpointsClient.BeginTriggerChangeDetection method.

Example

x-ms-original-file: specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2020-09-01/examples/CloudEndpoints_TriggerChangeDetection.json 

package main

import (
	"context"
	"log"

	"time"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/storagesync/armstoragesync"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armstoragesync.NewCloudEndpointsClient("<subscription-id>", cred, nil)
	poller, err := client.BeginTriggerChangeDetection(ctx,
		"<resource-group-name>",
		"<storage-sync-service-name>",
		"<sync-group-name>",
		"<cloud-endpoint-name>",
		armstoragesync.TriggerChangeDetectionParameters{
			ChangeDetectionMode: armstoragesync.ChangeDetectionMode("Recursive").ToPtr(),
			DirectoryPath:       to.StringPtr("<directory-path>"),
		},
		nil)
	if err != nil {
		log.Fatal(err)
	}
	_, err = poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
}

Output:

func (*CloudEndpointsClient) Get 

func (client *CloudEndpointsClient) Get(ctx context.Context, resourceGroupName string, storageSyncServiceName string, syncGroupName string, cloudEndpointName string, options *CloudEndpointsClientGetOptions) (CloudEndpointsClientGetResponse, error)

Get - Get a given CloudEndpoint. If the operation fails it returns an *azcore.ResponseError type. 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. options - CloudEndpointsClientGetOptions contains the optional parameters for the CloudEndpointsClient.Get method.

Example

x-ms-original-file: specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2020-09-01/examples/CloudEndpoints_Get.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/storagesync/armstoragesync"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armstoragesync.NewCloudEndpointsClient("<subscription-id>", cred, nil)
	res, err := client.Get(ctx,
		"<resource-group-name>",
		"<storage-sync-service-name>",
		"<sync-group-name>",
		"<cloud-endpoint-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.CloudEndpointsClientGetResult)
}

Output:

func (*CloudEndpointsClient) ListBySyncGroup 

func (client *CloudEndpointsClient) ListBySyncGroup(ctx context.Context, resourceGroupName string, storageSyncServiceName string, syncGroupName string, options *CloudEndpointsClientListBySyncGroupOptions) (CloudEndpointsClientListBySyncGroupResponse, error)

ListBySyncGroup - Get a CloudEndpoint List. If the operation fails it returns an *azcore.ResponseError type. 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. options - CloudEndpointsClientListBySyncGroupOptions contains the optional parameters for the CloudEndpointsClient.ListBySyncGroup method.

Example

x-ms-original-file: specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2020-09-01/examples/CloudEndpoints_ListBySyncGroup.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/storagesync/armstoragesync"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armstoragesync.NewCloudEndpointsClient("<subscription-id>", cred, nil)
	res, err := client.ListBySyncGroup(ctx,
		"<resource-group-name>",
		"<storage-sync-service-name>",
		"<sync-group-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.CloudEndpointsClientListBySyncGroupResult)
}

Output:

func (*CloudEndpointsClient) Restoreheartbeat 

func (client *CloudEndpointsClient) Restoreheartbeat(ctx context.Context, resourceGroupName string, storageSyncServiceName string, syncGroupName string, cloudEndpointName string, options *CloudEndpointsClientRestoreheartbeatOptions) (CloudEndpointsClientRestoreheartbeatResponse, error)

Restoreheartbeat - Restore Heartbeat a given CloudEndpoint. If the operation fails it returns an *azcore.ResponseError type. 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. options - CloudEndpointsClientRestoreheartbeatOptions contains the optional parameters for the CloudEndpointsClient.Restoreheartbeat method.

Example

x-ms-original-file: specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2020-09-01/examples/CloudEndpoints_RestoreHeatbeat.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/storagesync/armstoragesync"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armstoragesync.NewCloudEndpointsClient("<subscription-id>", cred, nil)
	_, err = client.Restoreheartbeat(ctx,
		"<resource-group-name>",
		"<storage-sync-service-name>",
		"<sync-group-name>",
		"<cloud-endpoint-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
}

Output:

type CloudEndpointsClientBeginCreateOptions added in v0.2.0 

type CloudEndpointsClientBeginCreateOptions struct {
}

CloudEndpointsClientBeginCreateOptions contains the optional parameters for the CloudEndpointsClient.BeginCreate method.

type CloudEndpointsClientBeginDeleteOptions added in v0.2.0 

type CloudEndpointsClientBeginDeleteOptions struct {
}

CloudEndpointsClientBeginDeleteOptions contains the optional parameters for the CloudEndpointsClient.BeginDelete method.

type CloudEndpointsClientBeginPostBackupOptions added in v0.2.0 

type CloudEndpointsClientBeginPostBackupOptions struct {
}

CloudEndpointsClientBeginPostBackupOptions contains the optional parameters for the CloudEndpointsClient.BeginPostBackup method.

type CloudEndpointsClientBeginPostRestoreOptions added in v0.2.0 

type CloudEndpointsClientBeginPostRestoreOptions struct {
}

CloudEndpointsClientBeginPostRestoreOptions contains the optional parameters for the CloudEndpointsClient.BeginPostRestore method.

type CloudEndpointsClientBeginPreBackupOptions added in v0.2.0 

type CloudEndpointsClientBeginPreBackupOptions struct {
}

CloudEndpointsClientBeginPreBackupOptions contains the optional parameters for the CloudEndpointsClient.BeginPreBackup method.

type CloudEndpointsClientBeginPreRestoreOptions added in v0.2.0 

type CloudEndpointsClientBeginPreRestoreOptions struct {
}

CloudEndpointsClientBeginPreRestoreOptions contains the optional parameters for the CloudEndpointsClient.BeginPreRestore method.

type CloudEndpointsClientBeginTriggerChangeDetectionOptions added in v0.2.0 

type CloudEndpointsClientBeginTriggerChangeDetectionOptions struct {
}

CloudEndpointsClientBeginTriggerChangeDetectionOptions contains the optional parameters for the CloudEndpointsClient.BeginTriggerChangeDetection method.

type CloudEndpointsClientCreatePoller added in v0.2.0 

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

CloudEndpointsClientCreatePoller provides polling facilities until the operation reaches a terminal state.

func (*CloudEndpointsClientCreatePoller) Done added in v0.2.0 

func (p *CloudEndpointsClientCreatePoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*CloudEndpointsClientCreatePoller) FinalResponse added in v0.2.0 

func (p *CloudEndpointsClientCreatePoller) FinalResponse(ctx context.Context) (CloudEndpointsClientCreateResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final CloudEndpointsClientCreateResponse will be returned.

func (*CloudEndpointsClientCreatePoller) Poll added in v0.2.0 

func (p *CloudEndpointsClientCreatePoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*CloudEndpointsClientCreatePoller) ResumeToken added in v0.2.0 

func (p *CloudEndpointsClientCreatePoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type CloudEndpointsClientCreatePollerResponse added in v0.2.0 

type CloudEndpointsClientCreatePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *CloudEndpointsClientCreatePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

CloudEndpointsClientCreatePollerResponse contains the response from method CloudEndpointsClient.Create.

func (CloudEndpointsClientCreatePollerResponse) PollUntilDone added in v0.2.0 

func (l CloudEndpointsClientCreatePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (CloudEndpointsClientCreateResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*CloudEndpointsClientCreatePollerResponse) Resume added in v0.2.0 

func (l *CloudEndpointsClientCreatePollerResponse) Resume(ctx context.Context, client *CloudEndpointsClient, token string) error

Resume rehydrates a CloudEndpointsClientCreatePollerResponse from the provided client and resume token.

type CloudEndpointsClientCreateResponse added in v0.2.0 

type CloudEndpointsClientCreateResponse struct {
	CloudEndpointsClientCreateResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

CloudEndpointsClientCreateResponse contains the response from method CloudEndpointsClient.Create.

type CloudEndpointsClientCreateResult added in v0.2.0 

type CloudEndpointsClientCreateResult struct {
	CloudEndpoint
}

CloudEndpointsClientCreateResult contains the result from method CloudEndpointsClient.Create.

type CloudEndpointsClientDeletePoller added in v0.2.0 

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

CloudEndpointsClientDeletePoller provides polling facilities until the operation reaches a terminal state.

func (*CloudEndpointsClientDeletePoller) Done added in v0.2.0 

func (p *CloudEndpointsClientDeletePoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*CloudEndpointsClientDeletePoller) FinalResponse added in v0.2.0 

func (p *CloudEndpointsClientDeletePoller) FinalResponse(ctx context.Context) (CloudEndpointsClientDeleteResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final CloudEndpointsClientDeleteResponse will be returned.

func (*CloudEndpointsClientDeletePoller) Poll added in v0.2.0 

func (p *CloudEndpointsClientDeletePoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*CloudEndpointsClientDeletePoller) ResumeToken added in v0.2.0 

func (p *CloudEndpointsClientDeletePoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type CloudEndpointsClientDeletePollerResponse added in v0.2.0 

type CloudEndpointsClientDeletePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *CloudEndpointsClientDeletePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

CloudEndpointsClientDeletePollerResponse contains the response from method CloudEndpointsClient.Delete.

func (CloudEndpointsClientDeletePollerResponse) PollUntilDone added in v0.2.0 

func (l CloudEndpointsClientDeletePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (CloudEndpointsClientDeleteResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*CloudEndpointsClientDeletePollerResponse) Resume added in v0.2.0 

func (l *CloudEndpointsClientDeletePollerResponse) Resume(ctx context.Context, client *CloudEndpointsClient, token string) error

Resume rehydrates a CloudEndpointsClientDeletePollerResponse from the provided client and resume token.

type CloudEndpointsClientDeleteResponse added in v0.2.0 

type CloudEndpointsClientDeleteResponse struct {
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

CloudEndpointsClientDeleteResponse contains the response from method CloudEndpointsClient.Delete.

type CloudEndpointsClientGetOptions added in v0.2.0 

type CloudEndpointsClientGetOptions struct {
}

CloudEndpointsClientGetOptions contains the optional parameters for the CloudEndpointsClient.Get method.

type CloudEndpointsClientGetResponse added in v0.2.0 

type CloudEndpointsClientGetResponse struct {
	CloudEndpointsClientGetResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

CloudEndpointsClientGetResponse contains the response from method CloudEndpointsClient.Get.

type CloudEndpointsClientGetResult added in v0.2.0 

type CloudEndpointsClientGetResult struct {
	CloudEndpoint
	// XMSCorrelationRequestID contains the information returned from the x-ms-correlation-request-id header response.
	XMSCorrelationRequestID *string

	// XMSRequestID contains the information returned from the x-ms-request-id header response.
	XMSRequestID *string
}

CloudEndpointsClientGetResult contains the result from method CloudEndpointsClient.Get.

type CloudEndpointsClientListBySyncGroupOptions added in v0.2.0 

type CloudEndpointsClientListBySyncGroupOptions struct {
}

CloudEndpointsClientListBySyncGroupOptions contains the optional parameters for the CloudEndpointsClient.ListBySyncGroup method.

type CloudEndpointsClientListBySyncGroupResponse added in v0.2.0 

type CloudEndpointsClientListBySyncGroupResponse struct {
	CloudEndpointsClientListBySyncGroupResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

CloudEndpointsClientListBySyncGroupResponse contains the response from method CloudEndpointsClient.ListBySyncGroup.

type CloudEndpointsClientListBySyncGroupResult added in v0.2.0 

type CloudEndpointsClientListBySyncGroupResult struct {
	CloudEndpointArray
	// XMSCorrelationRequestID contains the information returned from the x-ms-correlation-request-id header response.
	XMSCorrelationRequestID *string

	// XMSRequestID contains the information returned from the x-ms-request-id header response.
	XMSRequestID *string
}

CloudEndpointsClientListBySyncGroupResult contains the result from method CloudEndpointsClient.ListBySyncGroup.

type CloudEndpointsClientPostBackupPoller added in v0.2.0 

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

CloudEndpointsClientPostBackupPoller provides polling facilities until the operation reaches a terminal state.

func (*CloudEndpointsClientPostBackupPoller) Done added in v0.2.0 

func (p *CloudEndpointsClientPostBackupPoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*CloudEndpointsClientPostBackupPoller) FinalResponse added in v0.2.0 

func (p *CloudEndpointsClientPostBackupPoller) FinalResponse(ctx context.Context) (CloudEndpointsClientPostBackupResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final CloudEndpointsClientPostBackupResponse will be returned.

func (*CloudEndpointsClientPostBackupPoller) Poll added in v0.2.0 

func (p *CloudEndpointsClientPostBackupPoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*CloudEndpointsClientPostBackupPoller) ResumeToken added in v0.2.0 

func (p *CloudEndpointsClientPostBackupPoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type CloudEndpointsClientPostBackupPollerResponse added in v0.2.0 

type CloudEndpointsClientPostBackupPollerResponse struct {
	// Poller contains an initialized poller.
	Poller *CloudEndpointsClientPostBackupPoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

CloudEndpointsClientPostBackupPollerResponse contains the response from method CloudEndpointsClient.PostBackup.

func (CloudEndpointsClientPostBackupPollerResponse) PollUntilDone added in v0.2.0 

func (l CloudEndpointsClientPostBackupPollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (CloudEndpointsClientPostBackupResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*CloudEndpointsClientPostBackupPollerResponse) Resume added in v0.2.0 

func (l *CloudEndpointsClientPostBackupPollerResponse) Resume(ctx context.Context, client *CloudEndpointsClient, token string) error

Resume rehydrates a CloudEndpointsClientPostBackupPollerResponse from the provided client and resume token.

type CloudEndpointsClientPostBackupResponse added in v0.2.0 

type CloudEndpointsClientPostBackupResponse struct {
	CloudEndpointsClientPostBackupResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

CloudEndpointsClientPostBackupResponse contains the response from method CloudEndpointsClient.PostBackup.

type CloudEndpointsClientPostBackupResult added in v0.2.0 

type CloudEndpointsClientPostBackupResult struct {
	PostBackupResponse
}

CloudEndpointsClientPostBackupResult contains the result from method CloudEndpointsClient.PostBackup.

type CloudEndpointsClientPostRestorePoller added in v0.2.0 

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

CloudEndpointsClientPostRestorePoller provides polling facilities until the operation reaches a terminal state.

func (*CloudEndpointsClientPostRestorePoller) Done added in v0.2.0 

func (p *CloudEndpointsClientPostRestorePoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*CloudEndpointsClientPostRestorePoller) FinalResponse added in v0.2.0 

func (p *CloudEndpointsClientPostRestorePoller) FinalResponse(ctx context.Context) (CloudEndpointsClientPostRestoreResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final CloudEndpointsClientPostRestoreResponse will be returned.

func (*CloudEndpointsClientPostRestorePoller) Poll added in v0.2.0 

func (p *CloudEndpointsClientPostRestorePoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*CloudEndpointsClientPostRestorePoller) ResumeToken added in v0.2.0 

func (p *CloudEndpointsClientPostRestorePoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type CloudEndpointsClientPostRestorePollerResponse added in v0.2.0 

type CloudEndpointsClientPostRestorePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *CloudEndpointsClientPostRestorePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

CloudEndpointsClientPostRestorePollerResponse contains the response from method CloudEndpointsClient.PostRestore.

func (CloudEndpointsClientPostRestorePollerResponse) PollUntilDone added in v0.2.0 

func (l CloudEndpointsClientPostRestorePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (CloudEndpointsClientPostRestoreResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*CloudEndpointsClientPostRestorePollerResponse) Resume added in v0.2.0 

func (l *CloudEndpointsClientPostRestorePollerResponse) Resume(ctx context.Context, client *CloudEndpointsClient, token string) error

Resume rehydrates a CloudEndpointsClientPostRestorePollerResponse from the provided client and resume token.

type CloudEndpointsClientPostRestoreResponse added in v0.2.0 

type CloudEndpointsClientPostRestoreResponse struct {
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

CloudEndpointsClientPostRestoreResponse contains the response from method CloudEndpointsClient.PostRestore.

type CloudEndpointsClientPreBackupPoller added in v0.2.0 

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

CloudEndpointsClientPreBackupPoller provides polling facilities until the operation reaches a terminal state.

func (*CloudEndpointsClientPreBackupPoller) Done added in v0.2.0 

func (p *CloudEndpointsClientPreBackupPoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*CloudEndpointsClientPreBackupPoller) FinalResponse added in v0.2.0 

func (p *CloudEndpointsClientPreBackupPoller) FinalResponse(ctx context.Context) (CloudEndpointsClientPreBackupResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final CloudEndpointsClientPreBackupResponse will be returned.

func (*CloudEndpointsClientPreBackupPoller) Poll added in v0.2.0 

func (p *CloudEndpointsClientPreBackupPoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*CloudEndpointsClientPreBackupPoller) ResumeToken added in v0.2.0 

func (p *CloudEndpointsClientPreBackupPoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type CloudEndpointsClientPreBackupPollerResponse added in v0.2.0 

type CloudEndpointsClientPreBackupPollerResponse struct {
	// Poller contains an initialized poller.
	Poller *CloudEndpointsClientPreBackupPoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

CloudEndpointsClientPreBackupPollerResponse contains the response from method CloudEndpointsClient.PreBackup.

func (CloudEndpointsClientPreBackupPollerResponse) PollUntilDone added in v0.2.0 

func (l CloudEndpointsClientPreBackupPollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (CloudEndpointsClientPreBackupResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*CloudEndpointsClientPreBackupPollerResponse) Resume added in v0.2.0 

func (l *CloudEndpointsClientPreBackupPollerResponse) Resume(ctx context.Context, client *CloudEndpointsClient, token string) error

Resume rehydrates a CloudEndpointsClientPreBackupPollerResponse from the provided client and resume token.

type CloudEndpointsClientPreBackupResponse added in v0.2.0 

type CloudEndpointsClientPreBackupResponse struct {
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

CloudEndpointsClientPreBackupResponse contains the response from method CloudEndpointsClient.PreBackup.

type CloudEndpointsClientPreRestorePoller added in v0.2.0 

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

CloudEndpointsClientPreRestorePoller provides polling facilities until the operation reaches a terminal state.

func (*CloudEndpointsClientPreRestorePoller) Done added in v0.2.0 

func (p *CloudEndpointsClientPreRestorePoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*CloudEndpointsClientPreRestorePoller) FinalResponse added in v0.2.0 

func (p *CloudEndpointsClientPreRestorePoller) FinalResponse(ctx context.Context) (CloudEndpointsClientPreRestoreResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final CloudEndpointsClientPreRestoreResponse will be returned.

func (*CloudEndpointsClientPreRestorePoller) Poll added in v0.2.0 

func (p *CloudEndpointsClientPreRestorePoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*CloudEndpointsClientPreRestorePoller) ResumeToken added in v0.2.0 

func (p *CloudEndpointsClientPreRestorePoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type CloudEndpointsClientPreRestorePollerResponse added in v0.2.0 

type CloudEndpointsClientPreRestorePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *CloudEndpointsClientPreRestorePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

CloudEndpointsClientPreRestorePollerResponse contains the response from method CloudEndpointsClient.PreRestore.

func (CloudEndpointsClientPreRestorePollerResponse) PollUntilDone added in v0.2.0 

func (l CloudEndpointsClientPreRestorePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (CloudEndpointsClientPreRestoreResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*CloudEndpointsClientPreRestorePollerResponse) Resume added in v0.2.0 

func (l *CloudEndpointsClientPreRestorePollerResponse) Resume(ctx context.Context, client *CloudEndpointsClient, token string) error

Resume rehydrates a CloudEndpointsClientPreRestorePollerResponse from the provided client and resume token.

type CloudEndpointsClientPreRestoreResponse added in v0.2.0 

type CloudEndpointsClientPreRestoreResponse struct {
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

CloudEndpointsClientPreRestoreResponse contains the response from method CloudEndpointsClient.PreRestore.

type CloudEndpointsClientRestoreheartbeatOptions added in v0.2.0 

type CloudEndpointsClientRestoreheartbeatOptions struct {
}

CloudEndpointsClientRestoreheartbeatOptions contains the optional parameters for the CloudEndpointsClient.Restoreheartbeat method.

type CloudEndpointsClientRestoreheartbeatResponse added in v0.2.0 

type CloudEndpointsClientRestoreheartbeatResponse struct {
	CloudEndpointsClientRestoreheartbeatResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

CloudEndpointsClientRestoreheartbeatResponse contains the response from method CloudEndpointsClient.Restoreheartbeat.

type CloudEndpointsClientRestoreheartbeatResult added in v0.2.0 

type CloudEndpointsClientRestoreheartbeatResult struct {
	// XMSCorrelationRequestID contains the information returned from the x-ms-correlation-request-id header response.
	XMSCorrelationRequestID *string

	// XMSRequestID contains the information returned from the x-ms-request-id header response.
	XMSRequestID *string
}

CloudEndpointsClientRestoreheartbeatResult contains the result from method CloudEndpointsClient.Restoreheartbeat.

type CloudEndpointsClientTriggerChangeDetectionPoller added in v0.2.0 

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

CloudEndpointsClientTriggerChangeDetectionPoller provides polling facilities until the operation reaches a terminal state.

func (*CloudEndpointsClientTriggerChangeDetectionPoller) Done added in v0.2.0 

func (p *CloudEndpointsClientTriggerChangeDetectionPoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*CloudEndpointsClientTriggerChangeDetectionPoller) FinalResponse added in v0.2.0 

func (p *CloudEndpointsClientTriggerChangeDetectionPoller) FinalResponse(ctx context.Context) (CloudEndpointsClientTriggerChangeDetectionResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final CloudEndpointsClientTriggerChangeDetectionResponse will be returned.

func (*CloudEndpointsClientTriggerChangeDetectionPoller) Poll added in v0.2.0 

func (p *CloudEndpointsClientTriggerChangeDetectionPoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*CloudEndpointsClientTriggerChangeDetectionPoller) ResumeToken added in v0.2.0 

func (p *CloudEndpointsClientTriggerChangeDetectionPoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type CloudEndpointsClientTriggerChangeDetectionPollerResponse added in v0.2.0 

type CloudEndpointsClientTriggerChangeDetectionPollerResponse struct {
	// Poller contains an initialized poller.
	Poller *CloudEndpointsClientTriggerChangeDetectionPoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

CloudEndpointsClientTriggerChangeDetectionPollerResponse contains the response from method CloudEndpointsClient.TriggerChangeDetection.

func (CloudEndpointsClientTriggerChangeDetectionPollerResponse) PollUntilDone added in v0.2.0 

func (l CloudEndpointsClientTriggerChangeDetectionPollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (CloudEndpointsClientTriggerChangeDetectionResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*CloudEndpointsClientTriggerChangeDetectionPollerResponse) Resume added in v0.2.0 

func (l *CloudEndpointsClientTriggerChangeDetectionPollerResponse) Resume(ctx context.Context, client *CloudEndpointsClient, token string) error

Resume rehydrates a CloudEndpointsClientTriggerChangeDetectionPollerResponse from the provided client and resume token.

type CloudEndpointsClientTriggerChangeDetectionResponse added in v0.2.0 

type CloudEndpointsClientTriggerChangeDetectionResponse struct {
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

CloudEndpointsClientTriggerChangeDetectionResponse contains the response from method CloudEndpointsClient.TriggerChangeDetection.

type CloudTieringCachePerformance 

type CloudTieringCachePerformance struct {
	// READ-ONLY; Count of bytes that were served from the local server
	CacheHitBytes *int64 `json:"cacheHitBytes,omitempty" azure:"ro"`

	// READ-ONLY; Percentage of total bytes (hit + miss) that were served from the local server
	CacheHitBytesPercent *int32 `json:"cacheHitBytesPercent,omitempty" azure:"ro"`

	// READ-ONLY; Count of bytes that were served from the cloud
	CacheMissBytes *int64 `json:"cacheMissBytes,omitempty" azure:"ro"`

	// READ-ONLY; Last updated timestamp
	LastUpdatedTimestamp *time.Time `json:"lastUpdatedTimestamp,omitempty" azure:"ro"`
}

CloudTieringCachePerformance - Server endpoint cloud tiering status object.

func (CloudTieringCachePerformance) MarshalJSON 

func (c CloudTieringCachePerformance) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type CloudTieringCachePerformance.

func (*CloudTieringCachePerformance) UnmarshalJSON 

func (c *CloudTieringCachePerformance) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type CloudTieringCachePerformance.

type CloudTieringDatePolicyStatus 

type CloudTieringDatePolicyStatus struct {
	// READ-ONLY; Last updated timestamp
	LastUpdatedTimestamp *time.Time `json:"lastUpdatedTimestamp,omitempty" azure:"ro"`

	// READ-ONLY; Most recent access time of tiered files
	TieredFilesMostRecentAccessTimestamp *time.Time `json:"tieredFilesMostRecentAccessTimestamp,omitempty" azure:"ro"`
}

CloudTieringDatePolicyStatus - Status of the date policy

func (CloudTieringDatePolicyStatus) MarshalJSON 

func (c CloudTieringDatePolicyStatus) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type CloudTieringDatePolicyStatus.

func (*CloudTieringDatePolicyStatus) UnmarshalJSON 

func (c *CloudTieringDatePolicyStatus) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type CloudTieringDatePolicyStatus.

type CloudTieringFilesNotTiering 

type CloudTieringFilesNotTiering struct {
	// READ-ONLY; Array of tiering errors
	Errors []*FilesNotTieringError `json:"errors,omitempty" azure:"ro"`

	// READ-ONLY; Last updated timestamp
	LastUpdatedTimestamp *time.Time `json:"lastUpdatedTimestamp,omitempty" azure:"ro"`

	// READ-ONLY; Last cloud tiering result (HResult)
	TotalFileCount *int64 `json:"totalFileCount,omitempty" azure:"ro"`
}

CloudTieringFilesNotTiering - Server endpoint cloud tiering status object.

func (CloudTieringFilesNotTiering) MarshalJSON 

func (c CloudTieringFilesNotTiering) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type CloudTieringFilesNotTiering.

func (*CloudTieringFilesNotTiering) UnmarshalJSON 

func (c *CloudTieringFilesNotTiering) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type CloudTieringFilesNotTiering.

type CloudTieringSpaceSavings 

type CloudTieringSpaceSavings struct {
	// READ-ONLY; Cached content size on the server
	CachedSizeBytes *int64 `json:"cachedSizeBytes,omitempty" azure:"ro"`

	// READ-ONLY; Last updated timestamp
	LastUpdatedTimestamp *time.Time `json:"lastUpdatedTimestamp,omitempty" azure:"ro"`

	// READ-ONLY; Count of bytes saved on the server
	SpaceSavingsBytes *int64 `json:"spaceSavingsBytes,omitempty" azure:"ro"`

	// READ-ONLY; Percentage of cached size over total size
	SpaceSavingsPercent *int32 `json:"spaceSavingsPercent,omitempty" azure:"ro"`

	// READ-ONLY; Total size of content in the azure file share
	TotalSizeCloudBytes *int64 `json:"totalSizeCloudBytes,omitempty" azure:"ro"`

	// READ-ONLY; Volume size
	VolumeSizeBytes *int64 `json:"volumeSizeBytes,omitempty" azure:"ro"`
}

CloudTieringSpaceSavings - Server endpoint cloud tiering status object.

func (CloudTieringSpaceSavings) MarshalJSON 

func (c CloudTieringSpaceSavings) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type CloudTieringSpaceSavings.

func (*CloudTieringSpaceSavings) UnmarshalJSON 

func (c *CloudTieringSpaceSavings) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type CloudTieringSpaceSavings.

type CloudTieringVolumeFreeSpacePolicyStatus 

type CloudTieringVolumeFreeSpacePolicyStatus struct {
	// READ-ONLY; Current volume free space percentage.
	CurrentVolumeFreeSpacePercent *int32 `json:"currentVolumeFreeSpacePercent,omitempty" azure:"ro"`

	// 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" azure:"ro"`

	// READ-ONLY; Last updated timestamp
	LastUpdatedTimestamp *time.Time `json:"lastUpdatedTimestamp,omitempty" azure:"ro"`
}

CloudTieringVolumeFreeSpacePolicyStatus - Status of the volume free space policy

func (CloudTieringVolumeFreeSpacePolicyStatus) MarshalJSON 

func (c CloudTieringVolumeFreeSpacePolicyStatus) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type CloudTieringVolumeFreeSpacePolicyStatus.

func (*CloudTieringVolumeFreeSpacePolicyStatus) UnmarshalJSON 

func (c *CloudTieringVolumeFreeSpacePolicyStatus) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type CloudTieringVolumeFreeSpacePolicyStatus.

type Error added in v0.2.0 

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

	// Error details of the given entry.
	Innererror *APIError `json:"innererror,omitempty"`
}

Error type

type ErrorDetails added in v0.2.0 

type ErrorDetails struct {
	// Error code of the given entry.
	Code *string `json:"code,omitempty"`

	// Exception type of the given entry.
	ExceptionType *string `json:"exceptionType,omitempty"`

	// HTTP error code of the given entry.
	HTTPErrorCode *string `json:"httpErrorCode,omitempty"`

	// HTTP method of the given entry.
	HTTPMethod *string `json:"httpMethod,omitempty"`

	// Hashed message of the given entry.
	HashedMessage *string `json:"hashedMessage,omitempty"`

	// Error message of the given entry.
	Message *string `json:"message,omitempty"`

	// Request URI of the given entry.
	RequestURI *string `json:"requestUri,omitempty"`

	// Target of the given entry.
	Target *string `json:"target,omitempty"`
}

ErrorDetails - Error Details object.

type FeatureStatus 

type FeatureStatus string

FeatureStatus - Type of the Feature Status 

const (
	FeatureStatusOff FeatureStatus = "off"
	FeatureStatusOn  FeatureStatus = "on"
)

func PossibleFeatureStatusValues 

func PossibleFeatureStatusValues() []FeatureStatus

PossibleFeatureStatusValues returns the possible values for the FeatureStatus const type.

func (FeatureStatus) ToPtr 

func (c FeatureStatus) ToPtr() *FeatureStatus

ToPtr returns a *FeatureStatus pointing to the current value.

type FilesNotTieringError 

type FilesNotTieringError struct {
	// READ-ONLY; Error code (HResult)
	ErrorCode *int32 `json:"errorCode,omitempty" azure:"ro"`

	// READ-ONLY; Count of files with this error
	FileCount *int64 `json:"fileCount,omitempty" azure:"ro"`
}

FilesNotTieringError - Files not tiering error object

type IncomingTrafficPolicy 

type IncomingTrafficPolicy string

IncomingTrafficPolicy - Type of the Incoming Traffic Policy 

const (
	IncomingTrafficPolicyAllowAllTraffic          IncomingTrafficPolicy = "AllowAllTraffic"
	IncomingTrafficPolicyAllowVirtualNetworksOnly IncomingTrafficPolicy = "AllowVirtualNetworksOnly"
)

func PossibleIncomingTrafficPolicyValues 

func PossibleIncomingTrafficPolicyValues() []IncomingTrafficPolicy

PossibleIncomingTrafficPolicyValues returns the possible values for the IncomingTrafficPolicy const type.

func (IncomingTrafficPolicy) ToPtr 

func (c IncomingTrafficPolicy) ToPtr() *IncomingTrafficPolicy

ToPtr returns a *IncomingTrafficPolicy pointing to the current value.

type InitialDownloadPolicy 

type InitialDownloadPolicy string

InitialDownloadPolicy - Policy for how namespace and files are recalled during FastDr 

const (
	InitialDownloadPolicyAvoidTieredFiles           InitialDownloadPolicy = "AvoidTieredFiles"
	InitialDownloadPolicyNamespaceOnly              InitialDownloadPolicy = "NamespaceOnly"
	InitialDownloadPolicyNamespaceThenModifiedFiles InitialDownloadPolicy = "NamespaceThenModifiedFiles"
)

func PossibleInitialDownloadPolicyValues 

func PossibleInitialDownloadPolicyValues() []InitialDownloadPolicy

PossibleInitialDownloadPolicyValues returns the possible values for the InitialDownloadPolicy const type.

func (InitialDownloadPolicy) ToPtr 

func (c InitialDownloadPolicy) ToPtr() *InitialDownloadPolicy

ToPtr returns a *InitialDownloadPolicy pointing to the current value.

type InitialUploadPolicy 

type InitialUploadPolicy string

InitialUploadPolicy - Policy for how the initial upload sync session is performed. 

const (
	InitialUploadPolicyMerge               InitialUploadPolicy = "Merge"
	InitialUploadPolicyServerAuthoritative InitialUploadPolicy = "ServerAuthoritative"
)

func PossibleInitialUploadPolicyValues 

func PossibleInitialUploadPolicyValues() []InitialUploadPolicy

PossibleInitialUploadPolicyValues returns the possible values for the InitialUploadPolicy const type.

func (InitialUploadPolicy) ToPtr 

func (c InitialUploadPolicy) ToPtr() *InitialUploadPolicy

ToPtr returns a *InitialUploadPolicy pointing to the current value.

type InnerErrorDetails added in v0.2.0 

type InnerErrorDetails struct {
	// Call stack of the error.
	CallStack *string `json:"callStack,omitempty"`

	// Exception of the inner error.
	InnerException *string `json:"innerException,omitempty"`

	// Call stack of the inner error.
	InnerExceptionCallStack *string `json:"innerExceptionCallStack,omitempty"`

	// Error message of the error.
	Message *string `json:"message,omitempty"`
}

InnerErrorDetails - Error Details object.

type LocalCacheMode 

type LocalCacheMode string

LocalCacheMode - Policy for enabling follow-the-sun business models: link local cache to cloud behavior to pre-populate before local access. 

const (
	LocalCacheModeDownloadNewAndModifiedFiles LocalCacheMode = "DownloadNewAndModifiedFiles"
	LocalCacheModeUpdateLocallyCachedFiles    LocalCacheMode = "UpdateLocallyCachedFiles"
)

func PossibleLocalCacheModeValues 

func PossibleLocalCacheModeValues() []LocalCacheMode

PossibleLocalCacheModeValues returns the possible values for the LocalCacheMode const type.

func (LocalCacheMode) ToPtr 

func (c LocalCacheMode) ToPtr() *LocalCacheMode

ToPtr returns a *LocalCacheMode pointing to the current value.

type LocationOperationStatus 

type LocationOperationStatus struct {
	// READ-ONLY; End time of the operation
	EndTime *time.Time `json:"endTime,omitempty" azure:"ro"`

	// READ-ONLY; Error details.
	Error *APIError `json:"error,omitempty" azure:"ro"`

	// READ-ONLY; Operation resource Id
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; Operation Id
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; Percent complete.
	PercentComplete *int32 `json:"percentComplete,omitempty" azure:"ro"`

	// READ-ONLY; Start time of the operation
	StartTime *time.Time `json:"startTime,omitempty" azure:"ro"`

	// READ-ONLY; Operation status
	Status *string `json:"status,omitempty" azure:"ro"`
}

LocationOperationStatus - Operation status object

func (LocationOperationStatus) MarshalJSON 

func (l LocationOperationStatus) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type LocationOperationStatus.

func (*LocationOperationStatus) UnmarshalJSON 

func (l *LocationOperationStatus) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type LocationOperationStatus.

type MicrosoftStorageSyncClient 

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

MicrosoftStorageSyncClient contains the methods for the MicrosoftStorageSync group. Don't use this type directly, use NewMicrosoftStorageSyncClient() instead.

func NewMicrosoftStorageSyncClient 

func NewMicrosoftStorageSyncClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *MicrosoftStorageSyncClient

NewMicrosoftStorageSyncClient creates a new instance of MicrosoftStorageSyncClient with the specified values. subscriptionID - The ID of the target subscription. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*MicrosoftStorageSyncClient) LocationOperationStatus 

func (client *MicrosoftStorageSyncClient) LocationOperationStatus(ctx context.Context, locationName string, operationID string, options *MicrosoftStorageSyncClientLocationOperationStatusOptions) (MicrosoftStorageSyncClientLocationOperationStatusResponse, error)

LocationOperationStatus - Get Operation status If the operation fails it returns an *azcore.ResponseError type. locationName - The desired region to obtain information from. operationID - operation Id options - MicrosoftStorageSyncClientLocationOperationStatusOptions contains the optional parameters for the MicrosoftStorageSyncClient.LocationOperationStatus method.

Example

x-ms-original-file: specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2020-09-01/examples/LocationOperationStatus_Get.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/storagesync/armstoragesync"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armstoragesync.NewMicrosoftStorageSyncClient("<subscription-id>", cred, nil)
	res, err := client.LocationOperationStatus(ctx,
		"<location-name>",
		"<operation-id>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.MicrosoftStorageSyncClientLocationOperationStatusResult)
}

Output:

type MicrosoftStorageSyncClientLocationOperationStatusOptions added in v0.2.0 

type MicrosoftStorageSyncClientLocationOperationStatusOptions struct {
}

MicrosoftStorageSyncClientLocationOperationStatusOptions contains the optional parameters for the MicrosoftStorageSyncClient.LocationOperationStatus method.

type MicrosoftStorageSyncClientLocationOperationStatusResponse added in v0.2.0 

type MicrosoftStorageSyncClientLocationOperationStatusResponse struct {
	MicrosoftStorageSyncClientLocationOperationStatusResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

MicrosoftStorageSyncClientLocationOperationStatusResponse contains the response from method MicrosoftStorageSyncClient.LocationOperationStatus.

type MicrosoftStorageSyncClientLocationOperationStatusResult added in v0.2.0 

type MicrosoftStorageSyncClientLocationOperationStatusResult struct {
	LocationOperationStatus
	// XMSCorrelationRequestID contains the information returned from the x-ms-correlation-request-id header response.
	XMSCorrelationRequestID *string

	// XMSRequestID contains the information returned from the x-ms-request-id header response.
	XMSRequestID *string
}

MicrosoftStorageSyncClientLocationOperationStatusResult contains the result from method MicrosoftStorageSyncClient.LocationOperationStatus.

type NameAvailabilityReason 

type NameAvailabilityReason string

NameAvailabilityReason - Gets the reason that a Storage Sync Service name could not be used. The Reason element is only returned if NameAvailable is false. 

const (
	NameAvailabilityReasonInvalid       NameAvailabilityReason = "Invalid"
	NameAvailabilityReasonAlreadyExists NameAvailabilityReason = "AlreadyExists"
)

func PossibleNameAvailabilityReasonValues 

func PossibleNameAvailabilityReasonValues() []NameAvailabilityReason

PossibleNameAvailabilityReasonValues returns the possible values for the NameAvailabilityReason const type.

func (NameAvailabilityReason) ToPtr 

func (c NameAvailabilityReason) ToPtr() *NameAvailabilityReason

ToPtr returns a *NameAvailabilityReason pointing to the current value.

type OperationDirection 

type OperationDirection string

OperationDirection - Type of the Operation Direction 

const (
	OperationDirectionCancel OperationDirection = "cancel"
	OperationDirectionDo     OperationDirection = "do"
	OperationDirectionUndo   OperationDirection = "undo"
)

func PossibleOperationDirectionValues 

func PossibleOperationDirectionValues() []OperationDirection

PossibleOperationDirectionValues returns the possible values for the OperationDirection const type.

func (OperationDirection) ToPtr 

func (c OperationDirection) ToPtr() *OperationDirection

ToPtr returns a *OperationDirection pointing to the current value.

type OperationDisplayInfo 

type OperationDisplayInfo struct {
	// The description of the operation.
	Description *string `json:"description,omitempty"`

	// The action that users can perform, based on their permission level.
	Operation *string `json:"operation,omitempty"`

	// Service provider: Microsoft StorageSync.
	Provider *string `json:"provider,omitempty"`

	// Resource on which the operation is performed.
	Resource *string `json:"resource,omitempty"`
}

OperationDisplayInfo - The operation supported by storage sync.

type OperationDisplayResource 

type OperationDisplayResource struct {
	// Operation Display Resource Description.
	Description *string `json:"description,omitempty"`

	// Operation Display Resource Operation.
	Operation *string `json:"operation,omitempty"`

	// Operation Display Resource Provider.
	Provider *string `json:"provider,omitempty"`

	// Operation Display Resource.
	Resource *string `json:"resource,omitempty"`
}

OperationDisplayResource - Operation Display Resource object.

type OperationEntity 

type OperationEntity struct {
	// The operation supported by storage sync.
	Display *OperationDisplayInfo `json:"display,omitempty"`

	// Operation name: {provider}/{resource}/{operation}.
	Name *string `json:"name,omitempty"`

	// The origin.
	Origin *string `json:"origin,omitempty"`

	// Properties of the operations resource.
	Properties *OperationProperties `json:"properties,omitempty"`
}

OperationEntity - The operation supported by storage sync.

type OperationEntityListResult 

type OperationEntityListResult struct {
	// The link used to get the next page of operations.
	NextLink *string `json:"nextLink,omitempty"`

	// The list of operations.
	Value []*OperationEntity `json:"value,omitempty"`
}

OperationEntityListResult - The list of storage sync operations.

func (OperationEntityListResult) MarshalJSON 

func (o OperationEntityListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type OperationEntityListResult.

type OperationProperties 

type OperationProperties struct {
	// Service specification for the operations resource.
	ServiceSpecification *OperationResourceServiceSpecification `json:"serviceSpecification,omitempty"`
}

OperationProperties - Properties of the operations resource.

type OperationResourceMetricSpecification 

type OperationResourceMetricSpecification struct {
	// Aggregation type for the metric.
	AggregationType *string `json:"aggregationType,omitempty"`

	// Dimensions for the metric specification.
	Dimensions []*OperationResourceMetricSpecificationDimension `json:"dimensions,omitempty"`

	// Display description for the metric.
	DisplayDescription *string `json:"displayDescription,omitempty"`

	// Display name for the metric.
	DisplayName *string `json:"displayName,omitempty"`

	// Fill gaps in the metric with zero.
	FillGapWithZero *bool `json:"fillGapWithZero,omitempty"`

	// Name of the metric.
	Name *string `json:"name,omitempty"`

	// Unit for the metric.
	Unit *string `json:"unit,omitempty"`
}

OperationResourceMetricSpecification - Operation Display Resource object.

func (OperationResourceMetricSpecification) MarshalJSON 

func (o OperationResourceMetricSpecification) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type OperationResourceMetricSpecification.

type OperationResourceMetricSpecificationDimension 

type OperationResourceMetricSpecificationDimension struct {
	// Display name of the dimensions.
	DisplayName *string `json:"displayName,omitempty"`

	// Name of the dimension.
	Name *string `json:"name,omitempty"`

	// Indicates metric should be exported for Shoebox.
	ToBeExportedForShoebox *bool `json:"toBeExportedForShoebox,omitempty"`
}

OperationResourceMetricSpecificationDimension object.

type OperationResourceServiceSpecification 

type OperationResourceServiceSpecification struct {
	// List of metric specifications.
	MetricSpecifications []*OperationResourceMetricSpecification `json:"metricSpecifications,omitempty"`
}

OperationResourceServiceSpecification - Service specification.

func (OperationResourceServiceSpecification) MarshalJSON 

func (o OperationResourceServiceSpecification) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type OperationResourceServiceSpecification.

type OperationStatus 

type OperationStatus struct {
	// READ-ONLY; End time of the operation
	EndTime *time.Time `json:"endTime,omitempty" azure:"ro"`

	// READ-ONLY; Error details.
	Error *APIError `json:"error,omitempty" azure:"ro"`

	// READ-ONLY; Operation Id
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; Start time of the operation
	StartTime *time.Time `json:"startTime,omitempty" azure:"ro"`

	// READ-ONLY; Operation status
	Status *string `json:"status,omitempty" azure:"ro"`
}

OperationStatus - Operation status object

func (OperationStatus) MarshalJSON 

func (o OperationStatus) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type OperationStatus.

func (*OperationStatus) UnmarshalJSON 

func (o *OperationStatus) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type OperationStatus.

type OperationStatusClient 

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

OperationStatusClient contains the methods for the OperationStatus group. Don't use this type directly, use NewOperationStatusClient() instead.

func NewOperationStatusClient 

func NewOperationStatusClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *OperationStatusClient

NewOperationStatusClient creates a new instance of OperationStatusClient with the specified values. subscriptionID - The ID of the target subscription. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*OperationStatusClient) Get 

func (client *OperationStatusClient) Get(ctx context.Context, resourceGroupName string, locationName string, workflowID string, operationID string, options *OperationStatusClientGetOptions) (OperationStatusClientGetResponse, error)

Get - Get Operation status If the operation fails it returns an *azcore.ResponseError type. 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 options - OperationStatusClientGetOptions contains the optional parameters for the OperationStatusClient.Get method.

Example

x-ms-original-file: specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2020-09-01/examples/OperationStatus_Get.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/storagesync/armstoragesync"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armstoragesync.NewOperationStatusClient("<subscription-id>", cred, nil)
	res, err := client.Get(ctx,
		"<resource-group-name>",
		"<location-name>",
		"<workflow-id>",
		"<operation-id>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.OperationStatusClientGetResult)
}

Output:

type OperationStatusClientGetOptions added in v0.2.0 

type OperationStatusClientGetOptions struct {
}

OperationStatusClientGetOptions contains the optional parameters for the OperationStatusClient.Get method.

type OperationStatusClientGetResponse added in v0.2.0 

type OperationStatusClientGetResponse struct {
	OperationStatusClientGetResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

OperationStatusClientGetResponse contains the response from method OperationStatusClient.Get.

type OperationStatusClientGetResult added in v0.2.0 

type OperationStatusClientGetResult struct {
	OperationStatus
	// XMSCorrelationRequestID contains the information returned from the x-ms-correlation-request-id header response.
	XMSCorrelationRequestID *string

	// XMSRequestID contains the information returned from the x-ms-request-id header response.
	XMSRequestID *string
}

OperationStatusClientGetResult contains the result from method OperationStatusClient.Get.

type OperationsClient 

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

OperationsClient contains the methods for the Operations group. Don't use this type directly, use NewOperationsClient() instead.

func NewOperationsClient 

func NewOperationsClient(credential azcore.TokenCredential, options *arm.ClientOptions) *OperationsClient

NewOperationsClient creates a new instance of OperationsClient with the specified values. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*OperationsClient) List 

func (client *OperationsClient) List(options *OperationsClientListOptions) *OperationsClientListPager

List - Lists all of the available Storage Sync Rest API operations. If the operation fails it returns an *azcore.ResponseError type. options - OperationsClientListOptions contains the optional parameters for the OperationsClient.List method.

Example

x-ms-original-file: specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2020-09-01/examples/Operations_List.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/storagesync/armstoragesync"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armstoragesync.NewOperationsClient(cred, nil)
	pager := client.List(nil)
	for {
		nextResult := pager.NextPage(ctx)
		if err := pager.Err(); err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		if !nextResult {
			break
		}
		for _, v := range pager.PageResponse().Value {
			log.Printf("Pager result: %#v\n", v)
		}
	}
}

Output:

type OperationsClientListOptions added in v0.2.0 

type OperationsClientListOptions struct {
}

OperationsClientListOptions contains the optional parameters for the OperationsClient.List method.

type OperationsClientListPager added in v0.2.0 

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

OperationsClientListPager provides operations for iterating over paged responses.

func (*OperationsClientListPager) Err added in v0.2.0 

func (p *OperationsClientListPager) Err() error

Err returns the last error encountered while paging.

func (*OperationsClientListPager) NextPage added in v0.2.0 

func (p *OperationsClientListPager) NextPage(ctx context.Context) bool

NextPage returns true if the pager advanced to the next page. Returns false if there are no more pages or an error occurred.

func (*OperationsClientListPager) PageResponse added in v0.2.0 

func (p *OperationsClientListPager) PageResponse() OperationsClientListResponse

PageResponse returns the current OperationsClientListResponse page.

type OperationsClientListResponse added in v0.2.0 

type OperationsClientListResponse struct {
	OperationsClientListResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

OperationsClientListResponse contains the response from method OperationsClient.List.

type OperationsClientListResult added in v0.2.0 

type OperationsClientListResult struct {
	OperationEntityListResult
	// XMSCorrelationRequestID contains the information returned from the x-ms-correlation-request-id header response.
	XMSCorrelationRequestID *string

	// XMSRequestID contains the information returned from the x-ms-request-id header response.
	XMSRequestID *string
}

OperationsClientListResult contains the result from method OperationsClient.List.

type PostBackupResponse 

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

PostBackupResponse - Post Backup Response

type PostBackupResponseProperties 

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

PostBackupResponseProperties - Post Backup Response Properties object.

type PostRestoreRequest 

type PostRestoreRequest struct {
	// Post Restore Azure file share uri.
	AzureFileShareURI *string `json:"azureFileShareUri,omitempty"`

	// Post Restore Azure failed file list.
	FailedFileList *string `json:"failedFileList,omitempty"`

	// Post Restore partition.
	Partition *string `json:"partition,omitempty"`

	// Post Restore replica group.
	ReplicaGroup *string `json:"replicaGroup,omitempty"`

	// Post Restore request id.
	RequestID *string `json:"requestId,omitempty"`

	// Post Restore restore file spec array.
	RestoreFileSpec []*RestoreFileSpec `json:"restoreFileSpec,omitempty"`

	// Post Restore Azure source azure file share uri.
	SourceAzureFileShareURI *string `json:"sourceAzureFileShareUri,omitempty"`

	// Post Restore Azure status.
	Status *string `json:"status,omitempty"`
}

PostRestoreRequest - Post Restore Request

func (PostRestoreRequest) MarshalJSON 

func (p PostRestoreRequest) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PostRestoreRequest.

type PreRestoreRequest 

type PreRestoreRequest struct {
	// Pre Restore Azure file share uri.
	AzureFileShareURI *string `json:"azureFileShareUri,omitempty"`

	// Pre Restore backup metadata property bag.
	BackupMetadataPropertyBag *string `json:"backupMetadataPropertyBag,omitempty"`

	// Pre Restore partition.
	Partition *string `json:"partition,omitempty"`

	// Pre Restore pause wait for sync drain time period in seconds.
	PauseWaitForSyncDrainTimePeriodInSeconds *int32 `json:"pauseWaitForSyncDrainTimePeriodInSeconds,omitempty"`

	// Pre Restore replica group.
	ReplicaGroup *string `json:"replicaGroup,omitempty"`

	// Pre Restore request id.
	RequestID *string `json:"requestId,omitempty"`

	// Pre Restore restore file spec array.
	RestoreFileSpec []*RestoreFileSpec `json:"restoreFileSpec,omitempty"`

	// Pre Restore Azure source azure file share uri.
	SourceAzureFileShareURI *string `json:"sourceAzureFileShareUri,omitempty"`

	// Pre Restore Azure status.
	Status *string `json:"status,omitempty"`
}

PreRestoreRequest - Pre Restore request object.

func (PreRestoreRequest) MarshalJSON 

func (p PreRestoreRequest) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PreRestoreRequest.

type PrivateEndpoint 

type PrivateEndpoint struct {
	// READ-ONLY; The ARM identifier for Private Endpoint
	ID *string `json:"id,omitempty" azure:"ro"`
}

PrivateEndpoint - The Private Endpoint resource.

type PrivateEndpointConnection 

type PrivateEndpointConnection struct {
	// Resource properties.
	Properties *PrivateEndpointConnectionProperties `json:"properties,omitempty"`

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; The name of the resource
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string `json:"type,omitempty" azure:"ro"`
}

PrivateEndpointConnection - The Private Endpoint Connection resource.

type PrivateEndpointConnectionListResult 

type PrivateEndpointConnectionListResult struct {
	// Array of private endpoint connections
	Value []*PrivateEndpointConnection `json:"value,omitempty"`
}

PrivateEndpointConnectionListResult - List of private endpoint connection associated with the specified storage account

func (PrivateEndpointConnectionListResult) MarshalJSON 

func (p PrivateEndpointConnectionListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PrivateEndpointConnectionListResult.

type PrivateEndpointConnectionProperties 

type PrivateEndpointConnectionProperties struct {
	// REQUIRED; A collection of information about the state of the connection between service consumer and provider.
	PrivateLinkServiceConnectionState *PrivateLinkServiceConnectionState `json:"privateLinkServiceConnectionState,omitempty"`

	// The resource of private end point.
	PrivateEndpoint *PrivateEndpoint `json:"privateEndpoint,omitempty"`

	// READ-ONLY; The provisioning state of the private endpoint connection resource.
	ProvisioningState *PrivateEndpointConnectionProvisioningState `json:"provisioningState,omitempty" azure:"ro"`
}

PrivateEndpointConnectionProperties - Properties of the PrivateEndpointConnectProperties.

type PrivateEndpointConnectionProvisioningState 

type PrivateEndpointConnectionProvisioningState string

PrivateEndpointConnectionProvisioningState - The current provisioning state. 

const (
	PrivateEndpointConnectionProvisioningStateCreating  PrivateEndpointConnectionProvisioningState = "Creating"
	PrivateEndpointConnectionProvisioningStateDeleting  PrivateEndpointConnectionProvisioningState = "Deleting"
	PrivateEndpointConnectionProvisioningStateFailed    PrivateEndpointConnectionProvisioningState = "Failed"
	PrivateEndpointConnectionProvisioningStateSucceeded PrivateEndpointConnectionProvisioningState = "Succeeded"
)

func PossiblePrivateEndpointConnectionProvisioningStateValues 

func PossiblePrivateEndpointConnectionProvisioningStateValues() []PrivateEndpointConnectionProvisioningState

PossiblePrivateEndpointConnectionProvisioningStateValues returns the possible values for the PrivateEndpointConnectionProvisioningState const type.

func (PrivateEndpointConnectionProvisioningState) ToPtr 

func (c PrivateEndpointConnectionProvisioningState) ToPtr() *PrivateEndpointConnectionProvisioningState

ToPtr returns a *PrivateEndpointConnectionProvisioningState pointing to the current value.

type PrivateEndpointConnectionsClient 

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

PrivateEndpointConnectionsClient contains the methods for the PrivateEndpointConnections group. Don't use this type directly, use NewPrivateEndpointConnectionsClient() instead.

func NewPrivateEndpointConnectionsClient 

func NewPrivateEndpointConnectionsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *PrivateEndpointConnectionsClient

NewPrivateEndpointConnectionsClient creates a new instance of PrivateEndpointConnectionsClient with the specified values. subscriptionID - The ID of the target subscription. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*PrivateEndpointConnectionsClient) BeginCreate 

func (client *PrivateEndpointConnectionsClient) BeginCreate(ctx context.Context, resourceGroupName string, storageSyncServiceName string, privateEndpointConnectionName string, properties PrivateEndpointConnection, options *PrivateEndpointConnectionsClientBeginCreateOptions) (PrivateEndpointConnectionsClientCreatePollerResponse, error)

BeginCreate - Update the state of specified private endpoint connection associated with the storage sync service. If the operation fails it returns an *azcore.ResponseError type. 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. options - PrivateEndpointConnectionsClientBeginCreateOptions contains the optional parameters for the PrivateEndpointConnectionsClient.BeginCreate method.

Example

x-ms-original-file: specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2020-09-01/examples/PrivateEndpointConnections_Create.json 

package main

import (
	"context"
	"log"

	"time"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/storagesync/armstoragesync"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armstoragesync.NewPrivateEndpointConnectionsClient("<subscription-id>", cred, nil)
	poller, err := client.BeginCreate(ctx,
		"<resource-group-name>",
		"<storage-sync-service-name>",
		"<private-endpoint-connection-name>",
		armstoragesync.PrivateEndpointConnection{
			Properties: &armstoragesync.PrivateEndpointConnectionProperties{
				PrivateLinkServiceConnectionState: &armstoragesync.PrivateLinkServiceConnectionState{
					Description: to.StringPtr("<description>"),
					Status:      armstoragesync.PrivateEndpointServiceConnectionStatus("Approved").ToPtr(),
				},
			},
		},
		nil)
	if err != nil {
		log.Fatal(err)
	}
	res, err := poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.PrivateEndpointConnectionsClientCreateResult)
}

Output:

func (*PrivateEndpointConnectionsClient) BeginDelete 

func (client *PrivateEndpointConnectionsClient) BeginDelete(ctx context.Context, resourceGroupName string, storageSyncServiceName string, privateEndpointConnectionName string, options *PrivateEndpointConnectionsClientBeginDeleteOptions) (PrivateEndpointConnectionsClientDeletePollerResponse, error)

BeginDelete - Deletes the specified private endpoint connection associated with the storage sync service. If the operation fails it returns an *azcore.ResponseError type. 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 options - PrivateEndpointConnectionsClientBeginDeleteOptions contains the optional parameters for the PrivateEndpointConnectionsClient.BeginDelete method.

Example

x-ms-original-file: specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2020-09-01/examples/PrivateEndpointConnections_Delete.json 

package main

import (
	"context"
	"log"

	"time"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/storagesync/armstoragesync"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armstoragesync.NewPrivateEndpointConnectionsClient("<subscription-id>", cred, nil)
	poller, err := client.BeginDelete(ctx,
		"<resource-group-name>",
		"<storage-sync-service-name>",
		"<private-endpoint-connection-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	_, err = poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
}

Output:

func (*PrivateEndpointConnectionsClient) Get 

func (client *PrivateEndpointConnectionsClient) Get(ctx context.Context, resourceGroupName string, storageSyncServiceName string, privateEndpointConnectionName string, options *PrivateEndpointConnectionsClientGetOptions) (PrivateEndpointConnectionsClientGetResponse, error)

Get - Gets the specified private endpoint connection associated with the storage sync service. If the operation fails it returns an *azcore.ResponseError type. 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 options - PrivateEndpointConnectionsClientGetOptions contains the optional parameters for the PrivateEndpointConnectionsClient.Get method.

Example

x-ms-original-file: specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2020-09-01/examples/PrivateEndpointConnections_Get.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/storagesync/armstoragesync"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armstoragesync.NewPrivateEndpointConnectionsClient("<subscription-id>", cred, nil)
	res, err := client.Get(ctx,
		"<resource-group-name>",
		"<storage-sync-service-name>",
		"<private-endpoint-connection-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.PrivateEndpointConnectionsClientGetResult)
}

Output:

func (*PrivateEndpointConnectionsClient) ListByStorageSyncService 

func (client *PrivateEndpointConnectionsClient) ListByStorageSyncService(ctx context.Context, resourceGroupName string, storageSyncServiceName string, options *PrivateEndpointConnectionsClientListByStorageSyncServiceOptions) (PrivateEndpointConnectionsClientListByStorageSyncServiceResponse, error)

ListByStorageSyncService - Get a PrivateEndpointConnection List. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. The name is case insensitive. storageSyncServiceName - Name of Storage Sync Service resource. options - PrivateEndpointConnectionsClientListByStorageSyncServiceOptions contains the optional parameters for the PrivateEndpointConnectionsClient.ListByStorageSyncService method.

Example

x-ms-original-file: specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2020-09-01/examples/PrivateEndpointConnections_ListByStorageSyncService.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/storagesync/armstoragesync"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armstoragesync.NewPrivateEndpointConnectionsClient("<subscription-id>", cred, nil)
	res, err := client.ListByStorageSyncService(ctx,
		"<resource-group-name>",
		"<storage-sync-service-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.PrivateEndpointConnectionsClientListByStorageSyncServiceResult)
}

Output:

type PrivateEndpointConnectionsClientBeginCreateOptions added in v0.2.0 

type PrivateEndpointConnectionsClientBeginCreateOptions struct {
}

PrivateEndpointConnectionsClientBeginCreateOptions contains the optional parameters for the PrivateEndpointConnectionsClient.BeginCreate method.

type PrivateEndpointConnectionsClientBeginDeleteOptions added in v0.2.0 

type PrivateEndpointConnectionsClientBeginDeleteOptions struct {
}

PrivateEndpointConnectionsClientBeginDeleteOptions contains the optional parameters for the PrivateEndpointConnectionsClient.BeginDelete method.

type PrivateEndpointConnectionsClientCreatePoller added in v0.2.0 

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

PrivateEndpointConnectionsClientCreatePoller provides polling facilities until the operation reaches a terminal state.

func (*PrivateEndpointConnectionsClientCreatePoller) Done added in v0.2.0 

func (p *PrivateEndpointConnectionsClientCreatePoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*PrivateEndpointConnectionsClientCreatePoller) FinalResponse added in v0.2.0 

func (p *PrivateEndpointConnectionsClientCreatePoller) FinalResponse(ctx context.Context) (PrivateEndpointConnectionsClientCreateResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final PrivateEndpointConnectionsClientCreateResponse will be returned.

func (*PrivateEndpointConnectionsClientCreatePoller) Poll added in v0.2.0 

func (p *PrivateEndpointConnectionsClientCreatePoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*PrivateEndpointConnectionsClientCreatePoller) ResumeToken added in v0.2.0 

func (p *PrivateEndpointConnectionsClientCreatePoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type PrivateEndpointConnectionsClientCreatePollerResponse added in v0.2.0 

type PrivateEndpointConnectionsClientCreatePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *PrivateEndpointConnectionsClientCreatePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

PrivateEndpointConnectionsClientCreatePollerResponse contains the response from method PrivateEndpointConnectionsClient.Create.

func (PrivateEndpointConnectionsClientCreatePollerResponse) PollUntilDone added in v0.2.0 

func (l PrivateEndpointConnectionsClientCreatePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (PrivateEndpointConnectionsClientCreateResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*PrivateEndpointConnectionsClientCreatePollerResponse) Resume added in v0.2.0 

func (l *PrivateEndpointConnectionsClientCreatePollerResponse) Resume(ctx context.Context, client *PrivateEndpointConnectionsClient, token string) error

Resume rehydrates a PrivateEndpointConnectionsClientCreatePollerResponse from the provided client and resume token.

type PrivateEndpointConnectionsClientCreateResponse added in v0.2.0 

type PrivateEndpointConnectionsClientCreateResponse struct {
	PrivateEndpointConnectionsClientCreateResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

PrivateEndpointConnectionsClientCreateResponse contains the response from method PrivateEndpointConnectionsClient.Create.

type PrivateEndpointConnectionsClientCreateResult added in v0.2.0 

type PrivateEndpointConnectionsClientCreateResult struct {
	PrivateEndpointConnection
}

PrivateEndpointConnectionsClientCreateResult contains the result from method PrivateEndpointConnectionsClient.Create.

type PrivateEndpointConnectionsClientDeletePoller added in v0.2.0 

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

PrivateEndpointConnectionsClientDeletePoller provides polling facilities until the operation reaches a terminal state.

func (*PrivateEndpointConnectionsClientDeletePoller) Done added in v0.2.0 

func (p *PrivateEndpointConnectionsClientDeletePoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*PrivateEndpointConnectionsClientDeletePoller) FinalResponse added in v0.2.0 

func (p *PrivateEndpointConnectionsClientDeletePoller) FinalResponse(ctx context.Context) (PrivateEndpointConnectionsClientDeleteResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final PrivateEndpointConnectionsClientDeleteResponse will be returned.

func (*PrivateEndpointConnectionsClientDeletePoller) Poll added in v0.2.0 

func (p *PrivateEndpointConnectionsClientDeletePoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*PrivateEndpointConnectionsClientDeletePoller) ResumeToken added in v0.2.0 

func (p *PrivateEndpointConnectionsClientDeletePoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type PrivateEndpointConnectionsClientDeletePollerResponse added in v0.2.0 

type PrivateEndpointConnectionsClientDeletePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *PrivateEndpointConnectionsClientDeletePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

PrivateEndpointConnectionsClientDeletePollerResponse contains the response from method PrivateEndpointConnectionsClient.Delete.

func (PrivateEndpointConnectionsClientDeletePollerResponse) PollUntilDone added in v0.2.0 

func (l PrivateEndpointConnectionsClientDeletePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (PrivateEndpointConnectionsClientDeleteResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*PrivateEndpointConnectionsClientDeletePollerResponse) Resume added in v0.2.0 

func (l *PrivateEndpointConnectionsClientDeletePollerResponse) Resume(ctx context.Context, client *PrivateEndpointConnectionsClient, token string) error

Resume rehydrates a PrivateEndpointConnectionsClientDeletePollerResponse from the provided client and resume token.

type PrivateEndpointConnectionsClientDeleteResponse added in v0.2.0 

type PrivateEndpointConnectionsClientDeleteResponse struct {
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

PrivateEndpointConnectionsClientDeleteResponse contains the response from method PrivateEndpointConnectionsClient.Delete.

type PrivateEndpointConnectionsClientGetOptions added in v0.2.0 

type PrivateEndpointConnectionsClientGetOptions struct {
}

PrivateEndpointConnectionsClientGetOptions contains the optional parameters for the PrivateEndpointConnectionsClient.Get method.

type PrivateEndpointConnectionsClientGetResponse added in v0.2.0 

type PrivateEndpointConnectionsClientGetResponse struct {
	PrivateEndpointConnectionsClientGetResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

PrivateEndpointConnectionsClientGetResponse contains the response from method PrivateEndpointConnectionsClient.Get.

type PrivateEndpointConnectionsClientGetResult added in v0.2.0 

type PrivateEndpointConnectionsClientGetResult struct {
	PrivateEndpointConnection
}

PrivateEndpointConnectionsClientGetResult contains the result from method PrivateEndpointConnectionsClient.Get.

type PrivateEndpointConnectionsClientListByStorageSyncServiceOptions added in v0.2.0 

type PrivateEndpointConnectionsClientListByStorageSyncServiceOptions struct {
}

PrivateEndpointConnectionsClientListByStorageSyncServiceOptions contains the optional parameters for the PrivateEndpointConnectionsClient.ListByStorageSyncService method.

type PrivateEndpointConnectionsClientListByStorageSyncServiceResponse added in v0.2.0 

type PrivateEndpointConnectionsClientListByStorageSyncServiceResponse struct {
	PrivateEndpointConnectionsClientListByStorageSyncServiceResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

PrivateEndpointConnectionsClientListByStorageSyncServiceResponse contains the response from method PrivateEndpointConnectionsClient.ListByStorageSyncService.

type PrivateEndpointConnectionsClientListByStorageSyncServiceResult added in v0.2.0 

type PrivateEndpointConnectionsClientListByStorageSyncServiceResult struct {
	PrivateEndpointConnectionListResult
	// XMSCorrelationRequestID contains the information returned from the x-ms-correlation-request-id header response.
	XMSCorrelationRequestID *string

	// XMSRequestID contains the information returned from the x-ms-request-id header response.
	XMSRequestID *string
}

PrivateEndpointConnectionsClientListByStorageSyncServiceResult contains the result from method PrivateEndpointConnectionsClient.ListByStorageSyncService.

type PrivateEndpointServiceConnectionStatus 

type PrivateEndpointServiceConnectionStatus string

PrivateEndpointServiceConnectionStatus - The private endpoint connection status. 

const (
	PrivateEndpointServiceConnectionStatusApproved PrivateEndpointServiceConnectionStatus = "Approved"
	PrivateEndpointServiceConnectionStatusPending  PrivateEndpointServiceConnectionStatus = "Pending"
	PrivateEndpointServiceConnectionStatusRejected PrivateEndpointServiceConnectionStatus = "Rejected"
)

func PossiblePrivateEndpointServiceConnectionStatusValues 

func PossiblePrivateEndpointServiceConnectionStatusValues() []PrivateEndpointServiceConnectionStatus

PossiblePrivateEndpointServiceConnectionStatusValues returns the possible values for the PrivateEndpointServiceConnectionStatus const type.

func (PrivateEndpointServiceConnectionStatus) ToPtr 

func (c PrivateEndpointServiceConnectionStatus) ToPtr() *PrivateEndpointServiceConnectionStatus

ToPtr returns a *PrivateEndpointServiceConnectionStatus pointing to the current value.

type PrivateLinkResource 

type PrivateLinkResource struct {
	// Resource properties.
	Properties *PrivateLinkResourceProperties `json:"properties,omitempty"`

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; The name of the resource
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string `json:"type,omitempty" azure:"ro"`
}

PrivateLinkResource - A private link resource

type PrivateLinkResourceListResult 

type PrivateLinkResourceListResult struct {
	// Array of private link resources
	Value []*PrivateLinkResource `json:"value,omitempty"`
}

PrivateLinkResourceListResult - A list of private link resources

func (PrivateLinkResourceListResult) MarshalJSON 

func (p PrivateLinkResourceListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PrivateLinkResourceListResult.

type PrivateLinkResourceProperties 

type PrivateLinkResourceProperties struct {
	// The private link resource Private link DNS zone name.
	RequiredZoneNames []*string `json:"requiredZoneNames,omitempty"`

	// READ-ONLY; The private link resource group id.
	GroupID *string `json:"groupId,omitempty" azure:"ro"`

	// READ-ONLY; The private link resource required member names.
	RequiredMembers []*string `json:"requiredMembers,omitempty" azure:"ro"`
}

PrivateLinkResourceProperties - Properties of a private link resource.

func (PrivateLinkResourceProperties) MarshalJSON 

func (p PrivateLinkResourceProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PrivateLinkResourceProperties.

type PrivateLinkResourcesClient 

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

PrivateLinkResourcesClient contains the methods for the PrivateLinkResources group. Don't use this type directly, use NewPrivateLinkResourcesClient() instead.

func NewPrivateLinkResourcesClient 

func NewPrivateLinkResourcesClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *PrivateLinkResourcesClient

NewPrivateLinkResourcesClient creates a new instance of PrivateLinkResourcesClient with the specified values. subscriptionID - The ID of the target subscription. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*PrivateLinkResourcesClient) ListByStorageSyncService 

func (client *PrivateLinkResourcesClient) ListByStorageSyncService(ctx context.Context, resourceGroupName string, storageSyncServiceName string, options *PrivateLinkResourcesClientListByStorageSyncServiceOptions) (PrivateLinkResourcesClientListByStorageSyncServiceResponse, error)

ListByStorageSyncService - Gets the private link resources that need to be created for a storage sync service. If the operation fails it returns an *azcore.ResponseError type. 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. options - PrivateLinkResourcesClientListByStorageSyncServiceOptions contains the optional parameters for the PrivateLinkResourcesClient.ListByStorageSyncService method.

Example

x-ms-original-file: specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2020-09-01/examples/PrivateLinkResources_List.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/storagesync/armstoragesync"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armstoragesync.NewPrivateLinkResourcesClient("<subscription-id>", cred, nil)
	res, err := client.ListByStorageSyncService(ctx,
		"<resource-group-name>",
		"<storage-sync-service-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.PrivateLinkResourcesClientListByStorageSyncServiceResult)
}

Output:

type PrivateLinkResourcesClientListByStorageSyncServiceOptions added in v0.2.0 

type PrivateLinkResourcesClientListByStorageSyncServiceOptions struct {
}

PrivateLinkResourcesClientListByStorageSyncServiceOptions contains the optional parameters for the PrivateLinkResourcesClient.ListByStorageSyncService method.

type PrivateLinkResourcesClientListByStorageSyncServiceResponse added in v0.2.0 

type PrivateLinkResourcesClientListByStorageSyncServiceResponse struct {
	PrivateLinkResourcesClientListByStorageSyncServiceResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

PrivateLinkResourcesClientListByStorageSyncServiceResponse contains the response from method PrivateLinkResourcesClient.ListByStorageSyncService.

type PrivateLinkResourcesClientListByStorageSyncServiceResult added in v0.2.0 

type PrivateLinkResourcesClientListByStorageSyncServiceResult struct {
	PrivateLinkResourceListResult
}

PrivateLinkResourcesClientListByStorageSyncServiceResult contains the result from method PrivateLinkResourcesClient.ListByStorageSyncService.

type PrivateLinkServiceConnectionState 

type PrivateLinkServiceConnectionState struct {
	// A message indicating if changes on the service provider require any updates on the consumer.
	ActionsRequired *string `json:"actionsRequired,omitempty"`

	// The reason for approval/rejection of the connection.
	Description *string `json:"description,omitempty"`

	// Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.
	Status *PrivateEndpointServiceConnectionStatus `json:"status,omitempty"`
}

PrivateLinkServiceConnectionState - A collection of information about the state of the connection between service consumer and provider.

type ProgressType 

type ProgressType string

ProgressType - Type of the ProgressType 

const (
	ProgressTypeDownload   ProgressType = "download"
	ProgressTypeInitialize ProgressType = "initialize"
	ProgressTypeNone       ProgressType = "none"
	ProgressTypeRecall     ProgressType = "recall"
	ProgressTypeUpload     ProgressType = "upload"
)

func PossibleProgressTypeValues 

func PossibleProgressTypeValues() []ProgressType

PossibleProgressTypeValues returns the possible values for the ProgressType const type.

func (ProgressType) ToPtr 

func (c ProgressType) ToPtr() *ProgressType

ToPtr returns a *ProgressType pointing to the current value.

type ProxyResource 

type ProxyResource struct {
	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; The name of the resource
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string `json:"type,omitempty" azure:"ro"`
}

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

type Reason 

type Reason string

Reason - State of Azure Subscription 

const (
	ReasonDeleted      Reason = "Deleted"
	ReasonRegistered   Reason = "Registered"
	ReasonSuspended    Reason = "Suspended"
	ReasonUnregistered Reason = "Unregistered"
	ReasonWarned       Reason = "Warned"
)

func PossibleReasonValues 

func PossibleReasonValues() []Reason

PossibleReasonValues returns the possible values for the Reason const type.

func (Reason) ToPtr 

func (c Reason) ToPtr() *Reason

ToPtr returns a *Reason pointing to the current value.

type RecallActionParameters 

type RecallActionParameters struct {
	// Pattern of the files.
	Pattern *string `json:"pattern,omitempty"`

	// Recall path.
	RecallPath *string `json:"recallPath,omitempty"`
}

RecallActionParameters - The parameters used when calling recall action on server endpoint.

type RegisteredServer 

type RegisteredServer struct {
	// RegisteredServer properties.
	Properties *RegisteredServerProperties `json:"properties,omitempty"`

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; The name of the resource
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string `json:"type,omitempty" azure:"ro"`
}

RegisteredServer - Registered Server resource.

type RegisteredServerAgentVersionStatus 

type RegisteredServerAgentVersionStatus string

RegisteredServerAgentVersionStatus - Type of the registered server agent version status 

const (
	RegisteredServerAgentVersionStatusBlocked    RegisteredServerAgentVersionStatus = "Blocked"
	RegisteredServerAgentVersionStatusExpired    RegisteredServerAgentVersionStatus = "Expired"
	RegisteredServerAgentVersionStatusNearExpiry RegisteredServerAgentVersionStatus = "NearExpiry"
	RegisteredServerAgentVersionStatusOk         RegisteredServerAgentVersionStatus = "Ok"
)

func PossibleRegisteredServerAgentVersionStatusValues 

func PossibleRegisteredServerAgentVersionStatusValues() []RegisteredServerAgentVersionStatus

PossibleRegisteredServerAgentVersionStatusValues returns the possible values for the RegisteredServerAgentVersionStatus const type.

func (RegisteredServerAgentVersionStatus) ToPtr 

func (c RegisteredServerAgentVersionStatus) ToPtr() *RegisteredServerAgentVersionStatus

ToPtr returns a *RegisteredServerAgentVersionStatus pointing to the current value.

type RegisteredServerArray 

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

RegisteredServerArray - Array of RegisteredServer

func (RegisteredServerArray) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type RegisteredServerArray.

type RegisteredServerCreateParameters 

type RegisteredServerCreateParameters struct {
	// The parameters used to create the registered server.
	Properties *RegisteredServerCreateParametersProperties `json:"properties,omitempty"`

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; The name of the resource
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string `json:"type,omitempty" azure:"ro"`
}

RegisteredServerCreateParameters - The parameters used when creating a registered server.

type RegisteredServerCreateParametersProperties 

type RegisteredServerCreateParametersProperties struct {
	// Registered Server Agent Version
	AgentVersion *string `json:"agentVersion,omitempty"`

	// Registered Server clusterId
	ClusterID *string `json:"clusterId,omitempty"`

	// Registered Server clusterName
	ClusterName *string `json:"clusterName,omitempty"`

	// Friendly Name
	FriendlyName *string `json:"friendlyName,omitempty"`

	// Registered Server last heart beat
	LastHeartBeat *string `json:"lastHeartBeat,omitempty"`

	// Registered Server Certificate
	ServerCertificate *string `json:"serverCertificate,omitempty"`

	// Registered Server serverId
	ServerID *string `json:"serverId,omitempty"`

	// Registered Server OS Version
	ServerOSVersion *string `json:"serverOSVersion,omitempty"`

	// Registered Server serverRole
	ServerRole *string `json:"serverRole,omitempty"`
}

RegisteredServerCreateParametersProperties - RegisteredServer Create Properties object.

type RegisteredServerProperties 

type RegisteredServerProperties struct {
	// Registered Server Agent Version
	AgentVersion *string `json:"agentVersion,omitempty"`

	// Registered Server clusterId
	ClusterID *string `json:"clusterId,omitempty"`

	// Registered Server clusterName
	ClusterName *string `json:"clusterName,omitempty"`

	// Resource discoveryEndpointUri
	DiscoveryEndpointURI *string `json:"discoveryEndpointUri,omitempty"`

	// Friendly Name
	FriendlyName *string `json:"friendlyName,omitempty"`

	// Registered Server last heart beat
	LastHeartBeat *string `json:"lastHeartBeat,omitempty"`

	// Resource Last Operation Name
	LastOperationName *string `json:"lastOperationName,omitempty"`

	// Registered Server lastWorkflowId
	LastWorkflowID *string `json:"lastWorkflowId,omitempty"`

	// Management Endpoint Uri
	ManagementEndpointURI *string `json:"managementEndpointUri,omitempty"`

	// Monitoring Configuration
	MonitoringConfiguration *string `json:"monitoringConfiguration,omitempty"`

	// Telemetry Endpoint Uri
	MonitoringEndpointURI *string `json:"monitoringEndpointUri,omitempty"`

	// Registered Server Provisioning State
	ProvisioningState *string `json:"provisioningState,omitempty"`

	// Resource Location
	ResourceLocation *string `json:"resourceLocation,omitempty"`

	// Registered Server Certificate
	ServerCertificate *string `json:"serverCertificate,omitempty"`

	// Registered Server serverId
	ServerID *string `json:"serverId,omitempty"`

	// Registered Server Management Error Code
	ServerManagementErrorCode *int32 `json:"serverManagementErrorCode,omitempty"`

	// Registered Server OS Version
	ServerOSVersion *string `json:"serverOSVersion,omitempty"`

	// Registered Server serverRole
	ServerRole *string `json:"serverRole,omitempty"`

	// Service Location
	ServiceLocation *string `json:"serviceLocation,omitempty"`

	// Registered Server storageSyncServiceUid
	StorageSyncServiceUID *string `json:"storageSyncServiceUid,omitempty"`

	// READ-ONLY; Registered Server Agent Version Expiration Date
	AgentVersionExpirationDate *time.Time `json:"agentVersionExpirationDate,omitempty" azure:"ro"`

	// READ-ONLY; Registered Server Agent Version Status
	AgentVersionStatus *RegisteredServerAgentVersionStatus `json:"agentVersionStatus,omitempty" azure:"ro"`

	// READ-ONLY; Server name
	ServerName *string `json:"serverName,omitempty" azure:"ro"`
}

RegisteredServerProperties - RegisteredServer Properties object.

func (RegisteredServerProperties) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type RegisteredServerProperties.

func (*RegisteredServerProperties) UnmarshalJSON 

func (r *RegisteredServerProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type RegisteredServerProperties.

type RegisteredServersClient 

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

RegisteredServersClient contains the methods for the RegisteredServers group. Don't use this type directly, use NewRegisteredServersClient() instead.

func NewRegisteredServersClient 

func NewRegisteredServersClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *RegisteredServersClient

NewRegisteredServersClient creates a new instance of RegisteredServersClient with the specified values. subscriptionID - The ID of the target subscription. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*RegisteredServersClient) BeginCreate 

func (client *RegisteredServersClient) BeginCreate(ctx context.Context, resourceGroupName string, storageSyncServiceName string, serverID string, parameters RegisteredServerCreateParameters, options *RegisteredServersClientBeginCreateOptions) (RegisteredServersClientCreatePollerResponse, error)

BeginCreate - Add a new registered server. If the operation fails it returns an *azcore.ResponseError type. 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. options - RegisteredServersClientBeginCreateOptions contains the optional parameters for the RegisteredServersClient.BeginCreate method.

Example

x-ms-original-file: specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2020-09-01/examples/RegisteredServers_Create.json 

package main

import (
	"context"
	"log"

	"time"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/storagesync/armstoragesync"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armstoragesync.NewRegisteredServersClient("<subscription-id>", cred, nil)
	poller, err := client.BeginCreate(ctx,
		"<resource-group-name>",
		"<storage-sync-service-name>",
		"<server-id>",
		armstoragesync.RegisteredServerCreateParameters{
			Properties: &armstoragesync.RegisteredServerCreateParametersProperties{
				AgentVersion:      to.StringPtr("<agent-version>"),
				FriendlyName:      to.StringPtr("<friendly-name>"),
				ServerCertificate: to.StringPtr("<server-certificate>"),
				ServerID:          to.StringPtr("<server-id>"),
				ServerOSVersion:   to.StringPtr("<server-osversion>"),
				ServerRole:        to.StringPtr("<server-role>"),
			},
		},
		nil)
	if err != nil {
		log.Fatal(err)
	}
	res, err := poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.RegisteredServersClientCreateResult)
}

Output:

func (*RegisteredServersClient) BeginDelete 

func (client *RegisteredServersClient) BeginDelete(ctx context.Context, resourceGroupName string, storageSyncServiceName string, serverID string, options *RegisteredServersClientBeginDeleteOptions) (RegisteredServersClientDeletePollerResponse, error)

BeginDelete - Delete the given registered server. If the operation fails it returns an *azcore.ResponseError type. 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. options - RegisteredServersClientBeginDeleteOptions contains the optional parameters for the RegisteredServersClient.BeginDelete method.

Example

x-ms-original-file: specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2020-09-01/examples/RegisteredServers_Delete.json 

package main

import (
	"context"
	"log"

	"time"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/storagesync/armstoragesync"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armstoragesync.NewRegisteredServersClient("<subscription-id>", cred, nil)
	poller, err := client.BeginDelete(ctx,
		"<resource-group-name>",
		"<storage-sync-service-name>",
		"<server-id>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	_, err = poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
}

Output:

func (*RegisteredServersClient) BeginTriggerRollover 

func (client *RegisteredServersClient) BeginTriggerRollover(ctx context.Context, resourceGroupName string, storageSyncServiceName string, serverID string, parameters TriggerRolloverRequest, options *RegisteredServersClientBeginTriggerRolloverOptions) (RegisteredServersClientTriggerRolloverPollerResponse, error)

BeginTriggerRollover - Triggers Server certificate rollover. If the operation fails it returns an *azcore.ResponseError type. 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. options - RegisteredServersClientBeginTriggerRolloverOptions contains the optional parameters for the RegisteredServersClient.BeginTriggerRollover method.

Example

x-ms-original-file: specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2020-09-01/examples/RegisteredServers_TriggerRollover.json 

package main

import (
	"context"
	"log"

	"time"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/storagesync/armstoragesync"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armstoragesync.NewRegisteredServersClient("<subscription-id>", cred, nil)
	poller, err := client.BeginTriggerRollover(ctx,
		"<resource-group-name>",
		"<storage-sync-service-name>",
		"<server-id>",
		armstoragesync.TriggerRolloverRequest{
			ServerCertificate: to.StringPtr("<server-certificate>"),
		},
		nil)
	if err != nil {
		log.Fatal(err)
	}
	_, err = poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
}

Output:

func (*RegisteredServersClient) Get 

func (client *RegisteredServersClient) Get(ctx context.Context, resourceGroupName string, storageSyncServiceName string, serverID string, options *RegisteredServersClientGetOptions) (RegisteredServersClientGetResponse, error)

Get - Get a given registered server. If the operation fails it returns an *azcore.ResponseError type. 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. options - RegisteredServersClientGetOptions contains the optional parameters for the RegisteredServersClient.Get method.

Example

x-ms-original-file: specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2020-09-01/examples/RegisteredServers_Get.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/storagesync/armstoragesync"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armstoragesync.NewRegisteredServersClient("<subscription-id>", cred, nil)
	res, err := client.Get(ctx,
		"<resource-group-name>",
		"<storage-sync-service-name>",
		"<server-id>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.RegisteredServersClientGetResult)
}

Output:

func (*RegisteredServersClient) ListByStorageSyncService 

func (client *RegisteredServersClient) ListByStorageSyncService(ctx context.Context, resourceGroupName string, storageSyncServiceName string, options *RegisteredServersClientListByStorageSyncServiceOptions) (RegisteredServersClientListByStorageSyncServiceResponse, error)

ListByStorageSyncService - Get a given registered server list. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. The name is case insensitive. storageSyncServiceName - Name of Storage Sync Service resource. options - RegisteredServersClientListByStorageSyncServiceOptions contains the optional parameters for the RegisteredServersClient.ListByStorageSyncService method.

Example

x-ms-original-file: specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2020-09-01/examples/RegisteredServers_ListByStorageSyncService.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/storagesync/armstoragesync"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armstoragesync.NewRegisteredServersClient("<subscription-id>", cred, nil)
	res, err := client.ListByStorageSyncService(ctx,
		"<resource-group-name>",
		"<storage-sync-service-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.RegisteredServersClientListByStorageSyncServiceResult)
}

Output:

type RegisteredServersClientBeginCreateOptions added in v0.2.0 

type RegisteredServersClientBeginCreateOptions struct {
}

RegisteredServersClientBeginCreateOptions contains the optional parameters for the RegisteredServersClient.BeginCreate method.

type RegisteredServersClientBeginDeleteOptions added in v0.2.0 

type RegisteredServersClientBeginDeleteOptions struct {
}

RegisteredServersClientBeginDeleteOptions contains the optional parameters for the RegisteredServersClient.BeginDelete method.

type RegisteredServersClientBeginTriggerRolloverOptions added in v0.2.0 

type RegisteredServersClientBeginTriggerRolloverOptions struct {
}

RegisteredServersClientBeginTriggerRolloverOptions contains the optional parameters for the RegisteredServersClient.BeginTriggerRollover method.

type RegisteredServersClientCreatePoller added in v0.2.0 

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

RegisteredServersClientCreatePoller provides polling facilities until the operation reaches a terminal state.

func (*RegisteredServersClientCreatePoller) Done added in v0.2.0 

func (p *RegisteredServersClientCreatePoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*RegisteredServersClientCreatePoller) FinalResponse added in v0.2.0 

func (p *RegisteredServersClientCreatePoller) FinalResponse(ctx context.Context) (RegisteredServersClientCreateResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final RegisteredServersClientCreateResponse will be returned.

func (*RegisteredServersClientCreatePoller) Poll added in v0.2.0 

func (p *RegisteredServersClientCreatePoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*RegisteredServersClientCreatePoller) ResumeToken added in v0.2.0 

func (p *RegisteredServersClientCreatePoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type RegisteredServersClientCreatePollerResponse added in v0.2.0 

type RegisteredServersClientCreatePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *RegisteredServersClientCreatePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

RegisteredServersClientCreatePollerResponse contains the response from method RegisteredServersClient.Create.

func (RegisteredServersClientCreatePollerResponse) PollUntilDone added in v0.2.0 

func (l RegisteredServersClientCreatePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (RegisteredServersClientCreateResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*RegisteredServersClientCreatePollerResponse) Resume added in v0.2.0 

func (l *RegisteredServersClientCreatePollerResponse) Resume(ctx context.Context, client *RegisteredServersClient, token string) error

Resume rehydrates a RegisteredServersClientCreatePollerResponse from the provided client and resume token.

type RegisteredServersClientCreateResponse added in v0.2.0 

type RegisteredServersClientCreateResponse struct {
	RegisteredServersClientCreateResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

RegisteredServersClientCreateResponse contains the response from method RegisteredServersClient.Create.

type RegisteredServersClientCreateResult added in v0.2.0 

type RegisteredServersClientCreateResult struct {
	RegisteredServer
}

RegisteredServersClientCreateResult contains the result from method RegisteredServersClient.Create.

type RegisteredServersClientDeletePoller added in v0.2.0 

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

RegisteredServersClientDeletePoller provides polling facilities until the operation reaches a terminal state.

func (*RegisteredServersClientDeletePoller) Done added in v0.2.0 

func (p *RegisteredServersClientDeletePoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*RegisteredServersClientDeletePoller) FinalResponse added in v0.2.0 

func (p *RegisteredServersClientDeletePoller) FinalResponse(ctx context.Context) (RegisteredServersClientDeleteResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final RegisteredServersClientDeleteResponse will be returned.

func (*RegisteredServersClientDeletePoller) Poll added in v0.2.0 

func (p *RegisteredServersClientDeletePoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*RegisteredServersClientDeletePoller) ResumeToken added in v0.2.0 

func (p *RegisteredServersClientDeletePoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type RegisteredServersClientDeletePollerResponse added in v0.2.0 

type RegisteredServersClientDeletePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *RegisteredServersClientDeletePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

RegisteredServersClientDeletePollerResponse contains the response from method RegisteredServersClient.Delete.

func (RegisteredServersClientDeletePollerResponse) PollUntilDone added in v0.2.0 

func (l RegisteredServersClientDeletePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (RegisteredServersClientDeleteResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*RegisteredServersClientDeletePollerResponse) Resume added in v0.2.0 

func (l *RegisteredServersClientDeletePollerResponse) Resume(ctx context.Context, client *RegisteredServersClient, token string) error

Resume rehydrates a RegisteredServersClientDeletePollerResponse from the provided client and resume token.

type RegisteredServersClientDeleteResponse added in v0.2.0 

type RegisteredServersClientDeleteResponse struct {
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

RegisteredServersClientDeleteResponse contains the response from method RegisteredServersClient.Delete.

type RegisteredServersClientGetOptions added in v0.2.0 

type RegisteredServersClientGetOptions struct {
}

RegisteredServersClientGetOptions contains the optional parameters for the RegisteredServersClient.Get method.

type RegisteredServersClientGetResponse added in v0.2.0 

type RegisteredServersClientGetResponse struct {
	RegisteredServersClientGetResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

RegisteredServersClientGetResponse contains the response from method RegisteredServersClient.Get.

type RegisteredServersClientGetResult added in v0.2.0 

type RegisteredServersClientGetResult struct {
	RegisteredServer
	// XMSCorrelationRequestID contains the information returned from the x-ms-correlation-request-id header response.
	XMSCorrelationRequestID *string

	// XMSRequestID contains the information returned from the x-ms-request-id header response.
	XMSRequestID *string
}

RegisteredServersClientGetResult contains the result from method RegisteredServersClient.Get.

type RegisteredServersClientListByStorageSyncServiceOptions added in v0.2.0 

type RegisteredServersClientListByStorageSyncServiceOptions struct {
}

RegisteredServersClientListByStorageSyncServiceOptions contains the optional parameters for the RegisteredServersClient.ListByStorageSyncService method.

type RegisteredServersClientListByStorageSyncServiceResponse added in v0.2.0 

type RegisteredServersClientListByStorageSyncServiceResponse struct {
	RegisteredServersClientListByStorageSyncServiceResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

RegisteredServersClientListByStorageSyncServiceResponse contains the response from method RegisteredServersClient.ListByStorageSyncService.

type RegisteredServersClientListByStorageSyncServiceResult added in v0.2.0 

type RegisteredServersClientListByStorageSyncServiceResult struct {
	RegisteredServerArray
	// XMSCorrelationRequestID contains the information returned from the x-ms-correlation-request-id header response.
	XMSCorrelationRequestID *string

	// XMSRequestID contains the information returned from the x-ms-request-id header response.
	XMSRequestID *string
}

RegisteredServersClientListByStorageSyncServiceResult contains the result from method RegisteredServersClient.ListByStorageSyncService.

type RegisteredServersClientTriggerRolloverPoller added in v0.2.0 

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

RegisteredServersClientTriggerRolloverPoller provides polling facilities until the operation reaches a terminal state.

func (*RegisteredServersClientTriggerRolloverPoller) Done added in v0.2.0 

func (p *RegisteredServersClientTriggerRolloverPoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*RegisteredServersClientTriggerRolloverPoller) FinalResponse added in v0.2.0 

func (p *RegisteredServersClientTriggerRolloverPoller) FinalResponse(ctx context.Context) (RegisteredServersClientTriggerRolloverResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final RegisteredServersClientTriggerRolloverResponse will be returned.

func (*RegisteredServersClientTriggerRolloverPoller) Poll added in v0.2.0 

func (p *RegisteredServersClientTriggerRolloverPoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*RegisteredServersClientTriggerRolloverPoller) ResumeToken added in v0.2.0 

func (p *RegisteredServersClientTriggerRolloverPoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type RegisteredServersClientTriggerRolloverPollerResponse added in v0.2.0 

type RegisteredServersClientTriggerRolloverPollerResponse struct {
	// Poller contains an initialized poller.
	Poller *RegisteredServersClientTriggerRolloverPoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

RegisteredServersClientTriggerRolloverPollerResponse contains the response from method RegisteredServersClient.TriggerRollover.

func (RegisteredServersClientTriggerRolloverPollerResponse) PollUntilDone added in v0.2.0 

func (l RegisteredServersClientTriggerRolloverPollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (RegisteredServersClientTriggerRolloverResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*RegisteredServersClientTriggerRolloverPollerResponse) Resume added in v0.2.0 

func (l *RegisteredServersClientTriggerRolloverPollerResponse) Resume(ctx context.Context, client *RegisteredServersClient, token string) error

Resume rehydrates a RegisteredServersClientTriggerRolloverPollerResponse from the provided client and resume token.

type RegisteredServersClientTriggerRolloverResponse added in v0.2.0 

type RegisteredServersClientTriggerRolloverResponse struct {
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

RegisteredServersClientTriggerRolloverResponse contains the response from method RegisteredServersClient.TriggerRollover.

type Resource 

type Resource struct {
	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; The name of the resource
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string `json:"type,omitempty" azure:"ro"`
}

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

type ResourcesMoveInfo 

type ResourcesMoveInfo struct {
	// Collection of Resources.
	Resources []*string `json:"resources,omitempty"`

	// Target resource group.
	TargetResourceGroup *string `json:"targetResourceGroup,omitempty"`
}

ResourcesMoveInfo - Resource Move Info.

func (ResourcesMoveInfo) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type ResourcesMoveInfo.

type RestoreFileSpec 

type RestoreFileSpec struct {
	// Restore file spec isdir
	Isdir *bool `json:"isdir,omitempty"`

	// Restore file spec path
	Path *string `json:"path,omitempty"`
}

RestoreFileSpec - Restore file spec.

type ServerEndpoint 

type ServerEndpoint struct {
	// Server Endpoint properties.
	Properties *ServerEndpointProperties `json:"properties,omitempty"`

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; The name of the resource
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string `json:"type,omitempty" azure:"ro"`
}

ServerEndpoint - Server Endpoint object.

type ServerEndpointArray 

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

ServerEndpointArray - Array of ServerEndpoint

func (ServerEndpointArray) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type ServerEndpointArray.

type ServerEndpointBackgroundDataDownloadActivity 

type ServerEndpointBackgroundDataDownloadActivity struct {
	// READ-ONLY; Running count of bytes downloaded
	DownloadedBytes *int64 `json:"downloadedBytes,omitempty" azure:"ro"`

	// READ-ONLY; Progress percentage
	PercentProgress *int32 `json:"percentProgress,omitempty" azure:"ro"`

	// READ-ONLY; Timestamp when the operation started
	StartedTimestamp *time.Time `json:"startedTimestamp,omitempty" azure:"ro"`

	// READ-ONLY; Timestamp when properties were updated
	Timestamp *time.Time `json:"timestamp,omitempty" azure:"ro"`
}

ServerEndpointBackgroundDataDownloadActivity - Background data download activity object

func (ServerEndpointBackgroundDataDownloadActivity) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type ServerEndpointBackgroundDataDownloadActivity.

func (*ServerEndpointBackgroundDataDownloadActivity) UnmarshalJSON 

func (s *ServerEndpointBackgroundDataDownloadActivity) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ServerEndpointBackgroundDataDownloadActivity.

type ServerEndpointCloudTieringStatus 

type ServerEndpointCloudTieringStatus struct {
	// READ-ONLY; Information regarding how well the local cache on the server is performing.
	CachePerformance *CloudTieringCachePerformance `json:"cachePerformance,omitempty" azure:"ro"`

	// READ-ONLY; Status of the date policy
	DatePolicyStatus *CloudTieringDatePolicyStatus `json:"datePolicyStatus,omitempty" azure:"ro"`

	// READ-ONLY; Information regarding files that failed to be tiered
	FilesNotTiering *CloudTieringFilesNotTiering `json:"filesNotTiering,omitempty" azure:"ro"`

	// READ-ONLY; Cloud tiering health state.
	Health *ServerEndpointHealthState `json:"health,omitempty" azure:"ro"`

	// READ-ONLY; The last updated timestamp of health state
	HealthLastUpdatedTimestamp *time.Time `json:"healthLastUpdatedTimestamp,omitempty" azure:"ro"`

	// READ-ONLY; Last cloud tiering result (HResult)
	LastCloudTieringResult *int32 `json:"lastCloudTieringResult,omitempty" azure:"ro"`

	// READ-ONLY; Last cloud tiering success timestamp
	LastSuccessTimestamp *time.Time `json:"lastSuccessTimestamp,omitempty" azure:"ro"`

	// READ-ONLY; Last updated timestamp
	LastUpdatedTimestamp *time.Time `json:"lastUpdatedTimestamp,omitempty" azure:"ro"`

	// READ-ONLY; Information regarding how much local space cloud tiering is saving.
	SpaceSavings *CloudTieringSpaceSavings `json:"spaceSavings,omitempty" azure:"ro"`

	// READ-ONLY; Status of the volume free space policy
	VolumeFreeSpacePolicyStatus *CloudTieringVolumeFreeSpacePolicyStatus `json:"volumeFreeSpacePolicyStatus,omitempty" azure:"ro"`
}

ServerEndpointCloudTieringStatus - Server endpoint cloud tiering status object.

func (ServerEndpointCloudTieringStatus) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type ServerEndpointCloudTieringStatus.

func (*ServerEndpointCloudTieringStatus) UnmarshalJSON 

func (s *ServerEndpointCloudTieringStatus) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ServerEndpointCloudTieringStatus.

type ServerEndpointCreateParameters 

type ServerEndpointCreateParameters struct {
	// The parameters used to create the server endpoint.
	Properties *ServerEndpointCreateParametersProperties `json:"properties,omitempty"`

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; The name of the resource
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string `json:"type,omitempty" azure:"ro"`
}

ServerEndpointCreateParameters - The parameters used when creating a server endpoint.

type ServerEndpointCreateParametersProperties 

type ServerEndpointCreateParametersProperties struct {
	// Cloud Tiering.
	CloudTiering *FeatureStatus `json:"cloudTiering,omitempty"`

	// Friendly Name
	FriendlyName *string `json:"friendlyName,omitempty"`

	// Policy for how namespace and files are recalled during FastDr.
	InitialDownloadPolicy *InitialDownloadPolicy `json:"initialDownloadPolicy,omitempty"`

	// Policy for how the initial upload sync session is performed.
	InitialUploadPolicy *InitialUploadPolicy `json:"initialUploadPolicy,omitempty"`

	// Policy for enabling follow-the-sun business models: link local cache to cloud behavior to pre-populate before local access.
	LocalCacheMode *LocalCacheMode `json:"localCacheMode,omitempty"`

	// Offline data transfer
	OfflineDataTransfer *FeatureStatus `json:"offlineDataTransfer,omitempty"`

	// Offline data transfer share name
	OfflineDataTransferShareName *string `json:"offlineDataTransferShareName,omitempty"`

	// Server Local path.
	ServerLocalPath *string `json:"serverLocalPath,omitempty"`

	// Server Resource Id.
	ServerResourceID *string `json:"serverResourceId,omitempty"`

	// Tier files older than days.
	TierFilesOlderThanDays *int32 `json:"tierFilesOlderThanDays,omitempty"`

	// Level of free space to be maintained by Cloud Tiering if it is enabled.
	VolumeFreeSpacePercent *int32 `json:"volumeFreeSpacePercent,omitempty"`
}

ServerEndpointCreateParametersProperties - ServerEndpoint Properties object.

type ServerEndpointFilesNotSyncingError 

type ServerEndpointFilesNotSyncingError struct {
	// READ-ONLY; Error code (HResult)
	ErrorCode *int32 `json:"errorCode,omitempty" azure:"ro"`

	// READ-ONLY; Count of persistent files not syncing with the specified error code
	PersistentCount *int64 `json:"persistentCount,omitempty" azure:"ro"`

	// READ-ONLY; Count of transient files not syncing with the specified error code
	TransientCount *int64 `json:"transientCount,omitempty" azure:"ro"`
}

ServerEndpointFilesNotSyncingError - Files not syncing error object

type ServerEndpointHealthState 

type ServerEndpointHealthState string

ServerEndpointHealthState - Type of the server endpoint health state 

const (
	ServerEndpointHealthStateError       ServerEndpointHealthState = "Error"
	ServerEndpointHealthStateHealthy     ServerEndpointHealthState = "Healthy"
	ServerEndpointHealthStateUnavailable ServerEndpointHealthState = "Unavailable"
)

func PossibleServerEndpointHealthStateValues 

func PossibleServerEndpointHealthStateValues() []ServerEndpointHealthState

PossibleServerEndpointHealthStateValues returns the possible values for the ServerEndpointHealthState const type.

func (ServerEndpointHealthState) ToPtr 

func (c ServerEndpointHealthState) ToPtr() *ServerEndpointHealthState

ToPtr returns a *ServerEndpointHealthState pointing to the current value.

type ServerEndpointOfflineDataTransferState 

type ServerEndpointOfflineDataTransferState string

ServerEndpointOfflineDataTransferState - Type of the Health state 

const (
	ServerEndpointOfflineDataTransferStateComplete   ServerEndpointOfflineDataTransferState = "Complete"
	ServerEndpointOfflineDataTransferStateInProgress ServerEndpointOfflineDataTransferState = "InProgress"
	ServerEndpointOfflineDataTransferStateNotRunning ServerEndpointOfflineDataTransferState = "NotRunning"
	ServerEndpointOfflineDataTransferStateStopping   ServerEndpointOfflineDataTransferState = "Stopping"
)

func PossibleServerEndpointOfflineDataTransferStateValues 

func PossibleServerEndpointOfflineDataTransferStateValues() []ServerEndpointOfflineDataTransferState

PossibleServerEndpointOfflineDataTransferStateValues returns the possible values for the ServerEndpointOfflineDataTransferState const type.

func (ServerEndpointOfflineDataTransferState) ToPtr 

func (c ServerEndpointOfflineDataTransferState) ToPtr() *ServerEndpointOfflineDataTransferState

ToPtr returns a *ServerEndpointOfflineDataTransferState pointing to the current value.

type ServerEndpointProperties 

type ServerEndpointProperties struct {
	// Cloud Tiering.
	CloudTiering *FeatureStatus `json:"cloudTiering,omitempty"`

	// Friendly Name
	FriendlyName *string `json:"friendlyName,omitempty"`

	// Policy for how namespace and files are recalled during FastDr.
	InitialDownloadPolicy *InitialDownloadPolicy `json:"initialDownloadPolicy,omitempty"`

	// Policy for how the initial upload sync session is performed.
	InitialUploadPolicy *InitialUploadPolicy `json:"initialUploadPolicy,omitempty"`

	// Policy for enabling follow-the-sun business models: link local cache to cloud behavior to pre-populate before local access.
	LocalCacheMode *LocalCacheMode `json:"localCacheMode,omitempty"`

	// Offline data transfer
	OfflineDataTransfer *FeatureStatus `json:"offlineDataTransfer,omitempty"`

	// Offline data transfer share name
	OfflineDataTransferShareName *string `json:"offlineDataTransferShareName,omitempty"`

	// Server Local path.
	ServerLocalPath *string `json:"serverLocalPath,omitempty"`

	// Server Resource Id.
	ServerResourceID *string `json:"serverResourceId,omitempty"`

	// Tier files older than days.
	TierFilesOlderThanDays *int32 `json:"tierFilesOlderThanDays,omitempty"`

	// Level of free space to be maintained by Cloud Tiering if it is enabled.
	VolumeFreeSpacePercent *int32 `json:"volumeFreeSpacePercent,omitempty"`

	// READ-ONLY; Cloud tiering status. Only populated if cloud tiering is enabled.
	CloudTieringStatus *ServerEndpointCloudTieringStatus `json:"cloudTieringStatus,omitempty" azure:"ro"`

	// READ-ONLY; Resource Last Operation Name
	LastOperationName *string `json:"lastOperationName,omitempty" azure:"ro"`

	// READ-ONLY; ServerEndpoint lastWorkflowId
	LastWorkflowID *string `json:"lastWorkflowId,omitempty" azure:"ro"`

	// READ-ONLY; Offline data transfer storage account resource ID
	OfflineDataTransferStorageAccountResourceID *string `json:"offlineDataTransferStorageAccountResourceId,omitempty" azure:"ro"`

	// READ-ONLY; Offline data transfer storage account tenant ID
	OfflineDataTransferStorageAccountTenantID *string `json:"offlineDataTransferStorageAccountTenantId,omitempty" azure:"ro"`

	// READ-ONLY; ServerEndpoint Provisioning State
	ProvisioningState *string `json:"provisioningState,omitempty" azure:"ro"`

	// READ-ONLY; Recall status. Only populated if cloud tiering is enabled.
	RecallStatus *ServerEndpointRecallStatus `json:"recallStatus,omitempty" azure:"ro"`

	// READ-ONLY; Server name
	ServerName *string `json:"serverName,omitempty" azure:"ro"`

	// READ-ONLY; Server Endpoint sync status
	SyncStatus *ServerEndpointSyncStatus `json:"syncStatus,omitempty" azure:"ro"`
}

ServerEndpointProperties - ServerEndpoint Properties object.

type ServerEndpointRecallError 

type ServerEndpointRecallError struct {
	// READ-ONLY; Count of occurences of the error
	Count *int64 `json:"count,omitempty" azure:"ro"`

	// READ-ONLY; Error code (HResult)
	ErrorCode *int32 `json:"errorCode,omitempty" azure:"ro"`
}

ServerEndpointRecallError - Server endpoint recall error object

type ServerEndpointRecallStatus 

type ServerEndpointRecallStatus struct {
	// READ-ONLY; Last updated timestamp
	LastUpdatedTimestamp *time.Time `json:"lastUpdatedTimestamp,omitempty" azure:"ro"`

	// READ-ONLY; Array of recall errors
	RecallErrors []*ServerEndpointRecallError `json:"recallErrors,omitempty" azure:"ro"`

	// READ-ONLY; Total count of recall errors.
	TotalRecallErrorsCount *int64 `json:"totalRecallErrorsCount,omitempty" azure:"ro"`
}

ServerEndpointRecallStatus - Server endpoint recall status object.

func (ServerEndpointRecallStatus) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type ServerEndpointRecallStatus.

func (*ServerEndpointRecallStatus) UnmarshalJSON 

func (s *ServerEndpointRecallStatus) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ServerEndpointRecallStatus.

type ServerEndpointSyncActivityState 

type ServerEndpointSyncActivityState string

ServerEndpointSyncActivityState - Type of the sync activity state 

const (
	ServerEndpointSyncActivityStateDownload          ServerEndpointSyncActivityState = "Download"
	ServerEndpointSyncActivityStateUpload            ServerEndpointSyncActivityState = "Upload"
	ServerEndpointSyncActivityStateUploadAndDownload ServerEndpointSyncActivityState = "UploadAndDownload"
)

func PossibleServerEndpointSyncActivityStateValues 

func PossibleServerEndpointSyncActivityStateValues() []ServerEndpointSyncActivityState

PossibleServerEndpointSyncActivityStateValues returns the possible values for the ServerEndpointSyncActivityState const type.

func (ServerEndpointSyncActivityState) ToPtr 

func (c ServerEndpointSyncActivityState) ToPtr() *ServerEndpointSyncActivityState

ToPtr returns a *ServerEndpointSyncActivityState pointing to the current value.

type ServerEndpointSyncActivityStatus 

type ServerEndpointSyncActivityStatus struct {
	// READ-ONLY; Applied bytes
	AppliedBytes *int64 `json:"appliedBytes,omitempty" azure:"ro"`

	// READ-ONLY; Applied item count.
	AppliedItemCount *int64 `json:"appliedItemCount,omitempty" azure:"ro"`

	// READ-ONLY; Per item error count
	PerItemErrorCount *int64 `json:"perItemErrorCount,omitempty" azure:"ro"`

	// READ-ONLY; Session minutes remaining (if available)
	SessionMinutesRemaining *int32 `json:"sessionMinutesRemaining,omitempty" azure:"ro"`

	// READ-ONLY; Sync mode
	SyncMode *ServerEndpointSyncMode `json:"syncMode,omitempty" azure:"ro"`

	// READ-ONLY; Timestamp when properties were updated
	Timestamp *time.Time `json:"timestamp,omitempty" azure:"ro"`

	// READ-ONLY; Total bytes (if available)
	TotalBytes *int64 `json:"totalBytes,omitempty" azure:"ro"`

	// READ-ONLY; Total item count (if available)
	TotalItemCount *int64 `json:"totalItemCount,omitempty" azure:"ro"`
}

ServerEndpointSyncActivityStatus - Sync Session status object.

func (ServerEndpointSyncActivityStatus) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type ServerEndpointSyncActivityStatus.

func (*ServerEndpointSyncActivityStatus) UnmarshalJSON 

func (s *ServerEndpointSyncActivityStatus) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ServerEndpointSyncActivityStatus.

type ServerEndpointSyncMode 

type ServerEndpointSyncMode string

ServerEndpointSyncMode - Sync mode for the server endpoint. 

const (
	ServerEndpointSyncModeInitialFullDownload ServerEndpointSyncMode = "InitialFullDownload"
	ServerEndpointSyncModeInitialUpload       ServerEndpointSyncMode = "InitialUpload"
	ServerEndpointSyncModeNamespaceDownload   ServerEndpointSyncMode = "NamespaceDownload"
	ServerEndpointSyncModeRegular             ServerEndpointSyncMode = "Regular"
	ServerEndpointSyncModeSnapshotUpload      ServerEndpointSyncMode = "SnapshotUpload"
)

func PossibleServerEndpointSyncModeValues 

func PossibleServerEndpointSyncModeValues() []ServerEndpointSyncMode

PossibleServerEndpointSyncModeValues returns the possible values for the ServerEndpointSyncMode const type.

func (ServerEndpointSyncMode) ToPtr 

func (c ServerEndpointSyncMode) ToPtr() *ServerEndpointSyncMode

ToPtr returns a *ServerEndpointSyncMode pointing to the current value.

type ServerEndpointSyncSessionStatus 

type ServerEndpointSyncSessionStatus struct {
	// READ-ONLY; Array of per-item errors coming from the last sync session.
	FilesNotSyncingErrors []*ServerEndpointFilesNotSyncingError `json:"filesNotSyncingErrors,omitempty" azure:"ro"`

	// READ-ONLY; Sync mode
	LastSyncMode *ServerEndpointSyncMode `json:"lastSyncMode,omitempty" azure:"ro"`

	// READ-ONLY; Last sync per item error count.
	LastSyncPerItemErrorCount *int64 `json:"lastSyncPerItemErrorCount,omitempty" azure:"ro"`

	// READ-ONLY; Last sync result (HResult)
	LastSyncResult *int32 `json:"lastSyncResult,omitempty" azure:"ro"`

	// READ-ONLY; Last sync success timestamp
	LastSyncSuccessTimestamp *time.Time `json:"lastSyncSuccessTimestamp,omitempty" azure:"ro"`

	// READ-ONLY; Last sync timestamp
	LastSyncTimestamp *time.Time `json:"lastSyncTimestamp,omitempty" azure:"ro"`

	// READ-ONLY; Count of persistent files not syncing.
	PersistentFilesNotSyncingCount *int64 `json:"persistentFilesNotSyncingCount,omitempty" azure:"ro"`

	// READ-ONLY; Count of transient files not syncing.
	TransientFilesNotSyncingCount *int64 `json:"transientFilesNotSyncingCount,omitempty" azure:"ro"`
}

ServerEndpointSyncSessionStatus - Sync Session status object.

func (ServerEndpointSyncSessionStatus) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type ServerEndpointSyncSessionStatus.

func (*ServerEndpointSyncSessionStatus) UnmarshalJSON 

func (s *ServerEndpointSyncSessionStatus) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ServerEndpointSyncSessionStatus.

type ServerEndpointSyncStatus 

type ServerEndpointSyncStatus struct {
	// READ-ONLY; Background data download activity
	BackgroundDataDownloadActivity *ServerEndpointBackgroundDataDownloadActivity `json:"backgroundDataDownloadActivity,omitempty" azure:"ro"`

	// READ-ONLY; Combined Health Status.
	CombinedHealth *ServerEndpointHealthState `json:"combinedHealth,omitempty" azure:"ro"`

	// READ-ONLY; Download sync activity
	DownloadActivity *ServerEndpointSyncActivityStatus `json:"downloadActivity,omitempty" azure:"ro"`

	// READ-ONLY; Download Health Status.
	DownloadHealth *ServerEndpointHealthState `json:"downloadHealth,omitempty" azure:"ro"`

	// READ-ONLY; Download Status
	DownloadStatus *ServerEndpointSyncSessionStatus `json:"downloadStatus,omitempty" azure:"ro"`

	// READ-ONLY; Last Updated Timestamp
	LastUpdatedTimestamp *time.Time `json:"lastUpdatedTimestamp,omitempty" azure:"ro"`

	// READ-ONLY; Offline Data Transfer State
	OfflineDataTransferStatus *ServerEndpointOfflineDataTransferState `json:"offlineDataTransferStatus,omitempty" azure:"ro"`

	// READ-ONLY; Sync activity
	SyncActivity *ServerEndpointSyncActivityState `json:"syncActivity,omitempty" azure:"ro"`

	// READ-ONLY; Total count of persistent files not syncing (combined upload + download).
	TotalPersistentFilesNotSyncingCount *int64 `json:"totalPersistentFilesNotSyncingCount,omitempty" azure:"ro"`

	// READ-ONLY; Upload sync activity
	UploadActivity *ServerEndpointSyncActivityStatus `json:"uploadActivity,omitempty" azure:"ro"`

	// READ-ONLY; Upload Health Status.
	UploadHealth *ServerEndpointHealthState `json:"uploadHealth,omitempty" azure:"ro"`

	// READ-ONLY; Upload Status
	UploadStatus *ServerEndpointSyncSessionStatus `json:"uploadStatus,omitempty" azure:"ro"`
}

ServerEndpointSyncStatus - Server Endpoint sync status

func (ServerEndpointSyncStatus) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type ServerEndpointSyncStatus.

func (*ServerEndpointSyncStatus) UnmarshalJSON 

func (s *ServerEndpointSyncStatus) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ServerEndpointSyncStatus.

type ServerEndpointUpdateParameters 

type ServerEndpointUpdateParameters struct {
	// The properties of the server endpoint.
	Properties *ServerEndpointUpdateProperties `json:"properties,omitempty"`
}

ServerEndpointUpdateParameters - Parameters for updating an Server Endpoint.

func (ServerEndpointUpdateParameters) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type ServerEndpointUpdateParameters.

type ServerEndpointUpdateProperties 

type ServerEndpointUpdateProperties struct {
	// Cloud Tiering.
	CloudTiering *FeatureStatus `json:"cloudTiering,omitempty"`

	// Policy for enabling follow-the-sun business models: link local cache to cloud behavior to pre-populate before local access.
	LocalCacheMode *LocalCacheMode `json:"localCacheMode,omitempty"`

	// Offline data transfer
	OfflineDataTransfer *FeatureStatus `json:"offlineDataTransfer,omitempty"`

	// Offline data transfer share name
	OfflineDataTransferShareName *string `json:"offlineDataTransferShareName,omitempty"`

	// Tier files older than days.
	TierFilesOlderThanDays *int32 `json:"tierFilesOlderThanDays,omitempty"`

	// Level of free space to be maintained by Cloud Tiering if it is enabled.
	VolumeFreeSpacePercent *int32 `json:"volumeFreeSpacePercent,omitempty"`
}

ServerEndpointUpdateProperties - ServerEndpoint Update Properties object.

type ServerEndpointsClient 

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

ServerEndpointsClient contains the methods for the ServerEndpoints group. Don't use this type directly, use NewServerEndpointsClient() instead.

func NewServerEndpointsClient 

func NewServerEndpointsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *ServerEndpointsClient

NewServerEndpointsClient creates a new instance of ServerEndpointsClient with the specified values. subscriptionID - The ID of the target subscription. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*ServerEndpointsClient) BeginCreate 

func (client *ServerEndpointsClient) BeginCreate(ctx context.Context, resourceGroupName string, storageSyncServiceName string, syncGroupName string, serverEndpointName string, parameters ServerEndpointCreateParameters, options *ServerEndpointsClientBeginCreateOptions) (ServerEndpointsClientCreatePollerResponse, error)

BeginCreate - Create a new ServerEndpoint. If the operation fails it returns an *azcore.ResponseError type. 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. options - ServerEndpointsClientBeginCreateOptions contains the optional parameters for the ServerEndpointsClient.BeginCreate method.

Example

x-ms-original-file: specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2020-09-01/examples/ServerEndpoints_Create.json 

package main

import (
	"context"
	"log"

	"time"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/storagesync/armstoragesync"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armstoragesync.NewServerEndpointsClient("<subscription-id>", cred, nil)
	poller, err := client.BeginCreate(ctx,
		"<resource-group-name>",
		"<storage-sync-service-name>",
		"<sync-group-name>",
		"<server-endpoint-name>",
		armstoragesync.ServerEndpointCreateParameters{
			Properties: &armstoragesync.ServerEndpointCreateParametersProperties{
				CloudTiering:                 armstoragesync.FeatureStatus("off").ToPtr(),
				InitialDownloadPolicy:        armstoragesync.InitialDownloadPolicy("NamespaceThenModifiedFiles").ToPtr(),
				InitialUploadPolicy:          armstoragesync.InitialUploadPolicy("ServerAuthoritative").ToPtr(),
				LocalCacheMode:               armstoragesync.LocalCacheMode("UpdateLocallyCachedFiles").ToPtr(),
				OfflineDataTransfer:          armstoragesync.FeatureStatus("on").ToPtr(),
				OfflineDataTransferShareName: to.StringPtr("<offline-data-transfer-share-name>"),
				ServerLocalPath:              to.StringPtr("<server-local-path>"),
				ServerResourceID:             to.StringPtr("<server-resource-id>"),
				TierFilesOlderThanDays:       to.Int32Ptr(0),
				VolumeFreeSpacePercent:       to.Int32Ptr(100),
			},
		},
		nil)
	if err != nil {
		log.Fatal(err)
	}
	res, err := poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.ServerEndpointsClientCreateResult)
}

Output:

func (*ServerEndpointsClient) BeginDelete 

func (client *ServerEndpointsClient) BeginDelete(ctx context.Context, resourceGroupName string, storageSyncServiceName string, syncGroupName string, serverEndpointName string, options *ServerEndpointsClientBeginDeleteOptions) (ServerEndpointsClientDeletePollerResponse, error)

BeginDelete - Delete a given ServerEndpoint. If the operation fails it returns an *azcore.ResponseError type. 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. options - ServerEndpointsClientBeginDeleteOptions contains the optional parameters for the ServerEndpointsClient.BeginDelete method.

Example

x-ms-original-file: specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2020-09-01/examples/ServerEndpoints_Delete.json 

package main

import (
	"context"
	"log"

	"time"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/storagesync/armstoragesync"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armstoragesync.NewServerEndpointsClient("<subscription-id>", cred, nil)
	poller, err := client.BeginDelete(ctx,
		"<resource-group-name>",
		"<storage-sync-service-name>",
		"<sync-group-name>",
		"<server-endpoint-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	_, err = poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
}

Output:

func (*ServerEndpointsClient) BeginRecallAction 

func (client *ServerEndpointsClient) BeginRecallAction(ctx context.Context, resourceGroupName string, storageSyncServiceName string, syncGroupName string, serverEndpointName string, parameters RecallActionParameters, options *ServerEndpointsClientBeginRecallActionOptions) (ServerEndpointsClientRecallActionPollerResponse, error)

BeginRecallAction - Recall a server endpoint. If the operation fails it returns an *azcore.ResponseError type. 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. options - ServerEndpointsClientBeginRecallActionOptions contains the optional parameters for the ServerEndpointsClient.BeginRecallAction method.

Example

x-ms-original-file: specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2020-09-01/examples/ServerEndpoints_Recall.json 

package main

import (
	"context"
	"log"

	"time"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/storagesync/armstoragesync"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armstoragesync.NewServerEndpointsClient("<subscription-id>", cred, nil)
	poller, err := client.BeginRecallAction(ctx,
		"<resource-group-name>",
		"<storage-sync-service-name>",
		"<sync-group-name>",
		"<server-endpoint-name>",
		armstoragesync.RecallActionParameters{
			Pattern:    to.StringPtr("<pattern>"),
			RecallPath: to.StringPtr("<recall-path>"),
		},
		nil)
	if err != nil {
		log.Fatal(err)
	}
	_, err = poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
}

Output:

func (*ServerEndpointsClient) BeginUpdate 

func (client *ServerEndpointsClient) BeginUpdate(ctx context.Context, resourceGroupName string, storageSyncServiceName string, syncGroupName string, serverEndpointName string, options *ServerEndpointsClientBeginUpdateOptions) (ServerEndpointsClientUpdatePollerResponse, error)

BeginUpdate - Patch a given ServerEndpoint. If the operation fails it returns an *azcore.ResponseError type. 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. options - ServerEndpointsClientBeginUpdateOptions contains the optional parameters for the ServerEndpointsClient.BeginUpdate method.

Example

x-ms-original-file: specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2020-09-01/examples/ServerEndpoints_Update.json 

package main

import (
	"context"
	"log"

	"time"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/storagesync/armstoragesync"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armstoragesync.NewServerEndpointsClient("<subscription-id>", cred, nil)
	poller, err := client.BeginUpdate(ctx,
		"<resource-group-name>",
		"<storage-sync-service-name>",
		"<sync-group-name>",
		"<server-endpoint-name>",
		&armstoragesync.ServerEndpointsClientBeginUpdateOptions{Parameters: &armstoragesync.ServerEndpointUpdateParameters{
			Properties: &armstoragesync.ServerEndpointUpdateProperties{
				CloudTiering:           armstoragesync.FeatureStatus("off").ToPtr(),
				LocalCacheMode:         armstoragesync.LocalCacheMode("UpdateLocallyCachedFiles").ToPtr(),
				OfflineDataTransfer:    armstoragesync.FeatureStatus("off").ToPtr(),
				TierFilesOlderThanDays: to.Int32Ptr(0),
				VolumeFreeSpacePercent: to.Int32Ptr(100),
			},
		},
		})
	if err != nil {
		log.Fatal(err)
	}
	res, err := poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.ServerEndpointsClientUpdateResult)
}

Output:

func (*ServerEndpointsClient) Get 

func (client *ServerEndpointsClient) Get(ctx context.Context, resourceGroupName string, storageSyncServiceName string, syncGroupName string, serverEndpointName string, options *ServerEndpointsClientGetOptions) (ServerEndpointsClientGetResponse, error)

Get - Get a ServerEndpoint. If the operation fails it returns an *azcore.ResponseError type. 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. options - ServerEndpointsClientGetOptions contains the optional parameters for the ServerEndpointsClient.Get method.

Example

x-ms-original-file: specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2020-09-01/examples/ServerEndpoints_Get.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/storagesync/armstoragesync"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armstoragesync.NewServerEndpointsClient("<subscription-id>", cred, nil)
	res, err := client.Get(ctx,
		"<resource-group-name>",
		"<storage-sync-service-name>",
		"<sync-group-name>",
		"<server-endpoint-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.ServerEndpointsClientGetResult)
}

Output:

func (*ServerEndpointsClient) ListBySyncGroup 

func (client *ServerEndpointsClient) ListBySyncGroup(ctx context.Context, resourceGroupName string, storageSyncServiceName string, syncGroupName string, options *ServerEndpointsClientListBySyncGroupOptions) (ServerEndpointsClientListBySyncGroupResponse, error)

ListBySyncGroup - Get a ServerEndpoint list. If the operation fails it returns an *azcore.ResponseError type. 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. options - ServerEndpointsClientListBySyncGroupOptions contains the optional parameters for the ServerEndpointsClient.ListBySyncGroup method.

Example

x-ms-original-file: specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2020-09-01/examples/ServerEndpoints_ListBySyncGroup.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/storagesync/armstoragesync"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armstoragesync.NewServerEndpointsClient("<subscription-id>", cred, nil)
	res, err := client.ListBySyncGroup(ctx,
		"<resource-group-name>",
		"<storage-sync-service-name>",
		"<sync-group-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.ServerEndpointsClientListBySyncGroupResult)
}

Output:

type ServerEndpointsClientBeginCreateOptions added in v0.2.0 

type ServerEndpointsClientBeginCreateOptions struct {
}

ServerEndpointsClientBeginCreateOptions contains the optional parameters for the ServerEndpointsClient.BeginCreate method.

type ServerEndpointsClientBeginDeleteOptions added in v0.2.0 

type ServerEndpointsClientBeginDeleteOptions struct {
}

ServerEndpointsClientBeginDeleteOptions contains the optional parameters for the ServerEndpointsClient.BeginDelete method.

type ServerEndpointsClientBeginRecallActionOptions added in v0.2.0 

type ServerEndpointsClientBeginRecallActionOptions struct {
}

ServerEndpointsClientBeginRecallActionOptions contains the optional parameters for the ServerEndpointsClient.BeginRecallAction method.

type ServerEndpointsClientBeginUpdateOptions added in v0.2.0 

type ServerEndpointsClientBeginUpdateOptions struct {
	// Any of the properties applicable in PUT request.
	Parameters *ServerEndpointUpdateParameters
}

ServerEndpointsClientBeginUpdateOptions contains the optional parameters for the ServerEndpointsClient.BeginUpdate method.

type ServerEndpointsClientCreatePoller added in v0.2.0 

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

ServerEndpointsClientCreatePoller provides polling facilities until the operation reaches a terminal state.

func (*ServerEndpointsClientCreatePoller) Done added in v0.2.0 

func (p *ServerEndpointsClientCreatePoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*ServerEndpointsClientCreatePoller) FinalResponse added in v0.2.0 

func (p *ServerEndpointsClientCreatePoller) FinalResponse(ctx context.Context) (ServerEndpointsClientCreateResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final ServerEndpointsClientCreateResponse will be returned.

func (*ServerEndpointsClientCreatePoller) Poll added in v0.2.0 

func (p *ServerEndpointsClientCreatePoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*ServerEndpointsClientCreatePoller) ResumeToken added in v0.2.0 

func (p *ServerEndpointsClientCreatePoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type ServerEndpointsClientCreatePollerResponse added in v0.2.0 

type ServerEndpointsClientCreatePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *ServerEndpointsClientCreatePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ServerEndpointsClientCreatePollerResponse contains the response from method ServerEndpointsClient.Create.

func (ServerEndpointsClientCreatePollerResponse) PollUntilDone added in v0.2.0 

func (l ServerEndpointsClientCreatePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (ServerEndpointsClientCreateResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*ServerEndpointsClientCreatePollerResponse) Resume added in v0.2.0 

func (l *ServerEndpointsClientCreatePollerResponse) Resume(ctx context.Context, client *ServerEndpointsClient, token string) error

Resume rehydrates a ServerEndpointsClientCreatePollerResponse from the provided client and resume token.

type ServerEndpointsClientCreateResponse added in v0.2.0 

type ServerEndpointsClientCreateResponse struct {
	ServerEndpointsClientCreateResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ServerEndpointsClientCreateResponse contains the response from method ServerEndpointsClient.Create.

type ServerEndpointsClientCreateResult added in v0.2.0 

type ServerEndpointsClientCreateResult struct {
	ServerEndpoint
}

ServerEndpointsClientCreateResult contains the result from method ServerEndpointsClient.Create.

type ServerEndpointsClientDeletePoller added in v0.2.0 

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

ServerEndpointsClientDeletePoller provides polling facilities until the operation reaches a terminal state.

func (*ServerEndpointsClientDeletePoller) Done added in v0.2.0 

func (p *ServerEndpointsClientDeletePoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*ServerEndpointsClientDeletePoller) FinalResponse added in v0.2.0 

func (p *ServerEndpointsClientDeletePoller) FinalResponse(ctx context.Context) (ServerEndpointsClientDeleteResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final ServerEndpointsClientDeleteResponse will be returned.

func (*ServerEndpointsClientDeletePoller) Poll added in v0.2.0 

func (p *ServerEndpointsClientDeletePoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*ServerEndpointsClientDeletePoller) ResumeToken added in v0.2.0 

func (p *ServerEndpointsClientDeletePoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type ServerEndpointsClientDeletePollerResponse added in v0.2.0 

type ServerEndpointsClientDeletePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *ServerEndpointsClientDeletePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ServerEndpointsClientDeletePollerResponse contains the response from method ServerEndpointsClient.Delete.

func (ServerEndpointsClientDeletePollerResponse) PollUntilDone added in v0.2.0 

func (l ServerEndpointsClientDeletePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (ServerEndpointsClientDeleteResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*ServerEndpointsClientDeletePollerResponse) Resume added in v0.2.0 

func (l *ServerEndpointsClientDeletePollerResponse) Resume(ctx context.Context, client *ServerEndpointsClient, token string) error

Resume rehydrates a ServerEndpointsClientDeletePollerResponse from the provided client and resume token.

type ServerEndpointsClientDeleteResponse added in v0.2.0 

type ServerEndpointsClientDeleteResponse struct {
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ServerEndpointsClientDeleteResponse contains the response from method ServerEndpointsClient.Delete.

type ServerEndpointsClientGetOptions added in v0.2.0 

type ServerEndpointsClientGetOptions struct {
}

ServerEndpointsClientGetOptions contains the optional parameters for the ServerEndpointsClient.Get method.

type ServerEndpointsClientGetResponse added in v0.2.0 

type ServerEndpointsClientGetResponse struct {
	ServerEndpointsClientGetResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ServerEndpointsClientGetResponse contains the response from method ServerEndpointsClient.Get.

type ServerEndpointsClientGetResult added in v0.2.0 

type ServerEndpointsClientGetResult struct {
	ServerEndpoint
	// XMSCorrelationRequestID contains the information returned from the x-ms-correlation-request-id header response.
	XMSCorrelationRequestID *string

	// XMSRequestID contains the information returned from the x-ms-request-id header response.
	XMSRequestID *string
}

ServerEndpointsClientGetResult contains the result from method ServerEndpointsClient.Get.

type ServerEndpointsClientListBySyncGroupOptions added in v0.2.0 

type ServerEndpointsClientListBySyncGroupOptions struct {
}

ServerEndpointsClientListBySyncGroupOptions contains the optional parameters for the ServerEndpointsClient.ListBySyncGroup method.

type ServerEndpointsClientListBySyncGroupResponse added in v0.2.0 

type ServerEndpointsClientListBySyncGroupResponse struct {
	ServerEndpointsClientListBySyncGroupResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ServerEndpointsClientListBySyncGroupResponse contains the response from method ServerEndpointsClient.ListBySyncGroup.

type ServerEndpointsClientListBySyncGroupResult added in v0.2.0 

type ServerEndpointsClientListBySyncGroupResult struct {
	ServerEndpointArray
	// Location contains the information returned from the Location header response.
	Location *string

	// XMSCorrelationRequestID contains the information returned from the x-ms-correlation-request-id header response.
	XMSCorrelationRequestID *string

	// XMSRequestID contains the information returned from the x-ms-request-id header response.
	XMSRequestID *string
}

ServerEndpointsClientListBySyncGroupResult contains the result from method ServerEndpointsClient.ListBySyncGroup.

type ServerEndpointsClientRecallActionPoller added in v0.2.0 

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

ServerEndpointsClientRecallActionPoller provides polling facilities until the operation reaches a terminal state.

func (*ServerEndpointsClientRecallActionPoller) Done added in v0.2.0 

func (p *ServerEndpointsClientRecallActionPoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*ServerEndpointsClientRecallActionPoller) FinalResponse added in v0.2.0 

func (p *ServerEndpointsClientRecallActionPoller) FinalResponse(ctx context.Context) (ServerEndpointsClientRecallActionResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final ServerEndpointsClientRecallActionResponse will be returned.

func (*ServerEndpointsClientRecallActionPoller) Poll added in v0.2.0 

func (p *ServerEndpointsClientRecallActionPoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*ServerEndpointsClientRecallActionPoller) ResumeToken added in v0.2.0 

func (p *ServerEndpointsClientRecallActionPoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type ServerEndpointsClientRecallActionPollerResponse added in v0.2.0 

type ServerEndpointsClientRecallActionPollerResponse struct {
	// Poller contains an initialized poller.
	Poller *ServerEndpointsClientRecallActionPoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ServerEndpointsClientRecallActionPollerResponse contains the response from method ServerEndpointsClient.RecallAction.

func (ServerEndpointsClientRecallActionPollerResponse) PollUntilDone added in v0.2.0 

func (l ServerEndpointsClientRecallActionPollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (ServerEndpointsClientRecallActionResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*ServerEndpointsClientRecallActionPollerResponse) Resume added in v0.2.0 

func (l *ServerEndpointsClientRecallActionPollerResponse) Resume(ctx context.Context, client *ServerEndpointsClient, token string) error

Resume rehydrates a ServerEndpointsClientRecallActionPollerResponse from the provided client and resume token.

type ServerEndpointsClientRecallActionResponse added in v0.2.0 

type ServerEndpointsClientRecallActionResponse struct {
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ServerEndpointsClientRecallActionResponse contains the response from method ServerEndpointsClient.RecallAction.

type ServerEndpointsClientUpdatePoller added in v0.2.0 

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

ServerEndpointsClientUpdatePoller provides polling facilities until the operation reaches a terminal state.

func (*ServerEndpointsClientUpdatePoller) Done added in v0.2.0 

func (p *ServerEndpointsClientUpdatePoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*ServerEndpointsClientUpdatePoller) FinalResponse added in v0.2.0 

func (p *ServerEndpointsClientUpdatePoller) FinalResponse(ctx context.Context) (ServerEndpointsClientUpdateResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final ServerEndpointsClientUpdateResponse will be returned.

func (*ServerEndpointsClientUpdatePoller) Poll added in v0.2.0 

func (p *ServerEndpointsClientUpdatePoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*ServerEndpointsClientUpdatePoller) ResumeToken added in v0.2.0 

func (p *ServerEndpointsClientUpdatePoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type ServerEndpointsClientUpdatePollerResponse added in v0.2.0 

type ServerEndpointsClientUpdatePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *ServerEndpointsClientUpdatePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ServerEndpointsClientUpdatePollerResponse contains the response from method ServerEndpointsClient.Update.

func (ServerEndpointsClientUpdatePollerResponse) PollUntilDone added in v0.2.0 

func (l ServerEndpointsClientUpdatePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (ServerEndpointsClientUpdateResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*ServerEndpointsClientUpdatePollerResponse) Resume added in v0.2.0 

func (l *ServerEndpointsClientUpdatePollerResponse) Resume(ctx context.Context, client *ServerEndpointsClient, token string) error

Resume rehydrates a ServerEndpointsClientUpdatePollerResponse from the provided client and resume token.

type ServerEndpointsClientUpdateResponse added in v0.2.0 

type ServerEndpointsClientUpdateResponse struct {
	ServerEndpointsClientUpdateResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ServerEndpointsClientUpdateResponse contains the response from method ServerEndpointsClient.Update.

type ServerEndpointsClientUpdateResult added in v0.2.0 

type ServerEndpointsClientUpdateResult struct {
	ServerEndpoint
}

ServerEndpointsClientUpdateResult contains the result from method ServerEndpointsClient.Update.

type Service added in v0.2.0 

type Service struct {
	// REQUIRED; The geo-location where the resource lives
	Location *string `json:"location,omitempty"`

	// Storage Sync Service properties.
	Properties *ServiceProperties `json:"properties,omitempty"`

	// Resource tags.
	Tags map[string]*string `json:"tags,omitempty"`

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; The name of the resource
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string `json:"type,omitempty" azure:"ro"`
}

Service - Storage Sync Service object.

func (Service) MarshalJSON added in v0.2.0 

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

MarshalJSON implements the json.Marshaller interface for type Service.

type ServiceArray added in v0.2.0 

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

ServiceArray - Array of StorageSyncServices

func (ServiceArray) MarshalJSON added in v0.2.0 

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

MarshalJSON implements the json.Marshaller interface for type ServiceArray.

type ServiceCreateParameters added in v0.2.0 

type ServiceCreateParameters struct {
	// REQUIRED; 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"`

	// The parameters used to create the storage sync service.
	Properties *ServiceCreateParametersProperties `json:"properties,omitempty"`

	// 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,omitempty"`
}

ServiceCreateParameters - The parameters used when creating a storage sync service.

func (ServiceCreateParameters) MarshalJSON added in v0.2.0 

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

MarshalJSON implements the json.Marshaller interface for type ServiceCreateParameters.

type ServiceCreateParametersProperties added in v0.2.0 

type ServiceCreateParametersProperties struct {
	// Incoming Traffic Policy
	IncomingTrafficPolicy *IncomingTrafficPolicy `json:"incomingTrafficPolicy,omitempty"`
}

ServiceCreateParametersProperties - StorageSyncService Properties object.

type ServiceProperties added in v0.2.0 

type ServiceProperties struct {
	// Incoming Traffic Policy
	IncomingTrafficPolicy *IncomingTrafficPolicy `json:"incomingTrafficPolicy,omitempty"`

	// READ-ONLY; Resource Last Operation Name
	LastOperationName *string `json:"lastOperationName,omitempty" azure:"ro"`

	// READ-ONLY; StorageSyncService lastWorkflowId
	LastWorkflowID *string `json:"lastWorkflowId,omitempty" azure:"ro"`

	// READ-ONLY; List of private endpoint connection associated with the specified storage sync service
	PrivateEndpointConnections []*PrivateEndpointConnection `json:"privateEndpointConnections,omitempty" azure:"ro"`

	// READ-ONLY; StorageSyncService Provisioning State
	ProvisioningState *string `json:"provisioningState,omitempty" azure:"ro"`

	// READ-ONLY; Storage Sync service status.
	StorageSyncServiceStatus *int32 `json:"storageSyncServiceStatus,omitempty" azure:"ro"`

	// READ-ONLY; Storage Sync service Uid
	StorageSyncServiceUID *string `json:"storageSyncServiceUid,omitempty" azure:"ro"`
}

ServiceProperties - Storage Sync Service Properties object.

func (ServiceProperties) MarshalJSON added in v0.2.0 

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

MarshalJSON implements the json.Marshaller interface for type ServiceProperties.

type ServiceUpdateParameters added in v0.2.0 

type ServiceUpdateParameters struct {
	// The properties of the server endpoint.
	Properties *ServiceUpdateProperties `json:"properties,omitempty"`

	// The user-specified tags associated with the storage sync service.
	Tags map[string]*string `json:"tags,omitempty"`
}

ServiceUpdateParameters - Parameters for updating an Storage sync service.

func (ServiceUpdateParameters) MarshalJSON added in v0.2.0 

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

MarshalJSON implements the json.Marshaller interface for type ServiceUpdateParameters.

type ServiceUpdateProperties added in v0.2.0 

type ServiceUpdateProperties struct {
	// Incoming Traffic Policy
	IncomingTrafficPolicy *IncomingTrafficPolicy `json:"incomingTrafficPolicy,omitempty"`
}

ServiceUpdateProperties - StorageSyncService Properties object.

type ServicesClient added in v0.2.0 

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

ServicesClient contains the methods for the StorageSyncServices group. Don't use this type directly, use NewServicesClient() instead.

func NewServicesClient added in v0.2.0 

func NewServicesClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *ServicesClient

NewServicesClient creates a new instance of ServicesClient with the specified values. subscriptionID - The ID of the target subscription. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*ServicesClient) BeginCreate added in v0.2.0 

func (client *ServicesClient) BeginCreate(ctx context.Context, resourceGroupName string, storageSyncServiceName string, parameters ServiceCreateParameters, options *ServicesClientBeginCreateOptions) (ServicesClientCreatePollerResponse, error)

BeginCreate - Create a new StorageSyncService. If the operation fails it returns an *azcore.ResponseError type. 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. options - ServicesClientBeginCreateOptions contains the optional parameters for the ServicesClient.BeginCreate method.

Example

x-ms-original-file: specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2020-09-01/examples/StorageSyncServices_Create.json 

package main

import (
	"context"
	"log"

	"time"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/storagesync/armstoragesync"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armstoragesync.NewServicesClient("<subscription-id>", cred, nil)
	poller, err := client.BeginCreate(ctx,
		"<resource-group-name>",
		"<storage-sync-service-name>",
		armstoragesync.ServiceCreateParameters{
			Location: to.StringPtr("<location>"),
			Properties: &armstoragesync.ServiceCreateParametersProperties{
				IncomingTrafficPolicy: armstoragesync.IncomingTrafficPolicy("AllowAllTraffic").ToPtr(),
			},
			Tags: map[string]*string{},
		},
		nil)
	if err != nil {
		log.Fatal(err)
	}
	res, err := poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.ServicesClientCreateResult)
}

Output:

func (*ServicesClient) BeginDelete added in v0.2.0 

func (client *ServicesClient) BeginDelete(ctx context.Context, resourceGroupName string, storageSyncServiceName string, options *ServicesClientBeginDeleteOptions) (ServicesClientDeletePollerResponse, error)

BeginDelete - Delete a given StorageSyncService. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. The name is case insensitive. storageSyncServiceName - Name of Storage Sync Service resource. options - ServicesClientBeginDeleteOptions contains the optional parameters for the ServicesClient.BeginDelete method.

Example

x-ms-original-file: specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2020-09-01/examples/StorageSyncServices_Delete.json 

package main

import (
	"context"
	"log"

	"time"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/storagesync/armstoragesync"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armstoragesync.NewServicesClient("<subscription-id>", cred, nil)
	poller, err := client.BeginDelete(ctx,
		"<resource-group-name>",
		"<storage-sync-service-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	_, err = poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
}

Output:

func (*ServicesClient) BeginUpdate added in v0.2.0 

func (client *ServicesClient) BeginUpdate(ctx context.Context, resourceGroupName string, storageSyncServiceName string, options *ServicesClientBeginUpdateOptions) (ServicesClientUpdatePollerResponse, error)

BeginUpdate - Patch a given StorageSyncService. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. The name is case insensitive. storageSyncServiceName - Name of Storage Sync Service resource. options - ServicesClientBeginUpdateOptions contains the optional parameters for the ServicesClient.BeginUpdate method.

Example

x-ms-original-file: specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2020-09-01/examples/StorageSyncServices_Update.json 

package main

import (
	"context"
	"log"

	"time"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/storagesync/armstoragesync"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armstoragesync.NewServicesClient("<subscription-id>", cred, nil)
	poller, err := client.BeginUpdate(ctx,
		"<resource-group-name>",
		"<storage-sync-service-name>",
		&armstoragesync.ServicesClientBeginUpdateOptions{Parameters: &armstoragesync.ServiceUpdateParameters{
			Properties: &armstoragesync.ServiceUpdateProperties{
				IncomingTrafficPolicy: armstoragesync.IncomingTrafficPolicy("AllowAllTraffic").ToPtr(),
			},
			Tags: map[string]*string{
				"Dept":        to.StringPtr("IT"),
				"Environment": to.StringPtr("Test"),
			},
		},
		})
	if err != nil {
		log.Fatal(err)
	}
	res, err := poller.PollUntilDone(ctx, 30*time.Second)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.ServicesClientUpdateResult)
}

Output:

func (*ServicesClient) CheckNameAvailability added in v0.2.0 

func (client *ServicesClient) CheckNameAvailability(ctx context.Context, locationName string, parameters CheckNameAvailabilityParameters, options *ServicesClientCheckNameAvailabilityOptions) (ServicesClientCheckNameAvailabilityResponse, error)

CheckNameAvailability - Check the give namespace name availability. If the operation fails it returns an *azcore.ResponseError type. locationName - The desired region for the name check. parameters - Parameters to check availability of the given namespace name options - ServicesClientCheckNameAvailabilityOptions contains the optional parameters for the ServicesClient.CheckNameAvailability method.

Example

x-ms-original-file: specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2020-09-01/examples/StorageSyncServiceCheckNameAvailability_AlreadyExists.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/storagesync/armstoragesync"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armstoragesync.NewServicesClient("<subscription-id>", cred, nil)
	res, err := client.CheckNameAvailability(ctx,
		"<location-name>",
		armstoragesync.CheckNameAvailabilityParameters{
			Name: to.StringPtr("<name>"),
			Type: to.StringPtr("<type>"),
		},
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.ServicesClientCheckNameAvailabilityResult)
}

Output:

func (*ServicesClient) Get added in v0.2.0 

func (client *ServicesClient) Get(ctx context.Context, resourceGroupName string, storageSyncServiceName string, options *ServicesClientGetOptions) (ServicesClientGetResponse, error)

Get - Get a given StorageSyncService. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. The name is case insensitive. storageSyncServiceName - Name of Storage Sync Service resource. options - ServicesClientGetOptions contains the optional parameters for the ServicesClient.Get method.

Example

x-ms-original-file: specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2020-09-01/examples/StorageSyncServices_Get.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/storagesync/armstoragesync"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armstoragesync.NewServicesClient("<subscription-id>", cred, nil)
	res, err := client.Get(ctx,
		"<resource-group-name>",
		"<storage-sync-service-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.ServicesClientGetResult)
}

Output:

func (*ServicesClient) ListByResourceGroup added in v0.2.0 

func (client *ServicesClient) ListByResourceGroup(ctx context.Context, resourceGroupName string, options *ServicesClientListByResourceGroupOptions) (ServicesClientListByResourceGroupResponse, error)

ListByResourceGroup - Get a StorageSyncService list by Resource group name. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. The name is case insensitive. options - ServicesClientListByResourceGroupOptions contains the optional parameters for the ServicesClient.ListByResourceGroup method.

Example

x-ms-original-file: specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2020-09-01/examples/StorageSyncServices_ListByResourceGroup.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/storagesync/armstoragesync"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armstoragesync.NewServicesClient("<subscription-id>", cred, nil)
	res, err := client.ListByResourceGroup(ctx,
		"<resource-group-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.ServicesClientListByResourceGroupResult)
}

Output:

func (*ServicesClient) ListBySubscription added in v0.2.0 

func (client *ServicesClient) ListBySubscription(ctx context.Context, options *ServicesClientListBySubscriptionOptions) (ServicesClientListBySubscriptionResponse, error)

ListBySubscription - Get a StorageSyncService list by subscription. If the operation fails it returns an *azcore.ResponseError type. options - ServicesClientListBySubscriptionOptions contains the optional parameters for the ServicesClient.ListBySubscription method.

Example

x-ms-original-file: specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2020-09-01/examples/StorageSyncServices_ListBySubscription.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/storagesync/armstoragesync"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armstoragesync.NewServicesClient("<subscription-id>", cred, nil)
	res, err := client.ListBySubscription(ctx,
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.ServicesClientListBySubscriptionResult)
}

Output:

type ServicesClientBeginCreateOptions added in v0.2.0 

type ServicesClientBeginCreateOptions struct {
}

ServicesClientBeginCreateOptions contains the optional parameters for the ServicesClient.BeginCreate method.

type ServicesClientBeginDeleteOptions added in v0.2.0 

type ServicesClientBeginDeleteOptions struct {
}

ServicesClientBeginDeleteOptions contains the optional parameters for the ServicesClient.BeginDelete method.

type ServicesClientBeginUpdateOptions added in v0.2.0 

type ServicesClientBeginUpdateOptions struct {
	// Storage Sync Service resource.
	Parameters *ServiceUpdateParameters
}

ServicesClientBeginUpdateOptions contains the optional parameters for the ServicesClient.BeginUpdate method.

type ServicesClientCheckNameAvailabilityOptions added in v0.2.0 

type ServicesClientCheckNameAvailabilityOptions struct {
}

ServicesClientCheckNameAvailabilityOptions contains the optional parameters for the ServicesClient.CheckNameAvailability method.

type ServicesClientCheckNameAvailabilityResponse added in v0.2.0 

type ServicesClientCheckNameAvailabilityResponse struct {
	ServicesClientCheckNameAvailabilityResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ServicesClientCheckNameAvailabilityResponse contains the response from method ServicesClient.CheckNameAvailability.

type ServicesClientCheckNameAvailabilityResult added in v0.2.0 

type ServicesClientCheckNameAvailabilityResult struct {
	CheckNameAvailabilityResult
}

ServicesClientCheckNameAvailabilityResult contains the result from method ServicesClient.CheckNameAvailability.

type ServicesClientCreatePoller added in v0.2.0 

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

ServicesClientCreatePoller provides polling facilities until the operation reaches a terminal state.

func (*ServicesClientCreatePoller) Done added in v0.2.0 

func (p *ServicesClientCreatePoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*ServicesClientCreatePoller) FinalResponse added in v0.2.0 

func (p *ServicesClientCreatePoller) FinalResponse(ctx context.Context) (ServicesClientCreateResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final ServicesClientCreateResponse will be returned.

func (*ServicesClientCreatePoller) Poll added in v0.2.0 

func (p *ServicesClientCreatePoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*ServicesClientCreatePoller) ResumeToken added in v0.2.0 

func (p *ServicesClientCreatePoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type ServicesClientCreatePollerResponse added in v0.2.0 

type ServicesClientCreatePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *ServicesClientCreatePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ServicesClientCreatePollerResponse contains the response from method ServicesClient.Create.

func (ServicesClientCreatePollerResponse) PollUntilDone added in v0.2.0 

func (l ServicesClientCreatePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (ServicesClientCreateResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*ServicesClientCreatePollerResponse) Resume added in v0.2.0 

func (l *ServicesClientCreatePollerResponse) Resume(ctx context.Context, client *ServicesClient, token string) error

Resume rehydrates a ServicesClientCreatePollerResponse from the provided client and resume token.

type ServicesClientCreateResponse added in v0.2.0 

type ServicesClientCreateResponse struct {
	ServicesClientCreateResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ServicesClientCreateResponse contains the response from method ServicesClient.Create.

type ServicesClientCreateResult added in v0.2.0 

type ServicesClientCreateResult struct {
	Service
}

ServicesClientCreateResult contains the result from method ServicesClient.Create.

type ServicesClientDeletePoller added in v0.2.0 

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

ServicesClientDeletePoller provides polling facilities until the operation reaches a terminal state.

func (*ServicesClientDeletePoller) Done added in v0.2.0 

func (p *ServicesClientDeletePoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*ServicesClientDeletePoller) FinalResponse added in v0.2.0 

func (p *ServicesClientDeletePoller) FinalResponse(ctx context.Context) (ServicesClientDeleteResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final ServicesClientDeleteResponse will be returned.

func (*ServicesClientDeletePoller) Poll added in v0.2.0 

func (p *ServicesClientDeletePoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*ServicesClientDeletePoller) ResumeToken added in v0.2.0 

func (p *ServicesClientDeletePoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type ServicesClientDeletePollerResponse added in v0.2.0 

type ServicesClientDeletePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *ServicesClientDeletePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ServicesClientDeletePollerResponse contains the response from method ServicesClient.Delete.

func (ServicesClientDeletePollerResponse) PollUntilDone added in v0.2.0 

func (l ServicesClientDeletePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (ServicesClientDeleteResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*ServicesClientDeletePollerResponse) Resume added in v0.2.0 

func (l *ServicesClientDeletePollerResponse) Resume(ctx context.Context, client *ServicesClient, token string) error

Resume rehydrates a ServicesClientDeletePollerResponse from the provided client and resume token.

type ServicesClientDeleteResponse added in v0.2.0 

type ServicesClientDeleteResponse struct {
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ServicesClientDeleteResponse contains the response from method ServicesClient.Delete.

type ServicesClientGetOptions added in v0.2.0 

type ServicesClientGetOptions struct {
}

ServicesClientGetOptions contains the optional parameters for the ServicesClient.Get method.

type ServicesClientGetResponse added in v0.2.0 

type ServicesClientGetResponse struct {
	ServicesClientGetResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ServicesClientGetResponse contains the response from method ServicesClient.Get.

type ServicesClientGetResult added in v0.2.0 

type ServicesClientGetResult struct {
	Service
	// XMSCorrelationRequestID contains the information returned from the x-ms-correlation-request-id header response.
	XMSCorrelationRequestID *string

	// XMSRequestID contains the information returned from the x-ms-request-id header response.
	XMSRequestID *string
}

ServicesClientGetResult contains the result from method ServicesClient.Get.

type ServicesClientListByResourceGroupOptions added in v0.2.0 

type ServicesClientListByResourceGroupOptions struct {
}

ServicesClientListByResourceGroupOptions contains the optional parameters for the ServicesClient.ListByResourceGroup method.

type ServicesClientListByResourceGroupResponse added in v0.2.0 

type ServicesClientListByResourceGroupResponse struct {
	ServicesClientListByResourceGroupResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ServicesClientListByResourceGroupResponse contains the response from method ServicesClient.ListByResourceGroup.

type ServicesClientListByResourceGroupResult added in v0.2.0 

type ServicesClientListByResourceGroupResult struct {
	ServiceArray
	// XMSCorrelationRequestID contains the information returned from the x-ms-correlation-request-id header response.
	XMSCorrelationRequestID *string

	// XMSRequestID contains the information returned from the x-ms-request-id header response.
	XMSRequestID *string
}

ServicesClientListByResourceGroupResult contains the result from method ServicesClient.ListByResourceGroup.

type ServicesClientListBySubscriptionOptions added in v0.2.0 

type ServicesClientListBySubscriptionOptions struct {
}

ServicesClientListBySubscriptionOptions contains the optional parameters for the ServicesClient.ListBySubscription method.

type ServicesClientListBySubscriptionResponse added in v0.2.0 

type ServicesClientListBySubscriptionResponse struct {
	ServicesClientListBySubscriptionResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ServicesClientListBySubscriptionResponse contains the response from method ServicesClient.ListBySubscription.

type ServicesClientListBySubscriptionResult added in v0.2.0 

type ServicesClientListBySubscriptionResult struct {
	ServiceArray
	// XMSCorrelationRequestID contains the information returned from the x-ms-correlation-request-id header response.
	XMSCorrelationRequestID *string

	// XMSRequestID contains the information returned from the x-ms-request-id header response.
	XMSRequestID *string
}

ServicesClientListBySubscriptionResult contains the result from method ServicesClient.ListBySubscription.

type ServicesClientUpdatePoller added in v0.2.0 

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

ServicesClientUpdatePoller provides polling facilities until the operation reaches a terminal state.

func (*ServicesClientUpdatePoller) Done added in v0.2.0 

func (p *ServicesClientUpdatePoller) Done() bool

Done returns true if the LRO has reached a terminal state.

func (*ServicesClientUpdatePoller) FinalResponse added in v0.2.0 

func (p *ServicesClientUpdatePoller) FinalResponse(ctx context.Context) (ServicesClientUpdateResponse, error)

FinalResponse performs a final GET to the service and returns the final response for the polling operation. If there is an error performing the final GET then an error is returned. If the final GET succeeded then the final ServicesClientUpdateResponse will be returned.

func (*ServicesClientUpdatePoller) Poll added in v0.2.0 

func (p *ServicesClientUpdatePoller) Poll(ctx context.Context) (*http.Response, error)

Poll fetches the latest state of the LRO. It returns an HTTP response or error. If the LRO has completed successfully, the poller's state is updated and the HTTP response is returned. If the LRO has completed with failure or was cancelled, the poller's state is updated and the error is returned. If the LRO has not reached a terminal state, the poller's state is updated and the latest HTTP response is returned. If Poll fails, the poller's state is unmodified and the error is returned. Calling Poll on an LRO that has reached a terminal state will return the final HTTP response or error.

func (*ServicesClientUpdatePoller) ResumeToken added in v0.2.0 

func (p *ServicesClientUpdatePoller) ResumeToken() (string, error)

ResumeToken returns a value representing the poller that can be used to resume the LRO at a later time. ResumeTokens are unique per service operation.

type ServicesClientUpdatePollerResponse added in v0.2.0 

type ServicesClientUpdatePollerResponse struct {
	// Poller contains an initialized poller.
	Poller *ServicesClientUpdatePoller

	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ServicesClientUpdatePollerResponse contains the response from method ServicesClient.Update.

func (ServicesClientUpdatePollerResponse) PollUntilDone added in v0.2.0 

func (l ServicesClientUpdatePollerResponse) PollUntilDone(ctx context.Context, freq time.Duration) (ServicesClientUpdateResponse, error)

PollUntilDone will poll the service endpoint until a terminal state is reached or an error is received. freq: the time to wait between intervals in absence of a Retry-After header. Allowed minimum is one second. A good starting value is 30 seconds. Note that some resources might benefit from a different value.

func (*ServicesClientUpdatePollerResponse) Resume added in v0.2.0 

func (l *ServicesClientUpdatePollerResponse) Resume(ctx context.Context, client *ServicesClient, token string) error

Resume rehydrates a ServicesClientUpdatePollerResponse from the provided client and resume token.

type ServicesClientUpdateResponse added in v0.2.0 

type ServicesClientUpdateResponse struct {
	ServicesClientUpdateResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

ServicesClientUpdateResponse contains the response from method ServicesClient.Update.

type ServicesClientUpdateResult added in v0.2.0 

type ServicesClientUpdateResult struct {
	Service
}

ServicesClientUpdateResult contains the result from method ServicesClient.Update.

type SubscriptionState 

type SubscriptionState struct {
	// Subscription state properties.
	Properties map[string]interface{} `json:"properties,omitempty"`

	// State of Azure Subscription
	State *Reason `json:"state,omitempty"`

	// READ-ONLY; Is Transitioning
	Istransitioning *bool `json:"istransitioning,omitempty" azure:"ro"`
}

SubscriptionState - Subscription State object.

type SyncGroup 

type SyncGroup struct {
	// SyncGroup properties.
	Properties *SyncGroupProperties `json:"properties,omitempty"`

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; The name of the resource
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string `json:"type,omitempty" azure:"ro"`
}

SyncGroup - Sync Group object.

type SyncGroupArray 

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

SyncGroupArray - Array of SyncGroup

func (SyncGroupArray) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type SyncGroupArray.

type SyncGroupCreateParameters 

type SyncGroupCreateParameters struct {
	// The parameters used to create the sync group
	Properties map[string]interface{} `json:"properties,omitempty"`

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; The name of the resource
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string `json:"type,omitempty" azure:"ro"`
}

SyncGroupCreateParameters - The parameters used when creating a sync group.

type SyncGroupProperties 

type SyncGroupProperties struct {
	// READ-ONLY; Sync group status
	SyncGroupStatus *string `json:"syncGroupStatus,omitempty" azure:"ro"`

	// READ-ONLY; Unique Id
	UniqueID *string `json:"uniqueId,omitempty" azure:"ro"`
}

SyncGroupProperties - SyncGroup Properties object.

type SyncGroupsClient 

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

SyncGroupsClient contains the methods for the SyncGroups group. Don't use this type directly, use NewSyncGroupsClient() instead.

func NewSyncGroupsClient 

func NewSyncGroupsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *SyncGroupsClient

NewSyncGroupsClient creates a new instance of SyncGroupsClient with the specified values. subscriptionID - The ID of the target subscription. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*SyncGroupsClient) Create 

func (client *SyncGroupsClient) Create(ctx context.Context, resourceGroupName string, storageSyncServiceName string, syncGroupName string, parameters SyncGroupCreateParameters, options *SyncGroupsClientCreateOptions) (SyncGroupsClientCreateResponse, error)

Create - Create a new SyncGroup. If the operation fails it returns an *azcore.ResponseError type. 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 options - SyncGroupsClientCreateOptions contains the optional parameters for the SyncGroupsClient.Create method.

Example

x-ms-original-file: specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2020-09-01/examples/SyncGroups_Create.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/storagesync/armstoragesync"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armstoragesync.NewSyncGroupsClient("<subscription-id>", cred, nil)
	res, err := client.Create(ctx,
		"<resource-group-name>",
		"<storage-sync-service-name>",
		"<sync-group-name>",
		armstoragesync.SyncGroupCreateParameters{
			Properties: map[string]interface{}{},
		},
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.SyncGroupsClientCreateResult)
}

Output:

func (*SyncGroupsClient) Delete 

func (client *SyncGroupsClient) Delete(ctx context.Context, resourceGroupName string, storageSyncServiceName string, syncGroupName string, options *SyncGroupsClientDeleteOptions) (SyncGroupsClientDeleteResponse, error)

Delete - Delete a given SyncGroup. If the operation fails it returns an *azcore.ResponseError type. 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. options - SyncGroupsClientDeleteOptions contains the optional parameters for the SyncGroupsClient.Delete method.

Example

x-ms-original-file: specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2020-09-01/examples/SyncGroups_Delete.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/storagesync/armstoragesync"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armstoragesync.NewSyncGroupsClient("<subscription-id>", cred, nil)
	_, err = client.Delete(ctx,
		"<resource-group-name>",
		"<storage-sync-service-name>",
		"<sync-group-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
}

Output:

func (*SyncGroupsClient) Get 

func (client *SyncGroupsClient) Get(ctx context.Context, resourceGroupName string, storageSyncServiceName string, syncGroupName string, options *SyncGroupsClientGetOptions) (SyncGroupsClientGetResponse, error)

Get - Get a given SyncGroup. If the operation fails it returns an *azcore.ResponseError type. 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. options - SyncGroupsClientGetOptions contains the optional parameters for the SyncGroupsClient.Get method.

Example

x-ms-original-file: specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2020-09-01/examples/SyncGroups_Get.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/storagesync/armstoragesync"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armstoragesync.NewSyncGroupsClient("<subscription-id>", cred, nil)
	res, err := client.Get(ctx,
		"<resource-group-name>",
		"<storage-sync-service-name>",
		"<sync-group-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.SyncGroupsClientGetResult)
}

Output:

func (*SyncGroupsClient) ListByStorageSyncService 

func (client *SyncGroupsClient) ListByStorageSyncService(ctx context.Context, resourceGroupName string, storageSyncServiceName string, options *SyncGroupsClientListByStorageSyncServiceOptions) (SyncGroupsClientListByStorageSyncServiceResponse, error)

ListByStorageSyncService - Get a SyncGroup List. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. The name is case insensitive. storageSyncServiceName - Name of Storage Sync Service resource. options - SyncGroupsClientListByStorageSyncServiceOptions contains the optional parameters for the SyncGroupsClient.ListByStorageSyncService method.

Example

x-ms-original-file: specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2020-09-01/examples/SyncGroups_ListByStorageSyncService.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/storagesync/armstoragesync"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armstoragesync.NewSyncGroupsClient("<subscription-id>", cred, nil)
	res, err := client.ListByStorageSyncService(ctx,
		"<resource-group-name>",
		"<storage-sync-service-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.SyncGroupsClientListByStorageSyncServiceResult)
}

Output:

type SyncGroupsClientCreateOptions added in v0.2.0 

type SyncGroupsClientCreateOptions struct {
}

SyncGroupsClientCreateOptions contains the optional parameters for the SyncGroupsClient.Create method.

type SyncGroupsClientCreateResponse added in v0.2.0 

type SyncGroupsClientCreateResponse struct {
	SyncGroupsClientCreateResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

SyncGroupsClientCreateResponse contains the response from method SyncGroupsClient.Create.

type SyncGroupsClientCreateResult added in v0.2.0 

type SyncGroupsClientCreateResult struct {
	SyncGroup
	// XMSCorrelationRequestID contains the information returned from the x-ms-correlation-request-id header response.
	XMSCorrelationRequestID *string

	// XMSRequestID contains the information returned from the x-ms-request-id header response.
	XMSRequestID *string
}

SyncGroupsClientCreateResult contains the result from method SyncGroupsClient.Create.

type SyncGroupsClientDeleteOptions added in v0.2.0 

type SyncGroupsClientDeleteOptions struct {
}

SyncGroupsClientDeleteOptions contains the optional parameters for the SyncGroupsClient.Delete method.

type SyncGroupsClientDeleteResponse added in v0.2.0 

type SyncGroupsClientDeleteResponse struct {
	SyncGroupsClientDeleteResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

SyncGroupsClientDeleteResponse contains the response from method SyncGroupsClient.Delete.

type SyncGroupsClientDeleteResult added in v0.2.0 

type SyncGroupsClientDeleteResult struct {
	// XMSCorrelationRequestID contains the information returned from the x-ms-correlation-request-id header response.
	XMSCorrelationRequestID *string

	// XMSRequestID contains the information returned from the x-ms-request-id header response.
	XMSRequestID *string
}

SyncGroupsClientDeleteResult contains the result from method SyncGroupsClient.Delete.

type SyncGroupsClientGetOptions added in v0.2.0 

type SyncGroupsClientGetOptions struct {
}

SyncGroupsClientGetOptions contains the optional parameters for the SyncGroupsClient.Get method.

type SyncGroupsClientGetResponse added in v0.2.0 

type SyncGroupsClientGetResponse struct {
	SyncGroupsClientGetResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

SyncGroupsClientGetResponse contains the response from method SyncGroupsClient.Get.

type SyncGroupsClientGetResult added in v0.2.0 

type SyncGroupsClientGetResult struct {
	SyncGroup
	// XMSCorrelationRequestID contains the information returned from the x-ms-correlation-request-id header response.
	XMSCorrelationRequestID *string

	// XMSRequestID contains the information returned from the x-ms-request-id header response.
	XMSRequestID *string
}

SyncGroupsClientGetResult contains the result from method SyncGroupsClient.Get.

type SyncGroupsClientListByStorageSyncServiceOptions added in v0.2.0 

type SyncGroupsClientListByStorageSyncServiceOptions struct {
}

SyncGroupsClientListByStorageSyncServiceOptions contains the optional parameters for the SyncGroupsClient.ListByStorageSyncService method.

type SyncGroupsClientListByStorageSyncServiceResponse added in v0.2.0 

type SyncGroupsClientListByStorageSyncServiceResponse struct {
	SyncGroupsClientListByStorageSyncServiceResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

SyncGroupsClientListByStorageSyncServiceResponse contains the response from method SyncGroupsClient.ListByStorageSyncService.

type SyncGroupsClientListByStorageSyncServiceResult added in v0.2.0 

type SyncGroupsClientListByStorageSyncServiceResult struct {
	SyncGroupArray
	// XMSCorrelationRequestID contains the information returned from the x-ms-correlation-request-id header response.
	XMSCorrelationRequestID *string

	// XMSRequestID contains the information returned from the x-ms-request-id header response.
	XMSRequestID *string
}

SyncGroupsClientListByStorageSyncServiceResult contains the result from method SyncGroupsClient.ListByStorageSyncService.

type TrackedResource 

type TrackedResource struct {
	// REQUIRED; The geo-location where the resource lives
	Location *string `json:"location,omitempty"`

	// Resource tags.
	Tags map[string]*string `json:"tags,omitempty"`

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; The name of the resource
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string `json:"type,omitempty" azure:"ro"`
}

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

func (TrackedResource) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type TrackedResource.

type TriggerChangeDetectionParameters 

type TriggerChangeDetectionParameters struct {
	// Change Detection Mode. Applies to a directory specified in directoryPath parameter.
	ChangeDetectionMode *ChangeDetectionMode `json:"changeDetectionMode,omitempty"`

	// Relative path to a directory Azure File share for which change detection is to be performed.
	DirectoryPath *string `json:"directoryPath,omitempty"`

	// 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.

func (TriggerChangeDetectionParameters) MarshalJSON 

func (t TriggerChangeDetectionParameters) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type TriggerChangeDetectionParameters.

type TriggerRolloverRequest 

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

TriggerRolloverRequest - Trigger Rollover Request.

type Workflow 

type Workflow struct {
	// Workflow properties.
	Properties *WorkflowProperties `json:"properties,omitempty"`

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; The name of the resource
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string `json:"type,omitempty" azure:"ro"`
}

Workflow resource.

type WorkflowArray 

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

WorkflowArray - Array of Workflow

func (WorkflowArray) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type WorkflowArray.

type WorkflowProperties 

type WorkflowProperties struct {
	// workflow last operation identifier.
	LastOperationID *string `json:"lastOperationId,omitempty"`

	// last step name
	LastStepName *string `json:"lastStepName,omitempty"`

	// operation direction.
	Operation *OperationDirection `json:"operation,omitempty"`

	// workflow status.
	Status *WorkflowStatus `json:"status,omitempty"`

	// workflow steps
	Steps *string `json:"steps,omitempty"`

	// READ-ONLY; workflow command name.
	CommandName *string `json:"commandName,omitempty" azure:"ro"`

	// READ-ONLY; workflow created timestamp.
	CreatedTimestamp *time.Time `json:"createdTimestamp,omitempty" azure:"ro"`

	// READ-ONLY; workflow last status timestamp.
	LastStatusTimestamp *time.Time `json:"lastStatusTimestamp,omitempty" azure:"ro"`
}

WorkflowProperties - Workflow Properties object.

func (WorkflowProperties) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type WorkflowProperties.

func (*WorkflowProperties) UnmarshalJSON 

func (w *WorkflowProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type WorkflowProperties.

type WorkflowStatus 

type WorkflowStatus string

WorkflowStatus - Type of the Workflow Status 

const (
	WorkflowStatusAborted   WorkflowStatus = "aborted"
	WorkflowStatusActive    WorkflowStatus = "active"
	WorkflowStatusExpired   WorkflowStatus = "expired"
	WorkflowStatusFailed    WorkflowStatus = "failed"
	WorkflowStatusSucceeded WorkflowStatus = "succeeded"
)

func PossibleWorkflowStatusValues 

func PossibleWorkflowStatusValues() []WorkflowStatus

PossibleWorkflowStatusValues returns the possible values for the WorkflowStatus const type.

func (WorkflowStatus) ToPtr 

func (c WorkflowStatus) ToPtr() *WorkflowStatus

ToPtr returns a *WorkflowStatus pointing to the current value.

type WorkflowsClient 

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

WorkflowsClient contains the methods for the Workflows group. Don't use this type directly, use NewWorkflowsClient() instead.

func NewWorkflowsClient 

func NewWorkflowsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) *WorkflowsClient

NewWorkflowsClient creates a new instance of WorkflowsClient with the specified values. subscriptionID - The ID of the target subscription. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*WorkflowsClient) Abort 

func (client *WorkflowsClient) Abort(ctx context.Context, resourceGroupName string, storageSyncServiceName string, workflowID string, options *WorkflowsClientAbortOptions) (WorkflowsClientAbortResponse, error)

Abort - Abort the given workflow. If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. The name is case insensitive. storageSyncServiceName - Name of Storage Sync Service resource. workflowID - workflow Id options - WorkflowsClientAbortOptions contains the optional parameters for the WorkflowsClient.Abort method.

Example

x-ms-original-file: specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2020-09-01/examples/Workflows_Abort.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/storagesync/armstoragesync"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armstoragesync.NewWorkflowsClient("<subscription-id>", cred, nil)
	_, err = client.Abort(ctx,
		"<resource-group-name>",
		"<storage-sync-service-name>",
		"<workflow-id>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
}

Output:

func (*WorkflowsClient) Get 

func (client *WorkflowsClient) Get(ctx context.Context, resourceGroupName string, storageSyncServiceName string, workflowID string, options *WorkflowsClientGetOptions) (WorkflowsClientGetResponse, error)

Get - Get Workflows resource If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. The name is case insensitive. storageSyncServiceName - Name of Storage Sync Service resource. workflowID - workflow Id options - WorkflowsClientGetOptions contains the optional parameters for the WorkflowsClient.Get method.

Example

x-ms-original-file: specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2020-09-01/examples/Workflows_Get.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/storagesync/armstoragesync"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armstoragesync.NewWorkflowsClient("<subscription-id>", cred, nil)
	res, err := client.Get(ctx,
		"<resource-group-name>",
		"<storage-sync-service-name>",
		"<workflow-id>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.WorkflowsClientGetResult)
}

Output:

func (*WorkflowsClient) ListByStorageSyncService 

func (client *WorkflowsClient) ListByStorageSyncService(ctx context.Context, resourceGroupName string, storageSyncServiceName string, options *WorkflowsClientListByStorageSyncServiceOptions) (WorkflowsClientListByStorageSyncServiceResponse, error)

ListByStorageSyncService - Get a Workflow List If the operation fails it returns an *azcore.ResponseError type. resourceGroupName - The name of the resource group. The name is case insensitive. storageSyncServiceName - Name of Storage Sync Service resource. options - WorkflowsClientListByStorageSyncServiceOptions contains the optional parameters for the WorkflowsClient.ListByStorageSyncService method.

Example

x-ms-original-file: specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2020-09-01/examples/Workflows_ListByStorageSyncService.json 

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/storagesync/armstoragesync"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client := armstoragesync.NewWorkflowsClient("<subscription-id>", cred, nil)
	res, err := client.ListByStorageSyncService(ctx,
		"<resource-group-name>",
		"<storage-sync-service-name>",
		nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Printf("Response result: %#v\n", res.WorkflowsClientListByStorageSyncServiceResult)
}

Output:

type WorkflowsClientAbortOptions added in v0.2.0 

type WorkflowsClientAbortOptions struct {
}

WorkflowsClientAbortOptions contains the optional parameters for the WorkflowsClient.Abort method.

type WorkflowsClientAbortResponse added in v0.2.0 

type WorkflowsClientAbortResponse struct {
	WorkflowsClientAbortResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

WorkflowsClientAbortResponse contains the response from method WorkflowsClient.Abort.

type WorkflowsClientAbortResult added in v0.2.0 

type WorkflowsClientAbortResult struct {
	// XMSCorrelationRequestID contains the information returned from the x-ms-correlation-request-id header response.
	XMSCorrelationRequestID *string

	// XMSRequestID contains the information returned from the x-ms-request-id header response.
	XMSRequestID *string
}

WorkflowsClientAbortResult contains the result from method WorkflowsClient.Abort.

type WorkflowsClientGetOptions added in v0.2.0 

type WorkflowsClientGetOptions struct {
}

WorkflowsClientGetOptions contains the optional parameters for the WorkflowsClient.Get method.

type WorkflowsClientGetResponse added in v0.2.0 

type WorkflowsClientGetResponse struct {
	WorkflowsClientGetResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

WorkflowsClientGetResponse contains the response from method WorkflowsClient.Get.

type WorkflowsClientGetResult added in v0.2.0 

type WorkflowsClientGetResult struct {
	Workflow
	// XMSCorrelationRequestID contains the information returned from the x-ms-correlation-request-id header response.
	XMSCorrelationRequestID *string

	// XMSRequestID contains the information returned from the x-ms-request-id header response.
	XMSRequestID *string
}

WorkflowsClientGetResult contains the result from method WorkflowsClient.Get.

type WorkflowsClientListByStorageSyncServiceOptions added in v0.2.0 

type WorkflowsClientListByStorageSyncServiceOptions struct {
}

WorkflowsClientListByStorageSyncServiceOptions contains the optional parameters for the WorkflowsClient.ListByStorageSyncService method.

type WorkflowsClientListByStorageSyncServiceResponse added in v0.2.0 

type WorkflowsClientListByStorageSyncServiceResponse struct {
	WorkflowsClientListByStorageSyncServiceResult
	// RawResponse contains the underlying HTTP response.
	RawResponse *http.Response
}

WorkflowsClientListByStorageSyncServiceResponse contains the response from method WorkflowsClient.ListByStorageSyncService.

type WorkflowsClientListByStorageSyncServiceResult added in v0.2.0 

type WorkflowsClientListByStorageSyncServiceResult struct {
	WorkflowArray
	// XMSCorrelationRequestID contains the information returned from the x-ms-correlation-request-id header response.
	XMSCorrelationRequestID *string

	// XMSRequestID contains the information returned from the x-ms-request-id header response.
	XMSRequestID *string
}

WorkflowsClientListByStorageSyncServiceResult contains the result from method WorkflowsClient.ListByStorageSyncService.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.