azure.mgmt.storagemover.operations module

class azure.mgmt.storagemover.operations.AgentsOperations(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through StorageMoverMgmtClient’s agents attribute.

begin_delete(resource_group_name: str, storage_mover_name: str, agent_name: str, **kwargs: Any) → LROPoller[None][source]

Deletes an Agent resource.

Parameters:

  • resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

  • storage_mover_name (str) – The name of the Storage Mover resource. Required.

  • agent_name (str) – The name of the Agent resource. Required.

Returns:

An instance of LROPoller that returns either None or the result of cls(response)

Return type:

LROPoller[None]

Raises:

HttpResponseError –

create_or_update(resource_group_name: str, storage_mover_name: str, agent_name: str, agent: _models.Agent, *, content_type: str = 'application/json', **kwargs: Any) → _models.Agent[source]
create_or_update(resource_group_name: str, storage_mover_name: str, agent_name: str, agent: IO[bytes], *, content_type: str = 'application/json', **kwargs: Any) → _models.Agent

Creates or updates an Agent resource, which references a hybrid compute machine that can run jobs.

Parameters:

  • resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

  • storage_mover_name (str) – The name of the Storage Mover resource. Required.

  • agent_name (str) – The name of the Agent resource. Required.

  • agent (Agent or IO[bytes]) – Is either a Agent type or a IO[bytes] type. Required.

Returns:

Agent or the result of cls(response)

Return type:

Agent

Raises:

HttpResponseError –

get(resource_group_name: str, storage_mover_name: str, agent_name: str, **kwargs: Any) → Agent[source]

Gets an Agent resource.

Parameters:

  • resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

  • storage_mover_name (str) – The name of the Storage Mover resource. Required.

  • agent_name (str) – The name of the Agent resource. Required.

Returns:

Agent or the result of cls(response)

Return type:

Agent

Raises:

HttpResponseError –

list(resource_group_name: str, storage_mover_name: str, **kwargs: Any) → Iterable[Agent][source]

Lists all Agents in a Storage Mover.

Parameters:

  • resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

  • storage_mover_name (str) – The name of the Storage Mover resource. Required.

Returns:

An iterator like instance of either Agent or the result of cls(response)

Return type:

ItemPaged[Agent]

Raises:

HttpResponseError –

update(resource_group_name: str, storage_mover_name: str, agent_name: str, agent: _models.AgentUpdateParameters, *, content_type: str = 'application/json', **kwargs: Any) → _models.Agent[source]
update(resource_group_name: str, storage_mover_name: str, agent_name: str, agent: IO[bytes], *, content_type: str = 'application/json', **kwargs: Any) → _models.Agent

Creates or updates an Agent resource.

Parameters:

  • resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

  • storage_mover_name (str) – The name of the Storage Mover resource. Required.

  • agent_name (str) – The name of the Agent resource. Required.

  • agent (AgentUpdateParameters or IO[bytes]) – Is either a AgentUpdateParameters type or a IO[bytes] type. Required.

Returns:

Agent or the result of cls(response)

Return type:

Agent

Raises:

HttpResponseError –

models = <module 'azure.mgmt.storagemover.models' from '/mnt/vss/_work/1/s/sdk/storagemover/azure-mgmt-storagemover/.tox/sphinx/lib/python3.11/site-packages/azure/mgmt/storagemover/models/__init__.py'>
class azure.mgmt.storagemover.operations.EndpointsOperations(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through StorageMoverMgmtClient’s endpoints attribute.

begin_delete(resource_group_name: str, storage_mover_name: str, endpoint_name: str, **kwargs: Any) → LROPoller[None][source]

Deletes an Endpoint resource.

Parameters:

  • resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

  • storage_mover_name (str) – The name of the Storage Mover resource. Required.

  • endpoint_name (str) – The name of the Endpoint resource. Required.

Returns:

An instance of LROPoller that returns either None or the result of cls(response)

Return type:

LROPoller[None]

Raises:

HttpResponseError –

create_or_update(resource_group_name: str, storage_mover_name: str, endpoint_name: str, endpoint: _models.Endpoint, *, content_type: str = 'application/json', **kwargs: Any) → _models.Endpoint[source]
create_or_update(resource_group_name: str, storage_mover_name: str, endpoint_name: str, endpoint: IO[bytes], *, content_type: str = 'application/json', **kwargs: Any) → _models.Endpoint

Creates or updates an Endpoint resource, which represents a data transfer source or destination.

Parameters:

  • resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

  • storage_mover_name (str) – The name of the Storage Mover resource. Required.

  • endpoint_name (str) – The name of the Endpoint resource. Required.

  • endpoint (Endpoint or IO[bytes]) – Is either a Endpoint type or a IO[bytes] type. Required.

Returns:

Endpoint or the result of cls(response)

Return type:

Endpoint

Raises:

HttpResponseError –

get(resource_group_name: str, storage_mover_name: str, endpoint_name: str, **kwargs: Any) → Endpoint[source]

Gets an Endpoint resource.

Parameters:

  • resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

  • storage_mover_name (str) – The name of the Storage Mover resource. Required.

  • endpoint_name (str) – The name of the Endpoint resource. Required.

Returns:

Endpoint or the result of cls(response)

Return type:

Endpoint

Raises:

HttpResponseError –

list(resource_group_name: str, storage_mover_name: str, **kwargs: Any) → Iterable[Endpoint][source]

Lists all Endpoints in a Storage Mover.

Parameters:

  • resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

  • storage_mover_name (str) – The name of the Storage Mover resource. Required.

Returns:

An iterator like instance of either Endpoint or the result of cls(response)

Return type:

ItemPaged[Endpoint]

Raises:

HttpResponseError –

update(resource_group_name: str, storage_mover_name: str, endpoint_name: str, endpoint: _models.EndpointBaseUpdateParameters, *, content_type: str = 'application/json', **kwargs: Any) → _models.Endpoint[source]
update(resource_group_name: str, storage_mover_name: str, endpoint_name: str, endpoint: IO[bytes], *, content_type: str = 'application/json', **kwargs: Any) → _models.Endpoint

Updates properties for an Endpoint resource. Properties not specified in the request body will be unchanged.

Parameters:

  • resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

  • storage_mover_name (str) – The name of the Storage Mover resource. Required.

  • endpoint_name (str) – The name of the Endpoint resource. Required.

  • endpoint (EndpointBaseUpdateParameters or IO[bytes]) – Is either a EndpointBaseUpdateParameters type or a IO[bytes] type. Required.

Returns:

Endpoint or the result of cls(response)

Return type:

Endpoint

Raises:

HttpResponseError –

models = <module 'azure.mgmt.storagemover.models' from '/mnt/vss/_work/1/s/sdk/storagemover/azure-mgmt-storagemover/.tox/sphinx/lib/python3.11/site-packages/azure/mgmt/storagemover/models/__init__.py'>
class azure.mgmt.storagemover.operations.JobDefinitionsOperations(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through StorageMoverMgmtClient’s job_definitions attribute.

begin_delete(resource_group_name: str, storage_mover_name: str, project_name: str, job_definition_name: str, **kwargs: Any) → LROPoller[None][source]

Deletes a Job Definition resource.

Parameters:

  • resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

  • storage_mover_name (str) – The name of the Storage Mover resource. Required.

  • project_name (str) – The name of the Project resource. Required.

  • job_definition_name (str) – The name of the Job Definition resource. Required.

Returns:

An instance of LROPoller that returns either None or the result of cls(response)

Return type:

LROPoller[None]

Raises:

HttpResponseError –

create_or_update(resource_group_name: str, storage_mover_name: str, project_name: str, job_definition_name: str, job_definition: _models.JobDefinition, *, content_type: str = 'application/json', **kwargs: Any) → _models.JobDefinition[source]
create_or_update(resource_group_name: str, storage_mover_name: str, project_name: str, job_definition_name: str, job_definition: IO[bytes], *, content_type: str = 'application/json', **kwargs: Any) → _models.JobDefinition

Creates or updates a Job Definition resource, which contains configuration for a single unit of managed data transfer.

Parameters:

  • resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

  • storage_mover_name (str) – The name of the Storage Mover resource. Required.

  • project_name (str) – The name of the Project resource. Required.

  • job_definition_name (str) – The name of the Job Definition resource. Required.

  • job_definition (JobDefinition or IO[bytes]) – Is either a JobDefinition type or a IO[bytes] type. Required.

Returns:

JobDefinition or the result of cls(response)

Return type:

JobDefinition

Raises:

HttpResponseError –

get(resource_group_name: str, storage_mover_name: str, project_name: str, job_definition_name: str, **kwargs: Any) → JobDefinition[source]

Gets a Job Definition resource.

Parameters:

  • resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

  • storage_mover_name (str) – The name of the Storage Mover resource. Required.

  • project_name (str) – The name of the Project resource. Required.

  • job_definition_name (str) – The name of the Job Definition resource. Required.

Returns:

JobDefinition or the result of cls(response)

Return type:

JobDefinition

Raises:

HttpResponseError –

list(resource_group_name: str, storage_mover_name: str, project_name: str, **kwargs: Any) → Iterable[JobDefinition][source]

Lists all Job Definitions in a Project.

Parameters:

  • resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

  • storage_mover_name (str) – The name of the Storage Mover resource. Required.

  • project_name (str) – The name of the Project resource. Required.

Returns:

An iterator like instance of either JobDefinition or the result of cls(response)

Return type:

ItemPaged[JobDefinition]

Raises:

HttpResponseError –

start_job(resource_group_name: str, storage_mover_name: str, project_name: str, job_definition_name: str, **kwargs: Any) → JobRunResourceId[source]

Creates a new Job Run resource for the specified Job Definition and passes it to the Agent for execution.

Parameters:

  • resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

  • storage_mover_name (str) – The name of the Storage Mover resource. Required.

  • project_name (str) – The name of the Project resource. Required.

  • job_definition_name (str) – The name of the Job Definition resource. Required.

Returns:

JobRunResourceId or the result of cls(response)

Return type:

JobRunResourceId

Raises:

HttpResponseError –

stop_job(resource_group_name: str, storage_mover_name: str, project_name: str, job_definition_name: str, **kwargs: Any) → JobRunResourceId[source]

Requests the Agent of any active instance of this Job Definition to stop.

Parameters:

  • resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

  • storage_mover_name (str) – The name of the Storage Mover resource. Required.

  • project_name (str) – The name of the Project resource. Required.

  • job_definition_name (str) – The name of the Job Definition resource. Required.

Returns:

JobRunResourceId or the result of cls(response)

Return type:

JobRunResourceId

Raises:

HttpResponseError –

update(resource_group_name: str, storage_mover_name: str, project_name: str, job_definition_name: str, job_definition: _models.JobDefinitionUpdateParameters, *, content_type: str = 'application/json', **kwargs: Any) → _models.JobDefinition[source]
update(resource_group_name: str, storage_mover_name: str, project_name: str, job_definition_name: str, job_definition: IO[bytes], *, content_type: str = 'application/json', **kwargs: Any) → _models.JobDefinition

Updates properties for a Job Definition resource. Properties not specified in the request body will be unchanged.

Parameters:

  • resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

  • storage_mover_name (str) – The name of the Storage Mover resource. Required.

  • project_name (str) – The name of the Project resource. Required.

  • job_definition_name (str) – The name of the Job Definition resource. Required.

  • job_definition (JobDefinitionUpdateParameters or IO[bytes]) – Is either a JobDefinitionUpdateParameters type or a IO[bytes] type. Required.

Returns:

JobDefinition or the result of cls(response)

Return type:

JobDefinition

Raises:

HttpResponseError –

models = <module 'azure.mgmt.storagemover.models' from '/mnt/vss/_work/1/s/sdk/storagemover/azure-mgmt-storagemover/.tox/sphinx/lib/python3.11/site-packages/azure/mgmt/storagemover/models/__init__.py'>
class azure.mgmt.storagemover.operations.JobRunsOperations(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through StorageMoverMgmtClient’s job_runs attribute.

get(resource_group_name: str, storage_mover_name: str, project_name: str, job_definition_name: str, job_run_name: str, **kwargs: Any) → JobRun[source]

Gets a Job Run resource.

Parameters:

  • resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

  • storage_mover_name (str) – The name of the Storage Mover resource. Required.

  • project_name (str) – The name of the Project resource. Required.

  • job_definition_name (str) – The name of the Job Definition resource. Required.

  • job_run_name (str) – The name of the Job Run resource. Required.

Returns:

JobRun or the result of cls(response)

Return type:

JobRun

Raises:

HttpResponseError –

list(resource_group_name: str, storage_mover_name: str, project_name: str, job_definition_name: str, **kwargs: Any) → Iterable[JobRun][source]

Lists all Job Runs in a Job Definition.

Parameters:

  • resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

  • storage_mover_name (str) – The name of the Storage Mover resource. Required.

  • project_name (str) – The name of the Project resource. Required.

  • job_definition_name (str) – The name of the Job Definition resource. Required.

Returns:

An iterator like instance of either JobRun or the result of cls(response)

Return type:

ItemPaged[JobRun]

Raises:

HttpResponseError –

models = <module 'azure.mgmt.storagemover.models' from '/mnt/vss/_work/1/s/sdk/storagemover/azure-mgmt-storagemover/.tox/sphinx/lib/python3.11/site-packages/azure/mgmt/storagemover/models/__init__.py'>
class azure.mgmt.storagemover.operations.Operations(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through StorageMoverMgmtClient’s operations attribute.

list(**kwargs: Any) → Iterable[Operation][source]

Lists all the supported operations for the Azure Storage Mover REST API.

Lists all the supported operations for the Azure Storage Mover REST API.

Returns:

An iterator like instance of either Operation or the result of cls(response)

Return type:

ItemPaged[Operation]

Raises:

HttpResponseError –

models = <module 'azure.mgmt.storagemover.models' from '/mnt/vss/_work/1/s/sdk/storagemover/azure-mgmt-storagemover/.tox/sphinx/lib/python3.11/site-packages/azure/mgmt/storagemover/models/__init__.py'>
class azure.mgmt.storagemover.operations.ProjectsOperations(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through StorageMoverMgmtClient’s projects attribute.

begin_delete(resource_group_name: str, storage_mover_name: str, project_name: str, **kwargs: Any) → LROPoller[None][source]

Deletes a Project resource.

Parameters:

  • resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

  • storage_mover_name (str) – The name of the Storage Mover resource. Required.

  • project_name (str) – The name of the Project resource. Required.

Returns:

An instance of LROPoller that returns either None or the result of cls(response)

Return type:

LROPoller[None]

Raises:

HttpResponseError –

create_or_update(resource_group_name: str, storage_mover_name: str, project_name: str, project: _models.Project, *, content_type: str = 'application/json', **kwargs: Any) → _models.Project[source]
create_or_update(resource_group_name: str, storage_mover_name: str, project_name: str, project: IO[bytes], *, content_type: str = 'application/json', **kwargs: Any) → _models.Project

Creates or updates a Project resource, which is a logical grouping of related jobs.

Parameters:

  • resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

  • storage_mover_name (str) – The name of the Storage Mover resource. Required.

  • project_name (str) – The name of the Project resource. Required.

  • project (Project or IO[bytes]) – Is either a Project type or a IO[bytes] type. Required.

Returns:

Project or the result of cls(response)

Return type:

Project

Raises:

HttpResponseError –

get(resource_group_name: str, storage_mover_name: str, project_name: str, **kwargs: Any) → Project[source]

Gets a Project resource.

Parameters:

  • resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

  • storage_mover_name (str) – The name of the Storage Mover resource. Required.

  • project_name (str) – The name of the Project resource. Required.

Returns:

Project or the result of cls(response)

Return type:

Project

Raises:

HttpResponseError –

list(resource_group_name: str, storage_mover_name: str, **kwargs: Any) → Iterable[Project][source]

Lists all Projects in a Storage Mover.

Parameters:

  • resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

  • storage_mover_name (str) – The name of the Storage Mover resource. Required.

Returns:

An iterator like instance of either Project or the result of cls(response)

Return type:

ItemPaged[Project]

Raises:

HttpResponseError –

update(resource_group_name: str, storage_mover_name: str, project_name: str, project: _models.ProjectUpdateParameters, *, content_type: str = 'application/json', **kwargs: Any) → _models.Project[source]
update(resource_group_name: str, storage_mover_name: str, project_name: str, project: IO[bytes], *, content_type: str = 'application/json', **kwargs: Any) → _models.Project

Updates properties for a Project resource. Properties not specified in the request body will be unchanged.

Parameters:

  • resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

  • storage_mover_name (str) – The name of the Storage Mover resource. Required.

  • project_name (str) – The name of the Project resource. Required.

  • project (ProjectUpdateParameters or IO[bytes]) – Is either a ProjectUpdateParameters type or a IO[bytes] type. Required.

Returns:

Project or the result of cls(response)

Return type:

Project

Raises:

HttpResponseError –

models = <module 'azure.mgmt.storagemover.models' from '/mnt/vss/_work/1/s/sdk/storagemover/azure-mgmt-storagemover/.tox/sphinx/lib/python3.11/site-packages/azure/mgmt/storagemover/models/__init__.py'>
class azure.mgmt.storagemover.operations.StorageMoversOperations(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through StorageMoverMgmtClient’s storage_movers attribute.

begin_delete(resource_group_name: str, storage_mover_name: str, **kwargs: Any) → LROPoller[None][source]

Deletes a Storage Mover resource.

Parameters:

  • resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

  • storage_mover_name (str) – The name of the Storage Mover resource. Required.

Returns:

An instance of LROPoller that returns either None or the result of cls(response)

Return type:

LROPoller[None]

Raises:

HttpResponseError –

create_or_update(resource_group_name: str, storage_mover_name: str, storage_mover: _models.StorageMover, *, content_type: str = 'application/json', **kwargs: Any) → _models.StorageMover[source]
create_or_update(resource_group_name: str, storage_mover_name: str, storage_mover: IO[bytes], *, content_type: str = 'application/json', **kwargs: Any) → _models.StorageMover

Creates or updates a top-level Storage Mover resource.

Parameters:

  • resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

  • storage_mover_name (str) – The name of the Storage Mover resource. Required.

  • storage_mover (StorageMover or IO[bytes]) – Is either a StorageMover type or a IO[bytes] type. Required.

Returns:

StorageMover or the result of cls(response)

Return type:

StorageMover

Raises:

HttpResponseError –

get(resource_group_name: str, storage_mover_name: str, **kwargs: Any) → StorageMover[source]

Gets a Storage Mover resource.

Parameters:

  • resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

  • storage_mover_name (str) – The name of the Storage Mover resource. Required.

Returns:

StorageMover or the result of cls(response)

Return type:

StorageMover

Raises:

HttpResponseError –

list(resource_group_name: str, **kwargs: Any) → Iterable[StorageMover][source]

Lists all Storage Movers in a resource group.

Parameters:

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

Returns:

An iterator like instance of either StorageMover or the result of cls(response)

Return type:

ItemPaged[StorageMover]

Raises:

HttpResponseError –

list_by_subscription(**kwargs: Any) → Iterable[StorageMover][source]

Lists all Storage Movers in a subscription.

Returns:

An iterator like instance of either StorageMover or the result of cls(response)

Return type:

ItemPaged[StorageMover]

Raises:

HttpResponseError –

update(resource_group_name: str, storage_mover_name: str, storage_mover: _models.StorageMoverUpdateParameters, *, content_type: str = 'application/json', **kwargs: Any) → _models.StorageMover[source]
update(resource_group_name: str, storage_mover_name: str, storage_mover: IO[bytes], *, content_type: str = 'application/json', **kwargs: Any) → _models.StorageMover

Updates properties for a Storage Mover resource. Properties not specified in the request body will be unchanged.

Parameters:

  • resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

  • storage_mover_name (str) – The name of the Storage Mover resource. Required.

  • storage_mover (StorageMoverUpdateParameters or IO[bytes]) – Is either a StorageMoverUpdateParameters type or a IO[bytes] type. Required.

Returns:

StorageMover or the result of cls(response)

Return type:

StorageMover

Raises:

HttpResponseError –

models = <module 'azure.mgmt.storagemover.models' from '/mnt/vss/_work/1/s/sdk/storagemover/azure-mgmt-storagemover/.tox/sphinx/lib/python3.11/site-packages/azure/mgmt/storagemover/models/__init__.py'>