NetworkManagementClient class

Package:

@azure/arm-network

Extends

ServiceClient

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
networkManagers
networkProfiles
networkSecurityGroups
networkVirtualApplianceConnections
networkVirtualAppliances
networkWatchers
operations
p2SVpnGateways
packetCaptures
peerExpressRouteCircuitConnections
privateDnsZoneGroups
privateEndpoints
privateLinkServices
publicIPAddresses
publicIPPrefixes
resourceNavigationLinks
routeFilterRules
routeFilters
routeMaps
routes
routeTables
routingIntentOperations
scopeConnections
securityAdminConfigurations
securityPartnerProviders
securityRules
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

options

NetworkManagementClientOptionalParams

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

AdminRuleCollections

adminRules

adminRules: AdminRules

Property Value

AdminRules

applicationGatewayPrivateEndpointConnections

applicationGatewayPrivateEndpointConnections: ApplicationGatewayPrivateEndpointConnections

Property Value

ApplicationGatewayPrivateEndpointConnections

applicationGatewayPrivateLinkResources

applicationGatewayPrivateLinkResources: ApplicationGatewayPrivateLinkResources

Property Value

ApplicationGatewayPrivateLinkResources

applicationGateways

applicationGateways: ApplicationGateways

Property Value

ApplicationGateways

applicationGatewayWafDynamicManifests

applicationGatewayWafDynamicManifests: ApplicationGatewayWafDynamicManifests

Property Value

ApplicationGatewayWafDynamicManifests

applicationGatewayWafDynamicManifestsDefault

applicationGatewayWafDynamicManifestsDefault: ApplicationGatewayWafDynamicManifestsDefault

Property Value

ApplicationGatewayWafDynamicManifestsDefault

applicationSecurityGroups

applicationSecurityGroups: ApplicationSecurityGroups

Property Value

ApplicationSecurityGroups

availableDelegations

availableDelegations: AvailableDelegations

Property Value

AvailableDelegations

availableEndpointServices

availableEndpointServices: AvailableEndpointServices

Property Value

AvailableEndpointServices

availablePrivateEndpointTypes

availablePrivateEndpointTypes: AvailablePrivateEndpointTypes

Property Value

AvailablePrivateEndpointTypes

availableResourceGroupDelegations

availableResourceGroupDelegations: AvailableResourceGroupDelegations

Property Value

AvailableResourceGroupDelegations

availableServiceAliases

availableServiceAliases: AvailableServiceAliases

Property Value

AvailableServiceAliases

azureFirewallFqdnTags

azureFirewallFqdnTags: AzureFirewallFqdnTags

Property Value

AzureFirewallFqdnTags

azureFirewalls

azureFirewalls: AzureFirewalls

Property Value

AzureFirewalls

bastionHosts

bastionHosts: BastionHosts

Property Value

BastionHosts

bgpServiceCommunities

bgpServiceCommunities: BgpServiceCommunities

Property Value

BgpServiceCommunities

configurationPolicyGroups

configurationPolicyGroups: ConfigurationPolicyGroups

Property Value

ConfigurationPolicyGroups

connectionMonitors

connectionMonitors: ConnectionMonitors

Property Value

ConnectionMonitors

connectivityConfigurations

connectivityConfigurations: ConnectivityConfigurations

Property Value

ConnectivityConfigurations

customIPPrefixes

customIPPrefixes: CustomIPPrefixes

Property Value

CustomIPPrefixes

ddosCustomPolicies

ddosCustomPolicies: DdosCustomPolicies

Property Value

DdosCustomPolicies

ddosProtectionPlans

ddosProtectionPlans: DdosProtectionPlans

Property Value

DdosProtectionPlans

defaultSecurityRules

defaultSecurityRules: DefaultSecurityRules

Property Value

DefaultSecurityRules

dscpConfigurationOperations

dscpConfigurationOperations: DscpConfigurationOperations

Property Value

DscpConfigurationOperations

expressRouteCircuitAuthorizations

expressRouteCircuitAuthorizations: ExpressRouteCircuitAuthorizations

Property Value

ExpressRouteCircuitAuthorizations

expressRouteCircuitConnections

expressRouteCircuitConnections: ExpressRouteCircuitConnections

Property Value

ExpressRouteCircuitConnections

expressRouteCircuitPeerings

expressRouteCircuitPeerings: ExpressRouteCircuitPeerings

Property Value

ExpressRouteCircuitPeerings

expressRouteCircuits

expressRouteCircuits: ExpressRouteCircuits

Property Value

ExpressRouteCircuits

expressRouteConnections

expressRouteConnections: ExpressRouteConnections

Property Value

ExpressRouteConnections

expressRouteCrossConnectionPeerings

expressRouteCrossConnectionPeerings: ExpressRouteCrossConnectionPeerings

Property Value

ExpressRouteCrossConnectionPeerings

expressRouteCrossConnections

expressRouteCrossConnections: ExpressRouteCrossConnections

Property Value

ExpressRouteCrossConnections

expressRouteGateways

expressRouteGateways: ExpressRouteGateways

Property Value

ExpressRouteGateways

expressRouteLinks

expressRouteLinks: ExpressRouteLinks

Property Value

ExpressRouteLinks

expressRoutePortAuthorizations

expressRoutePortAuthorizations: ExpressRoutePortAuthorizations

Property Value

ExpressRoutePortAuthorizations

expressRoutePorts

expressRoutePorts: ExpressRoutePorts

Property Value

ExpressRoutePorts

expressRoutePortsLocations

expressRoutePortsLocations: ExpressRoutePortsLocations

Property Value

ExpressRoutePortsLocations

expressRouteProviderPortsLocation

expressRouteProviderPortsLocation: ExpressRouteProviderPortsLocation

Property Value

ExpressRouteProviderPortsLocation

expressRouteServiceProviders

expressRouteServiceProviders: ExpressRouteServiceProviders

Property Value

ExpressRouteServiceProviders

firewallPolicies

firewallPolicies: FirewallPolicies

Property Value

FirewallPolicies

firewallPolicyDeployments

firewallPolicyDeployments: FirewallPolicyDeployments

Property Value

FirewallPolicyDeployments

firewallPolicyDrafts

firewallPolicyDrafts: FirewallPolicyDrafts

Property Value

FirewallPolicyDrafts

firewallPolicyIdpsSignatures

firewallPolicyIdpsSignatures: FirewallPolicyIdpsSignatures

Property Value

FirewallPolicyIdpsSignatures

firewallPolicyIdpsSignaturesFilterValues

firewallPolicyIdpsSignaturesFilterValues: FirewallPolicyIdpsSignaturesFilterValues

Property Value

FirewallPolicyIdpsSignaturesFilterValues

firewallPolicyIdpsSignaturesOverrides

firewallPolicyIdpsSignaturesOverrides: FirewallPolicyIdpsSignaturesOverrides

Property Value

FirewallPolicyIdpsSignaturesOverrides

firewallPolicyRuleCollectionGroupDrafts

firewallPolicyRuleCollectionGroupDrafts: FirewallPolicyRuleCollectionGroupDrafts

Property Value

FirewallPolicyRuleCollectionGroupDrafts

firewallPolicyRuleCollectionGroups

firewallPolicyRuleCollectionGroups: FirewallPolicyRuleCollectionGroups

Property Value

FirewallPolicyRuleCollectionGroups

flowLogs

flowLogs: FlowLogs

Property Value

FlowLogs

hubRouteTables

hubRouteTables: HubRouteTables

Property Value

HubRouteTables

hubVirtualNetworkConnections

hubVirtualNetworkConnections: HubVirtualNetworkConnections

Property Value

HubVirtualNetworkConnections

inboundNatRules

inboundNatRules: InboundNatRules

Property Value

InboundNatRules

inboundSecurityRuleOperations

inboundSecurityRuleOperations: InboundSecurityRuleOperations

Property Value

InboundSecurityRuleOperations

ipAllocations

ipAllocations: IpAllocations

Property Value

IpAllocations

ipGroups

ipGroups: IpGroups

Property Value

IpGroups

loadBalancerBackendAddressPools

loadBalancerBackendAddressPools: LoadBalancerBackendAddressPools

Property Value

LoadBalancerBackendAddressPools

loadBalancerFrontendIPConfigurations

loadBalancerFrontendIPConfigurations: LoadBalancerFrontendIPConfigurations

Property Value

LoadBalancerFrontendIPConfigurations

loadBalancerLoadBalancingRules

loadBalancerLoadBalancingRules: LoadBalancerLoadBalancingRules

Property Value

LoadBalancerLoadBalancingRules

loadBalancerNetworkInterfaces

loadBalancerNetworkInterfaces: LoadBalancerNetworkInterfaces

Property Value

LoadBalancerNetworkInterfaces

loadBalancerOutboundRules

loadBalancerOutboundRules: LoadBalancerOutboundRules

Property Value

LoadBalancerOutboundRules

loadBalancerProbes

loadBalancerProbes: LoadBalancerProbes

Property Value

LoadBalancerProbes

loadBalancers

loadBalancers: LoadBalancers

Property Value

LoadBalancers

localNetworkGateways

localNetworkGateways: LocalNetworkGateways

Property Value

LocalNetworkGateways

managementGroupNetworkManagerConnections

managementGroupNetworkManagerConnections: ManagementGroupNetworkManagerConnections

Property Value

ManagementGroupNetworkManagerConnections

natGateways

natGateways: NatGateways

Property Value

NatGateways

natRules

natRules: NatRules

Property Value

NatRules

networkGroups

networkGroups: NetworkGroups

Property Value

NetworkGroups

networkInterfaceIPConfigurations

networkInterfaceIPConfigurations: NetworkInterfaceIPConfigurations

Property Value

NetworkInterfaceIPConfigurations

networkInterfaceLoadBalancers

networkInterfaceLoadBalancers: NetworkInterfaceLoadBalancers

Property Value

NetworkInterfaceLoadBalancers

networkInterfaces

networkInterfaces: NetworkInterfaces

Property Value

NetworkInterfaces

networkInterfaceTapConfigurations

networkInterfaceTapConfigurations: NetworkInterfaceTapConfigurations

Property Value

NetworkInterfaceTapConfigurations

networkManagerCommits

networkManagerCommits: NetworkManagerCommits

Property Value

NetworkManagerCommits

networkManagerDeploymentStatusOperations

networkManagerDeploymentStatusOperations: NetworkManagerDeploymentStatusOperations

Property Value

NetworkManagerDeploymentStatusOperations

networkManagers

networkManagers: NetworkManagers

Property Value

NetworkManagers

networkProfiles

networkProfiles: NetworkProfiles

Property Value

NetworkProfiles

networkSecurityGroups

networkSecurityGroups: NetworkSecurityGroups

Property Value

NetworkSecurityGroups

networkVirtualApplianceConnections

networkVirtualApplianceConnections: NetworkVirtualApplianceConnections

Property Value

NetworkVirtualApplianceConnections

networkVirtualAppliances

networkVirtualAppliances: NetworkVirtualAppliances

Property Value

NetworkVirtualAppliances

networkWatchers

networkWatchers: NetworkWatchers

Property Value

NetworkWatchers

operations

operations: Operations

Property Value

Operations

p2SVpnGateways

p2SVpnGateways: P2SVpnGateways

Property Value

P2SVpnGateways

packetCaptures

packetCaptures: PacketCaptures

Property Value

PacketCaptures

peerExpressRouteCircuitConnections

peerExpressRouteCircuitConnections: PeerExpressRouteCircuitConnections

Property Value

PeerExpressRouteCircuitConnections

privateDnsZoneGroups

privateDnsZoneGroups: PrivateDnsZoneGroups

Property Value

PrivateDnsZoneGroups

privateEndpoints

privateEndpoints: PrivateEndpoints

Property Value

PrivateEndpoints

privateLinkServices

privateLinkServices: PrivateLinkServices

Property Value

PrivateLinkServices

publicIPAddresses

publicIPAddresses: PublicIPAddresses

Property Value

PublicIPAddresses

publicIPPrefixes

publicIPPrefixes: PublicIPPrefixes

Property Value

PublicIPPrefixes

resourceNavigationLinks

resourceNavigationLinks: ResourceNavigationLinks

Property Value

ResourceNavigationLinks

routeFilterRules

routeFilterRules: RouteFilterRules

Property Value

RouteFilterRules

routeFilters

routeFilters: RouteFilters

Property Value

RouteFilters

routeMaps

routeMaps: RouteMaps

Property Value

RouteMaps

routes

routes: Routes

Property Value

Routes

routeTables

routeTables: RouteTables

Property Value

RouteTables

routingIntentOperations

routingIntentOperations: RoutingIntentOperations

Property Value

RoutingIntentOperations

scopeConnections

scopeConnections: ScopeConnections

Property Value

ScopeConnections

securityAdminConfigurations

securityAdminConfigurations: SecurityAdminConfigurations

Property Value

SecurityAdminConfigurations

securityPartnerProviders

securityPartnerProviders: SecurityPartnerProviders

Property Value

SecurityPartnerProviders

securityRules

securityRules: SecurityRules

Property Value

SecurityRules

serviceAssociationLinks

serviceAssociationLinks: ServiceAssociationLinks

Property Value

ServiceAssociationLinks

serviceEndpointPolicies

serviceEndpointPolicies: ServiceEndpointPolicies

Property Value

ServiceEndpointPolicies

serviceEndpointPolicyDefinitions

serviceEndpointPolicyDefinitions: ServiceEndpointPolicyDefinitions

Property Value

ServiceEndpointPolicyDefinitions

serviceTagInformationOperations

serviceTagInformationOperations: ServiceTagInformationOperations

Property Value

ServiceTagInformationOperations

serviceTags

serviceTags: ServiceTags

Property Value

ServiceTags

staticMembers

staticMembers: StaticMembers

Property Value

StaticMembers

subnets

subnets: Subnets

Property Value

Subnets

subscriptionId

subscriptionId?: string

Property Value

string

subscriptionNetworkManagerConnections

subscriptionNetworkManagerConnections: SubscriptionNetworkManagerConnections

Property Value

SubscriptionNetworkManagerConnections

usages

usages: Usages

Property Value

Usages

vipSwap

vipSwap: VipSwap

Property Value

VipSwap

virtualApplianceSites

virtualApplianceSites: VirtualApplianceSites

Property Value

VirtualApplianceSites

virtualApplianceSkus

virtualApplianceSkus: VirtualApplianceSkus

Property Value

VirtualApplianceSkus

virtualHubBgpConnection

virtualHubBgpConnection: VirtualHubBgpConnection

Property Value

VirtualHubBgpConnection

virtualHubBgpConnections

virtualHubBgpConnections: VirtualHubBgpConnections

Property Value

VirtualHubBgpConnections

virtualHubIpConfiguration

virtualHubIpConfiguration: VirtualHubIpConfiguration

Property Value

VirtualHubIpConfiguration

virtualHubRouteTableV2S

virtualHubRouteTableV2S: VirtualHubRouteTableV2S

Property Value

VirtualHubRouteTableV2S

virtualHubs

virtualHubs: VirtualHubs

Property Value

VirtualHubs

virtualNetworkGatewayConnections

virtualNetworkGatewayConnections: VirtualNetworkGatewayConnections

Property Value

VirtualNetworkGatewayConnections

virtualNetworkGatewayNatRules

virtualNetworkGatewayNatRules: VirtualNetworkGatewayNatRules

Property Value

VirtualNetworkGatewayNatRules

virtualNetworkGateways

virtualNetworkGateways: VirtualNetworkGateways

Property Value

VirtualNetworkGateways

virtualNetworkPeerings

virtualNetworkPeerings: VirtualNetworkPeerings

Property Value

VirtualNetworkPeerings

virtualNetworks

virtualNetworks: VirtualNetworks

Property Value

VirtualNetworks

virtualNetworkTaps

virtualNetworkTaps: VirtualNetworkTaps

Property Value

VirtualNetworkTaps

virtualRouterPeerings

virtualRouterPeerings: VirtualRouterPeerings

Property Value

VirtualRouterPeerings

virtualRouters

virtualRouters: VirtualRouters

Property Value

VirtualRouters

virtualWans

virtualWans: VirtualWans

Property Value

VirtualWans

vpnConnections

vpnConnections: VpnConnections

Property Value

VpnConnections

vpnGateways

vpnGateways: VpnGateways

Property Value

VpnGateways

vpnLinkConnections

vpnLinkConnections: VpnLinkConnections

Property Value

VpnLinkConnections

vpnServerConfigurations

vpnServerConfigurations: VpnServerConfigurations

Property Value

VpnServerConfigurations

vpnServerConfigurationsAssociatedWithVirtualWan

vpnServerConfigurationsAssociatedWithVirtualWan: VpnServerConfigurationsAssociatedWithVirtualWan

Property Value

VpnServerConfigurationsAssociatedWithVirtualWan

vpnSiteLinkConnections

vpnSiteLinkConnections: VpnSiteLinkConnections

Property Value

VpnSiteLinkConnections

vpnSiteLinks

vpnSiteLinks: VpnSiteLinks

Property Value

VpnSiteLinks

vpnSites

vpnSites: VpnSites

Property Value

VpnSites

vpnSitesConfiguration

vpnSitesConfiguration: VpnSitesConfiguration

Property Value

VpnSitesConfiguration

webApplicationFirewallPolicies

webApplicationFirewallPolicies: WebApplicationFirewallPolicies

Property Value

WebApplicationFirewallPolicies

webCategories

webCategories: WebCategories

Property Value

WebCategories

Inherited Property Details

pipeline

The pipeline used by this client to make requests

pipeline: Pipeline

Property Value

Pipeline

Inherited From coreClient.ServiceClient.pipeline

Method Details

beginDeleteBastionShareableLink(string, string, BastionShareableLinkListRequest, DeleteBastionShareableLinkOptionalParams)

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

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

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

Promise<NetworkManagementClientDeleteBastionShareableLinkByTokenHeaders>

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.

options

GeneratevirtualwanvpnserverconfigurationvpnprofileOptionalParams

The options parameters.

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.

options

GeneratevirtualwanvpnserverconfigurationvpnprofileOptionalParams

The options parameters.

Returns

Promise<VpnProfileResponse>

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

PagedAsyncIterableIterator<BastionActiveSession, BastionActiveSession[], PageSettings>

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

PagedAsyncIterableIterator<BastionShareableLink, BastionShareableLink[], PageSettings>

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

Promise<DnsNameAvailabilityResult>

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

Promise<ExpressRouteProviderPort>

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

Promise<ActiveConnectivityConfigurationsListResult>

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

Promise<ActiveSecurityAdminRulesListResult>

listBastionShareableLink(string, string, BastionShareableLinkListRequest, GetBastionShareableLinkOptionalParams)

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

PagedAsyncIterableIterator<BastionShareableLink, BastionShareableLink[], PageSettings>

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

PagedAsyncIterableIterator<BastionSessionState, BastionSessionState[], PageSettings>

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.

options

ListNetworkManagerEffectiveConnectivityConfigurationsOptionalParams

The options parameters.

Returns

Promise<NetworkManagerEffectiveConnectivityConfigurationListResult>

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.

options

ListNetworkManagerEffectiveSecurityAdminRulesOptionalParams

The options parameters.

Returns

Promise<NetworkManagerEffectiveSecurityAdminRulesListResult>

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

Promise<VirtualWanSecurityProviders>

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