azure.mgmt.storagesync.models module¶

class azure.mgmt.storagesync.models.BackupRequest(*, azure_file_share: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.storagesync._serialization.Model

Backup request.

Variables: azure_file_share (str) – Azure File Share.
Keyword Arguments: azure_file_share (str) – Azure File Share.

class azure.mgmt.storagesync.models.ChangeDetectionMode(value)[source]¶

Bases: str, enum.Enum

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

DEFAULT = 'Default'¶

RECURSIVE = 'Recursive'¶

class azure.mgmt.storagesync.models.CheckNameAvailabilityParameters(*, name: str, **kwargs)[source]¶

Bases: azure.mgmt.storagesync._serialization.Model

Parameters for a check name availability request.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables

name (str) – The name to check for availability. Required.
type (str) – The resource type. Must be set to Microsoft.StorageSync/storageSyncServices. Required. Default value is “Microsoft.StorageSync/storageSyncServices”.

Keyword Arguments

name (str) – The name to check for availability. Required.

type = 'Microsoft.StorageSync/storageSyncServices'¶

class azure.mgmt.storagesync.models.CheckNameAvailabilityResult(**kwargs)[source]¶

Bases: azure.mgmt.storagesync._serialization.Model

The CheckNameAvailability operation response.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

name_available (bool) – 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.
reason (str or NameAvailabilityReason) – Gets the reason that a Storage Sync Service name could not be used. The Reason element is only returned if NameAvailable is false. Known values are: “Invalid” and “AlreadyExists”.
message (str) – Gets an error message explaining the Reason value in more detail.

class azure.mgmt.storagesync.models.CloudEndpoint(*, storage_account_resource_id: Optional[str] = None, azure_file_share_name: Optional[str] = None, storage_account_tenant_id: Optional[str] = None, partnership_id: Optional[str] = None, friendly_name: Optional[str] = None, provisioning_state: Optional[str] = None, last_workflow_id: Optional[str] = None, last_operation_name: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.storagesync.models._models_py3.ProxyResource

Cloud Endpoint object.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name (str) – The name of the resource.
type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.
system_data (SystemData) – Azure Resource Manager metadata containing createdBy and modifiedBy information.
storage_account_resource_id (str) – Storage Account Resource Id.
azure_file_share_name (str) – Azure file share name.
storage_account_tenant_id (str) – Storage Account Tenant Id.
partnership_id (str) – Partnership Id.
friendly_name (str) – Friendly Name.
backup_enabled (str) – Backup Enabled.
provisioning_state (str) – CloudEndpoint Provisioning State.
last_workflow_id (str) – CloudEndpoint lastWorkflowId.
last_operation_name (str) – Resource Last Operation Name.
change_enumeration_status (CloudEndpointChangeEnumerationStatus) – Cloud endpoint change enumeration status.

Keyword Arguments

storage_account_resource_id (str) – Storage Account Resource Id.
azure_file_share_name (str) – Azure file share name.
storage_account_tenant_id (str) – Storage Account Tenant Id.
partnership_id (str) – Partnership Id.
friendly_name (str) – Friendly Name.
provisioning_state (str) – CloudEndpoint Provisioning State.
last_workflow_id (str) – CloudEndpoint lastWorkflowId.
last_operation_name (str) – Resource Last Operation Name.

class azure.mgmt.storagesync.models.CloudEndpointAfsShareMetadataCertificatePublicKeys(**kwargs)[source]¶

Bases: azure.mgmt.storagesync._serialization.Model

Cloud endpoint AFS file share metadata signing certificate public keys.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

first_key (str) – The first public key.
second_key (str) – The second public key.

class azure.mgmt.storagesync.models.CloudEndpointArray(*, value: Optional[List[_models.CloudEndpoint]] = None, **kwargs)[source]¶

Bases: azure.mgmt.storagesync._serialization.Model

Array of CloudEndpoint.

Variables: value (list[CloudEndpoint]) – Collection of CloudEndpoint.
Keyword Arguments: value (list[CloudEndpoint]) – Collection of CloudEndpoint.

class azure.mgmt.storagesync.models.CloudEndpointChangeEnumerationActivity(**kwargs)[source]¶

Bases: azure.mgmt.storagesync._serialization.Model

Cloud endpoint change enumeration activity object.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

last_updated_timestamp (datetime) – Last updated timestamp.
operation_state (str or CloudEndpointChangeEnumerationActivityState) – Change enumeration operation state. Known values are: “InitialEnumerationInProgress” and “EnumerationInProgress”.
status_code (int) – When non-zero, indicates an issue that is delaying change enumeration.
started_timestamp (datetime) – Timestamp when change enumeration started.
processed_files_count (int) – Count of files processed.
processed_directories_count (int) – Count of directories processed.
total_files_count (int) – Total count of files enumerated.
total_directories_count (int) – Total count of directories enumerated.
total_size_bytes (int) – Total enumerated size in bytes.
progress_percent (int) – Progress percentage for change enumeration run, excluding processing of deletes.
minutes_remaining (int) – Estimate of time remaining for the enumeration run.
total_counts_state (str or CloudEndpointChangeEnumerationTotalCountsState) – Change enumeration total counts state. Known values are: “Calculating” and “Final”.
deletes_progress_percent (int) – Progress percentage for processing deletes. This is done separately from the rest of the enumeration run.

class azure.mgmt.storagesync.models.CloudEndpointChangeEnumerationActivityState(value)[source]¶

Bases: str, enum.Enum

State of change enumeration activity.

ENUMERATION_IN_PROGRESS = 'EnumerationInProgress'¶

INITIAL_ENUMERATION_IN_PROGRESS = 'InitialEnumerationInProgress'¶

class azure.mgmt.storagesync.models.CloudEndpointChangeEnumerationStatus(**kwargs)[source]¶

Bases: azure.mgmt.storagesync._serialization.Model

Cloud endpoint change enumeration status object.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

last_updated_timestamp (datetime) – Last updated timestamp.
last_enumeration_status (CloudEndpointLastChangeEnumerationStatus) – Status of last completed change enumeration.
activity (CloudEndpointChangeEnumerationActivity) – Change enumeration activity.

class azure.mgmt.storagesync.models.CloudEndpointChangeEnumerationTotalCountsState(value)[source]¶

Bases: str, enum.Enum

State of the total counts of change enumeration activity.

CALCULATING = 'Calculating'¶

FINAL = 'Final'¶

class azure.mgmt.storagesync.models.CloudEndpointCreateParameters(*, storage_account_resource_id: Optional[str] = None, azure_file_share_name: Optional[str] = None, storage_account_tenant_id: Optional[str] = None, friendly_name: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.storagesync.models._models_py3.ProxyResource

The parameters used when creating a cloud endpoint.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name (str) – The name of the resource.
type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.
system_data (SystemData) – Azure Resource Manager metadata containing createdBy and modifiedBy information.
storage_account_resource_id (str) – Storage Account Resource Id.
azure_file_share_name (str) – Azure file share name.
storage_account_tenant_id (str) – Storage Account Tenant Id.
friendly_name (str) – Friendly Name.

Keyword Arguments

storage_account_resource_id (str) – Storage Account Resource Id.
azure_file_share_name (str) – Azure file share name.
storage_account_tenant_id (str) – Storage Account Tenant Id.
friendly_name (str) – Friendly Name.

class azure.mgmt.storagesync.models.CloudEndpointLastChangeEnumerationStatus(**kwargs)[source]¶

Bases: azure.mgmt.storagesync._serialization.Model

Cloud endpoint change enumeration status object.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

started_timestamp (datetime) – Timestamp when change enumeration started.
completed_timestamp (datetime) – Timestamp when change enumeration completed.
namespace_files_count (int) – Count of files in the namespace.
namespace_directories_count (int) – Count of directories in the namespace.
namespace_size_bytes (int) – Namespace size in bytes.
next_run_timestamp (datetime) – Timestamp of when change enumeration is expected to run again.

class azure.mgmt.storagesync.models.CloudTieringCachePerformance(**kwargs)[source]¶

Bases: azure.mgmt.storagesync._serialization.Model

Server endpoint cloud tiering status object.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

last_updated_timestamp (datetime) – Last updated timestamp.
cache_hit_bytes (int) – Count of bytes that were served from the local server.
cache_miss_bytes (int) – Count of bytes that were served from the cloud.
cache_hit_bytes_percent (int) – Percentage of total bytes (hit + miss) that were served from the local server.

class azure.mgmt.storagesync.models.CloudTieringDatePolicyStatus(**kwargs)[source]¶

Bases: azure.mgmt.storagesync._serialization.Model

Status of the date policy.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

last_updated_timestamp (datetime) – Last updated timestamp.
tiered_files_most_recent_access_timestamp (datetime) – Most recent access time of tiered files.

class azure.mgmt.storagesync.models.CloudTieringFilesNotTiering(**kwargs)[source]¶

Bases: azure.mgmt.storagesync._serialization.Model

Server endpoint cloud tiering status object.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

last_updated_timestamp (datetime) – Last updated timestamp.
total_file_count (int) – Last cloud tiering result (HResult).
errors (list[FilesNotTieringError]) – Array of tiering errors.

class azure.mgmt.storagesync.models.CloudTieringLowDiskMode(**kwargs)[source]¶

Bases: azure.mgmt.storagesync._serialization.Model

Information regarding the low disk mode state.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

last_updated_timestamp (datetime) – Last updated timestamp.
state (str or CloudTieringLowDiskModeState) – Low disk mode state. Known values are: “Enabled” and “Disabled”.

class azure.mgmt.storagesync.models.CloudTieringLowDiskModeState(value)[source]¶

Bases: str, enum.Enum

Type of the cloud tiering low disk mode state.

DISABLED = 'Disabled'¶

ENABLED = 'Enabled'¶

class azure.mgmt.storagesync.models.CloudTieringSpaceSavings(**kwargs)[source]¶

Bases: azure.mgmt.storagesync._serialization.Model

Server endpoint cloud tiering status object.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

last_updated_timestamp (datetime) – Last updated timestamp.
volume_size_bytes (int) – Volume size.
total_size_cloud_bytes (int) – Total size of content in the azure file share.
cached_size_bytes (int) – Cached content size on the server.
space_savings_percent (int) – Percentage of cached size over total size.
space_savings_bytes (int) – Count of bytes saved on the server.

class azure.mgmt.storagesync.models.CloudTieringVolumeFreeSpacePolicyStatus(**kwargs)[source]¶

Bases: azure.mgmt.storagesync._serialization.Model

Status of the volume free space policy.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

last_updated_timestamp (datetime) – Last updated timestamp.
effective_volume_free_space_policy (int) – In the case where multiple server endpoints are present in a volume, an effective free space policy is applied.
current_volume_free_space_percent (int) – Current volume free space percentage.

class azure.mgmt.storagesync.models.CreatedByType(value)[source]¶

Bases: str, enum.Enum

The type of identity that created the resource.

APPLICATION = 'Application'¶

KEY = 'Key'¶

MANAGED_IDENTITY = 'ManagedIdentity'¶

USER = 'User'¶

class azure.mgmt.storagesync.models.FeatureStatus(value)[source]¶

Bases: str, enum.Enum

Type of the Feature Status.

OFF = 'off'¶

ON = 'on'¶

class azure.mgmt.storagesync.models.FilesNotTieringError(**kwargs)[source]¶

Bases: azure.mgmt.storagesync._serialization.Model

Files not tiering error object.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

error_code (int) – Error code (HResult).
file_count (int) – Count of files with this error.

class azure.mgmt.storagesync.models.IncomingTrafficPolicy(value)[source]¶

Bases: str, enum.Enum

Type of the Incoming Traffic Policy.

ALLOW_ALL_TRAFFIC = 'AllowAllTraffic'¶

ALLOW_VIRTUAL_NETWORKS_ONLY = 'AllowVirtualNetworksOnly'¶

class azure.mgmt.storagesync.models.InitialDownloadPolicy(value)[source]¶

Bases: str, enum.Enum

Policy for how namespace and files are recalled during FastDr.

AVOID_TIERED_FILES = 'AvoidTieredFiles'¶

NAMESPACE_ONLY = 'NamespaceOnly'¶

NAMESPACE_THEN_MODIFIED_FILES = 'NamespaceThenModifiedFiles'¶

class azure.mgmt.storagesync.models.InitialUploadPolicy(value)[source]¶

Bases: str, enum.Enum

Policy for how the initial upload sync session is performed.

MERGE = 'Merge'¶

SERVER_AUTHORITATIVE = 'ServerAuthoritative'¶

class azure.mgmt.storagesync.models.LocalCacheMode(value)[source]¶

Bases: str, enum.Enum

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

DOWNLOAD_NEW_AND_MODIFIED_FILES = 'DownloadNewAndModifiedFiles'¶

UPDATE_LOCALLY_CACHED_FILES = 'UpdateLocallyCachedFiles'¶

class azure.mgmt.storagesync.models.LocationOperationStatus(**kwargs)[source]¶

Bases: azure.mgmt.storagesync._serialization.Model

Operation status object.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – Operation resource Id.
name (str) – Operation Id.
status (str) – Operation status.
start_time (datetime) – Start time of the operation.
end_time (datetime) – End time of the operation.
error (StorageSyncApiError) – Error details.
percent_complete (int) – Percent complete.

class azure.mgmt.storagesync.models.NameAvailabilityReason(value)[source]¶

Bases: str, enum.Enum

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

ALREADY_EXISTS = 'AlreadyExists'¶

INVALID = 'Invalid'¶

class azure.mgmt.storagesync.models.OperationDirection(value)[source]¶

Bases: str, enum.Enum

Type of the Operation Direction.

CANCEL = 'cancel'¶

DO = 'do'¶

UNDO = 'undo'¶

class azure.mgmt.storagesync.models.OperationDisplayInfo(*, description: Optional[str] = None, operation: Optional[str] = None, provider: Optional[str] = None, resource: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.storagesync._serialization.Model

The operation supported by storage sync.

Variables

description (str) – The description of the operation.
operation (str) – The action that users can perform, based on their permission level.
provider (str) – Service provider: Microsoft StorageSync.
resource (str) – Resource on which the operation is performed.

Keyword Arguments

description (str) – The description of the operation.
operation (str) – The action that users can perform, based on their permission level.
provider (str) – Service provider: Microsoft StorageSync.
resource (str) – Resource on which the operation is performed.

class azure.mgmt.storagesync.models.OperationDisplayResource(*, provider: Optional[str] = None, resource: Optional[str] = None, operation: Optional[str] = None, description: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.storagesync._serialization.Model

Operation Display Resource object.

Variables

provider (str) – Operation Display Resource Provider.
resource (str) – Operation Display Resource.
operation (str) – Operation Display Resource Operation.
description (str) – Operation Display Resource Description.

Keyword Arguments

provider (str) – Operation Display Resource Provider.
resource (str) – Operation Display Resource.
operation (str) – Operation Display Resource Operation.
description (str) – Operation Display Resource Description.

class azure.mgmt.storagesync.models.OperationEntity(*, name: Optional[str] = None, display: Optional[_models.OperationDisplayInfo] = None, origin: Optional[str] = None, properties: Optional[_models.OperationProperties] = None, **kwargs)[source]¶

Bases: azure.mgmt.storagesync._serialization.Model

The operation supported by storage sync.

Variables

name (str) – Operation name: {provider}/{resource}/{operation}.
display (OperationDisplayInfo) – The operation supported by storage sync.
origin (str) – The origin.
properties (OperationProperties) – Properties of the operations resource.

Keyword Arguments

name (str) – Operation name: {provider}/{resource}/{operation}.
display (OperationDisplayInfo) – The operation supported by storage sync.
origin (str) – The origin.
properties (OperationProperties) – Properties of the operations resource.

class azure.mgmt.storagesync.models.OperationEntityListResult(*, next_link: Optional[str] = None, value: Optional[List[_models.OperationEntity]] = None, **kwargs)[source]¶

Bases: azure.mgmt.storagesync._serialization.Model

The list of storage sync operations.

Variables

next_link (str) – The link used to get the next page of operations.
value (list[OperationEntity]) – The list of operations.

Keyword Arguments

next_link (str) – The link used to get the next page of operations.
value (list[OperationEntity]) – The list of operations.

class azure.mgmt.storagesync.models.OperationProperties(*, service_specification: Optional[_models.OperationResourceServiceSpecification] = None, **kwargs)[source]¶

Bases: azure.mgmt.storagesync._serialization.Model

Properties of the operations resource.

Variables: service_specification (OperationResourceServiceSpecification) – Service specification for the operations resource.
Keyword Arguments: service_specification (OperationResourceServiceSpecification) – Service specification for the operations resource.

class azure.mgmt.storagesync.models.OperationResourceMetricSpecification(*, name: Optional[str] = None, display_name: Optional[str] = None, display_description: Optional[str] = None, unit: Optional[str] = None, aggregation_type: Optional[str] = None, supported_aggregation_types: Optional[List[str]] = None, fill_gap_with_zero: Optional[bool] = None, dimensions: Optional[List[_models.OperationResourceMetricSpecificationDimension]] = None, **kwargs)[source]¶

Bases: azure.mgmt.storagesync._serialization.Model

Operation Display Resource object.

Variables

name (str) – Name of the metric.
display_name (str) – Display name for the metric.
display_description (str) – Display description for the metric.
unit (str) – Unit for the metric.
aggregation_type (str) – Aggregation type for the metric.
supported_aggregation_types (list[str]) – Supported aggregation types for the metric.
fill_gap_with_zero (bool) – Fill gaps in the metric with zero.
dimensions (list[OperationResourceMetricSpecificationDimension]) – Dimensions for the metric specification.

Keyword Arguments

name (str) – Name of the metric.
display_name (str) – Display name for the metric.
display_description (str) – Display description for the metric.
unit (str) – Unit for the metric.
aggregation_type (str) – Aggregation type for the metric.
supported_aggregation_types (list[str]) – Supported aggregation types for the metric.
fill_gap_with_zero (bool) – Fill gaps in the metric with zero.
dimensions (list[OperationResourceMetricSpecificationDimension]) – Dimensions for the metric specification.

class azure.mgmt.storagesync.models.OperationResourceMetricSpecificationDimension(*, name: Optional[str] = None, display_name: Optional[str] = None, to_be_exported_for_shoebox: Optional[bool] = None, **kwargs)[source]¶

Bases: azure.mgmt.storagesync._serialization.Model

OperationResourceMetricSpecificationDimension object.

Variables

name (str) – Name of the dimension.
display_name (str) – Display name of the dimensions.
to_be_exported_for_shoebox (bool) – Indicates metric should be exported for Shoebox.

Keyword Arguments

name (str) – Name of the dimension.
display_name (str) – Display name of the dimensions.
to_be_exported_for_shoebox (bool) – Indicates metric should be exported for Shoebox.

class azure.mgmt.storagesync.models.OperationResourceServiceSpecification(*, metric_specifications: Optional[List[_models.OperationResourceMetricSpecification]] = None, **kwargs)[source]¶

Bases: azure.mgmt.storagesync._serialization.Model

Service specification.

Variables: metric_specifications (list[OperationResourceMetricSpecification]) – List of metric specifications.
Keyword Arguments: metric_specifications (list[OperationResourceMetricSpecification]) – List of metric specifications.

class azure.mgmt.storagesync.models.OperationStatus(**kwargs)[source]¶

Bases: azure.mgmt.storagesync._serialization.Model

Operation status object.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

name (str) – Operation Id.
status (str) – Operation status.
start_time (datetime) – Start time of the operation.
end_time (datetime) – End time of the operation.
error (StorageSyncApiError) – Error details.

class azure.mgmt.storagesync.models.PostBackupResponse(**kwargs)[source]¶

Bases: azure.mgmt.storagesync._serialization.Model

Post Backup Response.

Variables are only populated by the server, and will be ignored when sending a request.

Variables: cloud_endpoint_name (str) – cloud endpoint Name.

class azure.mgmt.storagesync.models.PostRestoreRequest(*, partition: Optional[str] = None, replica_group: Optional[str] = None, request_id: Optional[str] = None, azure_file_share_uri: Optional[str] = None, status: Optional[str] = None, source_azure_file_share_uri: Optional[str] = None, failed_file_list: Optional[str] = None, restore_file_spec: Optional[List[_models.RestoreFileSpec]] = None, **kwargs)[source]¶

Bases: azure.mgmt.storagesync._serialization.Model

Post Restore Request.

Variables

partition (str) – Post Restore partition.
replica_group (str) – Post Restore replica group.
request_id (str) – Post Restore request id.
azure_file_share_uri (str) – Post Restore Azure file share uri.
status (str) – Post Restore Azure status.
source_azure_file_share_uri (str) – Post Restore Azure source azure file share uri.
failed_file_list (str) – Post Restore Azure failed file list.
restore_file_spec (list[RestoreFileSpec]) – Post Restore restore file spec array.

Keyword Arguments

partition (str) – Post Restore partition.
replica_group (str) – Post Restore replica group.
request_id (str) – Post Restore request id.
azure_file_share_uri (str) – Post Restore Azure file share uri.
status (str) – Post Restore Azure status.
source_azure_file_share_uri (str) – Post Restore Azure source azure file share uri.
failed_file_list (str) – Post Restore Azure failed file list.
restore_file_spec (list[RestoreFileSpec]) – Post Restore restore file spec array.

class azure.mgmt.storagesync.models.PreRestoreRequest(*, partition: Optional[str] = None, replica_group: Optional[str] = None, request_id: Optional[str] = None, azure_file_share_uri: Optional[str] = None, status: Optional[str] = None, source_azure_file_share_uri: Optional[str] = None, backup_metadata_property_bag: Optional[str] = None, restore_file_spec: Optional[List[_models.RestoreFileSpec]] = None, pause_wait_for_sync_drain_time_period_in_seconds: Optional[int] = None, **kwargs)[source]¶

Bases: azure.mgmt.storagesync._serialization.Model

Pre Restore request object.

Variables

partition (str) – Pre Restore partition.
replica_group (str) – Pre Restore replica group.
request_id (str) – Pre Restore request id.
azure_file_share_uri (str) – Pre Restore Azure file share uri.
status (str) – Pre Restore Azure status.
source_azure_file_share_uri (str) – Pre Restore Azure source azure file share uri.
backup_metadata_property_bag (str) – Pre Restore backup metadata property bag.
restore_file_spec (list[RestoreFileSpec]) – Pre Restore restore file spec array.
pause_wait_for_sync_drain_time_period_in_seconds (int) – Pre Restore pause wait for sync drain time period in seconds.

Keyword Arguments

partition (str) – Pre Restore partition.
replica_group (str) – Pre Restore replica group.
request_id (str) – Pre Restore request id.
azure_file_share_uri (str) – Pre Restore Azure file share uri.
status (str) – Pre Restore Azure status.
source_azure_file_share_uri (str) – Pre Restore Azure source azure file share uri.
backup_metadata_property_bag (str) – Pre Restore backup metadata property bag.
restore_file_spec (list[RestoreFileSpec]) – Pre Restore restore file spec array.
pause_wait_for_sync_drain_time_period_in_seconds (int) – Pre Restore pause wait for sync drain time period in seconds.

class azure.mgmt.storagesync.models.PrivateEndpoint(**kwargs)[source]¶

Bases: azure.mgmt.storagesync._serialization.Model

The Private Endpoint resource.

Variables are only populated by the server, and will be ignored when sending a request.

Variables: id (str) – The ARM identifier for Private Endpoint.

class azure.mgmt.storagesync.models.PrivateEndpointConnection(*, private_endpoint: Optional[_models.PrivateEndpoint] = None, private_link_service_connection_state: Optional[_models.PrivateLinkServiceConnectionState] = None, **kwargs)[source]¶

Bases: azure.mgmt.storagesync.models._models_py3.Resource

The Private Endpoint Connection resource.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name (str) – The name of the resource.
type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.
system_data (SystemData) – Azure Resource Manager metadata containing createdBy and modifiedBy information.
private_endpoint (PrivateEndpoint) – The resource of private end point.
private_link_service_connection_state (PrivateLinkServiceConnectionState) – A collection of information about the state of the connection between service consumer and provider.
provisioning_state (str or PrivateEndpointConnectionProvisioningState) – The provisioning state of the private endpoint connection resource. Known values are: “Succeeded”, “Creating”, “Deleting”, and “Failed”.

Keyword Arguments

private_endpoint (PrivateEndpoint) – The resource of private end point.
private_link_service_connection_state (PrivateLinkServiceConnectionState) – A collection of information about the state of the connection between service consumer and provider.

class azure.mgmt.storagesync.models.PrivateEndpointConnectionListResult(*, value: Optional[List[_models.PrivateEndpointConnection]] = None, **kwargs)[source]¶

Bases: azure.mgmt.storagesync._serialization.Model

List of private endpoint connection associated with the specified storage account.

Variables: value (list[PrivateEndpointConnection]) – Array of private endpoint connections.
Keyword Arguments: value (list[PrivateEndpointConnection]) – Array of private endpoint connections.

class azure.mgmt.storagesync.models.PrivateEndpointConnectionProvisioningState(value)[source]¶

Bases: str, enum.Enum

The current provisioning state.

CREATING = 'Creating'¶

DELETING = 'Deleting'¶

FAILED = 'Failed'¶

SUCCEEDED = 'Succeeded'¶

class azure.mgmt.storagesync.models.PrivateEndpointServiceConnectionStatus(value)[source]¶

Bases: str, enum.Enum

The private endpoint connection status.

APPROVED = 'Approved'¶

PENDING = 'Pending'¶

REJECTED = 'Rejected'¶

class azure.mgmt.storagesync.models.PrivateLinkResource(*, required_zone_names: Optional[List[str]] = None, **kwargs)[source]¶

Bases: azure.mgmt.storagesync.models._models_py3.Resource

A private link resource.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name (str) – The name of the resource.
type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.
system_data (SystemData) – Azure Resource Manager metadata containing createdBy and modifiedBy information.
group_id (str) – The private link resource group id.
required_members (list[str]) – The private link resource required member names.
required_zone_names (list[str]) – The private link resource Private link DNS zone name.

Keyword Arguments

required_zone_names (list[str]) – The private link resource Private link DNS zone name.

class azure.mgmt.storagesync.models.PrivateLinkResourceListResult(*, value: Optional[List[_models.PrivateLinkResource]] = None, **kwargs)[source]¶

Bases: azure.mgmt.storagesync._serialization.Model

A list of private link resources.

Variables: value (list[PrivateLinkResource]) – Array of private link resources.
Keyword Arguments: value (list[PrivateLinkResource]) – Array of private link resources.

class azure.mgmt.storagesync.models.PrivateLinkServiceConnectionState(*, status: Optional[Union[str, _models.PrivateEndpointServiceConnectionStatus]] = None, description: Optional[str] = None, actions_required: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.storagesync._serialization.Model

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

Variables

status (str or PrivateEndpointServiceConnectionStatus) – Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. Known values are: “Pending”, “Approved”, and “Rejected”.
description (str) – The reason for approval/rejection of the connection.
actions_required (str) – A message indicating if changes on the service provider require any updates on the consumer.

Keyword Arguments

status (str or PrivateEndpointServiceConnectionStatus) – Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. Known values are: “Pending”, “Approved”, and “Rejected”.
description (str) – The reason for approval/rejection of the connection.
actions_required (str) – A message indicating if changes on the service provider require any updates on the consumer.

class azure.mgmt.storagesync.models.ProgressType(value)[source]¶

Bases: str, enum.Enum

Type of the ProgressType.

DOWNLOAD = 'download'¶

INITIALIZE = 'initialize'¶

NONE = 'none'¶

RECALL = 'recall'¶

UPLOAD = 'upload'¶

class azure.mgmt.storagesync.models.ProxyResource(**kwargs)[source]¶

Bases: azure.mgmt.storagesync.models._models_py3.Resource

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

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name (str) – The name of the resource.
type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.
system_data (SystemData) – Azure Resource Manager metadata containing createdBy and modifiedBy information.

class azure.mgmt.storagesync.models.Reason(value)[source]¶

Bases: str, enum.Enum

State of Azure Subscription.

DELETED = 'Deleted'¶

REGISTERED = 'Registered'¶

SUSPENDED = 'Suspended'¶

UNREGISTERED = 'Unregistered'¶

WARNED = 'Warned'¶

class azure.mgmt.storagesync.models.RecallActionParameters(*, pattern: Optional[str] = None, recall_path: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.storagesync._serialization.Model

The parameters used when calling recall action on server endpoint.

Variables

pattern (str) – Pattern of the files.
recall_path (str) – Recall path.

Keyword Arguments

pattern (str) – Pattern of the files.
recall_path (str) – Recall path.

class azure.mgmt.storagesync.models.RegisteredServer(*, server_certificate: Optional[str] = None, agent_version: Optional[str] = None, server_os_version: Optional[str] = None, server_management_error_code: Optional[int] = None, last_heart_beat: Optional[str] = None, provisioning_state: Optional[str] = None, server_role: Optional[str] = None, cluster_id: Optional[str] = None, cluster_name: Optional[str] = None, server_id: Optional[str] = None, storage_sync_service_uid: Optional[str] = None, last_workflow_id: Optional[str] = None, last_operation_name: Optional[str] = None, discovery_endpoint_uri: Optional[str] = None, resource_location: Optional[str] = None, service_location: Optional[str] = None, friendly_name: Optional[str] = None, management_endpoint_uri: Optional[str] = None, monitoring_endpoint_uri: Optional[str] = None, monitoring_configuration: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.storagesync.models._models_py3.ProxyResource

Registered Server resource.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name (str) – The name of the resource.
type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.
system_data (SystemData) – Azure Resource Manager metadata containing createdBy and modifiedBy information.
server_certificate (str) – Registered Server Certificate.
agent_version (str) – Registered Server Agent Version.
agent_version_status (str or RegisteredServerAgentVersionStatus) – Registered Server Agent Version Status. Known values are: “Ok”, “NearExpiry”, “Expired”, and “Blocked”.
agent_version_expiration_date (datetime) – Registered Server Agent Version Expiration Date.
server_os_version (str) – Registered Server OS Version.
server_management_error_code (int) – Registered Server Management Error Code.
last_heart_beat (str) – Registered Server last heart beat.
provisioning_state (str) – Registered Server Provisioning State.
server_role (str) – Registered Server serverRole.
cluster_id (str) – Registered Server clusterId.
cluster_name (str) – Registered Server clusterName.
server_id (str) – Registered Server serverId.
storage_sync_service_uid (str) – Registered Server storageSyncServiceUid.
last_workflow_id (str) – Registered Server lastWorkflowId.
last_operation_name (str) – Resource Last Operation Name.
discovery_endpoint_uri (str) – Resource discoveryEndpointUri.
resource_location (str) – Resource Location.
service_location (str) – Service Location.
friendly_name (str) – Friendly Name.
management_endpoint_uri (str) – Management Endpoint Uri.
monitoring_endpoint_uri (str) – Telemetry Endpoint Uri.
monitoring_configuration (str) – Monitoring Configuration.
server_name (str) – Server name.

Keyword Arguments

server_certificate (str) – Registered Server Certificate.
agent_version (str) – Registered Server Agent Version.
server_os_version (str) – Registered Server OS Version.
server_management_error_code (int) – Registered Server Management Error Code.
last_heart_beat (str) – Registered Server last heart beat.
provisioning_state (str) – Registered Server Provisioning State.
server_role (str) – Registered Server serverRole.
cluster_id (str) – Registered Server clusterId.
cluster_name (str) – Registered Server clusterName.
server_id (str) – Registered Server serverId.
storage_sync_service_uid (str) – Registered Server storageSyncServiceUid.
last_workflow_id (str) – Registered Server lastWorkflowId.
last_operation_name (str) – Resource Last Operation Name.
discovery_endpoint_uri (str) – Resource discoveryEndpointUri.
resource_location (str) – Resource Location.
service_location (str) – Service Location.
friendly_name (str) – Friendly Name.
management_endpoint_uri (str) – Management Endpoint Uri.
monitoring_endpoint_uri (str) – Telemetry Endpoint Uri.
monitoring_configuration (str) – Monitoring Configuration.

class azure.mgmt.storagesync.models.RegisteredServerAgentVersionStatus(value)[source]¶

Bases: str, enum.Enum

Type of the registered server agent version status.

BLOCKED = 'Blocked'¶

EXPIRED = 'Expired'¶

NEAR_EXPIRY = 'NearExpiry'¶

OK = 'Ok'¶

class azure.mgmt.storagesync.models.RegisteredServerArray(*, value: Optional[List[_models.RegisteredServer]] = None, **kwargs)[source]¶

Bases: azure.mgmt.storagesync._serialization.Model

Array of RegisteredServer.

Variables: value (list[RegisteredServer]) – Collection of Registered Server.
Keyword Arguments: value (list[RegisteredServer]) – Collection of Registered Server.

class azure.mgmt.storagesync.models.RegisteredServerCreateParameters(*, server_certificate: Optional[str] = None, agent_version: Optional[str] = None, server_os_version: Optional[str] = None, last_heart_beat: Optional[str] = None, server_role: Optional[str] = None, cluster_id: Optional[str] = None, cluster_name: Optional[str] = None, server_id: Optional[str] = None, friendly_name: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.storagesync.models._models_py3.ProxyResource

The parameters used when creating a registered server.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name (str) – The name of the resource.
type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.
system_data (SystemData) – Azure Resource Manager metadata containing createdBy and modifiedBy information.
server_certificate (str) – Registered Server Certificate.
agent_version (str) – Registered Server Agent Version.
server_os_version (str) – Registered Server OS Version.
last_heart_beat (str) – Registered Server last heart beat.
server_role (str) – Registered Server serverRole.
cluster_id (str) – Registered Server clusterId.
cluster_name (str) – Registered Server clusterName.
server_id (str) – Registered Server serverId.
friendly_name (str) – Friendly Name.

Keyword Arguments

server_certificate (str) – Registered Server Certificate.
agent_version (str) – Registered Server Agent Version.
server_os_version (str) – Registered Server OS Version.
last_heart_beat (str) – Registered Server last heart beat.
server_role (str) – Registered Server serverRole.
cluster_id (str) – Registered Server clusterId.
cluster_name (str) – Registered Server clusterName.
server_id (str) – Registered Server serverId.
friendly_name (str) – Friendly Name.

class azure.mgmt.storagesync.models.Resource(**kwargs)[source]¶

Bases: azure.mgmt.storagesync._serialization.Model

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

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name (str) – The name of the resource.
type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.
system_data (SystemData) – Azure Resource Manager metadata containing createdBy and modifiedBy information.

class azure.mgmt.storagesync.models.ResourcesMoveInfo(*, target_resource_group: Optional[str] = None, resources: Optional[List[str]] = None, **kwargs)[source]¶

Bases: azure.mgmt.storagesync._serialization.Model

Resource Move Info.

Variables

target_resource_group (str) – Target resource group.
resources (list[str]) – Collection of Resources.

Keyword Arguments

target_resource_group (str) – Target resource group.
resources (list[str]) – Collection of Resources.

class azure.mgmt.storagesync.models.RestoreFileSpec(*, path: Optional[str] = None, isdir: Optional[bool] = None, **kwargs)[source]¶

Bases: azure.mgmt.storagesync._serialization.Model

Restore file spec.

Variables

path (str) – Restore file spec path.
isdir (bool) – Restore file spec isdir.

Keyword Arguments

path (str) – Restore file spec path.
isdir (bool) – Restore file spec isdir.

class azure.mgmt.storagesync.models.ServerEndpoint(*, server_local_path: Optional[str] = None, cloud_tiering: Optional[Union[str, _models.FeatureStatus]] = None, volume_free_space_percent: Optional[int] = None, tier_files_older_than_days: Optional[int] = None, friendly_name: Optional[str] = None, server_resource_id: Optional[str] = None, offline_data_transfer: Optional[Union[str, _models.FeatureStatus]] = None, offline_data_transfer_share_name: Optional[str] = None, initial_download_policy: Optional[Union[str, _models.InitialDownloadPolicy]] = None, local_cache_mode: Optional[Union[str, _models.LocalCacheMode]] = None, initial_upload_policy: Optional[Union[str, _models.InitialUploadPolicy]] = None, **kwargs)[source]¶

Bases: azure.mgmt.storagesync.models._models_py3.ProxyResource

Server Endpoint object.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name (str) – The name of the resource.
type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.
system_data (SystemData) – Azure Resource Manager metadata containing createdBy and modifiedBy information.
server_local_path (str) – Server Local path.
cloud_tiering (str or FeatureStatus) – Cloud Tiering. Known values are: “on” and “off”.
volume_free_space_percent (int) – Level of free space to be maintained by Cloud Tiering if it is enabled.
tier_files_older_than_days (int) – Tier files older than days.
friendly_name (str) – Friendly Name.
server_resource_id (str) – Server Resource Id.
provisioning_state (str) – ServerEndpoint Provisioning State.
last_workflow_id (str) – ServerEndpoint lastWorkflowId.
last_operation_name (str) – Resource Last Operation Name.
sync_status (ServerEndpointSyncStatus) – Server Endpoint sync status.
offline_data_transfer (str or FeatureStatus) – Offline data transfer. Known values are: “on” and “off”.
offline_data_transfer_storage_account_resource_id (str) – Offline data transfer storage account resource ID.
offline_data_transfer_storage_account_tenant_id (str) – Offline data transfer storage account tenant ID.
offline_data_transfer_share_name (str) – Offline data transfer share name.
cloud_tiering_status (ServerEndpointCloudTieringStatus) – Cloud tiering status. Only populated if cloud tiering is enabled.
recall_status (ServerEndpointRecallStatus) – Recall status. Only populated if cloud tiering is enabled.
initial_download_policy (str or InitialDownloadPolicy) – Policy for how namespace and files are recalled during FastDr. Known values are: “NamespaceOnly”, “NamespaceThenModifiedFiles”, and “AvoidTieredFiles”.
local_cache_mode (str or LocalCacheMode) – Policy for enabling follow-the-sun business models: link local cache to cloud behavior to pre-populate before local access. Known values are: “DownloadNewAndModifiedFiles” and “UpdateLocallyCachedFiles”.
initial_upload_policy (str or InitialUploadPolicy) – Policy for how the initial upload sync session is performed. Known values are: “ServerAuthoritative” and “Merge”.
server_name (str) – Server name.

Keyword Arguments

server_local_path (str) – Server Local path.
cloud_tiering (str or FeatureStatus) – Cloud Tiering. Known values are: “on” and “off”.
volume_free_space_percent (int) – Level of free space to be maintained by Cloud Tiering if it is enabled.
tier_files_older_than_days (int) – Tier files older than days.
friendly_name (str) – Friendly Name.
server_resource_id (str) – Server Resource Id.
offline_data_transfer (str or FeatureStatus) – Offline data transfer. Known values are: “on” and “off”.
offline_data_transfer_share_name (str) – Offline data transfer share name.
initial_download_policy (str or InitialDownloadPolicy) – Policy for how namespace and files are recalled during FastDr. Known values are: “NamespaceOnly”, “NamespaceThenModifiedFiles”, and “AvoidTieredFiles”.
local_cache_mode (str or LocalCacheMode) – Policy for enabling follow-the-sun business models: link local cache to cloud behavior to pre-populate before local access. Known values are: “DownloadNewAndModifiedFiles” and “UpdateLocallyCachedFiles”.
initial_upload_policy (str or InitialUploadPolicy) – Policy for how the initial upload sync session is performed. Known values are: “ServerAuthoritative” and “Merge”.

class azure.mgmt.storagesync.models.ServerEndpointArray(*, value: Optional[List[_models.ServerEndpoint]] = None, **kwargs)[source]¶

Bases: azure.mgmt.storagesync._serialization.Model

Array of ServerEndpoint.

Variables: value (list[ServerEndpoint]) – Collection of ServerEndpoint.
Keyword Arguments: value (list[ServerEndpoint]) – Collection of ServerEndpoint.

class azure.mgmt.storagesync.models.ServerEndpointBackgroundDataDownloadActivity(**kwargs)[source]¶

Bases: azure.mgmt.storagesync._serialization.Model

Background data download activity object.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

timestamp (datetime) – Timestamp when properties were updated.
started_timestamp (datetime) – Timestamp when the operation started.
percent_progress (int) – Progress percentage.
downloaded_bytes (int) – Running count of bytes downloaded.

class azure.mgmt.storagesync.models.ServerEndpointCloudTieringStatus(**kwargs)[source]¶

Bases: azure.mgmt.storagesync._serialization.Model

Server endpoint cloud tiering status object.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

last_updated_timestamp (datetime) – Last updated timestamp.
health (str or ServerEndpointHealthState) – Cloud tiering health state. Known values are: “Unavailable”, “Healthy”, and “Error”.
health_last_updated_timestamp (datetime) – The last updated timestamp of health state.
last_cloud_tiering_result (int) – Last cloud tiering result (HResult).
last_success_timestamp (datetime) – Last cloud tiering success timestamp.
space_savings (CloudTieringSpaceSavings) – Information regarding how much local space cloud tiering is saving.
cache_performance (CloudTieringCachePerformance) – Information regarding how well the local cache on the server is performing.
files_not_tiering (CloudTieringFilesNotTiering) – Information regarding files that failed to be tiered.
volume_free_space_policy_status (CloudTieringVolumeFreeSpacePolicyStatus) – Status of the volume free space policy.
date_policy_status (CloudTieringDatePolicyStatus) – Status of the date policy.
low_disk_mode (CloudTieringLowDiskMode) – Information regarding the low disk mode state.

class azure.mgmt.storagesync.models.ServerEndpointCreateParameters(*, server_local_path: Optional[str] = None, cloud_tiering: Optional[Union[str, _models.FeatureStatus]] = None, volume_free_space_percent: int = 20, tier_files_older_than_days: int = 0, friendly_name: Optional[str] = None, server_resource_id: Optional[str] = None, offline_data_transfer: Optional[Union[str, _models.FeatureStatus]] = None, offline_data_transfer_share_name: Optional[str] = None, initial_download_policy: Optional[Union[str, _models.InitialDownloadPolicy]] = None, local_cache_mode: Optional[Union[str, _models.LocalCacheMode]] = None, initial_upload_policy: Optional[Union[str, _models.InitialUploadPolicy]] = None, **kwargs)[source]¶

Bases: azure.mgmt.storagesync.models._models_py3.ProxyResource

The parameters used when creating a server endpoint.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name (str) – The name of the resource.
type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.
system_data (SystemData) – Azure Resource Manager metadata containing createdBy and modifiedBy information.
server_local_path (str) – Server Local path.
cloud_tiering (str or FeatureStatus) – Cloud Tiering. Known values are: “on” and “off”.
volume_free_space_percent (int) – Level of free space to be maintained by Cloud Tiering if it is enabled.
tier_files_older_than_days (int) – Tier files older than days.
friendly_name (str) – Friendly Name.
server_resource_id (str) – Server Resource Id.
offline_data_transfer (str or FeatureStatus) – Offline data transfer. Known values are: “on” and “off”.
offline_data_transfer_share_name (str) – Offline data transfer share name.
initial_download_policy (str or InitialDownloadPolicy) – Policy for how namespace and files are recalled during FastDr. Known values are: “NamespaceOnly”, “NamespaceThenModifiedFiles”, and “AvoidTieredFiles”.
local_cache_mode (str or LocalCacheMode) – Policy for enabling follow-the-sun business models: link local cache to cloud behavior to pre-populate before local access. Known values are: “DownloadNewAndModifiedFiles” and “UpdateLocallyCachedFiles”.
initial_upload_policy (str or InitialUploadPolicy) – Policy for how the initial upload sync session is performed. Known values are: “ServerAuthoritative” and “Merge”.

Keyword Arguments

server_local_path (str) – Server Local path.
cloud_tiering (str or FeatureStatus) – Cloud Tiering. Known values are: “on” and “off”.
volume_free_space_percent (int) – Level of free space to be maintained by Cloud Tiering if it is enabled.
tier_files_older_than_days (int) – Tier files older than days.
friendly_name (str) – Friendly Name.
server_resource_id (str) – Server Resource Id.
offline_data_transfer (str or FeatureStatus) – Offline data transfer. Known values are: “on” and “off”.
offline_data_transfer_share_name (str) – Offline data transfer share name.
initial_download_policy (str or InitialDownloadPolicy) – Policy for how namespace and files are recalled during FastDr. Known values are: “NamespaceOnly”, “NamespaceThenModifiedFiles”, and “AvoidTieredFiles”.
local_cache_mode (str or LocalCacheMode) – Policy for enabling follow-the-sun business models: link local cache to cloud behavior to pre-populate before local access. Known values are: “DownloadNewAndModifiedFiles” and “UpdateLocallyCachedFiles”.
initial_upload_policy (str or InitialUploadPolicy) – Policy for how the initial upload sync session is performed. Known values are: “ServerAuthoritative” and “Merge”.

class azure.mgmt.storagesync.models.ServerEndpointFilesNotSyncingError(**kwargs)[source]¶

Bases: azure.mgmt.storagesync._serialization.Model

Files not syncing error object.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

error_code (int) – Error code (HResult).
persistent_count (int) – Count of persistent files not syncing with the specified error code.
transient_count (int) – Count of transient files not syncing with the specified error code.

class azure.mgmt.storagesync.models.ServerEndpointHealthState(value)[source]¶

Bases: str, enum.Enum

Type of the server endpoint health state.

ERROR = 'Error'¶

HEALTHY = 'Healthy'¶

UNAVAILABLE = 'Unavailable'¶

class azure.mgmt.storagesync.models.ServerEndpointOfflineDataTransferState(value)[source]¶

Bases: str, enum.Enum

Type of the Health state.

COMPLETE = 'Complete'¶

IN_PROGRESS = 'InProgress'¶

NOT_RUNNING = 'NotRunning'¶

STOPPING = 'Stopping'¶

class azure.mgmt.storagesync.models.ServerEndpointRecallError(**kwargs)[source]¶

Bases: azure.mgmt.storagesync._serialization.Model

Server endpoint recall error object.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

error_code (int) – Error code (HResult).
count (int) – Count of occurences of the error.

class azure.mgmt.storagesync.models.ServerEndpointRecallStatus(**kwargs)[source]¶

Bases: azure.mgmt.storagesync._serialization.Model

Server endpoint recall status object.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

last_updated_timestamp (datetime) – Last updated timestamp.
total_recall_errors_count (int) – Total count of recall errors.
recall_errors (list[ServerEndpointRecallError]) – Array of recall errors.

class azure.mgmt.storagesync.models.ServerEndpointSyncActivityState(value)[source]¶

Bases: str, enum.Enum

Type of the sync activity state.

DOWNLOAD = 'Download'¶

UPLOAD = 'Upload'¶

UPLOAD_AND_DOWNLOAD = 'UploadAndDownload'¶

class azure.mgmt.storagesync.models.ServerEndpointSyncActivityStatus(**kwargs)[source]¶

Bases: azure.mgmt.storagesync._serialization.Model

Sync Session status object.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

timestamp (datetime) – Timestamp when properties were updated.
per_item_error_count (int) – Per item error count.
applied_item_count (int) – Applied item count.
total_item_count (int) – Total item count (if available).
applied_bytes (int) – Applied bytes.
total_bytes (int) – Total bytes (if available).
sync_mode (str or ServerEndpointSyncMode) – Sync mode. Known values are: “Regular”, “NamespaceDownload”, “InitialUpload”, “SnapshotUpload”, and “InitialFullDownload”.
session_minutes_remaining (int) – Session minutes remaining (if available).

class azure.mgmt.storagesync.models.ServerEndpointSyncMode(value)[source]¶

Bases: str, enum.Enum

Sync mode for the server endpoint.

INITIAL_FULL_DOWNLOAD = 'InitialFullDownload'¶

INITIAL_UPLOAD = 'InitialUpload'¶

NAMESPACE_DOWNLOAD = 'NamespaceDownload'¶

REGULAR = 'Regular'¶

SNAPSHOT_UPLOAD = 'SnapshotUpload'¶

class azure.mgmt.storagesync.models.ServerEndpointSyncSessionStatus(**kwargs)[source]¶

Bases: azure.mgmt.storagesync._serialization.Model

Sync Session status object.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

last_sync_result (int) – Last sync result (HResult).
last_sync_timestamp (datetime) – Last sync timestamp.
last_sync_success_timestamp (datetime) – Last sync success timestamp.
last_sync_per_item_error_count (int) – Last sync per item error count.
persistent_files_not_syncing_count (int) – Count of persistent files not syncing.
transient_files_not_syncing_count (int) – Count of transient files not syncing.
files_not_syncing_errors (list[ServerEndpointFilesNotSyncingError]) – Array of per-item errors coming from the last sync session.
last_sync_mode (str or ServerEndpointSyncMode) – Sync mode. Known values are: “Regular”, “NamespaceDownload”, “InitialUpload”, “SnapshotUpload”, and “InitialFullDownload”.

class azure.mgmt.storagesync.models.ServerEndpointSyncStatus(**kwargs)[source]¶

Bases: azure.mgmt.storagesync._serialization.Model

Server Endpoint sync status.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

download_health (str or ServerEndpointHealthState) – Download Health Status. Known values are: “Unavailable”, “Healthy”, and “Error”.
upload_health (str or ServerEndpointHealthState) – Upload Health Status. Known values are: “Unavailable”, “Healthy”, and “Error”.
combined_health (str or ServerEndpointHealthState) – Combined Health Status. Known values are: “Unavailable”, “Healthy”, and “Error”.
sync_activity (str or ServerEndpointSyncActivityState) – Sync activity. Known values are: “Upload”, “Download”, and “UploadAndDownload”.
total_persistent_files_not_syncing_count (int) – Total count of persistent files not syncing (combined upload + download).
last_updated_timestamp (datetime) – Last Updated Timestamp.
upload_status (ServerEndpointSyncSessionStatus) – Upload Status.
download_status (ServerEndpointSyncSessionStatus) – Download Status.
upload_activity (ServerEndpointSyncActivityStatus) – Upload sync activity.
download_activity (ServerEndpointSyncActivityStatus) – Download sync activity.
offline_data_transfer_status (str or ServerEndpointOfflineDataTransferState) – Offline Data Transfer State. Known values are: “InProgress”, “Stopping”, “NotRunning”, and “Complete”.
background_data_download_activity (ServerEndpointBackgroundDataDownloadActivity) – Background data download activity.

class azure.mgmt.storagesync.models.ServerEndpointUpdateParameters(*, cloud_tiering: Optional[Union[str, _models.FeatureStatus]] = None, volume_free_space_percent: Optional[int] = None, tier_files_older_than_days: Optional[int] = None, offline_data_transfer: Optional[Union[str, _models.FeatureStatus]] = None, offline_data_transfer_share_name: Optional[str] = None, local_cache_mode: Optional[Union[str, _models.LocalCacheMode]] = None, **kwargs)[source]¶

Bases: azure.mgmt.storagesync._serialization.Model

Parameters for updating an Server Endpoint.

Variables

cloud_tiering (str or FeatureStatus) – Cloud Tiering. Known values are: “on” and “off”.
volume_free_space_percent (int) – Level of free space to be maintained by Cloud Tiering if it is enabled.
tier_files_older_than_days (int) – Tier files older than days.
offline_data_transfer (str or FeatureStatus) – Offline data transfer. Known values are: “on” and “off”.
offline_data_transfer_share_name (str) – Offline data transfer share name.
local_cache_mode (str or LocalCacheMode) – Policy for enabling follow-the-sun business models: link local cache to cloud behavior to pre-populate before local access. Known values are: “DownloadNewAndModifiedFiles” and “UpdateLocallyCachedFiles”.

Keyword Arguments

cloud_tiering (str or FeatureStatus) – Cloud Tiering. Known values are: “on” and “off”.
volume_free_space_percent (int) – Level of free space to be maintained by Cloud Tiering if it is enabled.
tier_files_older_than_days (int) – Tier files older than days.
offline_data_transfer (str or FeatureStatus) – Offline data transfer. Known values are: “on” and “off”.
offline_data_transfer_share_name (str) – Offline data transfer share name.
local_cache_mode (str or LocalCacheMode) – Policy for enabling follow-the-sun business models: link local cache to cloud behavior to pre-populate before local access. Known values are: “DownloadNewAndModifiedFiles” and “UpdateLocallyCachedFiles”.

class azure.mgmt.storagesync.models.StorageSyncApiError(*, code: Optional[str] = None, message: Optional[str] = None, target: Optional[str] = None, details: Optional[_models.StorageSyncErrorDetails] = None, innererror: Optional[_models.StorageSyncInnerErrorDetails] = None, **kwargs)[source]¶

Bases: azure.mgmt.storagesync._serialization.Model

Error type.

Variables

code (str) – Error code of the given entry.
message (str) – Error message of the given entry.
target (str) – Target of the given error entry.
details (StorageSyncErrorDetails) – Error details of the given entry.
innererror (StorageSyncInnerErrorDetails) – Inner error details of the given entry.

Keyword Arguments

code (str) – Error code of the given entry.
message (str) – Error message of the given entry.
target (str) – Target of the given error entry.
details (StorageSyncErrorDetails) – Error details of the given entry.
innererror (StorageSyncInnerErrorDetails) – Inner error details of the given entry.

class azure.mgmt.storagesync.models.StorageSyncError(*, error: Optional[_models.StorageSyncApiError] = None, innererror: Optional[_models.StorageSyncApiError] = None, **kwargs)[source]¶

Bases: azure.mgmt.storagesync._serialization.Model

Error type.

Variables

error (StorageSyncApiError) – Error details of the given entry.
innererror (StorageSyncApiError) – Error details of the given entry.

Keyword Arguments

error (StorageSyncApiError) – Error details of the given entry.
innererror (StorageSyncApiError) – Error details of the given entry.

class azure.mgmt.storagesync.models.StorageSyncErrorDetails(*, code: Optional[str] = None, message: Optional[str] = None, target: Optional[str] = None, request_uri: Optional[str] = None, exception_type: Optional[str] = None, http_method: Optional[str] = None, hashed_message: Optional[str] = None, http_error_code: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.storagesync._serialization.Model

Error Details object.

Variables

code (str) – Error code of the given entry.
message (str) – Error message of the given entry.
target (str) – Target of the given entry.
request_uri (str) – Request URI of the given entry.
exception_type (str) – Exception type of the given entry.
http_method (str) – HTTP method of the given entry.
hashed_message (str) – Hashed message of the given entry.
http_error_code (str) – HTTP error code of the given entry.

Keyword Arguments

code (str) – Error code of the given entry.
message (str) – Error message of the given entry.
target (str) – Target of the given entry.
request_uri (str) – Request URI of the given entry.
exception_type (str) – Exception type of the given entry.
http_method (str) – HTTP method of the given entry.
hashed_message (str) – Hashed message of the given entry.
http_error_code (str) – HTTP error code of the given entry.

class azure.mgmt.storagesync.models.StorageSyncInnerErrorDetails(*, call_stack: Optional[str] = None, message: Optional[str] = None, inner_exception: Optional[str] = None, inner_exception_call_stack: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.storagesync._serialization.Model

Error Details object.

Variables

call_stack (str) – Call stack of the error.
message (str) – Error message of the error.
inner_exception (str) – Exception of the inner error.
inner_exception_call_stack (str) – Call stack of the inner error.

Keyword Arguments

call_stack (str) – Call stack of the error.
message (str) – Error message of the error.
inner_exception (str) – Exception of the inner error.
inner_exception_call_stack (str) – Call stack of the inner error.

class azure.mgmt.storagesync.models.StorageSyncService(*, location: str, tags: Optional[Dict[str, str]] = None, incoming_traffic_policy: Optional[Union[str, _models.IncomingTrafficPolicy]] = None, **kwargs)[source]¶

Bases: azure.mgmt.storagesync.models._models_py3.TrackedResource

Storage Sync Service object.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables

id (str) – Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name (str) – The name of the resource.
type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.
system_data (SystemData) – Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags (dict[str, str]) – Resource tags.
location (str) – The geo-location where the resource lives. Required.
incoming_traffic_policy (str or IncomingTrafficPolicy) – Incoming Traffic Policy. Known values are: “AllowAllTraffic” and “AllowVirtualNetworksOnly”.
storage_sync_service_status (int) – Storage Sync service status.
storage_sync_service_uid (str) – Storage Sync service Uid.
provisioning_state (str) – StorageSyncService Provisioning State.
last_workflow_id (str) – StorageSyncService lastWorkflowId.
last_operation_name (str) – Resource Last Operation Name.
private_endpoint_connections (list[PrivateEndpointConnection]) – List of private endpoint connection associated with the specified storage sync service.

Keyword Arguments

tags (dict[str, str]) – Resource tags.
location (str) – The geo-location where the resource lives. Required.
incoming_traffic_policy (str or IncomingTrafficPolicy) – Incoming Traffic Policy. Known values are: “AllowAllTraffic” and “AllowVirtualNetworksOnly”.

class azure.mgmt.storagesync.models.StorageSyncServiceArray(*, value: Optional[List[_models.StorageSyncService]] = None, **kwargs)[source]¶

Bases: azure.mgmt.storagesync._serialization.Model

Array of StorageSyncServices.

Variables: value (list[StorageSyncService]) – Collection of StorageSyncServices.
Keyword Arguments: value (list[StorageSyncService]) – Collection of StorageSyncServices.

class azure.mgmt.storagesync.models.StorageSyncServiceCreateParameters(*, location: str, tags: Optional[Dict[str, str]] = None, incoming_traffic_policy: Optional[Union[str, _models.IncomingTrafficPolicy]] = None, **kwargs)[source]¶

Bases: azure.mgmt.storagesync._serialization.Model

The parameters used when creating a storage sync service.

All required parameters must be populated in order to send to Azure.

Variables

location (str) – 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. Required.
tags (dict[str, str]) – 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.
incoming_traffic_policy (str or IncomingTrafficPolicy) – Incoming Traffic Policy. Known values are: “AllowAllTraffic” and “AllowVirtualNetworksOnly”.

Keyword Arguments

location (str) – 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. Required.
tags (dict[str, str]) – 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.
incoming_traffic_policy (str or IncomingTrafficPolicy) – Incoming Traffic Policy. Known values are: “AllowAllTraffic” and “AllowVirtualNetworksOnly”.

class azure.mgmt.storagesync.models.StorageSyncServiceUpdateParameters(*, tags: Optional[Dict[str, str]] = None, incoming_traffic_policy: Optional[Union[str, _models.IncomingTrafficPolicy]] = None, **kwargs)[source]¶

Bases: azure.mgmt.storagesync._serialization.Model

Parameters for updating an Storage sync service.

Variables

tags (dict[str, str]) – The user-specified tags associated with the storage sync service.
incoming_traffic_policy (str or IncomingTrafficPolicy) – Incoming Traffic Policy. Known values are: “AllowAllTraffic” and “AllowVirtualNetworksOnly”.

Keyword Arguments

tags (dict[str, str]) – The user-specified tags associated with the storage sync service.
incoming_traffic_policy (str or IncomingTrafficPolicy) – Incoming Traffic Policy. Known values are: “AllowAllTraffic” and “AllowVirtualNetworksOnly”.

class azure.mgmt.storagesync.models.SubscriptionState(*, state: Optional[Union[str, _models.Reason]] = None, properties: Optional[collections.abc.MutableMapping[str, Any]] = None, **kwargs)[source]¶

Bases: azure.mgmt.storagesync._serialization.Model

Subscription State object.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

state (str or Reason) – State of Azure Subscription. Known values are: “Registered”, “Unregistered”, “Warned”, “Suspended”, and “Deleted”.
istransitioning (bool) – Is Transitioning.
properties (JSON) – Subscription state properties.

Keyword Arguments

state (str or Reason) – State of Azure Subscription. Known values are: “Registered”, “Unregistered”, “Warned”, “Suspended”, and “Deleted”.
properties (JSON) – Subscription state properties.

class azure.mgmt.storagesync.models.SyncGroup(**kwargs)[source]¶

Bases: azure.mgmt.storagesync.models._models_py3.ProxyResource

Sync Group object.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name (str) – The name of the resource.
type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.
system_data (SystemData) – Azure Resource Manager metadata containing createdBy and modifiedBy information.
unique_id (str) – Unique Id.
sync_group_status (str) – Sync group status.

class azure.mgmt.storagesync.models.SyncGroupArray(*, value: Optional[List[_models.SyncGroup]] = None, **kwargs)[source]¶

Bases: azure.mgmt.storagesync._serialization.Model

Array of SyncGroup.

Variables: value (list[SyncGroup]) – Collection of SyncGroup.
Keyword Arguments: value (list[SyncGroup]) – Collection of SyncGroup.

class azure.mgmt.storagesync.models.SyncGroupCreateParameters(*, properties: Optional[collections.abc.MutableMapping[str, Any]] = None, **kwargs)[source]¶

Bases: azure.mgmt.storagesync.models._models_py3.ProxyResource

The parameters used when creating a sync group.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name (str) – The name of the resource.
type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.
system_data (SystemData) – Azure Resource Manager metadata containing createdBy and modifiedBy information.
properties (JSON) – The parameters used to create the sync group.

Keyword Arguments

properties (JSON) – The parameters used to create the sync group.

class azure.mgmt.storagesync.models.SystemData(*, created_by: Optional[str] = None, created_by_type: Optional[Union[str, _models.CreatedByType]] = None, created_at: Optional[datetime.datetime] = None, last_modified_by: Optional[str] = None, last_modified_by_type: Optional[Union[str, _models.CreatedByType]] = None, last_modified_at: Optional[datetime.datetime] = None, **kwargs)[source]¶

Bases: azure.mgmt.storagesync._serialization.Model

Metadata pertaining to creation and last modification of the resource.

Variables

created_by (str) – The identity that created the resource.
created_by_type (str or CreatedByType) – The type of identity that created the resource. Known values are: “User”, “Application”, “ManagedIdentity”, and “Key”.
created_at (datetime) – The timestamp of resource creation (UTC).
last_modified_by (str) – The identity that last modified the resource.
last_modified_by_type (str or CreatedByType) – The type of identity that last modified the resource. Known values are: “User”, “Application”, “ManagedIdentity”, and “Key”.
last_modified_at (datetime) – The timestamp of resource last modification (UTC).

Keyword Arguments

created_by (str) – The identity that created the resource.
created_by_type (str or CreatedByType) – The type of identity that created the resource. Known values are: “User”, “Application”, “ManagedIdentity”, and “Key”.
created_at (datetime) – The timestamp of resource creation (UTC).
last_modified_by (str) – The identity that last modified the resource.
last_modified_by_type (str or CreatedByType) – The type of identity that last modified the resource. Known values are: “User”, “Application”, “ManagedIdentity”, and “Key”.
last_modified_at (datetime) – The timestamp of resource last modification (UTC).

class azure.mgmt.storagesync.models.TrackedResource(*, location: str, tags: Optional[Dict[str, str]] = None, **kwargs)[source]¶

Bases: azure.mgmt.storagesync.models._models_py3.Resource

The resource model definition for an Azure Resource Manager tracked top level resource which has ‘tags’ and a ‘location’.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables

id (str) – Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name (str) – The name of the resource.
type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.
system_data (SystemData) – Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags (dict[str, str]) – Resource tags.
location (str) – The geo-location where the resource lives. Required.

Keyword Arguments

tags (dict[str, str]) – Resource tags.
location (str) – The geo-location where the resource lives. Required.

class azure.mgmt.storagesync.models.TriggerChangeDetectionParameters(*, directory_path: Optional[str] = None, change_detection_mode: Optional[Union[str, _models.ChangeDetectionMode]] = None, paths: Optional[List[str]] = None, **kwargs)[source]¶

Bases: azure.mgmt.storagesync._serialization.Model

The parameters used when calling trigger change detection action on cloud endpoint.

Variables

directory_path (str) – Relative path to a directory Azure File share for which change detection is to be performed.
change_detection_mode (str or ChangeDetectionMode) – Change Detection Mode. Applies to a directory specified in directoryPath parameter. Known values are: “Default” and “Recursive”.
paths (list[str]) – Array of relative paths on the Azure File share to be included in the change detection. Can be files and directories.

Keyword Arguments

directory_path (str) – Relative path to a directory Azure File share for which change detection is to be performed.
change_detection_mode (str or ChangeDetectionMode) – Change Detection Mode. Applies to a directory specified in directoryPath parameter. Known values are: “Default” and “Recursive”.
paths (list[str]) – Array of relative paths on the Azure File share to be included in the change detection. Can be files and directories.

class azure.mgmt.storagesync.models.TriggerRolloverRequest(*, server_certificate: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.storagesync._serialization.Model

Trigger Rollover Request.

Variables: server_certificate (str) – Certificate Data.
Keyword Arguments: server_certificate (str) – Certificate Data.

class azure.mgmt.storagesync.models.Workflow(*, last_step_name: Optional[str] = None, status: Optional[Union[str, _models.WorkflowStatus]] = None, operation: Optional[Union[str, _models.OperationDirection]] = None, steps: Optional[str] = None, last_operation_id: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.storagesync.models._models_py3.ProxyResource

Workflow resource.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name (str) – The name of the resource.
type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.
system_data (SystemData) – Azure Resource Manager metadata containing createdBy and modifiedBy information.
last_step_name (str) – last step name.
status (str or WorkflowStatus) – workflow status. Known values are: “active”, “expired”, “succeeded”, “aborted”, and “failed”.
operation (str or OperationDirection) – operation direction. Known values are: “do”, “undo”, and “cancel”.
steps (str) – workflow steps.
last_operation_id (str) – workflow last operation identifier.
command_name (str) – workflow command name.
created_timestamp (datetime) – workflow created timestamp.
last_status_timestamp (datetime) – workflow last status timestamp.

Keyword Arguments

last_step_name (str) – last step name.
status (str or WorkflowStatus) – workflow status. Known values are: “active”, “expired”, “succeeded”, “aborted”, and “failed”.
operation (str or OperationDirection) – operation direction. Known values are: “do”, “undo”, and “cancel”.
steps (str) – workflow steps.
last_operation_id (str) – workflow last operation identifier.

class azure.mgmt.storagesync.models.WorkflowArray(*, value: Optional[List[_models.Workflow]] = None, **kwargs)[source]¶

Bases: azure.mgmt.storagesync._serialization.Model

Array of Workflow.

Variables: value (list[Workflow]) – Collection of workflow items.
Keyword Arguments: value (list[Workflow]) – Collection of workflow items.

class azure.mgmt.storagesync.models.WorkflowStatus(value)[source]¶

Bases: str, enum.Enum

Type of the Workflow Status.

ABORTED = 'aborted'¶

ACTIVE = 'active'¶

EXPIRED = 'expired'¶

FAILED = 'failed'¶

SUCCEEDED = 'succeeded'¶