Storage.ConnectorsTestExistingConnection Method

Definition

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.

public System.Threading.Tasks.Task ConnectorsTestExistingConnection(string subscriptionId, string resourceGroupName, string accountName, string connectorName, Microsoft.Azure.PowerShell.Cmdlets.Storage.Models.ITestExistingConnectionRequest body, Func<System.Net.Http.HttpResponseMessage,System.Threading.Tasks.Task<Microsoft.Azure.PowerShell.Cmdlets.Storage.Models.ITestConnectionResponse>,System.Threading.Tasks.Task> onOk, Func<System.Net.Http.HttpResponseMessage,System.Threading.Tasks.Task<Microsoft.Azure.PowerShell.Cmdlets.Storage.Models.IErrorResponseAutoGenerated>,System.Threading.Tasks.Task> onDefault, Microsoft.Azure.PowerShell.Cmdlets.Storage.Runtime.IEventListener eventListener, Microsoft.Azure.PowerShell.Cmdlets.Storage.Runtime.ISendAsync sender, Microsoft.Azure.PowerShell.Cmdlets.Storage.Runtime.SerializationMode serializationMode = Microsoft.Azure.PowerShell.Cmdlets.Storage.Runtime.SerializationMode.IncludeCreateOrUpdate);
member this.ConnectorsTestExistingConnection : string * string * string * string * Microsoft.Azure.PowerShell.Cmdlets.Storage.Models.ITestExistingConnectionRequest * Func<System.Net.Http.HttpResponseMessage, System.Threading.Tasks.Task<Microsoft.Azure.PowerShell.Cmdlets.Storage.Models.ITestConnectionResponse>, System.Threading.Tasks.Task> * Func<System.Net.Http.HttpResponseMessage, System.Threading.Tasks.Task<Microsoft.Azure.PowerShell.Cmdlets.Storage.Models.IErrorResponseAutoGenerated>, System.Threading.Tasks.Task> * Microsoft.Azure.PowerShell.Cmdlets.Storage.Runtime.IEventListener * Microsoft.Azure.PowerShell.Cmdlets.Storage.Runtime.ISendAsync * Microsoft.Azure.PowerShell.Cmdlets.Storage.Runtime.SerializationMode -> System.Threading.Tasks.Task
Public Function ConnectorsTestExistingConnection (subscriptionId As String, resourceGroupName As String, accountName As String, connectorName As String, body As ITestExistingConnectionRequest, onOk As Func(Of HttpResponseMessage, Task(Of ITestConnectionResponse), Task), onDefault As Func(Of HttpResponseMessage, Task(Of IErrorResponseAutoGenerated), Task), eventListener As IEventListener, sender As ISendAsync, Optional serializationMode As SerializationMode = Microsoft.Azure.PowerShell.Cmdlets.Storage.Runtime.SerializationMode.IncludeCreateOrUpdate) As Task

Parameters

subscriptionId
String

The ID of the target subscription. The value must be an UUID.

resourceGroupName
String

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

accountName
String

The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only.

connectorName
String

The name of the Storage Connector.

body
ITestExistingConnectionRequest

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.

onOk
Func<HttpResponseMessage,Task<ITestConnectionResponse>,Task>

a delegate that is called when the remote service returns 200 (OK).

onDefault
Func<HttpResponseMessage,Task<IErrorResponseAutoGenerated>,Task>

a delegate that is called when the remote service returns default (any response code not handled elsewhere).

eventListener
IEventListener

an IEventListener instance that will receive events.

sender
ISendAsync

an instance of an Microsoft.Azure.PowerShell.Cmdlets.Storage.Runtime.ISendAsync pipeline to use to make the request.

serializationMode
SerializationMode

Allows the caller to choose the depth of the serialization. See SerializationMode.

Returns

A Task that will be complete when handling of the response is completed.

Applies to