External Security Solutions - Get

Reference

Service:: Defender for Cloud

API Version:: 2020-01-01

Gets a specific external Security Solution.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/locations/{ascLocation}/ExternalSecuritySolutions/{externalSecuritySolutionsName}?api-version=2020-01-01

URI Parameters

Name	In	Required	Type	Description
ascLocation	path	True	string	The location where ASC stores the data of the subscription. can be retrieved from Get locations
externalSecuritySolutionsName	path	True	string	Name of an external security solution.
resourceGroupName	path	True	string	The name of the resource group within the user's subscription. The name is case insensitive. Regex pattern: `^[-\w\._]+$`
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	ExternalSecuritySolution: CefExternalSecuritySolution AtaExternalSecuritySolution AadExternalSecuritySolution	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 external security solution

Sample request

GET https://management.azure.com/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/defaultresourcegroup-eus/providers/Microsoft.Security/locations/centralus/ExternalSecuritySolutions/aad_defaultworkspace-20ff7fc3-e762-44dd-bd96-b71116dcdc23-eus?api-version=2020-01-01


/**
 * Samples for ExternalSecuritySolutions Get.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/security/resource-manager/Microsoft.Security/stable/2020-01-01/examples/ExternalSecuritySolutions/
     * GetExternalSecuritySolution_example.json
     */
    /**
     * Sample code: Get external security solution.
     * 
     * @param manager Entry point to SecurityManager.
     */
    public static void getExternalSecuritySolution(com.azure.resourcemanager.security.SecurityManager manager) {
        manager.externalSecuritySolutions().getWithResponse("defaultresourcegroup-eus", "centralus",
            "aad_defaultworkspace-20ff7fc3-e762-44dd-bd96-b71116dcdc23-eus", 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

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/9ac34f238dd6b9071f486b57e9f9f1a0c43ec6f6/specification/security/resource-manager/Microsoft.Security/stable/2020-01-01/examples/ExternalSecuritySolutions/GetExternalSecuritySolution_example.json
func ExampleExternalSecuritySolutionsClient_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.NewExternalSecuritySolutionsClient().Get(ctx, "defaultresourcegroup-eus", "centralus", "aad_defaultworkspace-20ff7fc3-e762-44dd-bd96-b71116dcdc23-eus", 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 = armsecurity.ExternalSecuritySolutionsClientGetResponse{
	// 	                            ExternalSecuritySolutionClassification: &armsecurity.AADExternalSecuritySolution{
	// 		Location: to.Ptr("eastus"),
	// 		Name: to.Ptr("aad_defaultworkspace-20ff7fc3-e762-44dd-bd96-b71116dcdc23-eus"),
	// 		Type: to.Ptr("Microsoft.Security/locations/externalSecuritySolutions"),
	// 		ID: to.Ptr("/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/defaultresourcegroup-eus/providers/Microsoft.Security/locations/centralus/externalSecuritySolutions/aad_defaultworkspace-20ff7fc3-e762-44dd-bd96-b71116dcdc23-eus"),
	// 		Kind: to.Ptr(armsecurity.ExternalSecuritySolutionKindAAD),
	// 		Properties: &armsecurity.AADSolutionProperties{
	// 			DeviceType: to.Ptr("Azure Active Directory Identity Protection"),
	// 			DeviceVendor: to.Ptr("Microsoft"),
	// 			Workspace: &armsecurity.ConnectedWorkspace{
	// 				ID: to.Ptr("/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourcegroups/defaultresourcegroup-eus/providers/Microsoft.OperationalInsights/workspaces/defaultworkspace-20ff7fc3-e762-44dd-bd96-b71116dcdc23-eus"),
	// 			},
	// 			AdditionalProperties: map[string]any{
	// 				"connectivityState": "Discovered",
	// 			},
	// 		},
	// 	},
	// 	                        }
}

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

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

/**
 * This sample demonstrates how to Gets a specific external Security Solution.
 *
 * @summary Gets a specific external Security Solution.
 * x-ms-original-file: specification/security/resource-manager/Microsoft.Security/stable/2020-01-01/examples/ExternalSecuritySolutions/GetExternalSecuritySolution_example.json
 */
async function getExternalSecuritySolution() {
  const subscriptionId =
    process.env["SECURITY_SUBSCRIPTION_ID"] || "20ff7fc3-e762-44dd-bd96-b71116dcdc23";
  const resourceGroupName = process.env["SECURITY_RESOURCE_GROUP"] || "defaultresourcegroup-eus";
  const ascLocation = "centralus";
  const externalSecuritySolutionsName =
    "aad_defaultworkspace-20ff7fc3-e762-44dd-bd96-b71116dcdc23-eus";
  const credential = new DefaultAzureCredential();
  const client = new SecurityCenter(credential, subscriptionId);
  const result = await client.externalSecuritySolutions.get(
    resourceGroupName,
    ascLocation,
    externalSecuritySolutionsName,
  );
  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

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

// Generated from example definition: specification/security/resource-manager/Microsoft.Security/stable/2020-01-01/examples/ExternalSecuritySolutions/GetExternalSecuritySolution_example.json
// this example is just showing the usage of "ExternalSecuritySolutions_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 ResourceGroupResource created on azure
// for more information of creating ResourceGroupResource, please refer to the document of ResourceGroupResource
string subscriptionId = "20ff7fc3-e762-44dd-bd96-b71116dcdc23";
string resourceGroupName = "defaultresourcegroup-eus";
ResourceIdentifier resourceGroupResourceId = ResourceGroupResource.CreateResourceIdentifier(subscriptionId, resourceGroupName);
ResourceGroupResource resourceGroupResource = client.GetResourceGroupResource(resourceGroupResourceId);

// invoke the operation
AzureLocation ascLocation = new AzureLocation("centralus");
string externalSecuritySolutionsName = "aad_defaultworkspace-20ff7fc3-e762-44dd-bd96-b71116dcdc23-eus";
ExternalSecuritySolution result = await resourceGroupResource.GetExternalSecuritySolutionAsync(ascLocation, externalSecuritySolutionsName);

Console.WriteLine($"Succeeded: {result}");

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

{
  "kind": "AAD",
  "properties": {
    "connectivityState": "Discovered",
    "deviceVendor": "Microsoft",
    "deviceType": "Azure Active Directory Identity Protection",
    "workspace": {
      "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourcegroups/defaultresourcegroup-eus/providers/Microsoft.OperationalInsights/workspaces/defaultworkspace-20ff7fc3-e762-44dd-bd96-b71116dcdc23-eus"
    }
  },
  "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/defaultresourcegroup-eus/providers/Microsoft.Security/locations/centralus/externalSecuritySolutions/aad_defaultworkspace-20ff7fc3-e762-44dd-bd96-b71116dcdc23-eus",
  "name": "aad_defaultworkspace-20ff7fc3-e762-44dd-bd96-b71116dcdc23-eus",
  "type": "Microsoft.Security/locations/externalSecuritySolutions",
  "location": "eastus"
}

Definitions

Name	Description
AadConnectivityState	Describes an Azure resource with kind
AadExternalSecuritySolution	Represents an AAD identity protection solution which sends logs to an OMS workspace.
AadSolutionProperties	The external security solution properties for AAD solutions
AtaExternalSecuritySolution	Represents an ATA security solution which sends logs to an OMS workspace
AtaSolutionProperties	The external security solution properties for ATA solutions
CefExternalSecuritySolution	Represents a security solution which sends CEF logs to an OMS workspace
CefSolutionProperties	The external security solution properties for CEF solutions
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.
ConnectedWorkspace	Represents an OMS workspace to which the solution is connected
ErrorAdditionalInfo	The resource management error additional info.
ExternalSecuritySolutionKind	Describes an Azure resource with kind

AadConnectivityState

Describes an Azure resource with kind

Name	Type	Description
connectivityState	AadConnectivityState	The connectivity state of the external AAD solution

AadExternalSecuritySolution

Represents an AAD identity protection solution which sends logs to an OMS workspace.

Name	Type	Description
id	string	Resource Id
kind	ExternalSecuritySolutionKind	The kind of the external solution
location	string	Location where the resource is stored
name	string	Resource name
properties	AadSolutionProperties	The external security solution properties for AAD solutions
type	string	Resource type

AadSolutionProperties

The external security solution properties for AAD solutions

Name	Type	Description
connectivityState	AadConnectivityState	The connectivity state of the external AAD solution
deviceType	string
deviceVendor	string
workspace	ConnectedWorkspace	Represents an OMS workspace to which the solution is connected

AtaExternalSecuritySolution

Represents an ATA security solution which sends logs to an OMS workspace

Name	Type	Description
id	string	Resource Id
kind	ExternalSecuritySolutionKind	The kind of the external solution
location	string	Location where the resource is stored
name	string	Resource name
properties	AtaSolutionProperties	The external security solution properties for ATA solutions
type	string	Resource type

AtaSolutionProperties

The external security solution properties for ATA solutions

Name	Type	Description
deviceType	string
deviceVendor	string
lastEventReceived	string
workspace	ConnectedWorkspace	Represents an OMS workspace to which the solution is connected

CefExternalSecuritySolution

Represents a security solution which sends CEF logs to an OMS workspace

Name	Type	Description
id	string	Resource Id
kind	ExternalSecuritySolutionKind	The kind of the external solution
location	string	Location where the resource is stored
name	string	Resource name
properties	CefSolutionProperties	The external security solution properties for CEF solutions
type	string	Resource type

CefSolutionProperties

The external security solution properties for CEF solutions

Name	Type	Description
agent	string
deviceType	string
deviceVendor	string
hostname	string
lastEventReceived	string
workspace	ConnectedWorkspace	Represents an OMS workspace to which the solution is connected

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.

ConnectedWorkspace

Represents an OMS workspace to which the solution is connected

Name	Type	Description
id	string	Azure resource ID of the connected OMS workspace

ErrorAdditionalInfo

The resource management error additional info.

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

ExternalSecuritySolutionKind

Describes an Azure resource with kind

Name	Type	Description
kind	ExternalSecuritySolutionKind	The kind of the external solution

Share via

External Security Solutions - Get

URI Parameters

Responses

Security

azure_auth

Scopes

Examples

Get external security solution

Sample request

Sample response

Definitions

AadConnectivityState

AadExternalSecuritySolution

AadSolutionProperties

AtaExternalSecuritySolution

AtaSolutionProperties

CefExternalSecuritySolution

CefSolutionProperties

CloudError

CloudErrorBody

ConnectedWorkspace

ErrorAdditionalInfo

ExternalSecuritySolutionKind

Additional resources