External Security Solutions - Get

Referens

Service:: Defender for Cloud

API Version:: 2020-01-01

Hämtar en specifik extern säkerhetslösning.

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
ascLocation	path	True	string	Platsen där ASC lagrar prenumerationens data. kan hämtas från Hämta platser
externalSecuritySolutionsName	path	True	string	Namnet på en extern säkerhetslösning.
resourceGroupName	path	True	string	Namnet på resursgruppen i användarens prenumeration. Namnet är skiftlägesokänsligt. Regex pattern: `^[-\w\._]+$`
subscriptionId	path	True	string	Azure-prenumerations-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 för åtgärden

Svar

Name	Typ	Description
200 OK	ExternalSecuritySolution: CefExternalSecuritySolution AtaExternalSecuritySolution AadExternalSecuritySolution	OK
Other Status Codes	CloudError	Felsvar som beskriver varför åtgärden misslyckades.

Säkerhet

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	personifiera ditt användarkonto

Exempel

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"
}

Definitioner

Name	Description
AadConnectivityState	Beskriver en Azure-resurs med typ
AadExternalSecuritySolution	Representerar en AAD-identitetsskyddslösning som skickar loggar till en OMS-arbetsyta.
AadSolutionProperties	Egenskaper för den externa säkerhetslösningen för AAD-lösningar
AtaExternalSecuritySolution	Representerar en ATA-säkerhetslösning som skickar loggar till en OMS-arbetsyta
AtaSolutionProperties	Egenskaper för den externa säkerhetslösningen för ATA-lösningar
CefExternalSecuritySolution	Representerar en säkerhetslösning som skickar CEF-loggar till en OMS-arbetsyta
CefSolutionProperties	Egenskaperna för den externa säkerhetslösningen för CEF-lösningar
CloudError	Vanligt felsvar för alla Azure Resource Manager-API:er för att returnera felinformation för misslyckade åtgärder. (Detta följer även OData-felsvarsformatet.).
CloudErrorBody	Felinformationen.
ConnectedWorkspace	Representerar en OMS-arbetsyta som lösningen är ansluten till
ErrorAdditionalInfo	Ytterligare information om resurshanteringsfelet.
ExternalSecuritySolutionKind	Beskriver en Azure-resurs med typ

AadConnectivityState

Beskriver en Azure-resurs med typ

Name	Typ	Description
connectivityState	AadConnectivityState	Anslutningstillståndet för den externa AAD-lösningen

AadExternalSecuritySolution

Representerar en AAD-identitetsskyddslösning som skickar loggar till en OMS-arbetsyta.

Name	Typ	Description
id	string	Resurs-ID
kind	ExternalSecuritySolutionKind	Typen av extern lösning
location	string	Plats där resursen lagras
name	string	Resursnamn
properties	AadSolutionProperties	Egenskaper för den externa säkerhetslösningen för AAD-lösningar
type	string	Resurstyp

AadSolutionProperties

Egenskaper för den externa säkerhetslösningen för AAD-lösningar

Name	Typ	Description
connectivityState	AadConnectivityState	Anslutningstillståndet för den externa AAD-lösningen
deviceType	string
deviceVendor	string
workspace	ConnectedWorkspace	Representerar en OMS-arbetsyta som lösningen är ansluten till

AtaExternalSecuritySolution

Representerar en ATA-säkerhetslösning som skickar loggar till en OMS-arbetsyta

Name	Typ	Description
id	string	Resurs-ID
kind	ExternalSecuritySolutionKind	Typen av extern lösning
location	string	Plats där resursen lagras
name	string	Resursnamn
properties	AtaSolutionProperties	Egenskaper för den externa säkerhetslösningen för ATA-lösningar
type	string	Resurstyp

AtaSolutionProperties

Egenskaper för den externa säkerhetslösningen för ATA-lösningar

Name	Typ	Description
deviceType	string
deviceVendor	string
lastEventReceived	string
workspace	ConnectedWorkspace	Representerar en OMS-arbetsyta som lösningen är ansluten till

CefExternalSecuritySolution

Representerar en säkerhetslösning som skickar CEF-loggar till en OMS-arbetsyta

Name	Typ	Description
id	string	Resurs-ID
kind	ExternalSecuritySolutionKind	Typen av extern lösning
location	string	Plats där resursen lagras
name	string	Resursnamn
properties	CefSolutionProperties	Egenskaperna för den externa säkerhetslösningen för CEF-lösningar
type	string	Resurstyp

CefSolutionProperties

Egenskaperna för den externa säkerhetslösningen för CEF-lösningar

Name	Typ	Description
agent	string
deviceType	string
deviceVendor	string
hostname	string
lastEventReceived	string
workspace	ConnectedWorkspace	Representerar en OMS-arbetsyta som lösningen är ansluten till

CloudError

Vanligt felsvar för alla Azure Resource Manager-API:er för att returnera felinformation för misslyckade åtgärder. (Detta följer även OData-felsvarsformatet.).

Name	Typ	Description
error.additionalInfo	ErrorAdditionalInfo[]	Ytterligare information om felet.
error.code	string	Felkoden.
error.details	CloudErrorBody[]	Felinformationen.
error.message	string	Felmeddelandet.
error.target	string	Felmålet.

CloudErrorBody

Felinformationen.

Name	Typ	Description
additionalInfo	ErrorAdditionalInfo[]	Ytterligare information om felet.
code	string	Felkoden.
details	CloudErrorBody[]	Felinformationen.
message	string	Felmeddelandet.
target	string	Felmålet.

ConnectedWorkspace

Representerar en OMS-arbetsyta som lösningen är ansluten till

Name	Typ	Description
id	string	Azure-resurs-ID för den anslutna OMS-arbetsytan

ErrorAdditionalInfo

Ytterligare information om resurshanteringsfelet.

Name	Typ	Description
info	object	Den ytterligare informationen.
type	string	Ytterligare informationstyp.

ExternalSecuritySolutionKind

Beskriver en Azure-resurs med typ

Name	Typ	Description
kind	ExternalSecuritySolutionKind	Typen av extern lösning

Dela via

External Security Solutions - Get

URI-parametrar

Svar

Säkerhet

azure_auth

Scopes

Exempel

Get external security solution

Sample Request

Sample Response

Definitioner

AadConnectivityState

AadExternalSecuritySolution

AadSolutionProperties

AtaExternalSecuritySolution

AtaSolutionProperties

CefExternalSecuritySolution

CefSolutionProperties

CloudError

CloudErrorBody

ConnectedWorkspace

ErrorAdditionalInfo

ExternalSecuritySolutionKind

Ytterligare resurser