Package version:

Interface NetworkConnections

Interface representing a NetworkConnections.

Hierarchy

NetworkConnections

Index

Methods

beginCreateOrUpdate beginCreateOrUpdateAndWait beginDelete beginDeleteAndWait beginUpdate beginUpdateAndWait get getHealthDetails listByResourceGroup listBySubscription listHealthDetails runHealthChecks

Methods

beginCreateOrUpdate

beginCreateOrUpdate(resourceGroupName: string, networkConnectionName: string, body: NetworkConnection, options?: NetworkConnectionsCreateOrUpdateOptionalParams): Promise<PollerLike<PollOperationState<NetworkConnection>, NetworkConnection>>
Creates or updates a Network Connections resource
Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- networkConnectionName: string
  
  Name of the Network Connection that can be applied to a Pool.
- body: NetworkConnection
  
  Represents network connection
- Optional options: NetworkConnectionsCreateOrUpdateOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<NetworkConnection>, NetworkConnection>>
- Defined in operationsInterfaces/networkConnections.ts:78

beginCreateOrUpdateAndWait

beginCreateOrUpdateAndWait(resourceGroupName: string, networkConnectionName: string, body: NetworkConnection, options?: NetworkConnectionsCreateOrUpdateOptionalParams): Promise<NetworkConnection>
Creates or updates a Network Connections resource
Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- networkConnectionName: string
  
  Name of the Network Connection that can be applied to a Pool.
- body: NetworkConnection
  
  Represents network connection
- Optional options: NetworkConnectionsCreateOrUpdateOptionalParams
  
  The options parameters.
Returns Promise<NetworkConnection>
- Defined in operationsInterfaces/networkConnections.ts:96

beginDelete

beginDelete(resourceGroupName: string, networkConnectionName: string, options?: NetworkConnectionsDeleteOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>
Deletes a Network Connections resource
Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- networkConnectionName: string
  
  Name of the Network Connection that can be applied to a Pool.
- Optional options: NetworkConnectionsDeleteOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<void>, void>>
- Defined in operationsInterfaces/networkConnections.ts:139

beginDeleteAndWait

beginDeleteAndWait(resourceGroupName: string, networkConnectionName: string, options?: NetworkConnectionsDeleteOptionalParams): Promise<void>
Deletes a Network Connections resource
Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- networkConnectionName: string
  
  Name of the Network Connection that can be applied to a Pool.
- Optional options: NetworkConnectionsDeleteOptionalParams
  
  The options parameters.
Returns Promise<void>
- Defined in operationsInterfaces/networkConnections.ts:150

beginUpdate

beginUpdate(resourceGroupName: string, networkConnectionName: string, body: NetworkConnectionUpdate, options?: NetworkConnectionsUpdateOptionalParams): Promise<PollerLike<PollOperationState<NetworkConnection>, NetworkConnection>>
Partially updates a Network Connection
Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- networkConnectionName: string
  
  Name of the Network Connection that can be applied to a Pool.
- body: NetworkConnectionUpdate
  
  Represents network connection
- Optional options: NetworkConnectionsUpdateOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<NetworkConnection>, NetworkConnection>>
- Defined in operationsInterfaces/networkConnections.ts:109

beginUpdateAndWait

beginUpdateAndWait(resourceGroupName: string, networkConnectionName: string, body: NetworkConnectionUpdate, options?: NetworkConnectionsUpdateOptionalParams): Promise<NetworkConnection>
Partially updates a Network Connection
Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- networkConnectionName: string
  
  Name of the Network Connection that can be applied to a Pool.
- body: NetworkConnectionUpdate
  
  Represents network connection
- Optional options: NetworkConnectionsUpdateOptionalParams
  
  The options parameters.
Returns Promise<NetworkConnection>
- Defined in operationsInterfaces/networkConnections.ts:127

get

get(resourceGroupName: string, networkConnectionName: string, options?: NetworkConnectionsGetOptionalParams): Promise<NetworkConnection>
Gets a network connection resource
Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- networkConnectionName: string
  
  Name of the Network Connection that can be applied to a Pool.
- Optional options: NetworkConnectionsGetOptionalParams
  
  The options parameters.
Returns Promise<NetworkConnection>
- Defined in operationsInterfaces/networkConnections.ts:66

getHealthDetails

getHealthDetails(resourceGroupName: string, networkConnectionName: string, options?: NetworkConnectionsGetHealthDetailsOptionalParams): Promise<HealthCheckStatusDetails>
Gets health check status details.
Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- networkConnectionName: string
  
  Name of the Network Connection that can be applied to a Pool.
- Optional options: NetworkConnectionsGetHealthDetailsOptionalParams
  
  The options parameters.
Returns Promise<HealthCheckStatusDetails>
- Defined in operationsInterfaces/networkConnections.ts:161

listByResourceGroup

listByResourceGroup(resourceGroupName: string, options?: NetworkConnectionsListByResourceGroupOptionalParams): PagedAsyncIterableIterator<NetworkConnection>
Lists network connections in a resource group
Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- Optional options: NetworkConnectionsListByResourceGroupOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<NetworkConnection>
- Defined in operationsInterfaces/networkConnections.ts:45

listBySubscription

listBySubscription(options?: NetworkConnectionsListBySubscriptionOptionalParams): PagedAsyncIterableIterator<NetworkConnection>
Lists network connections in a subscription
Parameters
- Optional options: NetworkConnectionsListBySubscriptionOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<NetworkConnection>
- Defined in operationsInterfaces/networkConnections.ts:37

listHealthDetails

listHealthDetails(resourceGroupName: string, networkConnectionName: string, options?: NetworkConnectionsListHealthDetailsOptionalParams): PagedAsyncIterableIterator<HealthCheckStatusDetails>
Lists health check status details
Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- networkConnectionName: string
  
  Name of the Network Connection that can be applied to a Pool.
- Optional options: NetworkConnectionsListHealthDetailsOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<HealthCheckStatusDetails>
- Defined in operationsInterfaces/networkConnections.ts:55

runHealthChecks

runHealthChecks(resourceGroupName: string, networkConnectionName: string, options?: NetworkConnectionsRunHealthChecksOptionalParams): Promise<void>
Triggers a new health check run. The execution and health check result can be tracked via the network Connection health check details
Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- networkConnectionName: string
  
  Name of the Network Connection that can be applied to a Pool.
- Optional options: NetworkConnectionsRunHealthChecksOptionalParams
  
  The options parameters.
Returns Promise<void>
- Defined in operationsInterfaces/networkConnections.ts:173

Interface NetworkConnections

Hierarchy

Index

Methods

Methods

beginCreateOrUpdate

Parameters

resourceGroupName: string

networkConnectionName: string

body: NetworkConnection

Optional options: NetworkConnectionsCreateOrUpdateOptionalParams

Returns Promise<PollerLike<PollOperationState<NetworkConnection>, NetworkConnection>>

beginCreateOrUpdateAndWait

Parameters

resourceGroupName: string

networkConnectionName: string

body: NetworkConnection

Optional options: NetworkConnectionsCreateOrUpdateOptionalParams

Returns Promise<NetworkConnection>

beginDelete

Parameters

resourceGroupName: string

networkConnectionName: string

Optional options: NetworkConnectionsDeleteOptionalParams

Returns Promise<PollerLike<PollOperationState<void>, void>>

beginDeleteAndWait

Parameters

resourceGroupName: string

networkConnectionName: string

Optional options: NetworkConnectionsDeleteOptionalParams

Returns Promise<void>

beginUpdate

Parameters

resourceGroupName: string

networkConnectionName: string

body: NetworkConnectionUpdate

Optional options: NetworkConnectionsUpdateOptionalParams

Returns Promise<PollerLike<PollOperationState<NetworkConnection>, NetworkConnection>>

beginUpdateAndWait

Parameters

resourceGroupName: string

networkConnectionName: string

body: NetworkConnectionUpdate

Optional options: NetworkConnectionsUpdateOptionalParams

Returns Promise<NetworkConnection>

get

Parameters

resourceGroupName: string

networkConnectionName: string

Optional options: NetworkConnectionsGetOptionalParams

Returns Promise<NetworkConnection>

getHealthDetails

Parameters

resourceGroupName: string

networkConnectionName: string

Optional options: NetworkConnectionsGetHealthDetailsOptionalParams

Returns Promise<HealthCheckStatusDetails>

listByResourceGroup

Parameters

resourceGroupName: string

Optional options: NetworkConnectionsListByResourceGroupOptionalParams

Returns PagedAsyncIterableIterator<NetworkConnection>

listBySubscription

Parameters

Optional options: NetworkConnectionsListBySubscriptionOptionalParams

Returns PagedAsyncIterableIterator<NetworkConnection>

listHealthDetails

Parameters

resourceGroupName: string

networkConnectionName: string

Optional options: NetworkConnectionsListHealthDetailsOptionalParams

Returns PagedAsyncIterableIterator<HealthCheckStatusDetails>

runHealthChecks

Parameters

resourceGroupName: string

networkConnectionName: string

Optional options: NetworkConnectionsRunHealthChecksOptionalParams

Returns Promise<void>

Settings

Member Visibility

`Optional` options: NetworkConnectionsCreateOrUpdateOptionalParams

`Optional` options: NetworkConnectionsCreateOrUpdateOptionalParams

`Optional` options: NetworkConnectionsDeleteOptionalParams

`Optional` options: NetworkConnectionsDeleteOptionalParams

`Optional` options: NetworkConnectionsUpdateOptionalParams

`Optional` options: NetworkConnectionsUpdateOptionalParams

`Optional` options: NetworkConnectionsGetOptionalParams

`Optional` options: NetworkConnectionsGetHealthDetailsOptionalParams

`Optional` options: NetworkConnectionsListByResourceGroupOptionalParams

`Optional` options: NetworkConnectionsListBySubscriptionOptionalParams

`Optional` options: NetworkConnectionsListHealthDetailsOptionalParams

`Optional` options: NetworkConnectionsRunHealthChecksOptionalParams