NetworkFunctions

Functions

Link copied to clipboard

Returns the list of currently active sessions on the Bastion. Uses Azure REST API version 2023-02-01. Other available API versions: 2023-04-01, 2023-05-01, 2023-06-01, 2023-09-01, 2023-11-01, 2024-01-01, 2024-03-01, 2024-05-01.

suspend fun getActiveSessions(bastionHostName: String, resourceGroupName: String): GetActiveSessionsResult
Link copied to clipboard

Gets a network manager security configuration admin rule. Uses Azure REST API version 2023-02-01. Other available API versions: 2021-02-01-preview, 2021-05-01-preview, 2023-04-01, 2023-05-01, 2023-06-01, 2023-09-01, 2023-11-01, 2024-01-01, 2024-01-01-preview, 2024-03-01, 2024-05-01.

suspend fun getAdminRule(configurationName: String, networkManagerName: String, resourceGroupName: String, ruleCollectionName: String, ruleName: String): GetAdminRuleResult
Link copied to clipboard

Gets a network manager security admin configuration rule collection. Uses Azure REST API version 2023-02-01. Other available API versions: 2021-02-01-preview, 2021-05-01-preview, 2023-04-01, 2023-05-01, 2023-06-01, 2023-09-01, 2023-11-01, 2024-01-01, 2024-01-01-preview, 2024-03-01, 2024-05-01.

suspend fun getAdminRuleCollection(configurationName: String, networkManagerName: String, resourceGroupName: String, ruleCollectionName: String): GetAdminRuleCollectionResult
Link copied to clipboard

Gets the specified application gateway. Uses Azure REST API version 2023-02-01. Other available API versions: 2019-06-01, 2019-08-01, 2023-04-01, 2023-05-01, 2023-06-01, 2023-09-01, 2023-11-01, 2024-01-01, 2024-03-01, 2024-05-01.

suspend fun getApplicationGateway(applicationGatewayName: String, resourceGroupName: String): GetApplicationGatewayResult

Gets the backend health for given combination of backend pool and http setting of the specified application gateway in a resource group. Uses Azure REST API version 2023-02-01. Other available API versions: 2019-06-01, 2019-08-01, 2023-04-01, 2023-05-01, 2023-06-01, 2023-09-01, 2023-11-01, 2024-01-01, 2024-03-01, 2024-05-01.

suspend fun getApplicationGatewayBackendHealthOnDemand(applicationGatewayName: String, backendAddressPool: SubResource? = null, backendHttpSettings: SubResource? = null, expand: String? = null, host: String? = null, match: ApplicationGatewayProbeHealthResponseMatch? = null, path: String? = null, pickHostNameFromBackendHttpSettings: Boolean? = null, protocol: Either<String, ApplicationGatewayProtocol>? = null, resourceGroupName: String, timeout: Int? = null): GetApplicationGatewayBackendHealthOnDemandResult

Gets the specified private endpoint connection on application gateway. Uses Azure REST API version 2023-02-01. Other available API versions: 2023-04-01, 2023-05-01, 2023-06-01, 2023-09-01, 2023-11-01, 2024-01-01, 2024-03-01, 2024-05-01.

suspend fun getApplicationGatewayPrivateEndpointConnection(applicationGatewayName: String, connectionName: String, resourceGroupName: String): GetApplicationGatewayPrivateEndpointConnectionResult
Link copied to clipboard

Gets information about the specified application security group. Uses Azure REST API version 2023-02-01. Other available API versions: 2023-04-01, 2023-05-01, 2023-06-01, 2023-09-01, 2023-11-01, 2024-01-01, 2024-03-01, 2024-05-01.

suspend fun getApplicationSecurityGroup(applicationSecurityGroupName: String, resourceGroupName: String): GetApplicationSecurityGroupResult
Link copied to clipboard

Gets the specified Azure Firewall. Uses Azure REST API version 2023-02-01. Other available API versions: 2020-04-01, 2023-04-01, 2023-05-01, 2023-06-01, 2023-09-01, 2023-11-01, 2024-01-01, 2024-03-01, 2024-05-01.

suspend fun getAzureFirewall(azureFirewallName: String, resourceGroupName: String): GetAzureFirewallResult
Link copied to clipboard

Gets the specified Bastion Host. Uses Azure REST API version 2023-02-01. Other available API versions: 2023-04-01, 2023-05-01, 2023-06-01, 2023-09-01, 2023-11-01, 2024-01-01, 2024-03-01, 2024-05-01.

suspend fun getBastionHost(bastionHostName: String, resourceGroupName: String): GetBastionHostResult
Link copied to clipboard

Return the Bastion Shareable Links for all the VMs specified in the request. Uses Azure REST API version 2023-02-01. Other available API versions: 2023-04-01, 2023-05-01, 2023-06-01, 2023-09-01, 2023-11-01, 2024-01-01, 2024-03-01, 2024-05-01.

suspend fun getBastionShareableLink(bastionHostName: String, resourceGroupName: String, vms: List<BastionShareableLink>? = null): GetBastionShareableLinkResult
Link copied to clipboard

Retrieves the details of a ConfigurationPolicyGroup. Uses Azure REST API version 2023-02-01. Other available API versions: 2023-04-01, 2023-05-01, 2023-06-01, 2023-09-01, 2023-11-01, 2024-01-01, 2024-03-01, 2024-05-01.

suspend fun getConfigurationPolicyGroup(configurationPolicyGroupName: String, resourceGroupName: String, vpnServerConfigurationName: String): GetConfigurationPolicyGroupResult
Link copied to clipboard

Gets a connection monitor by name. Uses Azure REST API version 2023-02-01. Other available API versions: 2019-09-01, 2023-04-01, 2023-05-01, 2023-06-01, 2023-09-01, 2023-11-01, 2024-01-01, 2024-03-01, 2024-05-01.

suspend fun getConnectionMonitor(connectionMonitorName: String, networkWatcherName: String, resourceGroupName: String): GetConnectionMonitorResult
Link copied to clipboard

Gets a Network Connectivity Configuration, specified by the resource group, network manager name, and connectivity Configuration name Uses Azure REST API version 2023-02-01. Other available API versions: 2021-02-01-preview, 2021-05-01-preview, 2023-04-01, 2023-05-01, 2023-06-01, 2023-09-01, 2023-11-01, 2024-01-01, 2024-03-01, 2024-05-01.

suspend fun getConnectivityConfiguration(configurationName: String, networkManagerName: String, resourceGroupName: String): GetConnectivityConfigurationResult
Link copied to clipboard

Gets the specified custom IP prefix in a specified resource group. Uses Azure REST API version 2023-02-01. Other available API versions: 2021-03-01, 2023-04-01, 2023-05-01, 2023-06-01, 2023-09-01, 2023-11-01, 2024-01-01, 2024-03-01, 2024-05-01.

suspend fun getCustomIPPrefix(customIpPrefixName: String, expand: String? = null, resourceGroupName: String): GetCustomIPPrefixResult
Link copied to clipboard

Gets information about the specified DDoS custom policy. Uses Azure REST API version 2023-02-01. Other available API versions: 2022-01-01, 2023-04-01, 2023-05-01, 2023-06-01, 2023-09-01, 2023-11-01, 2024-01-01, 2024-03-01, 2024-05-01.

suspend fun getDdosCustomPolicy(ddosCustomPolicyName: String, resourceGroupName: String): GetDdosCustomPolicyResult
Link copied to clipboard

Gets information about the specified DDoS protection plan. Uses Azure REST API version 2023-02-01. Other available API versions: 2022-05-01, 2023-04-01, 2023-05-01, 2023-06-01, 2023-09-01, 2023-11-01, 2024-01-01, 2024-03-01, 2024-05-01.

suspend fun getDdosProtectionPlan(ddosProtectionPlanName: String, resourceGroupName: String): GetDdosProtectionPlanResult
Link copied to clipboard

Gets a network manager security configuration admin rule. Uses Azure REST API version 2023-02-01.

suspend fun getDefaultAdminRule(configurationName: String, networkManagerName: String, resourceGroupName: String, ruleCollectionName: String, ruleName: String): GetDefaultAdminRuleResult
Link copied to clipboard

Gets a user rule. Uses Azure REST API version 2022-04-01-preview.

suspend fun getDefaultUserRule(configurationName: String, networkManagerName: String, resourceGroupName: String, ruleCollectionName: String, ruleName: String): GetDefaultUserRuleResult
Link copied to clipboard

Gets a DNS forwarding ruleset properties. Uses Azure REST API version 2022-07-01. Other available API versions: 2020-04-01-preview, 2023-07-01-preview.

suspend fun getDnsForwardingRuleset(dnsForwardingRulesetName: String, resourceGroupName: String): GetDnsForwardingRulesetResult
Link copied to clipboard

Gets properties of a DNS resolver. Uses Azure REST API version 2022-07-01. Other available API versions: 2023-07-01-preview.

suspend fun getDnsResolver(dnsResolverName: String, resourceGroupName: String): GetDnsResolverResult
Link copied to clipboard

Gets properties of a DNS resolver domain list. Uses Azure REST API version 2023-07-01-preview.

suspend fun getDnsResolverDomainList(dnsResolverDomainListName: String, resourceGroupName: String): GetDnsResolverDomainListResult
Link copied to clipboard

Gets properties of a DNS resolver policy. Uses Azure REST API version 2023-07-01-preview.

suspend fun getDnsResolverPolicy(dnsResolverPolicyName: String, resourceGroupName: String): GetDnsResolverPolicyResult
Link copied to clipboard

Gets properties of a DNS resolver policy virtual network link. Uses Azure REST API version 2023-07-01-preview.

suspend fun getDnsResolverPolicyVirtualNetworkLink(dnsResolverPolicyName: String, dnsResolverPolicyVirtualNetworkLinkName: String, resourceGroupName: String): GetDnsResolverPolicyVirtualNetworkLinkResult
Link copied to clipboard

Returns the DNS records specified by the referencing targetResourceIds. Uses Azure REST API version 2018-05-01. Other available API versions: 2023-07-01-preview.

Link copied to clipboard

Gets the DNSSEC configuration. Uses Azure REST API version 2023-07-01-preview.

suspend fun getDnssecConfig(resourceGroupName: String, zoneName: String): GetDnssecConfigResult
Link copied to clipboard

Gets properties of a DNS security rule for a DNS resolver policy. Uses Azure REST API version 2023-07-01-preview.

suspend fun getDnsSecurityRule(dnsResolverPolicyName: String, dnsSecurityRuleName: String, resourceGroupName: String): GetDnsSecurityRuleResult
Link copied to clipboard

Gets a DSCP Configuration. Uses Azure REST API version 2023-02-01. Other available API versions: 2023-04-01, 2023-05-01, 2023-06-01, 2023-09-01, 2023-11-01, 2024-01-01, 2024-03-01, 2024-05-01.

suspend fun getDscpConfiguration(dscpConfigurationName: String, resourceGroupName: String): GetDscpConfigurationResult
Link copied to clipboard

Gets a Traffic Manager endpoint. Uses Azure REST API version 2022-04-01. Other available API versions: 2022-04-01-preview.

suspend fun getEndpoint(argument: suspend GetEndpointPlainArgsBuilder.() -> Unit): GetEndpointResult
suspend fun getEndpoint(endpointName: String, endpointType: String, profileName: String, resourceGroupName: String): GetEndpointResult
Link copied to clipboard

Defines the properties of an Experiment Uses Azure REST API version 2019-11-01.

suspend fun getExperiment(experimentName: String, profileName: String, resourceGroupName: String): GetExperimentResult
Link copied to clipboard

Gets information about the specified express route circuit. Uses Azure REST API version 2023-02-01. Other available API versions: 2018-12-01, 2019-06-01, 2023-04-01, 2023-05-01, 2023-06-01, 2023-09-01, 2023-11-01, 2024-01-01, 2024-03-01, 2024-05-01.

suspend fun getExpressRouteCircuit(circuitName: String, resourceGroupName: String): GetExpressRouteCircuitResult
Link copied to clipboard

Gets the specified authorization from the specified express route circuit. Uses Azure REST API version 2023-02-01. Other available API versions: 2019-06-01, 2023-04-01, 2023-05-01, 2023-06-01, 2023-09-01, 2023-11-01, 2024-01-01, 2024-03-01, 2024-05-01.

suspend fun getExpressRouteCircuitAuthorization(authorizationName: String, circuitName: String, resourceGroupName: String): GetExpressRouteCircuitAuthorizationResult
Link copied to clipboard

Gets the specified Express Route Circuit Connection from the specified express route circuit. Uses Azure REST API version 2023-02-01. Other available API versions: 2023-04-01, 2023-05-01, 2023-06-01, 2023-09-01, 2023-11-01, 2024-01-01, 2024-03-01, 2024-05-01.

suspend fun getExpressRouteCircuitConnection(circuitName: String, connectionName: String, peeringName: String, resourceGroupName: String): GetExpressRouteCircuitConnectionResult
Link copied to clipboard

Gets the specified peering for the express route circuit. Uses Azure REST API version 2023-02-01. Other available API versions: 2019-02-01, 2019-06-01, 2019-08-01, 2023-04-01, 2023-05-01, 2023-06-01, 2023-09-01, 2023-11-01, 2024-01-01, 2024-03-01, 2024-05-01.

suspend fun getExpressRouteCircuitPeering(circuitName: String, peeringName: String, resourceGroupName: String): GetExpressRouteCircuitPeeringResult
Link copied to clipboard

Gets the specified ExpressRouteConnection. Uses Azure REST API version 2023-02-01. Other available API versions: 2023-04-01, 2023-05-01, 2023-06-01, 2023-09-01, 2023-11-01, 2024-01-01, 2024-03-01, 2024-05-01.

suspend fun getExpressRouteConnection(connectionName: String, expressRouteGatewayName: String, resourceGroupName: String): GetExpressRouteConnectionResult
Link copied to clipboard

Gets the specified peering for the ExpressRouteCrossConnection. Uses Azure REST API version 2023-02-01. Other available API versions: 2019-08-01, 2023-04-01, 2023-05-01, 2023-06-01, 2023-09-01, 2023-11-01, 2024-01-01, 2024-03-01, 2024-05-01.

suspend fun getExpressRouteCrossConnectionPeering(crossConnectionName: String, peeringName: String, resourceGroupName: String): GetExpressRouteCrossConnectionPeeringResult
Link copied to clipboard

Fetches the details of a ExpressRoute gateway in a resource group. Uses Azure REST API version 2023-02-01. Other available API versions: 2021-03-01, 2023-04-01, 2023-05-01, 2023-06-01, 2023-09-01, 2023-11-01, 2024-01-01, 2024-03-01, 2024-05-01.

suspend fun getExpressRouteGateway(expressRouteGatewayName: String, resourceGroupName: String): GetExpressRouteGatewayResult
Link copied to clipboard

Retrieves the requested ExpressRoutePort resource. Uses Azure REST API version 2023-02-01. Other available API versions: 2019-08-01, 2023-04-01, 2023-05-01, 2023-06-01, 2023-09-01, 2023-11-01, 2024-01-01, 2024-03-01, 2024-05-01.

suspend fun getExpressRoutePort(expressRoutePortName: String, resourceGroupName: String): GetExpressRoutePortResult
Link copied to clipboard

Gets the specified authorization from the specified express route port. Uses Azure REST API version 2023-02-01. Other available API versions: 2023-04-01, 2023-05-01, 2023-06-01, 2023-09-01, 2023-11-01, 2024-01-01, 2024-03-01, 2024-05-01.

suspend fun getExpressRoutePortAuthorization(authorizationName: String, expressRoutePortName: String, resourceGroupName: String): GetExpressRoutePortAuthorizationResult
Link copied to clipboard

Gets the specified Firewall Policy. Uses Azure REST API version 2023-02-01. Other available API versions: 2020-04-01, 2021-08-01, 2023-04-01, 2023-05-01, 2023-06-01, 2023-09-01, 2023-11-01, 2024-01-01, 2024-03-01, 2024-05-01.

suspend fun getFirewallPolicy(expand: String? = null, firewallPolicyName: String, resourceGroupName: String): GetFirewallPolicyResult
Link copied to clipboard

Get a draft Firewall Policy. Uses Azure REST API version 2023-11-01. Other available API versions: 2024-01-01, 2024-03-01, 2024-05-01.

suspend fun getFirewallPolicyDraft(firewallPolicyName: String, resourceGroupName: String): GetFirewallPolicyDraftResult
Link copied to clipboard

Gets the specified FirewallPolicyRuleCollectionGroup. Uses Azure REST API version 2023-02-01. Other available API versions: 2023-04-01, 2023-05-01, 2023-06-01, 2023-09-01, 2023-11-01, 2024-01-01, 2024-03-01, 2024-05-01.

suspend fun getFirewallPolicyRuleCollectionGroup(firewallPolicyName: String, resourceGroupName: String, ruleCollectionGroupName: String): GetFirewallPolicyRuleCollectionGroupResult

Get Rule Collection Group Draft. Uses Azure REST API version 2023-11-01. Other available API versions: 2024-01-01, 2024-03-01, 2024-05-01.

suspend fun getFirewallPolicyRuleCollectionGroupDraft(firewallPolicyName: String, resourceGroupName: String, ruleCollectionGroupName: String): GetFirewallPolicyRuleCollectionGroupDraftResult
Link copied to clipboard

Gets the specified FirewallPolicyRuleGroup. Uses Azure REST API version 2020-04-01.

suspend fun getFirewallPolicyRuleGroup(firewallPolicyName: String, resourceGroupName: String, ruleGroupName: String): GetFirewallPolicyRuleGroupResult
Link copied to clipboard

Gets a flow log resource by name. Uses Azure REST API version 2023-02-01. Other available API versions: 2023-04-01, 2023-05-01, 2023-06-01, 2023-09-01, 2023-11-01, 2024-01-01, 2024-03-01, 2024-05-01.

suspend fun getFlowLog(argument: suspend GetFlowLogPlainArgsBuilder.() -> Unit): GetFlowLogResult
suspend fun getFlowLog(flowLogName: String, networkWatcherName: String, resourceGroupName: String): GetFlowLogResult
Link copied to clipboard

Gets properties of a forwarding rule in a DNS forwarding ruleset. Uses Azure REST API version 2022-07-01. Other available API versions: 2023-07-01-preview.

suspend fun getForwardingRule(dnsForwardingRulesetName: String, forwardingRuleName: String, resourceGroupName: String): GetForwardingRuleResult
Link copied to clipboard

Gets a Front Door with the specified Front Door name under the specified subscription and resource group. Uses Azure REST API version 2021-06-01.

suspend fun getFrontDoor(frontDoorName: String, resourceGroupName: String): GetFrontDoorResult
Link copied to clipboard

Retrieves the details of a RouteTable. Uses Azure REST API version 2023-02-01. Other available API versions: 2023-04-01, 2023-05-01, 2023-06-01, 2023-09-01, 2023-11-01, 2024-01-01, 2024-03-01, 2024-05-01.

suspend fun getHubRouteTable(resourceGroupName: String, routeTableName: String, virtualHubName: String): GetHubRouteTableResult
Link copied to clipboard

Retrieves the details of a HubVirtualNetworkConnection. Uses Azure REST API version 2023-02-01. Other available API versions: 2023-04-01, 2023-05-01, 2023-06-01, 2023-09-01, 2023-11-01, 2024-01-01, 2024-03-01, 2024-05-01.

suspend fun getHubVirtualNetworkConnection(connectionName: String, resourceGroupName: String, virtualHubName: String): GetHubVirtualNetworkConnectionResult
Link copied to clipboard

Gets properties of an inbound endpoint for a DNS resolver. Uses Azure REST API version 2022-07-01. Other available API versions: 2020-04-01-preview, 2023-07-01-preview.

suspend fun getInboundEndpoint(dnsResolverName: String, inboundEndpointName: String, resourceGroupName: String): GetInboundEndpointResult
Link copied to clipboard

Gets the specified load balancer inbound NAT rule. Uses Azure REST API version 2023-02-01. Other available API versions: 2019-06-01, 2023-04-01, 2023-05-01, 2023-06-01, 2023-09-01, 2023-11-01, 2024-01-01, 2024-03-01, 2024-05-01.

suspend fun getInboundNatRule(expand: String? = null, inboundNatRuleName: String, loadBalancerName: String, resourceGroupName: String): GetInboundNatRuleResult
Link copied to clipboard

Gets the specified interface endpoint by resource group. Uses Azure REST API version 2019-02-01.

suspend fun getInterfaceEndpoint(expand: String? = null, interfaceEndpointName: String, resourceGroupName: String): GetInterfaceEndpointResult
Link copied to clipboard

Gets the specified IpAllocation by resource group. Uses Azure REST API version 2023-02-01. Other available API versions: 2023-04-01, 2023-05-01, 2023-06-01, 2023-09-01, 2023-11-01, 2024-01-01, 2024-03-01, 2024-05-01.

suspend fun getIpAllocation(expand: String? = null, ipAllocationName: String, resourceGroupName: String): GetIpAllocationResult
Link copied to clipboard

Instance of Pool resource. Uses Azure REST API version 2024-01-01-preview. Other available API versions: 2024-05-01.

suspend fun getIpamPool(argument: suspend GetIpamPoolPlainArgsBuilder.() -> Unit): GetIpamPoolResult
suspend fun getIpamPool(networkManagerName: String, poolName: String, resourceGroupName: String): GetIpamPoolResult
Link copied to clipboard

IpamPool usage information. Uses Azure REST API version 2024-01-01-preview. Other available API versions: 2024-05-01.

suspend fun getIpamPoolUsage(networkManagerName: String, poolName: String, resourceGroupName: String): GetIpamPoolUsageResult
Link copied to clipboard

Gets the specified ipGroups. Uses Azure REST API version 2023-02-01. Other available API versions: 2023-04-01, 2023-05-01, 2023-06-01, 2023-09-01, 2023-11-01, 2024-01-01, 2024-03-01, 2024-05-01.

suspend fun getIpGroup(argument: suspend GetIpGroupPlainArgsBuilder.() -> Unit): GetIpGroupResult
suspend fun getIpGroup(expand: String? = null, ipGroupsName: String, resourceGroupName: String): GetIpGroupResult
Link copied to clipboard

Gets the specified load balancer. Uses Azure REST API version 2023-02-01. Other available API versions: 2018-06-01, 2019-06-01, 2019-08-01, 2023-04-01, 2023-05-01, 2023-06-01, 2023-09-01, 2023-11-01, 2024-01-01, 2024-03-01, 2024-05-01.

suspend fun getLoadBalancer(expand: String? = null, loadBalancerName: String, resourceGroupName: String): GetLoadBalancerResult
Link copied to clipboard

Gets load balancer backend address pool. Uses Azure REST API version 2023-02-01. Other available API versions: 2023-04-01, 2023-05-01, 2023-06-01, 2023-09-01, 2023-11-01, 2024-01-01, 2024-03-01, 2024-05-01.

suspend fun getLoadBalancerBackendAddressPool(backendAddressPoolName: String, loadBalancerName: String, resourceGroupName: String): GetLoadBalancerBackendAddressPoolResult
Link copied to clipboard

Gets the specified local network gateway in a resource group. Uses Azure REST API version 2023-02-01. Other available API versions: 2019-08-01, 2023-04-01, 2023-05-01, 2023-06-01, 2023-09-01, 2023-11-01, 2024-01-01, 2024-03-01, 2024-05-01.

suspend fun getLocalNetworkGateway(localNetworkGatewayName: String, resourceGroupName: String): GetLocalNetworkGatewayResult

Get a specified connection created by this management group. Uses Azure REST API version 2023-02-01. Other available API versions: 2023-04-01, 2023-05-01, 2023-06-01, 2023-09-01, 2023-11-01, 2024-01-01, 2024-03-01, 2024-05-01.

Link copied to clipboard

Gets the specified nat gateway in a specified resource group. Uses Azure REST API version 2023-02-01. Other available API versions: 2019-06-01, 2019-08-01, 2023-04-01, 2023-05-01, 2023-06-01, 2023-09-01, 2023-11-01, 2024-01-01, 2024-03-01, 2024-05-01.

suspend fun getNatGateway(expand: String? = null, natGatewayName: String, resourceGroupName: String): GetNatGatewayResult
Link copied to clipboard

Retrieves the details of a nat ruleGet. Uses Azure REST API version 2023-02-01. Other available API versions: 2023-04-01, 2023-05-01, 2023-06-01, 2023-09-01, 2023-11-01, 2024-01-01, 2024-03-01, 2024-05-01.

suspend fun getNatRule(argument: suspend GetNatRulePlainArgsBuilder.() -> Unit): GetNatRuleResult
suspend fun getNatRule(gatewayName: String, natRuleName: String, resourceGroupName: String): GetNatRuleResult
Link copied to clipboard

Defines an Network Experiment Profile and lists of Experiments Uses Azure REST API version 2019-11-01.

suspend fun getNetworkExperimentProfile(profileName: String, resourceGroupName: String): GetNetworkExperimentProfileResult
Link copied to clipboard

Gets the specified network group. Uses Azure REST API version 2023-02-01. Other available API versions: 2021-02-01-preview, 2021-05-01-preview, 2022-04-01-preview, 2023-04-01, 2023-05-01, 2023-06-01, 2023-09-01, 2023-11-01, 2024-01-01, 2024-03-01, 2024-05-01.

suspend fun getNetworkGroup(networkGroupName: String, networkManagerName: String, resourceGroupName: String): GetNetworkGroupResult
Link copied to clipboard

Gets information about the specified network interface. Uses Azure REST API version 2023-02-01. Other available API versions: 2018-07-01, 2019-02-01, 2019-06-01, 2019-08-01, 2023-04-01, 2023-05-01, 2023-06-01, 2023-09-01, 2023-11-01, 2024-01-01, 2024-03-01, 2024-05-01.

suspend fun getNetworkInterface(expand: String? = null, networkInterfaceName: String, resourceGroupName: String): GetNetworkInterfaceResult
Link copied to clipboard

Get the specified tap configuration on a network interface. Uses Azure REST API version 2023-02-01. Other available API versions: 2023-04-01, 2023-05-01, 2023-06-01, 2023-09-01, 2023-11-01, 2024-01-01, 2024-03-01, 2024-05-01.

suspend fun getNetworkInterfaceTapConfiguration(networkInterfaceName: String, resourceGroupName: String, tapConfigurationName: String): GetNetworkInterfaceTapConfigurationResult
Link copied to clipboard

Gets the specified Network Manager. Uses Azure REST API version 2023-02-01. Other available API versions: 2021-02-01-preview, 2021-05-01-preview, 2023-04-01, 2023-05-01, 2023-06-01, 2023-09-01, 2023-11-01, 2024-01-01, 2024-01-01-preview, 2024-03-01, 2024-05-01.

suspend fun getNetworkManager(networkManagerName: String, resourceGroupName: String): GetNetworkManagerResult
Link copied to clipboard

Retrieves a network manager routing configuration. Uses Azure REST API version 2024-03-01. Other available API versions: 2024-05-01.

suspend fun getNetworkManagerRoutingConfiguration(configurationName: String, networkManagerName: String, resourceGroupName: String): GetNetworkManagerRoutingConfigurationResult
Link copied to clipboard

Gets the specified network profile in a specified resource group. Uses Azure REST API version 2023-02-01. Other available API versions: 2019-08-01, 2023-04-01, 2023-05-01, 2023-06-01, 2023-09-01, 2023-11-01, 2024-01-01, 2024-03-01, 2024-05-01.

suspend fun getNetworkProfile(expand: String? = null, networkProfileName: String, resourceGroupName: String): GetNetworkProfileResult
Link copied to clipboard

Gets the specified network security group. Uses Azure REST API version 2023-02-01. Other available API versions: 2019-06-01, 2019-08-01, 2023-04-01, 2023-05-01, 2023-06-01, 2023-09-01, 2023-11-01, 2024-01-01, 2024-03-01, 2024-05-01.

suspend fun getNetworkSecurityGroup(expand: String? = null, networkSecurityGroupName: String, resourceGroupName: String): GetNetworkSecurityGroupResult
Link copied to clipboard

Gets the specified network security perimeter by the name. Uses Azure REST API version 2021-03-01-preview. Other available API versions: 2021-02-01-preview, 2023-07-01-preview, 2023-08-01-preview, 2024-06-01-preview.

suspend fun getNetworkSecurityPerimeter(networkSecurityPerimeterName: String, resourceGroupName: String): GetNetworkSecurityPerimeterResult
Link copied to clipboard

Gets the specified NSP access rule by name. Uses Azure REST API version 2024-06-01-preview.

suspend fun getNetworkSecurityPerimeterAccessRule(accessRuleName: String, networkSecurityPerimeterName: String, profileName: String, resourceGroupName: String): GetNetworkSecurityPerimeterAccessRuleResult
Link copied to clipboard
Link copied to clipboard

Gets the specified NSP link resource. Uses Azure REST API version 2024-06-01-preview.

suspend fun getNetworkSecurityPerimeterLink(linkName: String, networkSecurityPerimeterName: String, resourceGroupName: String): GetNetworkSecurityPerimeterLinkResult
Link copied to clipboard

Gets the specified NSP profile. Uses Azure REST API version 2024-06-01-preview.

suspend fun getNetworkSecurityPerimeterProfile(networkSecurityPerimeterName: String, profileName: String, resourceGroupName: String): GetNetworkSecurityPerimeterProfileResult
Link copied to clipboard

Gets the specified Network Virtual Appliance. Uses Azure REST API version 2023-02-01. Other available API versions: 2020-04-01, 2023-04-01, 2023-05-01, 2023-06-01, 2023-09-01, 2023-11-01, 2024-01-01, 2024-03-01, 2024-05-01.

suspend fun getNetworkVirtualAppliance(expand: String? = null, networkVirtualApplianceName: String, resourceGroupName: String): GetNetworkVirtualApplianceResult
Link copied to clipboard

Retrieves the details of specified NVA connection. Uses Azure REST API version 2023-06-01. Other available API versions: 2023-09-01, 2023-11-01, 2024-01-01, 2024-03-01, 2024-05-01.

suspend fun getNetworkVirtualApplianceConnection(connectionName: String, networkVirtualApplianceName: String, resourceGroupName: String): GetNetworkVirtualApplianceConnectionResult
Link copied to clipboard

Gets the specified network watcher by resource group. Uses Azure REST API version 2023-02-01. Other available API versions: 2022-05-01, 2023-04-01, 2023-05-01, 2023-06-01, 2023-09-01, 2023-11-01, 2024-01-01, 2024-03-01, 2024-05-01.

suspend fun getNetworkWatcher(networkWatcherName: String, resourceGroupName: String): GetNetworkWatcherResult
Link copied to clipboard

Gets the specified NSP access rule by name. Uses Azure REST API version 2021-02-01-preview. Other available API versions: 2023-07-01-preview, 2023-08-01-preview.

suspend fun getNspAccessRule(accessRuleName: String, networkSecurityPerimeterName: String, profileName: String, resourceGroupName: String): GetNspAccessRuleResult
Link copied to clipboard

Gets the specified NSP association by name. Uses Azure REST API version 2021-02-01-preview. Other available API versions: 2023-07-01-preview, 2023-08-01-preview.

suspend fun getNspAssociation(associationName: String, networkSecurityPerimeterName: String, resourceGroupName: String): GetNspAssociationResult
Link copied to clipboard

Gets the specified NSP link resource. Uses Azure REST API version 2021-02-01-preview. Other available API versions: 2023-07-01-preview, 2023-08-01-preview.

suspend fun getNspLink(argument: suspend GetNspLinkPlainArgsBuilder.() -> Unit): GetNspLinkResult
suspend fun getNspLink(linkName: String, networkSecurityPerimeterName: String, resourceGroupName: String): GetNspLinkResult
Link copied to clipboard

Gets the specified NSP profile. Uses Azure REST API version 2021-02-01-preview. Other available API versions: 2023-07-01-preview, 2023-08-01-preview.

suspend fun getNspProfile(networkSecurityPerimeterName: String, profileName: String, resourceGroupName: String): GetNspProfileResult
Link copied to clipboard

Gets properties of an outbound endpoint for a DNS resolver. Uses Azure REST API version 2022-07-01. Other available API versions: 2020-04-01-preview, 2023-07-01-preview.

suspend fun getOutboundEndpoint(dnsResolverName: String, outboundEndpointName: String, resourceGroupName: String): GetOutboundEndpointResult
Link copied to clipboard

Retrieves the details of a virtual wan p2s vpn gateway. Uses Azure REST API version 2023-02-01. Other available API versions: 2019-07-01, 2023-04-01, 2023-05-01, 2023-06-01, 2023-09-01, 2023-11-01, 2024-01-01, 2024-03-01, 2024-05-01.

suspend fun getP2sVpnGateway(gatewayName: String, resourceGroupName: String): GetP2sVpnGatewayResult
Link copied to clipboard

Gets the connection health of P2S clients of the virtual wan P2SVpnGateway in the specified resource group. Uses Azure REST API version 2023-02-01. Other available API versions: 2019-07-01, 2023-04-01, 2023-05-01, 2023-06-01, 2023-09-01, 2023-11-01, 2024-01-01, 2024-03-01, 2024-05-01.

Gets the sas url to get the connection health detail of P2S clients of the virtual wan P2SVpnGateway in the specified resource group. Uses Azure REST API version 2023-02-01. Other available API versions: 2023-04-01, 2023-05-01, 2023-06-01, 2023-09-01, 2023-11-01, 2024-01-01, 2024-03-01, 2024-05-01.

suspend fun getP2sVpnGatewayP2sVpnConnectionHealthDetailed(gatewayName: String, outputBlobSasUrl: String? = null, resourceGroupName: String, vpnUserNamesFilter: List<String>? = null): GetP2sVpnGatewayP2sVpnConnectionHealthDetailedResult
Link copied to clipboard

Retrieves the details of a P2SVpnServerConfiguration. Uses Azure REST API version 2019-07-01.

suspend fun getP2sVpnServerConfiguration(p2SVpnServerConfigurationName: String, resourceGroupName: String, virtualWanName: String): GetP2sVpnServerConfigurationResult
Link copied to clipboard

Gets a packet capture session by name. Uses Azure REST API version 2023-02-01. Other available API versions: 2020-06-01, 2023-04-01, 2023-05-01, 2023-06-01, 2023-09-01, 2023-11-01, 2024-01-01, 2024-03-01, 2024-05-01.

suspend fun getPacketCapture(networkWatcherName: String, packetCaptureName: String, resourceGroupName: String): GetPacketCaptureResult
Link copied to clipboard

Retrieve protection policy with specified name within a resource group. Uses Azure REST API version 2022-05-01. Other available API versions: 2021-06-01, 2024-02-01.

suspend fun getPolicy(argument: suspend GetPolicyPlainArgsBuilder.() -> Unit): GetPolicyResult
suspend fun getPolicy(policyName: String, resourceGroupName: String): GetPolicyResult
Link copied to clipboard

Gets the private dns zone group resource by specified private dns zone group name. Uses Azure REST API version 2023-02-01. Other available API versions: 2021-02-01, 2023-04-01, 2023-05-01, 2023-06-01, 2023-09-01, 2023-11-01, 2024-01-01, 2024-03-01, 2024-05-01.

suspend fun getPrivateDnsZoneGroup(privateDnsZoneGroupName: String, privateEndpointName: String, resourceGroupName: String): GetPrivateDnsZoneGroupResult
Link copied to clipboard

Gets the specified private endpoint by resource group. Uses Azure REST API version 2023-02-01. Other available API versions: 2021-02-01, 2023-04-01, 2023-05-01, 2023-06-01, 2023-09-01, 2023-11-01, 2024-01-01, 2024-03-01, 2024-05-01.

suspend fun getPrivateEndpoint(expand: String? = null, privateEndpointName: String, resourceGroupName: String): GetPrivateEndpointResult
Link copied to clipboard

Gets the specified private link service by resource group. Uses Azure REST API version 2023-02-01. Other available API versions: 2019-08-01, 2021-02-01, 2023-04-01, 2023-05-01, 2023-06-01, 2023-09-01, 2023-11-01, 2024-01-01, 2024-03-01, 2024-05-01.

suspend fun getPrivateLinkService(expand: String? = null, resourceGroupName: String, serviceName: String): GetPrivateLinkServiceResult

Get the specific private end point connection by specific private link service in the resource group. Uses Azure REST API version 2023-02-01. Other available API versions: 2023-04-01, 2023-05-01, 2023-06-01, 2023-09-01, 2023-11-01, 2024-01-01, 2024-03-01, 2024-05-01.

suspend fun getPrivateLinkServicePrivateEndpointConnection(expand: String? = null, peConnectionName: String, resourceGroupName: String, serviceName: String): GetPrivateLinkServicePrivateEndpointConnectionResult
Link copied to clipboard

Gets a record set. Uses Azure REST API version 2020-06-01. Other available API versions: 2024-06-01.

suspend fun getPrivateRecordSet(privateZoneName: String, recordType: String, relativeRecordSetName: String, resourceGroupName: String): GetPrivateRecordSetResult
Link copied to clipboard

Gets properties of a virtual network link to a DNS forwarding ruleset. Uses Azure REST API version 2022-07-01. Other available API versions: 2020-04-01-preview, 2023-07-01-preview.

suspend fun getPrivateResolverVirtualNetworkLink(dnsForwardingRulesetName: String, resourceGroupName: String, virtualNetworkLinkName: String): GetPrivateResolverVirtualNetworkLinkResult
Link copied to clipboard

Gets a Private DNS zone. Retrieves the zone properties, but not the virtual networks links or the record sets within the zone. Uses Azure REST API version 2020-06-01. Other available API versions: 2024-06-01.

suspend fun getPrivateZone(privateZoneName: String, resourceGroupName: String): GetPrivateZoneResult
Link copied to clipboard

Gets a Traffic Manager profile. Uses Azure REST API version 2022-04-01. Other available API versions: 2022-04-01-preview.

suspend fun getProfile(argument: suspend GetProfilePlainArgsBuilder.() -> Unit): GetProfileResult
suspend fun getProfile(profileName: String, resourceGroupName: String): GetProfileResult
Link copied to clipboard

Gets the specified public IP address in a specified resource group. Uses Azure REST API version 2023-02-01. Other available API versions: 2019-06-01, 2019-08-01, 2023-04-01, 2023-05-01, 2023-06-01, 2023-09-01, 2023-11-01, 2024-01-01, 2024-03-01, 2024-05-01.

suspend fun getPublicIPAddress(expand: String? = null, publicIpAddressName: String, resourceGroupName: String): GetPublicIPAddressResult
Link copied to clipboard

Gets the specified public IP prefix in a specified resource group. Uses Azure REST API version 2023-02-01. Other available API versions: 2019-06-01, 2019-08-01, 2023-04-01, 2023-05-01, 2023-06-01, 2023-09-01, 2023-11-01, 2024-01-01, 2024-03-01, 2024-05-01.

suspend fun getPublicIPPrefix(expand: String? = null, publicIpPrefixName: String, resourceGroupName: String): GetPublicIPPrefixResult
Link copied to clipboard

Configuration information or intent on which to do the analysis on. Uses Azure REST API version 2024-01-01-preview. Other available API versions: 2024-05-01.

suspend fun getReachabilityAnalysisIntent(networkManagerName: String, reachabilityAnalysisIntentName: String, resourceGroupName: String, workspaceName: String): GetReachabilityAnalysisIntentResult
Link copied to clipboard

Configuration information for analysis run. Uses Azure REST API version 2024-01-01-preview. Other available API versions: 2024-05-01.

suspend fun getReachabilityAnalysisRun(networkManagerName: String, reachabilityAnalysisRunName: String, resourceGroupName: String, workspaceName: String): GetReachabilityAnalysisRunResult
Link copied to clipboard

Gets a record set. Uses Azure REST API version 2018-05-01. Other available API versions: 2023-07-01-preview.

suspend fun getRecordSet(recordType: String, relativeRecordSetName: String, resourceGroupName: String, zoneName: String): GetRecordSetResult
Link copied to clipboard
suspend fun getRoute(argument: GetRoutePlainArgs): GetRouteResult

Gets the specified route from a route table. Uses Azure REST API version 2023-02-01. Other available API versions: 2019-06-01, 2023-04-01, 2023-05-01, 2023-06-01, 2023-09-01, 2023-11-01, 2024-01-01, 2024-03-01, 2024-05-01.

suspend fun getRoute(argument: suspend GetRoutePlainArgsBuilder.() -> Unit): GetRouteResult
suspend fun getRoute(resourceGroupName: String, routeName: String, routeTableName: String): GetRouteResult
Link copied to clipboard

Gets the specified route filter. Uses Azure REST API version 2023-02-01. Other available API versions: 2019-08-01, 2023-04-01, 2023-05-01, 2023-06-01, 2023-09-01, 2023-11-01, 2024-01-01, 2024-03-01, 2024-05-01.

suspend fun getRouteFilter(expand: String? = null, resourceGroupName: String, routeFilterName: String): GetRouteFilterResult
Link copied to clipboard

Gets the specified rule from a route filter. Uses Azure REST API version 2023-02-01. Other available API versions: 2023-04-01, 2023-05-01, 2023-06-01, 2023-09-01, 2023-11-01, 2024-01-01, 2024-03-01, 2024-05-01.

suspend fun getRouteFilterRule(resourceGroupName: String, routeFilterName: String, ruleName: String): GetRouteFilterRuleResult
Link copied to clipboard

Retrieves the details of a RouteMap. Uses Azure REST API version 2023-02-01. Other available API versions: 2023-04-01, 2023-05-01, 2023-06-01, 2023-09-01, 2023-11-01, 2024-01-01, 2024-03-01, 2024-05-01.

suspend fun getRouteMap(argument: suspend GetRouteMapPlainArgsBuilder.() -> Unit): GetRouteMapResult
suspend fun getRouteMap(resourceGroupName: String, routeMapName: String, virtualHubName: String): GetRouteMapResult
Link copied to clipboard

Gets the specified route table. Uses Azure REST API version 2023-02-01. Other available API versions: 2019-06-01, 2023-04-01, 2023-05-01, 2023-06-01, 2023-09-01, 2023-11-01, 2024-01-01, 2024-03-01, 2024-05-01.

suspend fun getRouteTable(expand: String? = null, resourceGroupName: String, routeTableName: String): GetRouteTableResult
Link copied to clipboard

Retrieves the details of a RoutingIntent. Uses Azure REST API version 2023-02-01. Other available API versions: 2023-04-01, 2023-05-01, 2023-06-01, 2023-09-01, 2023-11-01, 2024-01-01, 2024-03-01, 2024-05-01.

suspend fun getRoutingIntent(resourceGroupName: String, routingIntentName: String, virtualHubName: String): GetRoutingIntentResult
Link copied to clipboard

Gets a network manager routing configuration routing rule. Uses Azure REST API version 2024-03-01. Other available API versions: 2024-05-01.

suspend fun getRoutingRule(configurationName: String, networkManagerName: String, resourceGroupName: String, ruleCollectionName: String, ruleName: String): GetRoutingRuleResult
Link copied to clipboard

Gets a network manager routing configuration rule collection. Uses Azure REST API version 2024-03-01. Other available API versions: 2024-05-01.

suspend fun getRoutingRuleCollection(configurationName: String, networkManagerName: String, resourceGroupName: String, ruleCollectionName: String): GetRoutingRuleCollectionResult
Link copied to clipboard

Gets a Rules Engine Configuration with the specified name within the specified Front Door. Uses Azure REST API version 2021-06-01.

suspend fun getRulesEngine(frontDoorName: String, resourceGroupName: String, rulesEngineName: String): GetRulesEngineResult
Link copied to clipboard

Get specified scope connection created by this Network Manager. Uses Azure REST API version 2023-02-01. Other available API versions: 2023-04-01, 2023-05-01, 2023-06-01, 2023-09-01, 2023-11-01, 2024-01-01, 2024-03-01, 2024-05-01.

suspend fun getScopeConnection(networkManagerName: String, resourceGroupName: String, scopeConnectionName: String): GetScopeConnectionResult
Link copied to clipboard

Retrieves a network manager security admin configuration. Uses Azure REST API version 2023-02-01. Other available API versions: 2021-05-01-preview, 2023-04-01, 2023-05-01, 2023-06-01, 2023-09-01, 2023-11-01, 2024-01-01, 2024-01-01-preview, 2024-03-01, 2024-05-01.

suspend fun getSecurityAdminConfiguration(configurationName: String, networkManagerName: String, resourceGroupName: String): GetSecurityAdminConfigurationResult
Link copied to clipboard

Gets the specified Security Partner Provider. Uses Azure REST API version 2023-02-01. Other available API versions: 2023-04-01, 2023-05-01, 2023-06-01, 2023-09-01, 2023-11-01, 2024-01-01, 2024-03-01, 2024-05-01.

suspend fun getSecurityPartnerProvider(resourceGroupName: String, securityPartnerProviderName: String): GetSecurityPartnerProviderResult
Link copied to clipboard

Get the specified network security rule. Uses Azure REST API version 2023-02-01. Other available API versions: 2019-06-01, 2022-07-01, 2023-04-01, 2023-05-01, 2023-06-01, 2023-09-01, 2023-11-01, 2024-01-01, 2024-03-01, 2024-05-01.

suspend fun getSecurityRule(networkSecurityGroupName: String, resourceGroupName: String, securityRuleName: String): GetSecurityRuleResult
Link copied to clipboard

Retrieves a network manager security user configuration. Uses Azure REST API version 2022-04-01-preview. Other available API versions: 2021-05-01-preview, 2024-03-01, 2024-05-01.

suspend fun getSecurityUserConfiguration(configurationName: String, networkManagerName: String, resourceGroupName: String): GetSecurityUserConfigurationResult
Link copied to clipboard

Gets a security user rule. Uses Azure REST API version 2024-03-01. Other available API versions: 2024-05-01.

suspend fun getSecurityUserRule(configurationName: String, networkManagerName: String, resourceGroupName: String, ruleCollectionName: String, ruleName: String): GetSecurityUserRuleResult
Link copied to clipboard

Gets a network manager security user configuration rule collection. Uses Azure REST API version 2024-03-01. Other available API versions: 2024-05-01.

suspend fun getSecurityUserRuleCollection(configurationName: String, networkManagerName: String, resourceGroupName: String, ruleCollectionName: String): GetSecurityUserRuleCollectionResult
Link copied to clipboard

Gets the specified service Endpoint Policies in a specified resource group. Uses Azure REST API version 2023-02-01. Other available API versions: 2018-07-01, 2023-04-01, 2023-05-01, 2023-06-01, 2023-09-01, 2023-11-01, 2024-01-01, 2024-03-01, 2024-05-01.

suspend fun getServiceEndpointPolicy(expand: String? = null, resourceGroupName: String, serviceEndpointPolicyName: String): GetServiceEndpointPolicyResult
Link copied to clipboard

Get the specified service endpoint policy definitions from service endpoint policy. Uses Azure REST API version 2023-02-01. Other available API versions: 2018-07-01, 2023-04-01, 2023-05-01, 2023-06-01, 2023-09-01, 2023-11-01, 2024-01-01, 2024-03-01, 2024-05-01.

suspend fun getServiceEndpointPolicyDefinition(resourceGroupName: String, serviceEndpointPolicyDefinitionName: String, serviceEndpointPolicyName: String): GetServiceEndpointPolicyDefinitionResult
Link copied to clipboard

Instance of StaticCidr resource. Uses Azure REST API version 2024-01-01-preview. Other available API versions: 2024-05-01.

suspend fun getStaticCidr(networkManagerName: String, poolName: String, resourceGroupName: String, staticCidrName: String): GetStaticCidrResult
Link copied to clipboard

Gets the specified static member. Uses Azure REST API version 2023-02-01. Other available API versions: 2023-04-01, 2023-05-01, 2023-06-01, 2023-09-01, 2023-11-01, 2024-01-01, 2024-03-01, 2024-05-01.

suspend fun getStaticMember(networkGroupName: String, networkManagerName: String, resourceGroupName: String, staticMemberName: String): GetStaticMemberResult
Link copied to clipboard

Gets the specified subnet by virtual network and resource group. Uses Azure REST API version 2023-02-01. Other available API versions: 2019-02-01, 2019-06-01, 2019-08-01, 2020-06-01, 2022-07-01, 2023-04-01, 2023-05-01, 2023-06-01, 2023-09-01, 2023-11-01, 2024-01-01, 2024-03-01, 2024-05-01.

suspend fun getSubnet(argument: suspend GetSubnetPlainArgsBuilder.() -> Unit): GetSubnetResult
suspend fun getSubnet(expand: String? = null, resourceGroupName: String, subnetName: String, virtualNetworkName: String): GetSubnetResult
Link copied to clipboard

Get a specified connection created by this subscription. Uses Azure REST API version 2023-02-01. Other available API versions: 2023-04-01, 2023-05-01, 2023-06-01, 2023-09-01, 2023-11-01, 2024-01-01, 2024-03-01, 2024-05-01.

Link copied to clipboard

Get the subscription-level key used for Real User Metrics collection. Uses Azure REST API version 2022-04-01. Other available API versions: 2022-04-01-preview.

Link copied to clipboard

Gets a user rule. Uses Azure REST API version 2022-04-01-preview. Other available API versions: 2021-05-01-preview.

suspend fun getUserRule(argument: suspend GetUserRulePlainArgsBuilder.() -> Unit): GetUserRuleResult
suspend fun getUserRule(configurationName: String, networkManagerName: String, resourceGroupName: String, ruleCollectionName: String, ruleName: String): GetUserRuleResult
Link copied to clipboard

Gets a network manager security user configuration rule collection. Uses Azure REST API version 2022-04-01-preview. Other available API versions: 2021-02-01-preview, 2021-05-01-preview.

suspend fun getUserRuleCollection(configurationName: String, networkManagerName: String, resourceGroupName: String, ruleCollectionName: String): GetUserRuleCollectionResult
Link copied to clipboard

Instance of Verifier Workspace. Uses Azure REST API version 2024-01-01-preview. Other available API versions: 2024-05-01.

suspend fun getVerifierWorkspace(networkManagerName: String, resourceGroupName: String, workspaceName: String): GetVerifierWorkspaceResult
Link copied to clipboard

Gets the specified Virtual Appliance Site. Uses Azure REST API version 2023-02-01. Other available API versions: 2023-04-01, 2023-05-01, 2023-06-01, 2023-09-01, 2023-11-01, 2024-01-01, 2024-03-01, 2024-05-01.

suspend fun getVirtualApplianceSite(networkVirtualApplianceName: String, resourceGroupName: String, siteName: String): GetVirtualApplianceSiteResult
Link copied to clipboard

Retrieves the details of a VirtualHub. Uses Azure REST API version 2023-02-01. Other available API versions: 2018-07-01, 2020-04-01, 2020-06-01, 2023-04-01, 2023-05-01, 2023-06-01, 2023-09-01, 2023-11-01, 2024-01-01, 2024-03-01, 2024-05-01.

suspend fun getVirtualHub(resourceGroupName: String, virtualHubName: String): GetVirtualHubResult
Link copied to clipboard

Retrieves the details of a Virtual Hub Bgp Connection. Uses Azure REST API version 2023-02-01. Other available API versions: 2023-04-01, 2023-05-01, 2023-06-01, 2023-09-01, 2023-11-01, 2024-01-01, 2024-03-01, 2024-05-01.

suspend fun getVirtualHubBgpConnection(connectionName: String, resourceGroupName: String, virtualHubName: String): GetVirtualHubBgpConnectionResult
Link copied to clipboard

Retrieves the details of a Virtual Hub Ip configuration. Uses Azure REST API version 2023-02-01. Other available API versions: 2023-04-01, 2023-05-01, 2023-06-01, 2023-09-01, 2023-11-01, 2024-01-01, 2024-03-01, 2024-05-01.

suspend fun getVirtualHubIpConfiguration(ipConfigName: String, resourceGroupName: String, virtualHubName: String): GetVirtualHubIpConfigurationResult
Link copied to clipboard

Retrieves the details of a VirtualHubRouteTableV2. Uses Azure REST API version 2023-02-01. Other available API versions: 2023-04-01, 2023-05-01, 2023-06-01, 2023-09-01, 2023-11-01, 2024-01-01, 2024-03-01, 2024-05-01.

suspend fun getVirtualHubRouteTableV2(resourceGroupName: String, routeTableName: String, virtualHubName: String): GetVirtualHubRouteTableV2Result
Link copied to clipboard

Gets the specified virtual network by resource group. Uses Azure REST API version 2023-02-01. Other available API versions: 2019-06-01, 2019-08-01, 2023-04-01, 2023-05-01, 2023-06-01, 2023-09-01, 2023-11-01, 2024-01-01, 2024-03-01, 2024-05-01.

suspend fun getVirtualNetwork(expand: String? = null, resourceGroupName: String, virtualNetworkName: String): GetVirtualNetworkResult
Link copied to clipboard

Gets the specified virtual network gateway by resource group. Uses Azure REST API version 2023-02-01. Other available API versions: 2019-08-01, 2023-04-01, 2023-05-01, 2023-06-01, 2023-09-01, 2023-11-01, 2024-01-01, 2024-03-01, 2024-05-01.

suspend fun getVirtualNetworkGateway(resourceGroupName: String, virtualNetworkGatewayName: String): GetVirtualNetworkGatewayResult
Link copied to clipboard

This operation retrieves a list of routes the virtual network gateway is advertising to the specified peer. Uses Azure REST API version 2023-02-01. Other available API versions: 2019-08-01, 2023-04-01, 2023-05-01, 2023-06-01, 2023-09-01, 2023-11-01, 2024-01-01, 2024-03-01, 2024-05-01.

suspend fun getVirtualNetworkGatewayAdvertisedRoutes(peer: String, resourceGroupName: String, virtualNetworkGatewayName: String): GetVirtualNetworkGatewayAdvertisedRoutesResult
Link copied to clipboard

The GetBgpPeerStatus operation retrieves the status of all BGP peers. Uses Azure REST API version 2023-02-01. Other available API versions: 2019-08-01, 2023-04-01, 2023-05-01, 2023-06-01, 2023-09-01, 2023-11-01, 2024-01-01, 2024-03-01, 2024-05-01.

suspend fun getVirtualNetworkGatewayBgpPeerStatus(peer: String? = null, resourceGroupName: String, virtualNetworkGatewayName: String): GetVirtualNetworkGatewayBgpPeerStatusResult
Link copied to clipboard

Gets the specified virtual network gateway connection by resource group. Uses Azure REST API version 2023-02-01. Other available API versions: 2019-08-01, 2023-04-01, 2023-05-01, 2023-06-01, 2023-09-01, 2023-11-01, 2024-01-01, 2024-03-01, 2024-05-01.

suspend fun getVirtualNetworkGatewayConnection(resourceGroupName: String, virtualNetworkGatewayConnectionName: String): GetVirtualNetworkGatewayConnectionResult
Link copied to clipboard

Lists IKE Security Associations for the virtual network gateway connection in the specified resource group. Uses Azure REST API version 2023-02-01. Other available API versions: 2023-04-01, 2023-05-01, 2023-06-01, 2023-09-01, 2023-11-01, 2024-01-01, 2024-03-01, 2024-05-01.

suspend fun getVirtualNetworkGatewayConnectionIkeSas(resourceGroupName: String, virtualNetworkGatewayConnectionName: String): GetVirtualNetworkGatewayConnectionIkeSasResult
Link copied to clipboard

This operation retrieves a list of routes the virtual network gateway has learned, including routes learned from BGP peers. Uses Azure REST API version 2023-02-01. Other available API versions: 2019-08-01, 2023-04-01, 2023-05-01, 2023-06-01, 2023-09-01, 2023-11-01, 2024-01-01, 2024-03-01, 2024-05-01.

suspend fun getVirtualNetworkGatewayLearnedRoutes(resourceGroupName: String, virtualNetworkGatewayName: String): GetVirtualNetworkGatewayLearnedRoutesResult
Link copied to clipboard

Retrieves the details of a nat rule. Uses Azure REST API version 2023-02-01. Other available API versions: 2023-04-01, 2023-05-01, 2023-06-01, 2023-09-01, 2023-11-01, 2024-01-01, 2024-03-01, 2024-05-01.

suspend fun getVirtualNetworkGatewayNatRule(natRuleName: String, resourceGroupName: String, virtualNetworkGatewayName: String): GetVirtualNetworkGatewayNatRuleResult

Get VPN client connection health detail per P2S client connection of the virtual network gateway in the specified resource group. Uses Azure REST API version 2023-02-01. Other available API versions: 2019-08-01, 2023-04-01, 2023-05-01, 2023-06-01, 2023-09-01, 2023-11-01, 2024-01-01, 2024-03-01, 2024-05-01.

The Get VpnclientIpsecParameters operation retrieves information about the vpnclient ipsec policy for P2S client of virtual network gateway in the specified resource group through Network resource provider. Uses Azure REST API version 2023-02-01. Other available API versions: 2019-08-01, 2023-04-01, 2023-05-01, 2023-06-01, 2023-09-01, 2023-11-01, 2024-01-01, 2024-03-01, 2024-05-01.

Gets pre-generated VPN profile for P2S client of the virtual network gateway in the specified resource group. The profile needs to be generated first using generateVpnProfile. Uses Azure REST API version 2023-02-01. Other available API versions: 2019-08-01, 2023-04-01, 2023-05-01, 2023-06-01, 2023-09-01, 2023-11-01, 2024-01-01, 2024-03-01, 2024-05-01.

Link copied to clipboard

Gets a virtual network link to the specified Private DNS zone. Uses Azure REST API version 2020-06-01. Other available API versions: 2024-06-01.

suspend fun getVirtualNetworkLink(privateZoneName: String, resourceGroupName: String, virtualNetworkLinkName: String): GetVirtualNetworkLinkResult
Link copied to clipboard

Gets the specified virtual network peering. Uses Azure REST API version 2023-02-01. Other available API versions: 2019-06-01, 2023-04-01, 2023-05-01, 2023-06-01, 2023-09-01, 2023-11-01, 2024-01-01, 2024-03-01, 2024-05-01.

suspend fun getVirtualNetworkPeering(resourceGroupName: String, virtualNetworkName: String, virtualNetworkPeeringName: String): GetVirtualNetworkPeeringResult
Link copied to clipboard

Gets information about the specified virtual network tap. Uses Azure REST API version 2023-02-01. Other available API versions: 2023-04-01, 2023-05-01, 2023-06-01, 2023-09-01, 2023-11-01, 2024-01-01, 2024-03-01, 2024-05-01.

suspend fun getVirtualNetworkTap(resourceGroupName: String, tapName: String): GetVirtualNetworkTapResult
Link copied to clipboard

Gets the specified Virtual Router. Uses Azure REST API version 2023-02-01. Other available API versions: 2023-04-01, 2023-05-01, 2023-06-01, 2023-09-01, 2023-11-01, 2024-01-01, 2024-03-01, 2024-05-01.

suspend fun getVirtualRouter(expand: String? = null, resourceGroupName: String, virtualRouterName: String): GetVirtualRouterResult
Link copied to clipboard

Gets the specified Virtual Router Peering. Uses Azure REST API version 2023-02-01. Other available API versions: 2023-04-01, 2023-05-01, 2023-06-01, 2023-09-01, 2023-11-01, 2024-01-01, 2024-03-01, 2024-05-01.

suspend fun getVirtualRouterPeering(peeringName: String, resourceGroupName: String, virtualRouterName: String): GetVirtualRouterPeeringResult
Link copied to clipboard

Retrieves the details of a VirtualWAN. Uses Azure REST API version 2023-02-01. Other available API versions: 2019-07-01, 2023-04-01, 2023-05-01, 2023-06-01, 2023-09-01, 2023-11-01, 2024-01-01, 2024-03-01, 2024-05-01.

suspend fun getVirtualWan(resourceGroupName: String, virtualWANName: String): GetVirtualWanResult
Link copied to clipboard

Retrieves the details of a vpn connection. Uses Azure REST API version 2023-02-01. Other available API versions: 2018-07-01, 2023-04-01, 2023-05-01, 2023-06-01, 2023-09-01, 2023-11-01, 2024-01-01, 2024-03-01, 2024-05-01.

suspend fun getVpnConnection(connectionName: String, gatewayName: String, resourceGroupName: String): GetVpnConnectionResult
Link copied to clipboard

Retrieves the details of a virtual wan vpn gateway. Uses Azure REST API version 2023-02-01. Other available API versions: 2018-07-01, 2023-04-01, 2023-05-01, 2023-06-01, 2023-09-01, 2023-11-01, 2024-01-01, 2024-03-01, 2024-05-01.

suspend fun getVpnGateway(gatewayName: String, resourceGroupName: String): GetVpnGatewayResult
Link copied to clipboard

Lists IKE Security Associations for Vpn Site Link Connection in the specified resource group. Uses Azure REST API version 2023-02-01. Other available API versions: 2023-04-01, 2023-05-01, 2023-06-01, 2023-09-01, 2023-11-01, 2024-01-01, 2024-03-01, 2024-05-01.

suspend fun getVpnLinkConnectionIkeSas(connectionName: String, gatewayName: String, linkConnectionName: String, resourceGroupName: String): GetVpnLinkConnectionIkeSasResult
Link copied to clipboard

Retrieves the details of a VpnServerConfiguration. Uses Azure REST API version 2023-02-01. Other available API versions: 2023-04-01, 2023-05-01, 2023-06-01, 2023-09-01, 2023-11-01, 2024-01-01, 2024-03-01, 2024-05-01.

suspend fun getVpnServerConfiguration(resourceGroupName: String, vpnServerConfigurationName: String): GetVpnServerConfigurationResult
Link copied to clipboard

Retrieves the details of a VPN site. Uses Azure REST API version 2023-02-01. Other available API versions: 2018-07-01, 2023-04-01, 2023-05-01, 2023-06-01, 2023-09-01, 2023-11-01, 2024-01-01, 2024-03-01, 2024-05-01.

suspend fun getVpnSite(argument: suspend GetVpnSitePlainArgsBuilder.() -> Unit): GetVpnSiteResult
suspend fun getVpnSite(resourceGroupName: String, vpnSiteName: String): GetVpnSiteResult
Link copied to clipboard

Retrieve protection policy with specified name within a resource group. Uses Azure REST API version 2023-02-01. Other available API versions: 2019-07-01, 2023-04-01, 2023-05-01, 2023-06-01, 2023-09-01, 2023-11-01, 2024-01-01, 2024-03-01, 2024-05-01.

Link copied to clipboard
suspend fun getZone(argument: GetZonePlainArgs): GetZoneResult

Gets a DNS zone. Retrieves the zone properties, but not the record sets within the zone. Uses Azure REST API version 2018-05-01. Other available API versions: 2023-07-01-preview.

suspend fun getZone(argument: suspend GetZonePlainArgsBuilder.() -> Unit): GetZoneResult
suspend fun getZone(resourceGroupName: String, zoneName: String): GetZoneResult
Link copied to clipboard

Lists active connectivity configurations in a network manager. Uses Azure REST API version 2021-02-01-preview.

suspend fun listActiveConnectivityConfiguration(networkManagerName: String, regions: List<String>? = null, resourceGroupName: String, skipToken: String? = null): ListActiveConnectivityConfigurationResult
Link copied to clipboard

Lists active connectivity configurations in a network manager. Uses Azure REST API version 2023-02-01. Other available API versions: 2021-05-01-preview, 2023-04-01, 2023-05-01, 2023-06-01, 2023-09-01, 2023-11-01, 2024-01-01, 2024-03-01, 2024-05-01.

suspend fun listActiveConnectivityConfigurations(networkManagerName: String, regions: List<String>? = null, resourceGroupName: String, skipToken: String? = null, top: Int? = null): ListActiveConnectivityConfigurationsResult
Link copied to clipboard

Lists active security admin rules in a network manager. Uses Azure REST API version 2021-02-01-preview.

suspend fun listActiveSecurityAdminRule(networkManagerName: String, regions: List<String>? = null, resourceGroupName: String, skipToken: String? = null): ListActiveSecurityAdminRuleResult
Link copied to clipboard

Lists active security admin rules in a network manager. Uses Azure REST API version 2023-02-01. Other available API versions: 2021-05-01-preview, 2023-04-01, 2023-05-01, 2023-06-01, 2023-09-01, 2023-11-01, 2024-01-01, 2024-03-01, 2024-05-01.

suspend fun listActiveSecurityAdminRules(networkManagerName: String, regions: List<String>? = null, resourceGroupName: String, skipToken: String? = null, top: Int? = null): ListActiveSecurityAdminRulesResult
Link copied to clipboard

Lists Active Security User Rules in a network manager. Uses Azure REST API version 2021-02-01-preview.

suspend fun listActiveSecurityUserRule(networkManagerName: String, regions: List<String>? = null, resourceGroupName: String, skipToken: String? = null): ListActiveSecurityUserRuleResult
Link copied to clipboard

Lists Active Security User Rules in a network manager. Uses Azure REST API version 2022-04-01-preview. Other available API versions: 2021-05-01-preview.

suspend fun listActiveSecurityUserRules(networkManagerName: String, regions: List<String>? = null, resourceGroupName: String, skipToken: String? = null): ListActiveSecurityUserRulesResult
Link copied to clipboard

Lists DNS forwarding ruleset resource IDs attached to a virtual network. Uses Azure REST API version 2022-07-01. Other available API versions: 2020-04-01-preview, 2023-07-01-preview.

suspend fun listDnsForwardingRulesetByVirtualNetwork(resourceGroupName: String, top: Int? = null, virtualNetworkName: String): ListDnsForwardingRulesetByVirtualNetworkResult
Link copied to clipboard

Lists DNS resolver resource IDs linked to a virtual network. Uses Azure REST API version 2022-07-01. Other available API versions: 2020-04-01-preview, 2023-07-01-preview.

suspend fun listDnsResolverByVirtualNetwork(resourceGroupName: String, top: Int? = null, virtualNetworkName: String): ListDnsResolverByVirtualNetworkResult
Link copied to clipboard

Lists DNS resolver policy resource IDs linked to a virtual network. Uses Azure REST API version 2023-07-01-preview.

Link copied to clipboard

List all effective connectivity configurations applied on a virtual network. Uses Azure REST API version 2021-02-01-preview.

suspend fun listEffectiveConnectivityConfiguration(resourceGroupName: String, skipToken: String? = null, virtualNetworkName: String): ListEffectiveConnectivityConfigurationResult

Lists all effective virtual networks by specified network group. Uses Azure REST API version 2021-02-01-preview.

suspend fun listEffectiveVirtualNetworkByNetworkGroup(networkGroupName: String, networkManagerName: String, resourceGroupName: String, skipToken: String? = null): ListEffectiveVirtualNetworkByNetworkGroupResult

List effective virtual networks in a network manager. Uses Azure REST API version 2022-04-01-preview. Other available API versions: 2021-02-01-preview, 2021-05-01-preview.

suspend fun listEffectiveVirtualNetworkByNetworkManager(conditionalMembers: String? = null, networkManagerName: String, resourceGroupName: String, skipToken: String? = null, top: Int? = null): ListEffectiveVirtualNetworkByNetworkManagerResult
Link copied to clipboard

Retrieves the current status of IDPS signatures for the relevant policy Uses Azure REST API version 2023-02-01. Other available API versions: 2021-08-01, 2023-04-01, 2023-05-01, 2023-06-01, 2023-09-01, 2023-11-01, 2024-01-01, 2024-03-01, 2024-05-01.

suspend fun listFirewallPolicyIdpsSignature(filters: List<FilterItems>? = null, firewallPolicyName: String, orderBy: OrderBy? = null, resourceGroupName: String, resultsPerPage: Int? = null, search: String? = null, skip: Int? = null): ListFirewallPolicyIdpsSignatureResult

Retrieves the current filter values for the signatures overrides Uses Azure REST API version 2023-02-01. Other available API versions: 2021-08-01, 2023-04-01, 2023-05-01, 2023-06-01, 2023-09-01, 2023-11-01, 2024-01-01, 2024-03-01, 2024-05-01.

suspend fun listFirewallPolicyIdpsSignaturesFilterValue(filterName: String? = null, firewallPolicyName: String, resourceGroupName: String): ListFirewallPolicyIdpsSignaturesFilterValueResult
Link copied to clipboard

List of PoolAssociation Uses Azure REST API version 2024-01-01-preview. Other available API versions: 2024-05-01.

suspend fun listIpamPoolAssociatedResources(networkManagerName: String, poolName: String, resourceGroupName: String): ListIpamPoolAssociatedResourcesResult

Lists all effective virtual networks by specified network group. Uses Azure REST API version 2022-04-01-preview. Other available API versions: 2021-05-01-preview.

suspend fun listListEffectiveVirtualNetworkByNetworkGroup(networkGroupName: String, networkManagerName: String, resourceGroupName: String, skipToken: String? = null): ListListEffectiveVirtualNetworkByNetworkGroupResult
Link copied to clipboard

Post to List of Network Manager Deployment Status. Uses Azure REST API version 2023-02-01. Other available API versions: 2021-02-01-preview, 2021-05-01-preview, 2023-04-01, 2023-05-01, 2023-06-01, 2023-09-01, 2023-11-01, 2024-01-01, 2024-01-01-preview, 2024-03-01, 2024-05-01.

suspend fun listNetworkManagerDeploymentStatus(deploymentTypes: List<Either<String, ConfigurationType>>? = null, networkManagerName: String, regions: List<String>? = null, resourceGroupName: String, skipToken: String? = null, top: Int? = null): ListNetworkManagerDeploymentStatusResult

List all effective connectivity configurations applied on a virtual network. Uses Azure REST API version 2023-02-01. Other available API versions: 2021-05-01-preview, 2022-02-01-preview, 2022-04-01-preview, 2023-04-01, 2023-05-01, 2023-06-01, 2023-09-01, 2023-11-01, 2024-01-01, 2024-03-01, 2024-05-01.

suspend fun listNetworkManagerEffectiveConnectivityConfigurations(resourceGroupName: String, skipToken: String? = null, top: Int? = null, virtualNetworkName: String): ListNetworkManagerEffectiveConnectivityConfigurationsResult

List all effective security admin rules applied on a virtual network. Uses Azure REST API version 2023-02-01. Other available API versions: 2021-05-01-preview, 2022-02-01-preview, 2022-04-01-preview, 2023-04-01, 2023-05-01, 2023-06-01, 2023-09-01, 2023-11-01, 2024-01-01, 2024-03-01, 2024-05-01.

suspend fun listNetworkManagerEffectiveSecurityAdminRules(resourceGroupName: String, skipToken: String? = null, top: Int? = null, virtualNetworkName: String): ListNetworkManagerEffectiveSecurityAdminRulesResult
Link copied to clipboard

Gets the value of the shared key of VpnLink connection specified. Uses Azure REST API version 2024-03-01. Other available API versions: 2024-05-01.

suspend fun listVpnLinkConnectionDefaultSharedKey(connectionName: String, gatewayName: String, linkConnectionName: String, resourceGroupName: String): ListVpnLinkConnectionDefaultSharedKeyResult