Adaptive Network Hardenings - Get

Service:

Defender for Cloud

API Version:

2020-01-01

Gets a single Adaptive Network Hardening resource

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceNamespace}/{resourceType}/{resourceName}/providers/Microsoft.Security/adaptiveNetworkHardenings/{adaptiveNetworkHardeningResourceName}?api-version=2020-01-01

URI Parameters

Name	In	Required	Type	Description
adaptiveNetworkHardeningResourceName	path	True	string	The name of the Adaptive Network Hardening resource.
resourceGroupName	path	True	string	The name of the resource group within the user's subscription. The name is case insensitive. Regex pattern: ^[-\w\._\(\)]+$
resourceName	path	True	string	Name of the resource.
resourceNamespace	path	True	string	The Namespace of the resource.
resourceType	path	True	string	The type of the resource.
subscriptionId	path	True	string	Azure subscription ID Regex pattern: ^[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}$
api-version	query	True	string	API version for the operation

Responses

Name	Type	Description
200 OK	AdaptiveNetworkHardening	OK
Other Status Codes	CloudError	Error response describing why the operation failed.

Security

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

Get a single Adaptive Network Hardening resource

Sample Request

HTTP

GET https://management.azure.com/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/rg1/providers/Microsoft.Compute/virtualMachines/vm1/providers/Microsoft.Security/adaptiveNetworkHardenings/default?api-version=2020-01-01

Java

/** Samples for AdaptiveNetworkHardenings Get. */
public final class Main {
    /*
     * x-ms-original-file: specification/security/resource-manager/Microsoft.Security/stable/2020-01-01/examples/AdaptiveNetworkHardenings/GetAdaptiveNetworkHardening_example.json
     */
    /**
     * Sample code: Get a single Adaptive Network Hardening resource.
     *
     * @param manager Entry point to SecurityManager.
     */
    public static void getASingleAdaptiveNetworkHardeningResource(
        com.azure.resourcemanager.security.SecurityManager manager) {
        manager
            .adaptiveNetworkHardenings()
            .getWithResponse(
                "rg1", "Microsoft.Compute", "virtualMachines", "vm1", "default", com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Go

package armsecurity_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/security/armsecurity"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/b43974e07d3204c4b6f8396627f5430994a7f7c9/specification/security/resource-manager/Microsoft.Security/stable/2020-01-01/examples/AdaptiveNetworkHardenings/GetAdaptiveNetworkHardening_example.json
func ExampleAdaptiveNetworkHardeningsClient_Get() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsecurity.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewAdaptiveNetworkHardeningsClient().Get(ctx, "rg1", "Microsoft.Compute", "virtualMachines", "vm1", "default", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.AdaptiveNetworkHardening = armsecurity.AdaptiveNetworkHardening{
	// 	Name: to.Ptr("default"),
	// 	Type: to.Ptr("Microsoft.Security/adaptiveNetworkHardenings"),
	// 	ID: to.Ptr("/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourcegroups/rg1/providers/Microsoft.Compute/virtualMachines/vm1/providers/Microsoft.Security/adaptiveNetworkHardenings/default"),
	// 	Properties: &armsecurity.AdaptiveNetworkHardeningProperties{
	// 		EffectiveNetworkSecurityGroups: []*armsecurity.EffectiveNetworkSecurityGroups{
	// 			{
	// 				NetworkInterface: to.Ptr("/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourcegroups/rg1/providers/Microsoft.Network/networkInterfaces/nic1"),
	// 				NetworkSecurityGroups: []*string{
	// 					to.Ptr("/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nicNsg"),
	// 					to.Ptr("/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/subnetNsg")},
	// 				},
	// 				{
	// 					NetworkInterface: to.Ptr("/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourcegroups/rg2/providers/Microsoft.Network/networkInterfaces/nic2"),
	// 					NetworkSecurityGroups: []*string{
	// 						to.Ptr("/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/rg2/providers/Microsoft.Network/networkSecurityGroups/nicNsg")},
	// 				}},
	// 				Rules: []*armsecurity.Rule{
	// 					{
	// 						Name: to.Ptr("rule1"),
	// 						DestinationPort: to.Ptr[int32](3389),
	// 						Direction: to.Ptr(armsecurity.DirectionInbound),
	// 						IPAddresses: []*string{
	// 							to.Ptr("100.10.1.1"),
	// 							to.Ptr("200.20.2.2"),
	// 							to.Ptr("81.199.3.0/24")},
	// 							Protocols: []*armsecurity.TransportProtocol{
	// 								to.Ptr(armsecurity.TransportProtocolTCP)},
	// 							},
	// 							{
	// 								Name: to.Ptr("rule2"),
	// 								DestinationPort: to.Ptr[int32](22),
	// 								Direction: to.Ptr(armsecurity.DirectionInbound),
	// 								IPAddresses: []*string{
	// 								},
	// 								Protocols: []*armsecurity.TransportProtocol{
	// 									to.Ptr(armsecurity.TransportProtocolTCP)},
	// 							}},
	// 							RulesCalculationTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-08-15T00:00:00.000Z"); return t}()),
	// 						},
	// 					}
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

JavaScript

const { SecurityCenter } = require("@azure/arm-security");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Gets a single Adaptive Network Hardening resource
 *
 * @summary Gets a single Adaptive Network Hardening resource
 * x-ms-original-file: specification/security/resource-manager/Microsoft.Security/stable/2020-01-01/examples/AdaptiveNetworkHardenings/GetAdaptiveNetworkHardening_example.json
 */
async function getASingleAdaptiveNetworkHardeningResource() {
  const subscriptionId =
    process.env["SECURITY_SUBSCRIPTION_ID"] || "20ff7fc3-e762-44dd-bd96-b71116dcdc23";
  const resourceGroupName = process.env["SECURITY_RESOURCE_GROUP"] || "rg1";
  const resourceNamespace = "Microsoft.Compute";
  const resourceType = "virtualMachines";
  const resourceName = "vm1";
  const adaptiveNetworkHardeningResourceName = "default";
  const credential = new DefaultAzureCredential();
  const client = new SecurityCenter(credential, subscriptionId);
  const result = await client.adaptiveNetworkHardenings.get(
    resourceGroupName,
    resourceNamespace,
    resourceType,
    resourceName,
    adaptiveNetworkHardeningResourceName
  );
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

dotnet

using System;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.SecurityCenter;
using Azure.ResourceManager.SecurityCenter.Models;

// Generated from example definition: specification/security/resource-manager/Microsoft.Security/stable/2020-01-01/examples/AdaptiveNetworkHardenings/GetAdaptiveNetworkHardening_example.json
// this example is just showing the usage of "AdaptiveNetworkHardenings_Get" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this AdaptiveNetworkHardeningResource created on azure
// for more information of creating AdaptiveNetworkHardeningResource, please refer to the document of AdaptiveNetworkHardeningResource
string subscriptionId = "20ff7fc3-e762-44dd-bd96-b71116dcdc23";
string resourceGroupName = "rg1";
string resourceNamespace = "Microsoft.Compute";
string resourceType = "virtualMachines";
string resourceName = "vm1";
string adaptiveNetworkHardeningResourceName = "default";
ResourceIdentifier adaptiveNetworkHardeningResourceId = AdaptiveNetworkHardeningResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, resourceNamespace, resourceType, resourceName, adaptiveNetworkHardeningResourceName);
AdaptiveNetworkHardeningResource adaptiveNetworkHardening = client.GetAdaptiveNetworkHardeningResource(adaptiveNetworkHardeningResourceId);

// invoke the operation
AdaptiveNetworkHardeningResource result = await adaptiveNetworkHardening.GetAsync();

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
AdaptiveNetworkHardeningData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample Response

Status code:

200

{
  "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourcegroups/rg1/providers/Microsoft.Compute/virtualMachines/vm1/providers/Microsoft.Security/adaptiveNetworkHardenings/default",
  "name": "default",
  "type": "Microsoft.Security/adaptiveNetworkHardenings",
  "properties": {
    "rulesCalculationTime": "2018-08-15T00:00:00.0000000Z",
    "rules": [
      {
        "name": "rule1",
        "direction": "Inbound",
        "destinationPort": 3389,
        "protocols": [
          "TCP"
        ],
        "ipAddresses": [
          "100.10.1.1",
          "200.20.2.2",
          "81.199.3.0/24"
        ]
      },
      {
        "name": "rule2",
        "direction": "Inbound",
        "destinationPort": 22,
        "protocols": [
          "TCP"
        ],
        "ipAddresses": []
      }
    ],
    "effectiveNetworkSecurityGroups": [
      {
        "networkInterface": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourcegroups/rg1/providers/Microsoft.Network/networkInterfaces/nic1",
        "networkSecurityGroups": [
          "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nicNsg",
          "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/subnetNsg"
        ]
      },
      {
        "networkInterface": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourcegroups/rg2/providers/Microsoft.Network/networkInterfaces/nic2",
        "networkSecurityGroups": [
          "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/rg2/providers/Microsoft.Network/networkSecurityGroups/nicNsg"
        ]
      }
    ]
  }
}

Definitions

Name	Description
AdaptiveNetworkHardening	The resource whose properties describes the Adaptive Network Hardening settings for some Azure resource
CloudError	Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).
CloudErrorBody	The error detail.
direction	The rule's direction
EffectiveNetworkSecurityGroups	Describes the Network Security Groups effective on a network interface
ErrorAdditionalInfo	The resource management error additional info.
Rule	Describes remote addresses that is recommended to communicate with the Azure resource on some (Protocol, Port, Direction). All other remote addresses are recommended to be blocked
transportProtocol	The rule's transport protocols

AdaptiveNetworkHardening

The resource whose properties describes the Adaptive Network Hardening settings for some Azure resource

Name	Type	Description
id	string	Resource Id
name	string	Resource name
properties.effectiveNetworkSecurityGroups	EffectiveNetworkSecurityGroups[]	The Network Security Groups effective on the network interfaces of the protected resource
properties.rules	Rule[]	The security rules which are recommended to be effective on the VM
properties.rulesCalculationTime	string	The UTC time on which the rules were calculated
type	string	Resource type

CloudError

Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).

Name	Type	Description
error.additionalInfo	ErrorAdditionalInfo[]	The error additional info.
error.code	string	The error code.
error.details	CloudErrorBody[]	The error details.
error.message	string	The error message.
error.target	string	The error target.

CloudErrorBody

The error detail.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	The error additional info.
code	string	The error code.
details	CloudErrorBody[]	The error details.
message	string	The error message.
target	string	The error target.

direction

The rule's direction

Name	Type	Description
Inbound	string
Outbound	string

EffectiveNetworkSecurityGroups

Describes the Network Security Groups effective on a network interface

Name	Type	Description
networkInterface	string	The Azure resource ID of the network interface
networkSecurityGroups	string[]	The Network Security Groups effective on the network interface

ErrorAdditionalInfo

The resource management error additional info.

Name	Type	Description
info	object	The additional info.
type	string	The additional info type.

Rule

Describes remote addresses that is recommended to communicate with the Azure resource on some (Protocol, Port, Direction). All other remote addresses are recommended to be blocked

Name	Type	Description
destinationPort	integer	The rule's destination port
direction	direction	The rule's direction
ipAddresses	string[]	The remote IP addresses that should be able to communicate with the Azure resource on the rule's destination port and protocol
name	string	The name of the rule
protocols	transportProtocol[]	The rule's transport protocols

transportProtocol

The rule's transport protocols

Name	Type	Description
TCP	string
UDP	string