ConnectorsOperations interface

Interface representing a Connectors operations.

Properties

beginCreate
beginCreateAndWait
beginDelete
beginDeleteAndWait
beginTestExistingConnection
beginTestExistingConnectionAndWait
beginUpdate
beginUpdateAndWait
create

Create a Storage Connector if it does not already exist; otherwise, error out. This API will not allow you to replace an already existing resource.

delete

Delete a Storage Connector.

get

Get the specified Storage Connector.

listByStorageAccount

List all Storage Connectors in a Storage Account.

testExistingConnection

This method is used to verify that the connection to the backing data store works. This API is designed to be used for monitoring and debugging purposes. From the caller’s perspective, this method does the following: Calls List on the backing data store, attempting to list up to one blob/object/etc. If the above succeeds, and if a blob/object/etc is found, calls Get on that object, attempting to download one byte.

update

Update a Storage Connector.

Property Details

beginCreate

Warning

This API is now deprecated.

use create instead

beginCreate: (resourceGroupName: string, accountName: string, connectorName: string, resource: Connector, options?: ConnectorsCreateOptionalParams) => Promise<SimplePollerLike<OperationState<Connector>, Connector>>

Property Value

(resourceGroupName: string, accountName: string, connectorName: string, resource: Connector, options?: ConnectorsCreateOptionalParams) => Promise<SimplePollerLike<OperationState<Connector>, Connector>>

beginCreateAndWait

Warning

This API is now deprecated.

use create instead

beginCreateAndWait: (resourceGroupName: string, accountName: string, connectorName: string, resource: Connector, options?: ConnectorsCreateOptionalParams) => Promise<Connector>

Property Value

(resourceGroupName: string, accountName: string, connectorName: string, resource: Connector, options?: ConnectorsCreateOptionalParams) => Promise<Connector>

beginDelete

Warning

This API is now deprecated.

use delete instead

beginDelete: (resourceGroupName: string, accountName: string, connectorName: string, options?: ConnectorsDeleteOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

Property Value

(resourceGroupName: string, accountName: string, connectorName: string, options?: ConnectorsDeleteOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

beginDeleteAndWait

Warning

This API is now deprecated.

use delete instead

beginDeleteAndWait: (resourceGroupName: string, accountName: string, connectorName: string, options?: ConnectorsDeleteOptionalParams) => Promise<void>

Property Value

(resourceGroupName: string, accountName: string, connectorName: string, options?: ConnectorsDeleteOptionalParams) => Promise<void>

beginTestExistingConnection

Warning

This API is now deprecated.

use testExistingConnection instead

beginTestExistingConnection: (resourceGroupName: string, accountName: string, connectorName: string, body: TestExistingConnectionRequest, options?: ConnectorsTestExistingConnectionOptionalParams) => Promise<SimplePollerLike<OperationState<TestConnectionResponse>, TestConnectionResponse>>

Property Value

(resourceGroupName: string, accountName: string, connectorName: string, body: TestExistingConnectionRequest, options?: ConnectorsTestExistingConnectionOptionalParams) => Promise<SimplePollerLike<OperationState<TestConnectionResponse>, TestConnectionResponse>>

beginTestExistingConnectionAndWait

Warning

This API is now deprecated.

use testExistingConnection instead

beginTestExistingConnectionAndWait: (resourceGroupName: string, accountName: string, connectorName: string, body: TestExistingConnectionRequest, options?: ConnectorsTestExistingConnectionOptionalParams) => Promise<TestConnectionResponse>

Property Value

(resourceGroupName: string, accountName: string, connectorName: string, body: TestExistingConnectionRequest, options?: ConnectorsTestExistingConnectionOptionalParams) => Promise<TestConnectionResponse>

beginUpdate

Warning

This API is now deprecated.

use update instead

beginUpdate: (resourceGroupName: string, accountName: string, connectorName: string, properties: ConnectorUpdate, options?: ConnectorsUpdateOptionalParams) => Promise<SimplePollerLike<OperationState<Connector>, Connector>>

Property Value

(resourceGroupName: string, accountName: string, connectorName: string, properties: ConnectorUpdate, options?: ConnectorsUpdateOptionalParams) => Promise<SimplePollerLike<OperationState<Connector>, Connector>>

beginUpdateAndWait

Warning

This API is now deprecated.

use update instead

beginUpdateAndWait: (resourceGroupName: string, accountName: string, connectorName: string, properties: ConnectorUpdate, options?: ConnectorsUpdateOptionalParams) => Promise<Connector>

Property Value

(resourceGroupName: string, accountName: string, connectorName: string, properties: ConnectorUpdate, options?: ConnectorsUpdateOptionalParams) => Promise<Connector>

create

Create a Storage Connector if it does not already exist; otherwise, error out. This API will not allow you to replace an already existing resource.

create: (resourceGroupName: string, accountName: string, connectorName: string, resource: Connector, options?: ConnectorsCreateOptionalParams) => PollerLike<OperationState<Connector>, Connector>

Property Value

(resourceGroupName: string, accountName: string, connectorName: string, resource: Connector, options?: ConnectorsCreateOptionalParams) => PollerLike<OperationState<Connector>, Connector>

delete

Delete a Storage Connector.

delete: (resourceGroupName: string, accountName: string, connectorName: string, options?: ConnectorsDeleteOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(resourceGroupName: string, accountName: string, connectorName: string, options?: ConnectorsDeleteOptionalParams) => PollerLike<OperationState<void>, void>

get

Get the specified Storage Connector.

get: (resourceGroupName: string, accountName: string, connectorName: string, options?: ConnectorsGetOptionalParams) => Promise<Connector>

Property Value

(resourceGroupName: string, accountName: string, connectorName: string, options?: ConnectorsGetOptionalParams) => Promise<Connector>

listByStorageAccount

List all Storage Connectors in a Storage Account.

listByStorageAccount: (resourceGroupName: string, accountName: string, options?: ConnectorsListByStorageAccountOptionalParams) => PagedAsyncIterableIterator<Connector, Connector[], PageSettings>

Property Value

(resourceGroupName: string, accountName: string, options?: ConnectorsListByStorageAccountOptionalParams) => PagedAsyncIterableIterator<Connector, Connector[], PageSettings>

testExistingConnection

This method is used to verify that the connection to the backing data store works. This API is designed to be used for monitoring and debugging purposes. From the caller’s perspective, this method does the following: Calls List on the backing data store, attempting to list up to one blob/object/etc. If the above succeeds, and if a blob/object/etc is found, calls Get on that object, attempting to download one byte.

testExistingConnection: (resourceGroupName: string, accountName: string, connectorName: string, body: TestExistingConnectionRequest, options?: ConnectorsTestExistingConnectionOptionalParams) => PollerLike<OperationState<TestConnectionResponse>, TestConnectionResponse>

Property Value

(resourceGroupName: string, accountName: string, connectorName: string, body: TestExistingConnectionRequest, options?: ConnectorsTestExistingConnectionOptionalParams) => PollerLike<OperationState<TestConnectionResponse>, TestConnectionResponse>

update

Update a Storage Connector.

update: (resourceGroupName: string, accountName: string, connectorName: string, properties: ConnectorUpdate, options?: ConnectorsUpdateOptionalParams) => PollerLike<OperationState<Connector>, Connector>

Property Value

(resourceGroupName: string, accountName: string, connectorName: string, properties: ConnectorUpdate, options?: ConnectorsUpdateOptionalParams) => PollerLike<OperationState<Connector>, Connector>