Endpoints interface

Package:

@azure/arm-storagemover

Interface representing a Endpoints.

Methods

beginDelete(string, string, string, EndpointsDeleteOptionalParams)	Deletes an Endpoint resource.
beginDeleteAndWait(string, string, string, EndpointsDeleteOptionalParams)	Deletes an Endpoint resource.
createOrUpdate(string, string, string, Endpoint, EndpointsCreateOrUpdateOptionalParams)	Creates or updates an Endpoint resource, which represents a data transfer source or destination.
get(string, string, string, EndpointsGetOptionalParams)	Gets an Endpoint resource.
list(string, string, EndpointsListOptionalParams)	Lists all Endpoints in a Storage Mover.
update(string, string, string, EndpointBaseUpdateParameters, EndpointsUpdateOptionalParams)	Updates properties for an Endpoint resource. Properties not specified in the request body will be unchanged.

Method Details

beginDelete(string, string, string, EndpointsDeleteOptionalParams)

Deletes an Endpoint resource.

function beginDelete(resourceGroupName: string, storageMoverName: string, endpointName: string, options?: EndpointsDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

storageMoverName

string

The name of the Storage Mover resource.

endpointName

string

The name of the Endpoint resource.

options

EndpointsDeleteOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>

beginDeleteAndWait(string, string, string, EndpointsDeleteOptionalParams)

Deletes an Endpoint resource.

function beginDeleteAndWait(resourceGroupName: string, storageMoverName: string, endpointName: string, options?: EndpointsDeleteOptionalParams): Promise<void>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

storageMoverName

string

The name of the Storage Mover resource.

endpointName

string

The name of the Endpoint resource.

options

EndpointsDeleteOptionalParams

The options parameters.

Returns

Promise<void>

createOrUpdate(string, string, string, Endpoint, EndpointsCreateOrUpdateOptionalParams)

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

function createOrUpdate(resourceGroupName: string, storageMoverName: string, endpointName: string, endpoint: Endpoint, options?: EndpointsCreateOrUpdateOptionalParams): Promise<Endpoint>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

storageMoverName

string

The name of the Storage Mover resource.

endpointName

string

The name of the Endpoint resource.

endpoint

Endpoint

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

options

EndpointsCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<Endpoint>

get(string, string, string, EndpointsGetOptionalParams)

Gets an Endpoint resource.

function get(resourceGroupName: string, storageMoverName: string, endpointName: string, options?: EndpointsGetOptionalParams): Promise<Endpoint>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

storageMoverName

string

The name of the Storage Mover resource.

endpointName

string

The name of the Endpoint resource.

options

EndpointsGetOptionalParams

The options parameters.

Returns

Promise<Endpoint>

list(string, string, EndpointsListOptionalParams)

Lists all Endpoints in a Storage Mover.

function list(resourceGroupName: string, storageMoverName: string, options?: EndpointsListOptionalParams): PagedAsyncIterableIterator<Endpoint, Endpoint[], PageSettings>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

storageMoverName

string

The name of the Storage Mover resource.

options

EndpointsListOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<Endpoint, Endpoint[], PageSettings>

update(string, string, string, EndpointBaseUpdateParameters, EndpointsUpdateOptionalParams)

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

function update(resourceGroupName: string, storageMoverName: string, endpointName: string, endpoint: EndpointBaseUpdateParameters, options?: EndpointsUpdateOptionalParams): Promise<Endpoint>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

storageMoverName

string

The name of the Storage Mover resource.

endpointName

string

The name of the Endpoint resource.

endpoint

EndpointBaseUpdateParameters

The Endpoint resource.

options

EndpointsUpdateOptionalParams

The options parameters.

Returns

Promise<Endpoint>