PrivateEndpointConnections interface

Package:

@azure/arm-storagesync

Interface representing a PrivateEndpointConnections.

Methods

beginCreate(string, string, string, PrivateEndpointConnection, PrivateEndpointConnectionsCreateOptionalParams)	Update the state of specified private endpoint connection associated with the storage sync service.
beginCreateAndWait(string, string, string, PrivateEndpointConnection, PrivateEndpointConnectionsCreateOptionalParams)	Update the state of specified private endpoint connection associated with the storage sync service.
beginDelete(string, string, string, PrivateEndpointConnectionsDeleteOptionalParams)	Deletes the specified private endpoint connection associated with the storage sync service.
beginDeleteAndWait(string, string, string, PrivateEndpointConnectionsDeleteOptionalParams)	Deletes the specified private endpoint connection associated with the storage sync service.
get(string, string, string, PrivateEndpointConnectionsGetOptionalParams)	Gets the specified private endpoint connection associated with the storage sync service.
listByStorageSyncService(string, string, PrivateEndpointConnectionsListByStorageSyncServiceOptionalParams)	Get a PrivateEndpointConnection List.

Method Details

beginCreate(string, string, string, PrivateEndpointConnection, PrivateEndpointConnectionsCreateOptionalParams)

Update the state of specified private endpoint connection associated with the storage sync service.

function beginCreate(resourceGroupName: string, storageSyncServiceName: string, privateEndpointConnectionName: string, properties: PrivateEndpointConnection, options?: PrivateEndpointConnectionsCreateOptionalParams): Promise<PollerLike<PollOperationState<PrivateEndpointConnection>, PrivateEndpointConnection>>

Parameters

resourceGroupName

string

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

storageSyncServiceName

string

The name of the storage sync service name within the specified resource group.

privateEndpointConnectionName

string

The name of the private endpoint connection associated with the Azure resource

properties

PrivateEndpointConnection

The private endpoint connection properties.

options

PrivateEndpointConnectionsCreateOptionalParams

The options parameters.

Returns

Promise<PollerLike<@azure/core-lro.PollOperationState<PrivateEndpointConnection>, PrivateEndpointConnection>>

beginCreateAndWait(string, string, string, PrivateEndpointConnection, PrivateEndpointConnectionsCreateOptionalParams)

Update the state of specified private endpoint connection associated with the storage sync service.

function beginCreateAndWait(resourceGroupName: string, storageSyncServiceName: string, privateEndpointConnectionName: string, properties: PrivateEndpointConnection, options?: PrivateEndpointConnectionsCreateOptionalParams): Promise<PrivateEndpointConnection>

Parameters

resourceGroupName

string

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

storageSyncServiceName

string

The name of the storage sync service name within the specified resource group.

privateEndpointConnectionName

string

The name of the private endpoint connection associated with the Azure resource

properties

PrivateEndpointConnection

The private endpoint connection properties.

options

PrivateEndpointConnectionsCreateOptionalParams

The options parameters.

Returns

Promise<PrivateEndpointConnection>

beginDelete(string, string, string, PrivateEndpointConnectionsDeleteOptionalParams)

Deletes the specified private endpoint connection associated with the storage sync service.

function beginDelete(resourceGroupName: string, storageSyncServiceName: string, privateEndpointConnectionName: string, options?: PrivateEndpointConnectionsDeleteOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>

Parameters

resourceGroupName

string

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

storageSyncServiceName

string

The name of the storage sync service name within the specified resource group.

privateEndpointConnectionName

string

The name of the private endpoint connection associated with the Azure resource

options

PrivateEndpointConnectionsDeleteOptionalParams

The options parameters.

Returns

Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>

beginDeleteAndWait(string, string, string, PrivateEndpointConnectionsDeleteOptionalParams)

Deletes the specified private endpoint connection associated with the storage sync service.

function beginDeleteAndWait(resourceGroupName: string, storageSyncServiceName: string, privateEndpointConnectionName: string, options?: PrivateEndpointConnectionsDeleteOptionalParams): Promise<void>

Parameters

resourceGroupName

string

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

storageSyncServiceName

string

The name of the storage sync service name within the specified resource group.

privateEndpointConnectionName

string

The name of the private endpoint connection associated with the Azure resource

options

PrivateEndpointConnectionsDeleteOptionalParams

The options parameters.

Returns

Promise<void>

get(string, string, string, PrivateEndpointConnectionsGetOptionalParams)

Gets the specified private endpoint connection associated with the storage sync service.

function get(resourceGroupName: string, storageSyncServiceName: string, privateEndpointConnectionName: string, options?: PrivateEndpointConnectionsGetOptionalParams): Promise<PrivateEndpointConnection>

Parameters

resourceGroupName

string

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

storageSyncServiceName

string

The name of the storage sync service name within the specified resource group.

privateEndpointConnectionName

string

The name of the private endpoint connection associated with the Azure resource

options

PrivateEndpointConnectionsGetOptionalParams

The options parameters.

Returns

Promise<PrivateEndpointConnection>

listByStorageSyncService(string, string, PrivateEndpointConnectionsListByStorageSyncServiceOptionalParams)

Get a PrivateEndpointConnection List.

function listByStorageSyncService(resourceGroupName: string, storageSyncServiceName: string, options?: PrivateEndpointConnectionsListByStorageSyncServiceOptionalParams): PagedAsyncIterableIterator<PrivateEndpointConnection, PrivateEndpointConnection[], PageSettings>

Parameters

resourceGroupName

string

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

storageSyncServiceName

string

Name of Storage Sync Service resource.

options

PrivateEndpointConnectionsListByStorageSyncServiceOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<PrivateEndpointConnection, PrivateEndpointConnection[], PageSettings>