StorageConnectorResource.TestExistingConnection Method

Definition

Namespace:
Azure.ResourceManager.Storage
Assembly:
Azure.ResourceManager.Storage.dll
Package:
Azure.ResourceManager.Storage v1.7.0
Source:
StorageConnectorResource.cs

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.

  • Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/connectors/{connectorName}/testExistingConnection.
  • Operation Id. : Connectors_TestExistingConnection.
  • Default Api Version. : 2025-08-01.
  • Resource. : StorageConnectorResource. 
public virtual Azure.ResourceManager.ArmOperation<Azure.ResourceManager.Storage.Models.StorageConnectorTestConnectionResult> TestExistingConnection(Azure.WaitUntil waitUntil, Azure.ResourceManager.Storage.Models.StorageConnectorTestExistingConnectionContent content, System.Threading.CancellationToken cancellationToken = default);
abstract member TestExistingConnection : Azure.WaitUntil * Azure.ResourceManager.Storage.Models.StorageConnectorTestExistingConnectionContent * System.Threading.CancellationToken -> Azure.ResourceManager.ArmOperation<Azure.ResourceManager.Storage.Models.StorageConnectorTestConnectionResult>
override this.TestExistingConnection : Azure.WaitUntil * Azure.ResourceManager.Storage.Models.StorageConnectorTestExistingConnectionContent * System.Threading.CancellationToken -> Azure.ResourceManager.ArmOperation<Azure.ResourceManager.Storage.Models.StorageConnectorTestConnectionResult>
Public Overridable Function TestExistingConnection (waitUntil As WaitUntil, content As StorageConnectorTestExistingConnectionContent, Optional cancellationToken As CancellationToken = Nothing) As ArmOperation(Of StorageConnectorTestConnectionResult)

Parameters

waitUntil
WaitUntil

Completed if the method should wait to return until the long-running operation has completed on the service; Started if it should return after starting the operation. For more information on long-running operations, please see Azure.Core Long-Running Operation samples.

content
StorageConnectorTestExistingConnectionContent

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.

cancellationToken
CancellationToken

The cancellation token to use.

Returns

ArmOperation<StorageConnectorTestConnectionResult>

Exceptions

ArgumentNullException

content is null.

Applies to