NetworkManagementClient class
- Extends
Constructors
Network |
|
Network |
Initializes a new instance of the NetworkManagementClient class. |
Properties
Inherited Properties
pipeline | The pipeline used by this client to make requests |
Methods
Inherited Methods
send |
Send an HTTP request that is populated using the provided OperationSpec. |
send |
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.
The parameter options
Property Details
$host
$host: string
Property Value
string
adminRuleCollections
adminRules
applicationGatewayPrivateEndpointConnections
applicationGatewayPrivateEndpointConnections: ApplicationGatewayPrivateEndpointConnections
Property Value
applicationGatewayPrivateLinkResources
applicationGatewayPrivateLinkResources: ApplicationGatewayPrivateLinkResources
Property Value
applicationGateways
applicationGatewayWafDynamicManifests
applicationGatewayWafDynamicManifests: ApplicationGatewayWafDynamicManifests
Property Value
applicationGatewayWafDynamicManifestsDefault
applicationGatewayWafDynamicManifestsDefault: ApplicationGatewayWafDynamicManifestsDefault
Property Value
applicationSecurityGroups
availableDelegations
availableEndpointServices
availablePrivateEndpointTypes
availablePrivateEndpointTypes: AvailablePrivateEndpointTypes
Property Value
availableResourceGroupDelegations
availableResourceGroupDelegations: AvailableResourceGroupDelegations
Property Value
availableServiceAliases
azureFirewallFqdnTags
azureFirewalls
bastionHosts
bgpServiceCommunities
configurationPolicyGroups
connectionMonitors
connectivityConfigurations
customIPPrefixes
ddosCustomPolicies
ddosProtectionPlans
defaultSecurityRules
dscpConfigurationOperations
expressRouteCircuitAuthorizations
expressRouteCircuitAuthorizations: ExpressRouteCircuitAuthorizations
Property Value
expressRouteCircuitConnections
expressRouteCircuitConnections: ExpressRouteCircuitConnections
Property Value
expressRouteCircuitPeerings
expressRouteCircuits
expressRouteConnections
expressRouteCrossConnectionPeerings
expressRouteCrossConnectionPeerings: ExpressRouteCrossConnectionPeerings
Property Value
expressRouteCrossConnections
expressRouteCrossConnections: ExpressRouteCrossConnections
Property Value
expressRouteGateways
expressRouteLinks
expressRoutePortAuthorizations
expressRoutePortAuthorizations: ExpressRoutePortAuthorizations
Property Value
expressRoutePorts
expressRoutePortsLocations
expressRouteProviderPortsLocation
expressRouteProviderPortsLocation: ExpressRouteProviderPortsLocation
Property Value
expressRouteServiceProviders
expressRouteServiceProviders: ExpressRouteServiceProviders
Property Value
firewallPolicies
firewallPolicyDeployments
firewallPolicyDrafts
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
hubRouteTables
hubVirtualNetworkConnections
hubVirtualNetworkConnections: HubVirtualNetworkConnections
Property Value
inboundNatRules
inboundSecurityRuleOperations
inboundSecurityRuleOperations: InboundSecurityRuleOperations
Property Value
ipAllocations
ipGroups
loadBalancerBackendAddressPools
loadBalancerBackendAddressPools: LoadBalancerBackendAddressPools
Property Value
loadBalancerFrontendIPConfigurations
loadBalancerFrontendIPConfigurations: LoadBalancerFrontendIPConfigurations
Property Value
loadBalancerLoadBalancingRules
loadBalancerLoadBalancingRules: LoadBalancerLoadBalancingRules
Property Value
loadBalancerNetworkInterfaces
loadBalancerNetworkInterfaces: LoadBalancerNetworkInterfaces
Property Value
loadBalancerOutboundRules
loadBalancerProbes
loadBalancers
localNetworkGateways
managementGroupNetworkManagerConnections
managementGroupNetworkManagerConnections: ManagementGroupNetworkManagerConnections
Property Value
natGateways
natRules
networkGroups
networkInterfaceIPConfigurations
networkInterfaceIPConfigurations: NetworkInterfaceIPConfigurations
Property Value
networkInterfaceLoadBalancers
networkInterfaceLoadBalancers: NetworkInterfaceLoadBalancers
Property Value
networkInterfaces
networkInterfaceTapConfigurations
networkInterfaceTapConfigurations: NetworkInterfaceTapConfigurations
Property Value
networkManagerCommits
networkManagerDeploymentStatusOperations
networkManagerDeploymentStatusOperations: NetworkManagerDeploymentStatusOperations
Property Value
networkManagerRoutingConfigurations
networkManagerRoutingConfigurations: NetworkManagerRoutingConfigurations
Property Value
networkManagers
networkProfiles
networkSecurityGroups
networkVirtualApplianceConnections
networkVirtualApplianceConnections: NetworkVirtualApplianceConnections
Property Value
networkVirtualAppliances
networkWatchers
operations
p2SVpnGateways
packetCaptures
peerExpressRouteCircuitConnections
peerExpressRouteCircuitConnections: PeerExpressRouteCircuitConnections
Property Value
privateDnsZoneGroups
privateEndpoints
privateLinkServices
publicIPAddresses
publicIPPrefixes
resourceNavigationLinks
routeFilterRules
routeFilters
routeMaps
routes
routeTables
routingIntentOperations
routingRuleCollections
routingRules
scopeConnections
securityAdminConfigurations
securityPartnerProviders
securityRules
securityUserConfigurations
securityUserRuleCollections
securityUserRules
serviceAssociationLinks
serviceEndpointPolicies
serviceEndpointPolicyDefinitions
serviceEndpointPolicyDefinitions: ServiceEndpointPolicyDefinitions
Property Value
serviceTagInformationOperations
serviceTagInformationOperations: ServiceTagInformationOperations
Property Value
serviceTags
staticMembers
subnets
subscriptionId
subscriptionId?: string
Property Value
string
subscriptionNetworkManagerConnections
subscriptionNetworkManagerConnections: SubscriptionNetworkManagerConnections
Property Value
usages
vipSwap
virtualApplianceSites
virtualApplianceSkus
virtualHubBgpConnection
virtualHubBgpConnections
virtualHubIpConfiguration
virtualHubRouteTableV2S
virtualHubs
virtualNetworkGatewayConnections
virtualNetworkGatewayConnections: VirtualNetworkGatewayConnections
Property Value
virtualNetworkGatewayNatRules
virtualNetworkGatewayNatRules: VirtualNetworkGatewayNatRules
Property Value
virtualNetworkGateways
virtualNetworkPeerings
virtualNetworks
virtualNetworkTaps
virtualRouterPeerings
virtualRouters
virtualWans
vpnConnections
vpnGateways
vpnLinkConnections
vpnServerConfigurations
vpnServerConfigurationsAssociatedWithVirtualWan
vpnServerConfigurationsAssociatedWithVirtualWan: VpnServerConfigurationsAssociatedWithVirtualWan
Property Value
vpnSiteLinkConnections
vpnSiteLinks
vpnSites
vpnSitesConfiguration
webApplicationFirewallPolicies
webApplicationFirewallPolicies: WebApplicationFirewallPolicies
Property Value
webCategories
Inherited Property Details
pipeline
The pipeline used by this client to make requests
pipeline: Pipeline
Property Value
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.
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.
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.
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.
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.
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.
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
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.
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]$.
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.
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.
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.
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.
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.
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.
The options parameters.
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.
The options parameters.
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.
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