azure.mgmt.storagemover.models module¶

class azure.mgmt.storagemover.models.ActionType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶

Bases: str, Enum

Enum. Indicates the action type. “Internal” refers to actions that are for internal only APIs.

INTERNAL = 'Internal'¶

class azure.mgmt.storagemover.models.Agent(*, arc_resource_id: str, arc_vm_uuid: str, description: str | None = None, upload_limit_schedule: _models.UploadLimitSchedule | None = None, **kwargs: Any)[source]¶

Bases: ProxyResource

The Agent resource.

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 server.

Variables:

id (str) – Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}. # pylint: disable=line-too-long
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.
description (str) – A description for the Agent.
agent_version (str) – The Agent version.
arc_resource_id (str) – The fully qualified resource ID of the Hybrid Compute resource for the Agent. Required.
arc_vm_uuid (str) – The VM UUID of the Hybrid Compute resource for the Agent. Required.
agent_status (str or AgentStatus) – The Agent status. Known values are: “Registering”, “Offline”, “Online”, “Executing”, “RequiresAttention”, and “Unregistering”.
last_status_update (datetime) – The last updated time of the Agent status.
local_ip_address (str) – Local IP address reported by the Agent.
memory_in_mb (int) – Available memory reported by the Agent, in MB.
number_of_cores (int) – Available compute cores reported by the Agent.
uptime_in_seconds (int) – Uptime of the Agent in seconds.
time_zone (str) – The agent’s local time zone represented in Windows format.
upload_limit_schedule (UploadLimitSchedule) – The WAN-link upload limit schedule that applies to any Job Run the agent executes. Data plane operations (migrating files) are affected. Control plane operations ensure seamless migration functionality and are not limited by this schedule. The schedule is interpreted with the agent’s local time.
error_details (AgentPropertiesErrorDetails) –
provisioning_state (str or ProvisioningState) – The provisioning state of this resource. Known values are: “Succeeded”, “Canceled”, “Failed”, and “Deleting”.

Keyword Arguments:

description (str) – A description for the Agent.
arc_resource_id (str) – The fully qualified resource ID of the Hybrid Compute resource for the Agent. Required.
arc_vm_uuid (str) – The VM UUID of the Hybrid Compute resource for the Agent. Required.
upload_limit_schedule (UploadLimitSchedule) – The WAN-link upload limit schedule that applies to any Job Run the agent executes. Data plane operations (migrating files) are affected. Control plane operations ensure seamless migration functionality and are not limited by this schedule. The schedule is interpreted with the agent’s local time.

class azure.mgmt.storagemover.models.AgentList(**kwargs: Any)[source]¶

Bases: Model

List of Agents.

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

Variables:

value (list[Agent]) –
next_link (str) – Request URL that can be used to query next page of containers. Returned when total number of requested containers exceed maximum page size.

class azure.mgmt.storagemover.models.AgentPropertiesErrorDetails(*, code: str | None = None, message: str | None = None, **kwargs: Any)[source]¶

Bases: Model

AgentPropertiesErrorDetails.

Variables:

code (str) – Error code reported by Agent.
message (str) – Expanded description of reported error code.

Keyword Arguments:

code (str) – Error code reported by Agent.
message (str) – Expanded description of reported error code.

class azure.mgmt.storagemover.models.AgentStatus(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶

Bases: str, Enum

The Agent status.

EXECUTING = 'Executing'¶

OFFLINE = 'Offline'¶

ONLINE = 'Online'¶

REGISTERING = 'Registering'¶

REQUIRES_ATTENTION = 'RequiresAttention'¶

UNREGISTERING = 'Unregistering'¶

class azure.mgmt.storagemover.models.AgentUpdateParameters(*, description: str | None = None, upload_limit_schedule: _models.UploadLimitSchedule | None = None, **kwargs: Any)[source]¶

Bases: Model

The Agent resource.

Variables:

description (str) – A description for the Agent.
upload_limit_schedule (UploadLimitSchedule) – The WAN-link upload limit schedule that applies to any Job Run the agent executes. Data plane operations (migrating files) are affected. Control plane operations ensure seamless migration functionality and are not limited by this schedule. The schedule is interpreted with the agent’s local time.

Keyword Arguments:

description (str) – A description for the Agent.
upload_limit_schedule (UploadLimitSchedule) – The WAN-link upload limit schedule that applies to any Job Run the agent executes. Data plane operations (migrating files) are affected. Control plane operations ensure seamless migration functionality and are not limited by this schedule. The schedule is interpreted with the agent’s local time.

class azure.mgmt.storagemover.models.AzureKeyVaultSmbCredentials(*, username_uri: str | None = None, password_uri: str | None = None, **kwargs: Any)[source]¶

Bases: Credentials

The Azure Key Vault secret URIs which store the credentials.

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

Variables:

type (str or CredentialType) – The Credentials type. Required. “AzureKeyVaultSmb”
username_uri (str) – The Azure Key Vault secret URI which stores the username. Use empty string to clean-up existing value.
password_uri (str) – The Azure Key Vault secret URI which stores the password. Use empty string to clean-up existing value.

Keyword Arguments:

username_uri (str) – The Azure Key Vault secret URI which stores the username. Use empty string to clean-up existing value.
password_uri (str) – The Azure Key Vault secret URI which stores the password. Use empty string to clean-up existing value.

class azure.mgmt.storagemover.models.AzureStorageBlobContainerEndpointProperties(*, storage_account_resource_id: str, blob_container_name: str, description: str | None = None, **kwargs: Any)[source]¶

Bases: EndpointBaseProperties

The properties of Azure Storage blob container endpoint.

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 server.

Variables:

endpoint_type (str or EndpointType) – The Endpoint resource type. Required. Known values are: “AzureStorageBlobContainer”, “NfsMount”, “AzureStorageSmbFileShare”, and “SmbMount”.
description (str) – A description for the Endpoint.
provisioning_state (str or ProvisioningState) – The provisioning state of this resource. Known values are: “Succeeded”, “Canceled”, “Failed”, and “Deleting”.
storage_account_resource_id (str) – The Azure Resource ID of the storage account that is the target destination. Required.
blob_container_name (str) – The name of the Storage blob container that is the target destination. Required.

Keyword Arguments:

description (str) – A description for the Endpoint.
storage_account_resource_id (str) – The Azure Resource ID of the storage account that is the target destination. Required.
blob_container_name (str) – The name of the Storage blob container that is the target destination. Required.

class azure.mgmt.storagemover.models.AzureStorageBlobContainerEndpointUpdateProperties(*, description: str | None = None, **kwargs: Any)[source]¶

Bases: EndpointBaseUpdateProperties

AzureStorageBlobContainerEndpointUpdateProperties.

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

Variables:

endpoint_type (str or EndpointType) – The Endpoint resource type. Required. Known values are: “AzureStorageBlobContainer”, “NfsMount”, “AzureStorageSmbFileShare”, and “SmbMount”.
description (str) – A description for the Endpoint.

Keyword Arguments:

description (str) – A description for the Endpoint.

class azure.mgmt.storagemover.models.AzureStorageSmbFileShareEndpointProperties(*, storage_account_resource_id: str, file_share_name: str, description: str | None = None, **kwargs: Any)[source]¶

Bases: EndpointBaseProperties

The properties of Azure Storage SMB file share endpoint.

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 server.

Variables:

endpoint_type (str or EndpointType) – The Endpoint resource type. Required. Known values are: “AzureStorageBlobContainer”, “NfsMount”, “AzureStorageSmbFileShare”, and “SmbMount”.
description (str) – A description for the Endpoint.
provisioning_state (str or ProvisioningState) – The provisioning state of this resource. Known values are: “Succeeded”, “Canceled”, “Failed”, and “Deleting”.
storage_account_resource_id (str) – The Azure Resource ID of the storage account. Required.
file_share_name (str) – The name of the Azure Storage file share. Required.

Keyword Arguments:

description (str) – A description for the Endpoint.
storage_account_resource_id (str) – The Azure Resource ID of the storage account. Required.
file_share_name (str) – The name of the Azure Storage file share. Required.

class azure.mgmt.storagemover.models.AzureStorageSmbFileShareEndpointUpdateProperties(*, description: str | None = None, **kwargs: Any)[source]¶

Bases: EndpointBaseUpdateProperties

The properties of Azure Storage SMB file share endpoint to update.

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

Variables:

endpoint_type (str or EndpointType) – The Endpoint resource type. Required. Known values are: “AzureStorageBlobContainer”, “NfsMount”, “AzureStorageSmbFileShare”, and “SmbMount”.
description (str) – A description for the Endpoint.

Keyword Arguments:

description (str) – A description for the Endpoint.

class azure.mgmt.storagemover.models.CopyMode(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶

Bases: str, Enum

Strategy to use for copy.

ADDITIVE = 'Additive'¶

MIRROR = 'Mirror'¶

class azure.mgmt.storagemover.models.CreatedByType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶

Bases: str, Enum

The type of identity that created the resource.

APPLICATION = 'Application'¶

KEY = 'Key'¶

MANAGED_IDENTITY = 'ManagedIdentity'¶

USER = 'User'¶

class azure.mgmt.storagemover.models.CredentialType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶

Bases: str, Enum

The Credentials type.

AZURE_KEY_VAULT_SMB = 'AzureKeyVaultSmb'¶

class azure.mgmt.storagemover.models.Credentials(**kwargs: Any)[source]¶

Bases: Model

The Credentials.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: AzureKeyVaultSmbCredentials

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

Variables:: type (str or CredentialType) – The Credentials type. Required. “AzureKeyVaultSmb”

class azure.mgmt.storagemover.models.DayOfWeek(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶

Bases: str, Enum

The day of week.

FRIDAY = 'Friday'¶

MONDAY = 'Monday'¶

SATURDAY = 'Saturday'¶

SUNDAY = 'Sunday'¶

THURSDAY = 'Thursday'¶

TUESDAY = 'Tuesday'¶

WEDNESDAY = 'Wednesday'¶

class azure.mgmt.storagemover.models.Endpoint(*, properties: _models.EndpointBaseProperties, **kwargs: Any)[source]¶

Bases: ProxyResource

The Endpoint resource, which contains information about file sources and targets.

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 server.

Variables:

id (str) – Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}. # pylint: disable=line-too-long
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 (EndpointBaseProperties) – The resource specific properties for the Storage Mover resource. Required.

Keyword Arguments:

properties (EndpointBaseProperties) – The resource specific properties for the Storage Mover resource. Required.

class azure.mgmt.storagemover.models.EndpointBaseProperties(*, description: str | None = None, **kwargs: Any)[source]¶

Bases: Model

The resource specific properties for the Storage Mover resource.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: AzureStorageBlobContainerEndpointProperties, AzureStorageSmbFileShareEndpointProperties, NfsMountEndpointProperties, SmbMountEndpointProperties

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 server.

Variables:

endpoint_type (str or EndpointType) – The Endpoint resource type. Required. Known values are: “AzureStorageBlobContainer”, “NfsMount”, “AzureStorageSmbFileShare”, and “SmbMount”.
description (str) – A description for the Endpoint.
provisioning_state (str or ProvisioningState) – The provisioning state of this resource. Known values are: “Succeeded”, “Canceled”, “Failed”, and “Deleting”.

Keyword Arguments:

description (str) – A description for the Endpoint.

class azure.mgmt.storagemover.models.EndpointBaseUpdateParameters(*, properties: _models.EndpointBaseUpdateProperties | None = None, **kwargs: Any)[source]¶

Bases: Model

The Endpoint resource.

Variables:: properties (EndpointBaseUpdateProperties) – The Endpoint resource, which contains information about file sources and targets.
Keyword Arguments:: properties (EndpointBaseUpdateProperties) – The Endpoint resource, which contains information about file sources and targets.

class azure.mgmt.storagemover.models.EndpointBaseUpdateProperties(*, description: str | None = None, **kwargs: Any)[source]¶

Bases: Model

The Endpoint resource, which contains information about file sources and targets.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: AzureStorageBlobContainerEndpointUpdateProperties, AzureStorageSmbFileShareEndpointUpdateProperties, NfsMountEndpointUpdateProperties, SmbMountEndpointUpdateProperties

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

Variables:

endpoint_type (str or EndpointType) – The Endpoint resource type. Required. Known values are: “AzureStorageBlobContainer”, “NfsMount”, “AzureStorageSmbFileShare”, and “SmbMount”.
description (str) – A description for the Endpoint.

Keyword Arguments:

description (str) – A description for the Endpoint.

class azure.mgmt.storagemover.models.EndpointList(**kwargs: Any)[source]¶

Bases: Model

List of Endpoints.

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

Variables:

value (list[Endpoint]) –
next_link (str) – Request URL that can be used to query next page of containers. Returned when total number of requested containers exceed maximum page size.

class azure.mgmt.storagemover.models.EndpointType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶

Bases: str, Enum

The Endpoint resource type.

AZURE_STORAGE_BLOB_CONTAINER = 'AzureStorageBlobContainer'¶

AZURE_STORAGE_SMB_FILE_SHARE = 'AzureStorageSmbFileShare'¶

NFS_MOUNT = 'NfsMount'¶

SMB_MOUNT = 'SmbMount'¶

class azure.mgmt.storagemover.models.ErrorAdditionalInfo(**kwargs: Any)[source]¶

Bases: Model

The resource management error additional info.

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

Variables:

type (str) – The additional info type.
info (JSON) – The additional info.

class azure.mgmt.storagemover.models.ErrorDetail(**kwargs: Any)[source]¶

Bases: Model

The error detail.

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

Variables:

code (str) – The error code.
message (str) – The error message.
target (str) – The error target.
details (list[ErrorDetail]) – The error details.
additional_info (list[ErrorAdditionalInfo]) – The error additional info.

class azure.mgmt.storagemover.models.ErrorResponse(*, error: _models.ErrorDetail | None = None, **kwargs: Any)[source]¶

Bases: Model

Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).

Variables:: error (ErrorDetail) – The error object.
Keyword Arguments:: error (ErrorDetail) – The error object.

class azure.mgmt.storagemover.models.JobDefinition(*, copy_mode: str | _models.CopyMode, source_name: str, target_name: str, description: str | None = None, source_subpath: str | None = None, target_subpath: str | None = None, agent_name: str | None = None, **kwargs: Any)[source]¶

Bases: ProxyResource

The Job Definition resource.

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 server.

Variables:

id (str) – Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}. # pylint: disable=line-too-long
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.
description (str) – A description for the Job Definition.
copy_mode (str or CopyMode) – Strategy to use for copy. Required. Known values are: “Additive” and “Mirror”.
source_name (str) – The name of the source Endpoint. Required.
source_resource_id (str) – Fully qualified resource ID of the source Endpoint.
source_subpath (str) – The subpath to use when reading from the source Endpoint.
target_name (str) – The name of the target Endpoint. Required.
target_resource_id (str) – Fully qualified resource ID of the target Endpoint.
target_subpath (str) – The subpath to use when writing to the target Endpoint.
latest_job_run_name (str) – The name of the Job Run in a non-terminal state, if exists.
latest_job_run_resource_id (str) – The fully qualified resource ID of the Job Run in a non-terminal state, if exists.
latest_job_run_status (str or JobRunStatus) – The current status of the Job Run in a non-terminal state, if exists. Known values are: “Queued”, “Started”, “Running”, “CancelRequested”, “Canceling”, “Canceled”, “Failed”, “Succeeded”, and “PausedByBandwidthManagement”.
agent_name (str) – Name of the Agent to assign for new Job Runs of this Job Definition.
agent_resource_id (str) – Fully qualified resource id of the Agent to assign for new Job Runs of this Job Definition.
provisioning_state (str or ProvisioningState) – The provisioning state of this resource. Known values are: “Succeeded”, “Canceled”, “Failed”, and “Deleting”.

Keyword Arguments:

description (str) – A description for the Job Definition.
copy_mode (str or CopyMode) – Strategy to use for copy. Required. Known values are: “Additive” and “Mirror”.
source_name (str) – The name of the source Endpoint. Required.
source_subpath (str) – The subpath to use when reading from the source Endpoint.
target_name (str) – The name of the target Endpoint. Required.
target_subpath (str) – The subpath to use when writing to the target Endpoint.
agent_name (str) – Name of the Agent to assign for new Job Runs of this Job Definition.

class azure.mgmt.storagemover.models.JobDefinitionList(**kwargs: Any)[source]¶

Bases: Model

List of Job Definitions.

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

Variables:

value (list[JobDefinition]) –
next_link (str) – Request URL that can be used to query next page of containers. Returned when total number of requested containers exceed maximum page size.

class azure.mgmt.storagemover.models.JobDefinitionUpdateParameters(*, description: str | None = None, copy_mode: str | _models.CopyMode | None = None, agent_name: str | None = None, **kwargs: Any)[source]¶

Bases: Model

The Job Definition resource.

Variables:

description (str) – A description for the Job Definition.
copy_mode (str or CopyMode) – Strategy to use for copy. Known values are: “Additive” and “Mirror”.
agent_name (str) – Name of the Agent to assign for new Job Runs of this Job Definition.

Keyword Arguments:

description (str) – A description for the Job Definition.
copy_mode (str or CopyMode) – Strategy to use for copy. Known values are: “Additive” and “Mirror”.
agent_name (str) – Name of the Agent to assign for new Job Runs of this Job Definition.

class azure.mgmt.storagemover.models.JobRun(**kwargs: Any)[source]¶

Bases: ProxyResource

The Job Run 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}. # pylint: disable=line-too-long
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.
status (str or JobRunStatus) – The state of the job execution. Known values are: “Queued”, “Started”, “Running”, “CancelRequested”, “Canceling”, “Canceled”, “Failed”, “Succeeded”, and “PausedByBandwidthManagement”.
scan_status (str or JobRunScanStatus) – The status of Agent’s scanning of source. Known values are: “NotStarted”, “Scanning”, and “Completed”.
agent_name (str) – Name of the Agent assigned to this run.
agent_resource_id (str) – Fully qualified resource id of the Agent assigned to this run.
execution_start_time (datetime) – Start time of the run. Null if no Agent reported that the job has started.
execution_end_time (datetime) – End time of the run. Null if Agent has not reported that the job has ended.
last_status_update (datetime) – The last updated time of the Job Run.
items_scanned (int) – Number of items scanned so far in source.
items_excluded (int) – Number of items that will not be transferred, as they are excluded by user configuration.
items_unsupported (int) – Number of items that will not be transferred, as they are unsupported on target.
items_no_transfer_needed (int) – Number of items that will not be transferred, as they are already found on target (e.g. mirror mode).
items_failed (int) – Number of items that were attempted to transfer and failed.
items_transferred (int) – Number of items successfully transferred to target.
bytes_scanned (int) – Bytes of data scanned so far in source.
bytes_excluded (int) – Bytes of data that will not be transferred, as they are excluded by user configuration.
bytes_unsupported (int) – Bytes of data that will not be transferred, as they are unsupported on target.
bytes_no_transfer_needed (int) – Bytes of data that will not be transferred, as they are already found on target (e.g. mirror mode).
bytes_failed (int) – Bytes of data that were attempted to transfer and failed.
bytes_transferred (int) – Bytes of data successfully transferred to target.
source_name (str) – Name of source Endpoint resource. This resource may no longer exist.
source_resource_id (str) – Fully qualified resource id of source Endpoint. This id may no longer exist.
source_properties (JSON) – Copy of source Endpoint resource’s properties at time of Job Run creation.
target_name (str) – Name of target Endpoint resource. This resource may no longer exist.
target_resource_id (str) – Fully qualified resource id of of Endpoint. This id may no longer exist.
target_properties (JSON) – Copy of Endpoint resource’s properties at time of Job Run creation.
job_definition_properties (JSON) – Copy of parent Job Definition’s properties at time of Job Run creation.
error (JobRunError) – Error details.
provisioning_state (str or ProvisioningState) – The provisioning state of this resource. Known values are: “Succeeded”, “Canceled”, “Failed”, and “Deleting”.

class azure.mgmt.storagemover.models.JobRunError(*, code: str | None = None, message: str | None = None, target: str | None = None, **kwargs: Any)[source]¶

Bases: 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.

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.

class azure.mgmt.storagemover.models.JobRunList(**kwargs: Any)[source]¶

Bases: Model

List of Job Runs.

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

Variables:

value (list[JobRun]) –
next_link (str) – Request URL that can be used to query next page of containers. Returned when total number of requested containers exceed maximum page size.

class azure.mgmt.storagemover.models.JobRunResourceId(**kwargs: Any)[source]¶

Bases: Model

Response that identifies a Job Run.

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

Variables:: job_run_resource_id (str) – Fully qualified resource id of the Job Run.

class azure.mgmt.storagemover.models.JobRunScanStatus(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶

Bases: str, Enum

The status of Agent’s scanning of source.

COMPLETED = 'Completed'¶

NOT_STARTED = 'NotStarted'¶

SCANNING = 'Scanning'¶

class azure.mgmt.storagemover.models.JobRunStatus(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶

Bases: str, Enum

The current status of the Job Run in a non-terminal state, if exists.

CANCELED = 'Canceled'¶

CANCELING = 'Canceling'¶

CANCEL_REQUESTED = 'CancelRequested'¶

FAILED = 'Failed'¶

PAUSED_BY_BANDWIDTH_MANAGEMENT = 'PausedByBandwidthManagement'¶

QUEUED = 'Queued'¶

RUNNING = 'Running'¶

STARTED = 'Started'¶

SUCCEEDED = 'Succeeded'¶

class azure.mgmt.storagemover.models.Minute(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶

Bases: int, Enum

The minute element of the time. Allowed values are 0 and 30. If not specified, its value defaults to 0.

THIRTY = 30¶

ZERO = 0¶

class azure.mgmt.storagemover.models.NfsMountEndpointProperties(*, host: str, export: str, description: str | None = None, nfs_version: str | _models.NfsVersion | None = None, **kwargs: Any)[source]¶

Bases: EndpointBaseProperties

The properties of NFS share endpoint.

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 server.

Variables:

endpoint_type (str or EndpointType) – The Endpoint resource type. Required. Known values are: “AzureStorageBlobContainer”, “NfsMount”, “AzureStorageSmbFileShare”, and “SmbMount”.
description (str) – A description for the Endpoint.
provisioning_state (str or ProvisioningState) – The provisioning state of this resource. Known values are: “Succeeded”, “Canceled”, “Failed”, and “Deleting”.
host (str) – The host name or IP address of the server exporting the file system. Required.
nfs_version (str or NfsVersion) – The NFS protocol version. Known values are: “NFSauto”, “NFSv3”, and “NFSv4”.
export (str) – The directory being exported from the server. Required.

Keyword Arguments:

description (str) – A description for the Endpoint.
host (str) – The host name or IP address of the server exporting the file system. Required.
nfs_version (str or NfsVersion) – The NFS protocol version. Known values are: “NFSauto”, “NFSv3”, and “NFSv4”.
export (str) – The directory being exported from the server. Required.

class azure.mgmt.storagemover.models.NfsMountEndpointUpdateProperties(*, description: str | None = None, **kwargs: Any)[source]¶

Bases: EndpointBaseUpdateProperties

NfsMountEndpointUpdateProperties.

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

Variables:

endpoint_type (str or EndpointType) – The Endpoint resource type. Required. Known values are: “AzureStorageBlobContainer”, “NfsMount”, “AzureStorageSmbFileShare”, and “SmbMount”.
description (str) – A description for the Endpoint.

Keyword Arguments:

description (str) – A description for the Endpoint.

class azure.mgmt.storagemover.models.NfsVersion(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶

Bases: str, Enum

The NFS protocol version.

NF_SAUTO = 'NFSauto'¶

NF_SV3 = 'NFSv3'¶

NF_SV4 = 'NFSv4'¶

class azure.mgmt.storagemover.models.Operation(*, display: _models.OperationDisplay | None = None, **kwargs: Any)[source]¶

Bases: Model

Details of a REST API operation, returned from the Resource Provider Operations API.

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

Variables:

name (str) – The name of the operation, as per Resource-Based Access Control (RBAC). Examples: “Microsoft.Compute/virtualMachines/write”, “Microsoft.Compute/virtualMachines/capture/action”.
is_data_action (bool) – Whether the operation applies to data-plane. This is “true” for data-plane operations and “false” for ARM/control-plane operations.
display (OperationDisplay) – Localized display information for this particular operation.
origin (str or Origin) – The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is “user,system”. Known values are: “user”, “system”, and “user,system”.
action_type (str or ActionType) – Enum. Indicates the action type. “Internal” refers to actions that are for internal only APIs. “Internal”

Keyword Arguments:

display (OperationDisplay) – Localized display information for this particular operation.

class azure.mgmt.storagemover.models.OperationDisplay(**kwargs: Any)[source]¶

Bases: Model

Localized display information for this particular operation.

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

Variables:

provider (str) – The localized friendly form of the resource provider name, e.g. “Microsoft Monitoring Insights” or “Microsoft Compute”.
resource (str) – The localized friendly name of the resource type related to this operation. E.g. “Virtual Machines” or “Job Schedule Collections”.
operation (str) – The concise, localized friendly name for the operation; suitable for dropdowns. E.g. “Create or Update Virtual Machine”, “Restart Virtual Machine”.
description (str) – The short, localized friendly description of the operation; suitable for tool tips and detailed views.

class azure.mgmt.storagemover.models.OperationListResult(**kwargs: Any)[source]¶

Bases: Model

A list of REST API operations supported by an Azure Resource Provider. It contains an URL link to get the next set of results.

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

Variables:

value (list[Operation]) – List of operations supported by the resource provider.
next_link (str) – URL to get the next set of operation list results (if there are any).

class azure.mgmt.storagemover.models.Origin(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶

Bases: str, Enum

The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is “user,system”.

SYSTEM = 'system'¶

USER = 'user'¶

USER_SYSTEM = 'user,system'¶

class azure.mgmt.storagemover.models.Project(*, description: str | None = None, **kwargs: Any)[source]¶

Bases: ProxyResource

The Project 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}. # pylint: disable=line-too-long
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.
description (str) – A description for the Project.
provisioning_state (str or ProvisioningState) – The provisioning state of this resource. Known values are: “Succeeded”, “Canceled”, “Failed”, and “Deleting”.

Keyword Arguments:

description (str) – A description for the Project.

class azure.mgmt.storagemover.models.ProjectList(**kwargs: Any)[source]¶

Bases: Model

List of Project resources.

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

Variables:

value (list[Project]) –
next_link (str) – Request URL that can be used to query next page of containers. Returned when total number of requested containers exceed maximum page size.

class azure.mgmt.storagemover.models.ProjectUpdateParameters(*, description: str | None = None, **kwargs: Any)[source]¶

Bases: Model

The Project resource.

Variables:: description (str) – A description for the Project.
Keyword Arguments:: description (str) – A description for the Project.

class azure.mgmt.storagemover.models.ProvisioningState(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶

Bases: str, Enum

The provisioning state of a resource.

CANCELED = 'Canceled'¶

DELETING = 'Deleting'¶

FAILED = 'Failed'¶

SUCCEEDED = 'Succeeded'¶

class azure.mgmt.storagemover.models.ProxyResource(**kwargs: Any)[source]¶

Bases: 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}. # pylint: disable=line-too-long
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.storagemover.models.Recurrence(*, start_time: _models.Time, end_time: _models.Time, **kwargs: Any)[source]¶

Bases: Model

The schedule recurrence.

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

Variables:

start_time (Time) – The start time of the schedule recurrence. Full hour and 30-minute intervals are supported. Required.
end_time (Time) – The end time of the schedule recurrence. Full hour and 30-minute intervals are supported. Required.

Keyword Arguments:

start_time (Time) – The start time of the schedule recurrence. Full hour and 30-minute intervals are supported. Required.
end_time (Time) – The end time of the schedule recurrence. Full hour and 30-minute intervals are supported. Required.

class azure.mgmt.storagemover.models.Resource(**kwargs: Any)[source]¶

Bases: 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}. # pylint: disable=line-too-long
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.storagemover.models.SmbMountEndpointProperties(*, host: str, share_name: str, description: str | None = None, credentials: _models.AzureKeyVaultSmbCredentials | None = None, **kwargs: Any)[source]¶

Bases: EndpointBaseProperties

The properties of SMB share endpoint.

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 server.

Variables:

endpoint_type (str or EndpointType) – The Endpoint resource type. Required. Known values are: “AzureStorageBlobContainer”, “NfsMount”, “AzureStorageSmbFileShare”, and “SmbMount”.
description (str) – A description for the Endpoint.
provisioning_state (str or ProvisioningState) – The provisioning state of this resource. Known values are: “Succeeded”, “Canceled”, “Failed”, and “Deleting”.
host (str) – The host name or IP address of the server exporting the file system. Required.
share_name (str) – The name of the SMB share being exported from the server. Required.
credentials (AzureKeyVaultSmbCredentials) – The Azure Key Vault secret URIs which store the required credentials to access the SMB share.

Keyword Arguments:

description (str) – A description for the Endpoint.
host (str) – The host name or IP address of the server exporting the file system. Required.
share_name (str) – The name of the SMB share being exported from the server. Required.
credentials (AzureKeyVaultSmbCredentials) – The Azure Key Vault secret URIs which store the required credentials to access the SMB share.

class azure.mgmt.storagemover.models.SmbMountEndpointUpdateProperties(*, description: str | None = None, credentials: _models.AzureKeyVaultSmbCredentials | None = None, **kwargs: Any)[source]¶

Bases: EndpointBaseUpdateProperties

The properties of SMB share endpoint to update.

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

Variables:

endpoint_type (str or EndpointType) – The Endpoint resource type. Required. Known values are: “AzureStorageBlobContainer”, “NfsMount”, “AzureStorageSmbFileShare”, and “SmbMount”.
description (str) – A description for the Endpoint.
credentials (AzureKeyVaultSmbCredentials) – The Azure Key Vault secret URIs which store the required credentials to access the SMB share.

Keyword Arguments:

description (str) – A description for the Endpoint.
credentials (AzureKeyVaultSmbCredentials) – The Azure Key Vault secret URIs which store the required credentials to access the SMB share.

class azure.mgmt.storagemover.models.StorageMover(*, location: str, tags: Dict[str, str] | None = None, description: str | None = None, **kwargs: Any)[source]¶

Bases: TrackedResource

The Storage Mover resource, which is a container for a group of Agents, Projects, and Endpoints.

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 server.

Variables:

id (str) – Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}. # pylint: disable=line-too-long
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.
description (str) – A description for the Storage Mover.
provisioning_state (str or ProvisioningState) – The provisioning state of this resource. Known values are: “Succeeded”, “Canceled”, “Failed”, and “Deleting”.

Keyword Arguments:

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

class azure.mgmt.storagemover.models.StorageMoverList(**kwargs: Any)[source]¶

Bases: Model

List of Storage Movers.

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

Variables:

value (list[StorageMover]) –
next_link (str) – Request URL that can be used to query next page of containers. Returned when total number of requested containers exceed maximum page size.

class azure.mgmt.storagemover.models.StorageMoverUpdateParameters(*, tags: Dict[str, str] | None = None, description: str | None = None, **kwargs: Any)[source]¶

Bases: Model

The Storage Mover resource.

Variables:

tags (dict[str, str]) – Resource tags.
description (str) – A description for the Storage Mover.

Keyword Arguments:

tags (dict[str, str]) – Resource tags.
description (str) – A description for the Storage Mover.

Bases: 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.storagemover.models.Time(*, hour: int, minute: int | _models.Minute = 0, **kwargs: Any)[source]¶

Bases: Model

The time of day.

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

Variables:

hour (int) – The hour element of the time. Allowed values range from 0 (start of the selected day) to 24 (end of the selected day). Hour value 24 cannot be combined with any other minute value but 0. Required.
minute (int or Minute) – The minute element of the time. Allowed values are 0 and 30. If not specified, its value defaults to 0. Known values are: 0 and 30.

Keyword Arguments:

hour (int) – The hour element of the time. Allowed values range from 0 (start of the selected day) to 24 (end of the selected day). Hour value 24 cannot be combined with any other minute value but 0. Required.
minute (int or Minute) – The minute element of the time. Allowed values are 0 and 30. If not specified, its value defaults to 0. Known values are: 0 and 30.

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

Bases: 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 server.

Variables:

id (str) – Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}. # pylint: disable=line-too-long
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.storagemover.models.UploadLimit(*, limit_in_mbps: int, **kwargs: Any)[source]¶

Bases: Model

The WAN-link upload limit.

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

Variables:: limit_in_mbps (int) – The WAN-link upload bandwidth (maximum data transfer rate) in megabits per second. Value of 0 indicates no throughput is allowed and any running migration job is effectively paused for the duration of this recurrence. Only data plane operations are governed by this limit. Control plane operations ensure seamless functionality. The agent may exceed this limit with control messages, if necessary. Required.
Keyword Arguments:: limit_in_mbps (int) – The WAN-link upload bandwidth (maximum data transfer rate) in megabits per second. Value of 0 indicates no throughput is allowed and any running migration job is effectively paused for the duration of this recurrence. Only data plane operations are governed by this limit. Control plane operations ensure seamless functionality. The agent may exceed this limit with control messages, if necessary. Required.

class azure.mgmt.storagemover.models.UploadLimitSchedule(*, weekly_recurrences: List[_models.UploadLimitWeeklyRecurrence] | None = None, **kwargs: Any)[source]¶

Bases: Model

The WAN-link upload limit schedule. Overlapping recurrences are not allowed.

Variables:: weekly_recurrences (list[UploadLimitWeeklyRecurrence]) – The set of weekly repeating recurrences of the WAN-link upload limit schedule.
Keyword Arguments:: weekly_recurrences (list[UploadLimitWeeklyRecurrence]) – The set of weekly repeating recurrences of the WAN-link upload limit schedule.

class azure.mgmt.storagemover.models.UploadLimitWeeklyRecurrence(*, limit_in_mbps: int, start_time: _models.Time, end_time: _models.Time, days: List[str | _models.DayOfWeek], **kwargs: Any)[source]¶

Bases: WeeklyRecurrence, UploadLimit

The weekly recurrence of the WAN-link upload limit schedule. The start time must be earlier in the day than the end time. The recurrence must not span across multiple days.

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

Variables:

limit_in_mbps (int) – The WAN-link upload bandwidth (maximum data transfer rate) in megabits per second. Value of 0 indicates no throughput is allowed and any running migration job is effectively paused for the duration of this recurrence. Only data plane operations are governed by this limit. Control plane operations ensure seamless functionality. The agent may exceed this limit with control messages, if necessary. Required.
start_time (Time) – The start time of the schedule recurrence. Full hour and 30-minute intervals are supported. Required.
end_time (Time) – The end time of the schedule recurrence. Full hour and 30-minute intervals are supported. Required.
days (list[str or DayOfWeek]) – The set of days of week for the schedule recurrence. A day must not be specified more than once in a recurrence. Required.

Keyword Arguments:

limit_in_mbps (int) – The WAN-link upload bandwidth (maximum data transfer rate) in megabits per second. Value of 0 indicates no throughput is allowed and any running migration job is effectively paused for the duration of this recurrence. Only data plane operations are governed by this limit. Control plane operations ensure seamless functionality. The agent may exceed this limit with control messages, if necessary. Required.
start_time (Time) – The start time of the schedule recurrence. Full hour and 30-minute intervals are supported. Required.
end_time (Time) – The end time of the schedule recurrence. Full hour and 30-minute intervals are supported. Required.
days (list[str or DayOfWeek]) – The set of days of week for the schedule recurrence. A day must not be specified more than once in a recurrence. Required.

class azure.mgmt.storagemover.models.WeeklyRecurrence(*, start_time: _models.Time, end_time: _models.Time, days: List[str | _models.DayOfWeek], **kwargs: Any)[source]¶

Bases: Recurrence

The weekly recurrence of the schedule.

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

Variables:

start_time (Time) – The start time of the schedule recurrence. Full hour and 30-minute intervals are supported. Required.
end_time (Time) – The end time of the schedule recurrence. Full hour and 30-minute intervals are supported. Required.
days (list[str or DayOfWeek]) – The set of days of week for the schedule recurrence. A day must not be specified more than once in a recurrence. Required.

Keyword Arguments:

start_time (Time) – The start time of the schedule recurrence. Full hour and 30-minute intervals are supported. Required.
end_time (Time) – The end time of the schedule recurrence. Full hour and 30-minute intervals are supported. Required.
days (list[str or DayOfWeek]) – The set of days of week for the schedule recurrence. A day must not be specified more than once in a recurrence. Required.