External Security Solutions - Get

服務:

Defender for Cloud

API 版本:

2020-01-01

取得特定的外部安全性解決方案。

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

URI 參數

名稱	位於	必要	類型	Description
ascLocation	path	True	string	ASC 儲存訂閱數據的位置。 可以從取得位置擷取
externalSecuritySolutionsName	path	True	string	外部安全性解決方案的名稱。
resourceGroupName	path	True	string	用戶訂用帳戶內的資源組名。 名稱不區分大小寫。 Regex 模式: ^[-\w\._\(\)]+$
subscriptionId	path	True	string	Azure 訂用帳戶標識碼 Regex 模式: ^[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}$
api-version	query	True	string	作業的 API 版本

回應

名稱	類型	Description
200 OK	ExternalSecuritySolution: CefExternalSecuritySolution AtaExternalSecuritySolution AadExternalSecuritySolution	還行
Other Status Codes	CloudError	描述作業失敗原因的錯誤回應。

安全性

azure_auth

Azure Active Directory OAuth2 Flow

類型: oauth2
Flow: implicit
授權 URL: https://login.microsoftonline.com/common/oauth2/authorize

範圍

名稱	Description
user_impersonation	模擬您的用戶帳戶

範例

Get external security solution

範例要求

HTTP

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

Java

/**
 * 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

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/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

JavaScript

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

dotnet

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

範例回覆

狀態碼:

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

定義

名稱	Description
AadConnectivityState	描述具有種類的 Azure 資源
AadExternalSecuritySolution	代表將記錄傳送至 OMS 工作區的 AAD 身分識別保護解決方案。
AadSolutionProperties	AAD 解決方案的外部安全性解決方案屬性
AtaExternalSecuritySolution	表示將記錄傳送至 OMS 工作區的 ATA 安全性解決方案
AtaSolutionProperties	ATA 解決方案的外部安全性解決方案屬性
CefExternalSecuritySolution	表示將 CEF 記錄傳送至 OMS 工作區的安全性解決方案
CefSolutionProperties	CEF 解決方案的外部安全性解決方案屬性
CloudError	所有 Azure Resource Manager API 的常見錯誤回應，以傳回失敗作業的錯誤詳細數據。 （這也遵循 OData 錯誤回應格式。）。
CloudErrorBody	錯誤詳細數據。
ConnectedWorkspace	表示解決方案所連線的 OMS 工作區
ErrorAdditionalInfo	資源管理錯誤其他資訊。
ExternalSecuritySolutionKind	描述具有種類的 Azure 資源

AadConnectivityState

描述具有種類的 Azure 資源

名稱	類型	Description
connectivityState	AadConnectivityState	外部 AAD 解決方案的連線狀態

AadExternalSecuritySolution

代表將記錄傳送至 OMS 工作區的 AAD 身分識別保護解決方案。

名稱	類型	Description
id	string	資源標識碼
kind	ExternalSecuritySolutionKind	外部解決方案的種類
location	string	儲存資源的位置
name	string	資源名稱
properties	AadSolutionProperties	AAD 解決方案的外部安全性解決方案屬性
type	string	資源類型

AadSolutionProperties

AAD 解決方案的外部安全性解決方案屬性

名稱	類型	Description
connectivityState	AadConnectivityState	外部 AAD 解決方案的連線狀態
deviceType	string
deviceVendor	string
workspace	ConnectedWorkspace	表示解決方案所連線的 OMS 工作區

AtaExternalSecuritySolution

表示將記錄傳送至 OMS 工作區的 ATA 安全性解決方案

名稱	類型	Description
id	string	資源標識碼
kind	ExternalSecuritySolutionKind	外部解決方案的種類
location	string	儲存資源的位置
name	string	資源名稱
properties	AtaSolutionProperties	ATA 解決方案的外部安全性解決方案屬性
type	string	資源類型

AtaSolutionProperties

ATA 解決方案的外部安全性解決方案屬性

名稱	類型	Description
deviceType	string
deviceVendor	string
lastEventReceived	string
workspace	ConnectedWorkspace	表示解決方案所連線的 OMS 工作區

CefExternalSecuritySolution

表示將 CEF 記錄傳送至 OMS 工作區的安全性解決方案

名稱	類型	Description
id	string	資源標識碼
kind	ExternalSecuritySolutionKind	外部解決方案的種類
location	string	儲存資源的位置
name	string	資源名稱
properties	CefSolutionProperties	CEF 解決方案的外部安全性解決方案屬性
type	string	資源類型

CefSolutionProperties

CEF 解決方案的外部安全性解決方案屬性

名稱	類型	Description
agent	string
deviceType	string
deviceVendor	string
hostname	string
lastEventReceived	string
workspace	ConnectedWorkspace	表示解決方案所連線的 OMS 工作區

CloudError

所有 Azure Resource Manager API 的常見錯誤回應，以傳回失敗作業的錯誤詳細數據。 （這也遵循 OData 錯誤回應格式。）。

名稱	類型	Description
error.additionalInfo	ErrorAdditionalInfo[]	錯誤其他資訊。
error.code	string	錯誤碼。
error.details	CloudErrorBody[]	錯誤詳細數據。
error.message	string	錯誤訊息。
error.target	string	錯誤目標。

CloudErrorBody

錯誤詳細數據。

名稱	類型	Description
additionalInfo	ErrorAdditionalInfo[]	錯誤其他資訊。
code	string	錯誤碼。
details	CloudErrorBody[]	錯誤詳細數據。
message	string	錯誤訊息。
target	string	錯誤目標。

ConnectedWorkspace

表示解決方案所連線的 OMS 工作區

名稱	類型	Description
id	string	已連線 OMS 工作區的 Azure 資源識別碼

ErrorAdditionalInfo

資源管理錯誤其他資訊。

名稱	類型	Description
info	object	其他資訊。
type	string	其他信息類型。

ExternalSecuritySolutionKind

描述具有種類的 Azure 資源

名稱	類型	Description
kind	ExternalSecuritySolutionKind	外部解決方案的種類