NetworkManagementClient class

Extends

Constructors

NetworkManagementClient(TokenCredential, NetworkManagementClientOptionalParams)
NetworkManagementClient(TokenCredential, string, NetworkManagementClientOptionalParams)

Initializes a new instance of the NetworkManagementClient class.

Properties

$host
adminRuleCollections
adminRules
applicationGatewayPrivateEndpointConnections
applicationGatewayPrivateLinkResources
applicationGateways
applicationGatewayWafDynamicManifests
applicationGatewayWafDynamicManifestsDefault
applicationSecurityGroups
availableDelegations
availableEndpointServices
availablePrivateEndpointTypes
availableResourceGroupDelegations
availableServiceAliases
azureFirewallFqdnTags
azureFirewalls
bastionHosts
bgpServiceCommunities
configurationPolicyGroups
connectionMonitors
connectivityConfigurations
customIPPrefixes
ddosCustomPolicies
ddosProtectionPlans
defaultSecurityRules
dscpConfigurationOperations
expressRouteCircuitAuthorizations
expressRouteCircuitConnections
expressRouteCircuitPeerings
expressRouteCircuits
expressRouteConnections
expressRouteCrossConnectionPeerings
expressRouteCrossConnections
expressRouteGateways
expressRouteLinks
expressRoutePortAuthorizations
expressRoutePorts
expressRoutePortsLocations
expressRouteProviderPortsLocation
expressRouteServiceProviders
firewallPolicies
firewallPolicyDeployments
firewallPolicyDrafts
firewallPolicyIdpsSignatures
firewallPolicyIdpsSignaturesFilterValues
firewallPolicyIdpsSignaturesOverrides
firewallPolicyRuleCollectionGroupDrafts
firewallPolicyRuleCollectionGroups
flowLogs
hubRouteTables
hubVirtualNetworkConnections
inboundNatRules
inboundSecurityRuleOperations
ipAllocations
ipGroups
loadBalancerBackendAddressPools
loadBalancerFrontendIPConfigurations
loadBalancerLoadBalancingRules
loadBalancerNetworkInterfaces
loadBalancerOutboundRules
loadBalancerProbes
loadBalancers
localNetworkGateways
managementGroupNetworkManagerConnections
natGateways
natRules
networkGroups
networkInterfaceIPConfigurations
networkInterfaceLoadBalancers
networkInterfaces
networkInterfaceTapConfigurations
networkManagerCommits
networkManagerDeploymentStatusOperations
networkManagerRoutingConfigurations
networkManagers
networkProfiles
networkSecurityGroups
networkVirtualApplianceConnections
networkVirtualAppliances
networkWatchers
operations
p2SVpnGateways
packetCaptures
peerExpressRouteCircuitConnections
privateDnsZoneGroups
privateEndpoints
privateLinkServices
publicIPAddresses
publicIPPrefixes
resourceNavigationLinks
routeFilterRules
routeFilters
routeMaps
routes
routeTables
routingIntentOperations
routingRuleCollections
routingRules
scopeConnections
securityAdminConfigurations
securityPartnerProviders
securityRules
securityUserConfigurations
securityUserRuleCollections
securityUserRules
serviceAssociationLinks
serviceEndpointPolicies
serviceEndpointPolicyDefinitions
serviceTagInformationOperations
serviceTags
staticMembers
subnets
subscriptionId
subscriptionNetworkManagerConnections
usages
vipSwap
virtualApplianceSites
virtualApplianceSkus
virtualHubBgpConnection
virtualHubBgpConnections
virtualHubIpConfiguration
virtualHubRouteTableV2S
virtualHubs
virtualNetworkGatewayConnections
virtualNetworkGatewayNatRules
virtualNetworkGateways
virtualNetworkPeerings
virtualNetworks
virtualNetworkTaps
virtualRouterPeerings
virtualRouters
virtualWans
vpnConnections
vpnGateways
vpnLinkConnections
vpnServerConfigurations
vpnServerConfigurationsAssociatedWithVirtualWan
vpnSiteLinkConnections
vpnSiteLinks
vpnSites
vpnSitesConfiguration
webApplicationFirewallPolicies
webCategories

Inherited Properties

pipeline

The pipeline used by this client to make requests

Methods

beginDeleteBastionShareableLink(string, string, BastionShareableLinkListRequest, DeleteBastionShareableLinkOptionalParams)

Deletes the Bastion Shareable Links for all the VMs specified in the request.

beginDeleteBastionShareableLinkAndWait(string, string, BastionShareableLinkListRequest, DeleteBastionShareableLinkOptionalParams)

Deletes the Bastion Shareable Links for all the VMs specified in the request.

beginDeleteBastionShareableLinkByToken(string, string, BastionShareableLinkTokenListRequest, DeleteBastionShareableLinkByTokenOptionalParams)

Deletes the Bastion Shareable Links for all the tokens specified in the request.

beginDeleteBastionShareableLinkByTokenAndWait(string, string, BastionShareableLinkTokenListRequest, DeleteBastionShareableLinkByTokenOptionalParams)

Deletes the Bastion Shareable Links for all the tokens specified in the request.

beginGeneratevirtualwanvpnserverconfigurationvpnprofile(string, string, VirtualWanVpnProfileParameters, GeneratevirtualwanvpnserverconfigurationvpnprofileOptionalParams)

Generates a unique VPN profile for P2S clients for VirtualWan and associated VpnServerConfiguration combination in the specified resource group.

beginGeneratevirtualwanvpnserverconfigurationvpnprofileAndWait(string, string, VirtualWanVpnProfileParameters, GeneratevirtualwanvpnserverconfigurationvpnprofileOptionalParams)

Generates a unique VPN profile for P2S clients for VirtualWan and associated VpnServerConfiguration combination in the specified resource group.

beginListActiveSessionsAndWait(string, string, GetActiveSessionsOptionalParams)

Returns the list of currently active sessions on the Bastion.

beginListPutBastionShareableLinkAndWait(string, string, BastionShareableLinkListRequest, PutBastionShareableLinkOptionalParams)

Creates a Bastion Shareable Links for all the VMs specified in the request.

checkDnsNameAvailability(string, string, CheckDnsNameAvailabilityOptionalParams)

Checks whether a domain name in the cloudapp.azure.com zone is available for use.

expressRouteProviderPort(string, ExpressRouteProviderPortOptionalParams)

Retrieves detail of a provider port.

listActiveConnectivityConfigurations(string, string, ActiveConfigurationParameter, ListActiveConnectivityConfigurationsOptionalParams)

Lists active connectivity configurations in a network manager.

listActiveSecurityAdminRules(string, string, ActiveConfigurationParameter, ListActiveSecurityAdminRulesOptionalParams)

Lists active security admin rules in a network manager.

listBastionShareableLink(string, string, BastionShareableLinkListRequest, GetBastionShareableLinkOptionalParams)

Return the Bastion Shareable Links for all the VMs specified in the request.

listDisconnectActiveSessions(string, string, SessionIds, DisconnectActiveSessionsOptionalParams)

Returns the list of currently active sessions on the Bastion.

listNetworkManagerEffectiveConnectivityConfigurations(string, string, QueryRequestOptions, ListNetworkManagerEffectiveConnectivityConfigurationsOptionalParams)

List all effective connectivity configurations applied on a virtual network.

listNetworkManagerEffectiveSecurityAdminRules(string, string, QueryRequestOptions, ListNetworkManagerEffectiveSecurityAdminRulesOptionalParams)

List all effective security admin rules applied on a virtual network.

supportedSecurityProviders(string, string, SupportedSecurityProvidersOptionalParams)

Gives the supported security providers for the virtual wan.

Inherited Methods

sendOperationRequest<T>(OperationArguments, OperationSpec)

Send an HTTP request that is populated using the provided OperationSpec.

sendRequest(PipelineRequest)

Send the provided httpRequest.

Constructor Details

NetworkManagementClient(TokenCredential, NetworkManagementClientOptionalParams)

new NetworkManagementClient(credentials: TokenCredential, options?: NetworkManagementClientOptionalParams)

Parameters

credentials
TokenCredential

NetworkManagementClient(TokenCredential, string, NetworkManagementClientOptionalParams)

Initializes a new instance of the NetworkManagementClient class.

new NetworkManagementClient(credentials: TokenCredential, subscriptionId: string, options?: NetworkManagementClientOptionalParams)

Parameters

credentials
TokenCredential

Subscription credentials which uniquely identify client subscription.

subscriptionId

string

The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

options
NetworkManagementClientOptionalParams

The parameter options

Property Details

$host

$host: string

Property Value

string

adminRuleCollections

adminRuleCollections: AdminRuleCollections

Property Value

adminRules

adminRules: AdminRules

Property Value

applicationGatewayPrivateEndpointConnections

applicationGatewayPrivateEndpointConnections: ApplicationGatewayPrivateEndpointConnections

Property Value

applicationGatewayPrivateLinkResources

applicationGatewayPrivateLinkResources: ApplicationGatewayPrivateLinkResources

Property Value

applicationGateways

applicationGateways: ApplicationGateways

Property Value

applicationGatewayWafDynamicManifests

applicationGatewayWafDynamicManifests: ApplicationGatewayWafDynamicManifests

Property Value

applicationGatewayWafDynamicManifestsDefault

applicationGatewayWafDynamicManifestsDefault: ApplicationGatewayWafDynamicManifestsDefault

Property Value

applicationSecurityGroups

applicationSecurityGroups: ApplicationSecurityGroups

Property Value

availableDelegations

availableDelegations: AvailableDelegations

Property Value

availableEndpointServices

availableEndpointServices: AvailableEndpointServices

Property Value

availablePrivateEndpointTypes

availablePrivateEndpointTypes: AvailablePrivateEndpointTypes

Property Value

availableResourceGroupDelegations

availableResourceGroupDelegations: AvailableResourceGroupDelegations

Property Value

availableServiceAliases

availableServiceAliases: AvailableServiceAliases

Property Value

azureFirewallFqdnTags

azureFirewallFqdnTags: AzureFirewallFqdnTags

Property Value

azureFirewalls

azureFirewalls: AzureFirewalls

Property Value

bastionHosts

bastionHosts: BastionHosts

Property Value

bgpServiceCommunities

bgpServiceCommunities: BgpServiceCommunities

Property Value

configurationPolicyGroups

configurationPolicyGroups: ConfigurationPolicyGroups

Property Value

connectionMonitors

connectionMonitors: ConnectionMonitors

Property Value

connectivityConfigurations

connectivityConfigurations: ConnectivityConfigurations

Property Value

customIPPrefixes

customIPPrefixes: CustomIPPrefixes

Property Value

ddosCustomPolicies

ddosCustomPolicies: DdosCustomPolicies

Property Value

ddosProtectionPlans

ddosProtectionPlans: DdosProtectionPlans

Property Value

defaultSecurityRules

defaultSecurityRules: DefaultSecurityRules

Property Value

dscpConfigurationOperations

dscpConfigurationOperations: DscpConfigurationOperations

Property Value

expressRouteCircuitAuthorizations

expressRouteCircuitAuthorizations: ExpressRouteCircuitAuthorizations

Property Value

expressRouteCircuitConnections

expressRouteCircuitConnections: ExpressRouteCircuitConnections

Property Value

expressRouteCircuitPeerings

expressRouteCircuitPeerings: ExpressRouteCircuitPeerings

Property Value

expressRouteCircuits

expressRouteCircuits: ExpressRouteCircuits

Property Value

expressRouteConnections

expressRouteConnections: ExpressRouteConnections

Property Value

expressRouteCrossConnectionPeerings

expressRouteCrossConnectionPeerings: ExpressRouteCrossConnectionPeerings

Property Value

expressRouteCrossConnections

expressRouteCrossConnections: ExpressRouteCrossConnections

Property Value

expressRouteGateways

expressRouteGateways: ExpressRouteGateways

Property Value

expressRouteLinks: ExpressRouteLinks

Property Value

expressRoutePortAuthorizations

expressRoutePortAuthorizations: ExpressRoutePortAuthorizations

Property Value

expressRoutePorts

expressRoutePorts: ExpressRoutePorts

Property Value

expressRoutePortsLocations

expressRoutePortsLocations: ExpressRoutePortsLocations

Property Value

expressRouteProviderPortsLocation

expressRouteProviderPortsLocation: ExpressRouteProviderPortsLocation

Property Value

expressRouteServiceProviders

expressRouteServiceProviders: ExpressRouteServiceProviders

Property Value

firewallPolicies

firewallPolicies: FirewallPolicies

Property Value

firewallPolicyDeployments

firewallPolicyDeployments: FirewallPolicyDeployments

Property Value

firewallPolicyDrafts

firewallPolicyDrafts: FirewallPolicyDrafts

Property Value

firewallPolicyIdpsSignatures

firewallPolicyIdpsSignatures: FirewallPolicyIdpsSignatures

Property Value

firewallPolicyIdpsSignaturesFilterValues

firewallPolicyIdpsSignaturesFilterValues: FirewallPolicyIdpsSignaturesFilterValues

Property Value

firewallPolicyIdpsSignaturesOverrides

firewallPolicyIdpsSignaturesOverrides: FirewallPolicyIdpsSignaturesOverrides

Property Value

firewallPolicyRuleCollectionGroupDrafts

firewallPolicyRuleCollectionGroupDrafts: FirewallPolicyRuleCollectionGroupDrafts

Property Value

firewallPolicyRuleCollectionGroups

firewallPolicyRuleCollectionGroups: FirewallPolicyRuleCollectionGroups

Property Value

flowLogs

flowLogs: FlowLogs

Property Value

hubRouteTables

hubRouteTables: HubRouteTables

Property Value

hubVirtualNetworkConnections

hubVirtualNetworkConnections: HubVirtualNetworkConnections

Property Value

inboundNatRules

inboundNatRules: InboundNatRules

Property Value

inboundSecurityRuleOperations

inboundSecurityRuleOperations: InboundSecurityRuleOperations

Property Value

ipAllocations

ipAllocations: IpAllocations

Property Value

ipGroups

ipGroups: IpGroups

Property Value

loadBalancerBackendAddressPools

loadBalancerBackendAddressPools: LoadBalancerBackendAddressPools

Property Value

loadBalancerFrontendIPConfigurations

loadBalancerFrontendIPConfigurations: LoadBalancerFrontendIPConfigurations

Property Value

loadBalancerLoadBalancingRules

loadBalancerLoadBalancingRules: LoadBalancerLoadBalancingRules

Property Value

loadBalancerNetworkInterfaces

loadBalancerNetworkInterfaces: LoadBalancerNetworkInterfaces

Property Value

loadBalancerOutboundRules

loadBalancerOutboundRules: LoadBalancerOutboundRules

Property Value

loadBalancerProbes

loadBalancerProbes: LoadBalancerProbes

Property Value

loadBalancers

loadBalancers: LoadBalancers

Property Value

localNetworkGateways

localNetworkGateways: LocalNetworkGateways

Property Value

managementGroupNetworkManagerConnections

managementGroupNetworkManagerConnections: ManagementGroupNetworkManagerConnections

Property Value

natGateways

natGateways: NatGateways

Property Value

natRules

natRules: NatRules

Property Value

networkGroups

networkGroups: NetworkGroups

Property Value

networkInterfaceIPConfigurations

networkInterfaceIPConfigurations: NetworkInterfaceIPConfigurations

Property Value

networkInterfaceLoadBalancers

networkInterfaceLoadBalancers: NetworkInterfaceLoadBalancers

Property Value

networkInterfaces

networkInterfaces: NetworkInterfaces

Property Value

networkInterfaceTapConfigurations

networkInterfaceTapConfigurations: NetworkInterfaceTapConfigurations

Property Value

networkManagerCommits

networkManagerCommits: NetworkManagerCommits

Property Value

networkManagerDeploymentStatusOperations

networkManagerDeploymentStatusOperations: NetworkManagerDeploymentStatusOperations

Property Value

networkManagerRoutingConfigurations

networkManagerRoutingConfigurations: NetworkManagerRoutingConfigurations

Property Value

networkManagers

networkManagers: NetworkManagers

Property Value

networkProfiles

networkProfiles: NetworkProfiles

Property Value

networkSecurityGroups

networkSecurityGroups: NetworkSecurityGroups

Property Value

networkVirtualApplianceConnections

networkVirtualApplianceConnections: NetworkVirtualApplianceConnections

Property Value

networkVirtualAppliances

networkVirtualAppliances: NetworkVirtualAppliances

Property Value

networkWatchers

networkWatchers: NetworkWatchers

Property Value

operations

operations: Operations

Property Value

p2SVpnGateways

p2SVpnGateways: P2SVpnGateways

Property Value

packetCaptures

packetCaptures: PacketCaptures

Property Value

peerExpressRouteCircuitConnections

peerExpressRouteCircuitConnections: PeerExpressRouteCircuitConnections

Property Value

privateDnsZoneGroups

privateDnsZoneGroups: PrivateDnsZoneGroups

Property Value

privateEndpoints

privateEndpoints: PrivateEndpoints

Property Value

privateLinkServices

privateLinkServices: PrivateLinkServices

Property Value

publicIPAddresses

publicIPAddresses: PublicIPAddresses

Property Value

publicIPPrefixes

publicIPPrefixes: PublicIPPrefixes

Property Value

resourceNavigationLinks: ResourceNavigationLinks

Property Value

routeFilterRules

routeFilterRules: RouteFilterRules

Property Value

routeFilters

routeFilters: RouteFilters

Property Value

routeMaps

routeMaps: RouteMaps

Property Value

routes

routes: Routes

Property Value

routeTables

routeTables: RouteTables

Property Value

routingIntentOperations

routingIntentOperations: RoutingIntentOperations

Property Value

routingRuleCollections

routingRuleCollections: RoutingRuleCollections

Property Value

routingRules

routingRules: RoutingRules

Property Value

scopeConnections

scopeConnections: ScopeConnections

Property Value

securityAdminConfigurations

securityAdminConfigurations: SecurityAdminConfigurations

Property Value

securityPartnerProviders

securityPartnerProviders: SecurityPartnerProviders

Property Value

securityRules

securityRules: SecurityRules

Property Value

securityUserConfigurations

securityUserConfigurations: SecurityUserConfigurations

Property Value

securityUserRuleCollections

securityUserRuleCollections: SecurityUserRuleCollections

Property Value

securityUserRules

securityUserRules: SecurityUserRules

Property Value

serviceAssociationLinks: ServiceAssociationLinks

Property Value

serviceEndpointPolicies

serviceEndpointPolicies: ServiceEndpointPolicies

Property Value

serviceEndpointPolicyDefinitions

serviceEndpointPolicyDefinitions: ServiceEndpointPolicyDefinitions

Property Value

serviceTagInformationOperations

serviceTagInformationOperations: ServiceTagInformationOperations

Property Value

serviceTags

serviceTags: ServiceTags

Property Value

staticMembers

staticMembers: StaticMembers

Property Value

subnets

subnets: Subnets

Property Value

subscriptionId

subscriptionId?: string

Property Value

string

subscriptionNetworkManagerConnections

subscriptionNetworkManagerConnections: SubscriptionNetworkManagerConnections

Property Value

usages

usages: Usages

Property Value

vipSwap

vipSwap: VipSwap

Property Value

virtualApplianceSites

virtualApplianceSites: VirtualApplianceSites

Property Value

virtualApplianceSkus

virtualApplianceSkus: VirtualApplianceSkus

Property Value

virtualHubBgpConnection

virtualHubBgpConnection: VirtualHubBgpConnection

Property Value

virtualHubBgpConnections

virtualHubBgpConnections: VirtualHubBgpConnections

Property Value

virtualHubIpConfiguration

virtualHubIpConfiguration: VirtualHubIpConfiguration

Property Value

virtualHubRouteTableV2S

virtualHubRouteTableV2S: VirtualHubRouteTableV2S

Property Value

virtualHubs

virtualHubs: VirtualHubs

Property Value

virtualNetworkGatewayConnections

virtualNetworkGatewayConnections: VirtualNetworkGatewayConnections

Property Value

virtualNetworkGatewayNatRules

virtualNetworkGatewayNatRules: VirtualNetworkGatewayNatRules

Property Value

virtualNetworkGateways

virtualNetworkGateways: VirtualNetworkGateways

Property Value

virtualNetworkPeerings

virtualNetworkPeerings: VirtualNetworkPeerings

Property Value

virtualNetworks

virtualNetworks: VirtualNetworks

Property Value

virtualNetworkTaps

virtualNetworkTaps: VirtualNetworkTaps

Property Value

virtualRouterPeerings

virtualRouterPeerings: VirtualRouterPeerings

Property Value

virtualRouters

virtualRouters: VirtualRouters

Property Value

virtualWans

virtualWans: VirtualWans

Property Value

vpnConnections

vpnConnections: VpnConnections

Property Value

vpnGateways

vpnGateways: VpnGateways

Property Value

vpnLinkConnections

vpnLinkConnections: VpnLinkConnections

Property Value

vpnServerConfigurations

vpnServerConfigurations: VpnServerConfigurations

Property Value

vpnServerConfigurationsAssociatedWithVirtualWan

vpnServerConfigurationsAssociatedWithVirtualWan: VpnServerConfigurationsAssociatedWithVirtualWan

Property Value

vpnSiteLinkConnections

vpnSiteLinkConnections: VpnSiteLinkConnections

Property Value

vpnSiteLinks: VpnSiteLinks

Property Value

vpnSites

vpnSites: VpnSites

Property Value

vpnSitesConfiguration

vpnSitesConfiguration: VpnSitesConfiguration

Property Value

webApplicationFirewallPolicies

webApplicationFirewallPolicies: WebApplicationFirewallPolicies

Property Value

webCategories

webCategories: WebCategories

Property Value

Inherited Property Details

pipeline

The pipeline used by this client to make requests

pipeline: Pipeline

Property Value

Inherited From coreClient.ServiceClient.pipeline

Method Details

Deletes the Bastion Shareable Links for all the VMs specified in the request.

function beginDeleteBastionShareableLink(resourceGroupName: string, bastionHostName: string, bslRequest: BastionShareableLinkListRequest, options?: DeleteBastionShareableLinkOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

Parameters

resourceGroupName

string

The name of the resource group.

bastionHostName

string

The name of the Bastion Host.

bslRequest
BastionShareableLinkListRequest

Post request for Create/Delete/Get Bastion Shareable Link endpoints.

options
DeleteBastionShareableLinkOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>

beginDeleteBastionShareableLinkAndWait(string, string, BastionShareableLinkListRequest, DeleteBastionShareableLinkOptionalParams)

Deletes the Bastion Shareable Links for all the VMs specified in the request.

function beginDeleteBastionShareableLinkAndWait(resourceGroupName: string, bastionHostName: string, bslRequest: BastionShareableLinkListRequest, options?: DeleteBastionShareableLinkOptionalParams): Promise<void>

Parameters

resourceGroupName

string

The name of the resource group.

bastionHostName

string

The name of the Bastion Host.

bslRequest
BastionShareableLinkListRequest

Post request for Create/Delete/Get Bastion Shareable Link endpoints.

options
DeleteBastionShareableLinkOptionalParams

The options parameters.

Returns

Promise<void>

beginDeleteBastionShareableLinkByToken(string, string, BastionShareableLinkTokenListRequest, DeleteBastionShareableLinkByTokenOptionalParams)

Deletes the Bastion Shareable Links for all the tokens specified in the request.

function beginDeleteBastionShareableLinkByToken(resourceGroupName: string, bastionHostName: string, bslTokenRequest: BastionShareableLinkTokenListRequest, options?: DeleteBastionShareableLinkByTokenOptionalParams): Promise<SimplePollerLike<OperationState<NetworkManagementClientDeleteBastionShareableLinkByTokenHeaders>, NetworkManagementClientDeleteBastionShareableLinkByTokenHeaders>>

Parameters

resourceGroupName

string

The name of the resource group.

bastionHostName

string

The name of the Bastion Host.

bslTokenRequest
BastionShareableLinkTokenListRequest

Post request for Delete Bastion Shareable Link By Token endpoint.

options
DeleteBastionShareableLinkByTokenOptionalParams

The options parameters.

Returns

beginDeleteBastionShareableLinkByTokenAndWait(string, string, BastionShareableLinkTokenListRequest, DeleteBastionShareableLinkByTokenOptionalParams)

Deletes the Bastion Shareable Links for all the tokens specified in the request.

function beginDeleteBastionShareableLinkByTokenAndWait(resourceGroupName: string, bastionHostName: string, bslTokenRequest: BastionShareableLinkTokenListRequest, options?: DeleteBastionShareableLinkByTokenOptionalParams): Promise<NetworkManagementClientDeleteBastionShareableLinkByTokenHeaders>

Parameters

resourceGroupName

string

The name of the resource group.

bastionHostName

string

The name of the Bastion Host.

bslTokenRequest
BastionShareableLinkTokenListRequest

Post request for Delete Bastion Shareable Link By Token endpoint.

options
DeleteBastionShareableLinkByTokenOptionalParams

The options parameters.

Returns

beginGeneratevirtualwanvpnserverconfigurationvpnprofile(string, string, VirtualWanVpnProfileParameters, GeneratevirtualwanvpnserverconfigurationvpnprofileOptionalParams)

Generates a unique VPN profile for P2S clients for VirtualWan and associated VpnServerConfiguration combination in the specified resource group.

function beginGeneratevirtualwanvpnserverconfigurationvpnprofile(resourceGroupName: string, virtualWANName: string, vpnClientParams: VirtualWanVpnProfileParameters, options?: GeneratevirtualwanvpnserverconfigurationvpnprofileOptionalParams): Promise<SimplePollerLike<OperationState<VpnProfileResponse>, VpnProfileResponse>>

Parameters

resourceGroupName

string

The resource group name.

virtualWANName

string

The name of the VirtualWAN whose associated VpnServerConfigurations is needed.

vpnClientParams
VirtualWanVpnProfileParameters

Parameters supplied to the generate VirtualWan VPN profile generation operation.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<VpnProfileResponse>, VpnProfileResponse>>

beginGeneratevirtualwanvpnserverconfigurationvpnprofileAndWait(string, string, VirtualWanVpnProfileParameters, GeneratevirtualwanvpnserverconfigurationvpnprofileOptionalParams)

Generates a unique VPN profile for P2S clients for VirtualWan and associated VpnServerConfiguration combination in the specified resource group.

function beginGeneratevirtualwanvpnserverconfigurationvpnprofileAndWait(resourceGroupName: string, virtualWANName: string, vpnClientParams: VirtualWanVpnProfileParameters, options?: GeneratevirtualwanvpnserverconfigurationvpnprofileOptionalParams): Promise<VpnProfileResponse>

Parameters

resourceGroupName

string

The resource group name.

virtualWANName

string

The name of the VirtualWAN whose associated VpnServerConfigurations is needed.

vpnClientParams
VirtualWanVpnProfileParameters

Parameters supplied to the generate VirtualWan VPN profile generation operation.

Returns

beginListActiveSessionsAndWait(string, string, GetActiveSessionsOptionalParams)

Returns the list of currently active sessions on the Bastion.

function beginListActiveSessionsAndWait(resourceGroupName: string, bastionHostName: string, options?: GetActiveSessionsOptionalParams): PagedAsyncIterableIterator<BastionActiveSession, BastionActiveSession[], PageSettings>

Parameters

resourceGroupName

string

The name of the resource group.

bastionHostName

string

The name of the Bastion Host.

options
GetActiveSessionsOptionalParams

The options parameters.

Returns

beginListPutBastionShareableLinkAndWait(string, string, BastionShareableLinkListRequest, PutBastionShareableLinkOptionalParams)

Creates a Bastion Shareable Links for all the VMs specified in the request.

function beginListPutBastionShareableLinkAndWait(resourceGroupName: string, bastionHostName: string, bslRequest: BastionShareableLinkListRequest, options?: PutBastionShareableLinkOptionalParams): PagedAsyncIterableIterator<BastionShareableLink, BastionShareableLink[], PageSettings>

Parameters

resourceGroupName

string

The name of the resource group.

bastionHostName

string

The name of the Bastion Host.

bslRequest
BastionShareableLinkListRequest

Post request for Create/Delete/Get Bastion Shareable Link endpoints.

options
PutBastionShareableLinkOptionalParams

The options parameters.

Returns

checkDnsNameAvailability(string, string, CheckDnsNameAvailabilityOptionalParams)

Checks whether a domain name in the cloudapp.azure.com zone is available for use.

function checkDnsNameAvailability(location: string, domainNameLabel: string, options?: CheckDnsNameAvailabilityOptionalParams): Promise<DnsNameAvailabilityResult>

Parameters

location

string

The location of the domain name.

domainNameLabel

string

The domain name to be verified. It must conform to the following regular expression: ^[a-z][a-z0-9-]{1,61}[a-z0-9]$.

options
CheckDnsNameAvailabilityOptionalParams

The options parameters.

Returns

expressRouteProviderPort(string, ExpressRouteProviderPortOptionalParams)

Retrieves detail of a provider port.

function expressRouteProviderPort(providerport: string, options?: ExpressRouteProviderPortOptionalParams): Promise<ExpressRouteProviderPort>

Parameters

providerport

string

The name of the provider port.

options
ExpressRouteProviderPortOptionalParams

The options parameters.

Returns

listActiveConnectivityConfigurations(string, string, ActiveConfigurationParameter, ListActiveConnectivityConfigurationsOptionalParams)

Lists active connectivity configurations in a network manager.

function listActiveConnectivityConfigurations(resourceGroupName: string, networkManagerName: string, parameters: ActiveConfigurationParameter, options?: ListActiveConnectivityConfigurationsOptionalParams): Promise<ActiveConnectivityConfigurationsListResult>

Parameters

resourceGroupName

string

The name of the resource group.

networkManagerName

string

The name of the network manager.

parameters
ActiveConfigurationParameter

Active Configuration Parameter.

options
ListActiveConnectivityConfigurationsOptionalParams

The options parameters.

Returns

listActiveSecurityAdminRules(string, string, ActiveConfigurationParameter, ListActiveSecurityAdminRulesOptionalParams)

Lists active security admin rules in a network manager.

function listActiveSecurityAdminRules(resourceGroupName: string, networkManagerName: string, parameters: ActiveConfigurationParameter, options?: ListActiveSecurityAdminRulesOptionalParams): Promise<ActiveSecurityAdminRulesListResult>

Parameters

resourceGroupName

string

The name of the resource group.

networkManagerName

string

The name of the network manager.

parameters
ActiveConfigurationParameter

Active Configuration Parameter.

options
ListActiveSecurityAdminRulesOptionalParams

The options parameters.

Returns

Return the Bastion Shareable Links for all the VMs specified in the request.

function listBastionShareableLink(resourceGroupName: string, bastionHostName: string, bslRequest: BastionShareableLinkListRequest, options?: GetBastionShareableLinkOptionalParams): PagedAsyncIterableIterator<BastionShareableLink, BastionShareableLink[], PageSettings>

Parameters

resourceGroupName

string

The name of the resource group.

bastionHostName

string

The name of the Bastion Host.

bslRequest
BastionShareableLinkListRequest

Post request for Create/Delete/Get Bastion Shareable Link endpoints.

options
GetBastionShareableLinkOptionalParams

The options parameters.

Returns

listDisconnectActiveSessions(string, string, SessionIds, DisconnectActiveSessionsOptionalParams)

Returns the list of currently active sessions on the Bastion.

function listDisconnectActiveSessions(resourceGroupName: string, bastionHostName: string, sessionIds: SessionIds, options?: DisconnectActiveSessionsOptionalParams): PagedAsyncIterableIterator<BastionSessionState, BastionSessionState[], PageSettings>

Parameters

resourceGroupName

string

The name of the resource group.

bastionHostName

string

The name of the Bastion Host.

sessionIds
SessionIds

The list of sessionids to disconnect.

options
DisconnectActiveSessionsOptionalParams

The options parameters.

Returns

listNetworkManagerEffectiveConnectivityConfigurations(string, string, QueryRequestOptions, ListNetworkManagerEffectiveConnectivityConfigurationsOptionalParams)

List all effective connectivity configurations applied on a virtual network.

function listNetworkManagerEffectiveConnectivityConfigurations(resourceGroupName: string, virtualNetworkName: string, parameters: QueryRequestOptions, options?: ListNetworkManagerEffectiveConnectivityConfigurationsOptionalParams): Promise<NetworkManagerEffectiveConnectivityConfigurationListResult>

Parameters

resourceGroupName

string

The name of the resource group.

virtualNetworkName

string

The name of the virtual network.

parameters
QueryRequestOptions

Parameters supplied to list correct page.

Returns

listNetworkManagerEffectiveSecurityAdminRules(string, string, QueryRequestOptions, ListNetworkManagerEffectiveSecurityAdminRulesOptionalParams)

List all effective security admin rules applied on a virtual network.

function listNetworkManagerEffectiveSecurityAdminRules(resourceGroupName: string, virtualNetworkName: string, parameters: QueryRequestOptions, options?: ListNetworkManagerEffectiveSecurityAdminRulesOptionalParams): Promise<NetworkManagerEffectiveSecurityAdminRulesListResult>

Parameters

resourceGroupName

string

The name of the resource group.

virtualNetworkName

string

The name of the virtual network.

parameters
QueryRequestOptions

Parameters supplied to list correct page.

Returns

supportedSecurityProviders(string, string, SupportedSecurityProvidersOptionalParams)

Gives the supported security providers for the virtual wan.

function supportedSecurityProviders(resourceGroupName: string, virtualWANName: string, options?: SupportedSecurityProvidersOptionalParams): Promise<VirtualWanSecurityProviders>

Parameters

resourceGroupName

string

The resource group name.

virtualWANName

string

The name of the VirtualWAN for which supported security providers are needed.

options
SupportedSecurityProvidersOptionalParams

The options parameters.

Returns

Inherited Method Details

sendOperationRequest<T>(OperationArguments, OperationSpec)

Send an HTTP request that is populated using the provided OperationSpec.

function sendOperationRequest<T>(operationArguments: OperationArguments, operationSpec: OperationSpec): Promise<T>

Parameters

operationArguments
OperationArguments

The arguments that the HTTP request's templated values will be populated from.

operationSpec
OperationSpec

The OperationSpec to use to populate the httpRequest.

Returns

Promise<T>

Inherited From coreClient.ServiceClient.sendOperationRequest

sendRequest(PipelineRequest)

Send the provided httpRequest.

function sendRequest(request: PipelineRequest): Promise<PipelineResponse>

Parameters

request
PipelineRequest

Returns

Promise<PipelineResponse>

Inherited From coreClient.ServiceClient.sendRequest