NetworkConnections interface

Interface representing a NetworkConnections.

Methods

beginCreateOrUpdate(string, string, NetworkConnection, NetworkConnectionsCreateOrUpdateOptionalParams)

Creates or updates a Network Connections resource

beginCreateOrUpdateAndWait(string, string, NetworkConnection, NetworkConnectionsCreateOrUpdateOptionalParams)

Creates or updates a Network Connections resource

beginDelete(string, string, NetworkConnectionsDeleteOptionalParams)

Deletes a Network Connections resource

beginDeleteAndWait(string, string, NetworkConnectionsDeleteOptionalParams)

Deletes a Network Connections resource

beginRunHealthChecks(string, string, NetworkConnectionsRunHealthChecksOptionalParams)

Triggers a new health check run. The execution and health check result can be tracked via the network Connection health check details

beginRunHealthChecksAndWait(string, string, NetworkConnectionsRunHealthChecksOptionalParams)

Triggers a new health check run. The execution and health check result can be tracked via the network Connection health check details

beginUpdate(string, string, NetworkConnectionUpdate, NetworkConnectionsUpdateOptionalParams)

Partially updates a Network Connection

beginUpdateAndWait(string, string, NetworkConnectionUpdate, NetworkConnectionsUpdateOptionalParams)

Partially updates a Network Connection

get(string, string, NetworkConnectionsGetOptionalParams)

Gets a network connection resource

getHealthDetails(string, string, NetworkConnectionsGetHealthDetailsOptionalParams)

Gets health check status details.

listByResourceGroup(string, NetworkConnectionsListByResourceGroupOptionalParams)

Lists network connections in a resource group

listBySubscription(NetworkConnectionsListBySubscriptionOptionalParams)

Lists network connections in a subscription

listHealthDetails(string, string, NetworkConnectionsListHealthDetailsOptionalParams)

Lists health check status details

listOutboundNetworkDependenciesEndpoints(string, string, NetworkConnectionsListOutboundNetworkDependenciesEndpointsOptionalParams)

Lists the endpoints that agents may call as part of Dev Box service administration. These FQDNs should be allowed for outbound access in order for the Dev Box service to function.

Method Details

beginCreateOrUpdate(string, string, NetworkConnection, NetworkConnectionsCreateOrUpdateOptionalParams)

Creates or updates a Network Connections resource

function beginCreateOrUpdate(resourceGroupName: string, networkConnectionName: string, body: NetworkConnection, options?: NetworkConnectionsCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<NetworkConnection>, NetworkConnection>>

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

options
NetworkConnectionsCreateOrUpdateOptionalParams

The options parameters.

Returns

beginCreateOrUpdateAndWait(string, string, NetworkConnection, NetworkConnectionsCreateOrUpdateOptionalParams)

Creates or updates a Network Connections resource

function beginCreateOrUpdateAndWait(resourceGroupName: string, networkConnectionName: string, body: NetworkConnection, options?: NetworkConnectionsCreateOrUpdateOptionalParams): Promise<NetworkConnection>

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

options
NetworkConnectionsCreateOrUpdateOptionalParams

The options parameters.

Returns

beginDelete(string, string, NetworkConnectionsDeleteOptionalParams)

Deletes a Network Connections resource

function beginDelete(resourceGroupName: string, networkConnectionName: string, options?: NetworkConnectionsDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

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.

options
NetworkConnectionsDeleteOptionalParams

The options parameters.

Returns

Promise<SimplePollerLike<OperationState<void>, void>>

beginDeleteAndWait(string, string, NetworkConnectionsDeleteOptionalParams)

Deletes a Network Connections resource

function beginDeleteAndWait(resourceGroupName: string, networkConnectionName: string, options?: NetworkConnectionsDeleteOptionalParams): Promise<void>

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.

options
NetworkConnectionsDeleteOptionalParams

The options parameters.

Returns

Promise<void>

beginRunHealthChecks(string, string, NetworkConnectionsRunHealthChecksOptionalParams)

Triggers a new health check run. The execution and health check result can be tracked via the network Connection health check details

function beginRunHealthChecks(resourceGroupName: string, networkConnectionName: string, options?: NetworkConnectionsRunHealthChecksOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

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.

options
NetworkConnectionsRunHealthChecksOptionalParams

The options parameters.

Returns

Promise<SimplePollerLike<OperationState<void>, void>>

beginRunHealthChecksAndWait(string, string, NetworkConnectionsRunHealthChecksOptionalParams)

Triggers a new health check run. The execution and health check result can be tracked via the network Connection health check details

function beginRunHealthChecksAndWait(resourceGroupName: string, networkConnectionName: string, options?: NetworkConnectionsRunHealthChecksOptionalParams): Promise<void>

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.

options
NetworkConnectionsRunHealthChecksOptionalParams

The options parameters.

Returns

Promise<void>

beginUpdate(string, string, NetworkConnectionUpdate, NetworkConnectionsUpdateOptionalParams)

Partially updates a Network Connection

function beginUpdate(resourceGroupName: string, networkConnectionName: string, body: NetworkConnectionUpdate, options?: NetworkConnectionsUpdateOptionalParams): Promise<SimplePollerLike<OperationState<NetworkConnection>, NetworkConnection>>

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

options
NetworkConnectionsUpdateOptionalParams

The options parameters.

Returns

beginUpdateAndWait(string, string, NetworkConnectionUpdate, NetworkConnectionsUpdateOptionalParams)

Partially updates a Network Connection

function beginUpdateAndWait(resourceGroupName: string, networkConnectionName: string, body: NetworkConnectionUpdate, options?: NetworkConnectionsUpdateOptionalParams): Promise<NetworkConnection>

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

options
NetworkConnectionsUpdateOptionalParams

The options parameters.

Returns

get(string, string, NetworkConnectionsGetOptionalParams)

Gets a network connection resource

function get(resourceGroupName: string, networkConnectionName: string, options?: NetworkConnectionsGetOptionalParams): Promise<NetworkConnection>

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.

options
NetworkConnectionsGetOptionalParams

The options parameters.

Returns

getHealthDetails(string, string, NetworkConnectionsGetHealthDetailsOptionalParams)

Gets health check status details.

function getHealthDetails(resourceGroupName: string, networkConnectionName: string, options?: NetworkConnectionsGetHealthDetailsOptionalParams): Promise<HealthCheckStatusDetails>

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.

options
NetworkConnectionsGetHealthDetailsOptionalParams

The options parameters.

Returns

listByResourceGroup(string, NetworkConnectionsListByResourceGroupOptionalParams)

Lists network connections in a resource group

function listByResourceGroup(resourceGroupName: string, options?: NetworkConnectionsListByResourceGroupOptionalParams): PagedAsyncIterableIterator<NetworkConnection, NetworkConnection[], PageSettings>

Parameters

resourceGroupName

string

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

options
NetworkConnectionsListByResourceGroupOptionalParams

The options parameters.

Returns

listBySubscription(NetworkConnectionsListBySubscriptionOptionalParams)

Lists network connections in a subscription

function listBySubscription(options?: NetworkConnectionsListBySubscriptionOptionalParams): PagedAsyncIterableIterator<NetworkConnection, NetworkConnection[], PageSettings>

Parameters

options
NetworkConnectionsListBySubscriptionOptionalParams

The options parameters.

Returns

listHealthDetails(string, string, NetworkConnectionsListHealthDetailsOptionalParams)

Lists health check status details

function listHealthDetails(resourceGroupName: string, networkConnectionName: string, options?: NetworkConnectionsListHealthDetailsOptionalParams): PagedAsyncIterableIterator<HealthCheckStatusDetails, HealthCheckStatusDetails[], PageSettings>

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.

options
NetworkConnectionsListHealthDetailsOptionalParams

The options parameters.

Returns

listOutboundNetworkDependenciesEndpoints(string, string, NetworkConnectionsListOutboundNetworkDependenciesEndpointsOptionalParams)

Lists the endpoints that agents may call as part of Dev Box service administration. These FQDNs should be allowed for outbound access in order for the Dev Box service to function.

function listOutboundNetworkDependenciesEndpoints(resourceGroupName: string, networkConnectionName: string, options?: NetworkConnectionsListOutboundNetworkDependenciesEndpointsOptionalParams): PagedAsyncIterableIterator<OutboundEnvironmentEndpoint, OutboundEnvironmentEndpoint[], PageSettings>

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.

Returns