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 パラメーター

名前	/	必須	型	説明
ascLocation	path	True	string	ASC がサブスクリプションのデータを格納する場所。 場所を取得から取得できます
externalSecuritySolutionsName	path	True	string	外部セキュリティ ソリューションの名前。
resourceGroupName	path	True	string	ユーザーのサブスクリプション内のリソース グループの名前。 名前では大文字と小文字が区別されません。 正規表現パターン: ^[-\w\._\(\)]+$
subscriptionId	path	True	string	Azure サブスクリプション ID 正規表現パターン: ^[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}$
api-version	query	True	string	操作の API バージョン

応答

名前	型	説明
200 OK	ExternalSecuritySolution: CefExternalSecuritySolution AtaExternalSecuritySolution AadExternalSecuritySolution	わかりました
Other Status Codes	CloudError	操作が失敗した理由を説明するエラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/authorize

スコープ

名前	説明
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"
}

定義

名前	説明
AadConnectivityState	種類を持つ Azure リソースについて説明します
AadExternalSecuritySolution	OMS ワークスペースにログを送信する AAD ID 保護ソリューションを表します。
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 リソースについて説明します

名前	型	説明
connectivityState	AadConnectivityState	外部 AAD ソリューションの接続状態

AadExternalSecuritySolution

OMS ワークスペースにログを送信する AAD ID 保護ソリューションを表します。

名前	型	説明
id	string	リソース ID
kind	ExternalSecuritySolutionKind	外部ソリューションの種類
location	string	リソースが格納されている場所
name	string	リソース名
properties	AadSolutionProperties	AAD ソリューションの外部セキュリティ ソリューションのプロパティ
type	string	リソースの種類

AadSolutionProperties

AAD ソリューションの外部セキュリティ ソリューションのプロパティ

名前	型	説明
connectivityState	AadConnectivityState	外部 AAD ソリューションの接続状態
deviceType	string
deviceVendor	string
workspace	ConnectedWorkspace	ソリューションが接続されている OMS ワークスペースを表します。

AtaExternalSecuritySolution

OMS ワークスペースにログを送信する ATA セキュリティ ソリューションを表します

名前	型	説明
id	string	リソース ID
kind	ExternalSecuritySolutionKind	外部ソリューションの種類
location	string	リソースが格納されている場所
name	string	リソース名
properties	AtaSolutionProperties	ATA ソリューションの外部セキュリティ ソリューションのプロパティ
type	string	リソースの種類

AtaSolutionProperties

ATA ソリューションの外部セキュリティ ソリューションのプロパティ

名前	型	説明
deviceType	string
deviceVendor	string
lastEventReceived	string
workspace	ConnectedWorkspace	ソリューションが接続されている OMS ワークスペースを表します。

CefExternalSecuritySolution

CEF ログを OMS ワークスペースに送信するセキュリティ ソリューションを表します

名前	型	説明
id	string	リソース ID
kind	ExternalSecuritySolutionKind	外部ソリューションの種類
location	string	リソースが格納されている場所
name	string	リソース名
properties	CefSolutionProperties	CEF ソリューションの外部セキュリティ ソリューションのプロパティ
type	string	リソースの種類

CefSolutionProperties

CEF ソリューションの外部セキュリティ ソリューションのプロパティ

名前	型	説明
agent	string
deviceType	string
deviceVendor	string
hostname	string
lastEventReceived	string
workspace	ConnectedWorkspace	ソリューションが接続されている OMS ワークスペースを表します。

CloudError

失敗した操作のエラーの詳細を返す、すべての Azure Resource Manager API の一般的なエラー応答。 (これは、OData エラー応答形式にも従います)。

名前	型	説明
error.additionalInfo	ErrorAdditionalInfo[]	エラーの追加情報。
error.code	string	エラー コード。
error.details	CloudErrorBody[]	エラーの詳細。
error.message	string	エラー メッセージ。
error.target	string	エラーターゲット。

CloudErrorBody

エラーの詳細。

名前	型	説明
additionalInfo	ErrorAdditionalInfo[]	エラーの追加情報。
code	string	エラー コード。
details	CloudErrorBody[]	エラーの詳細。
message	string	エラー メッセージ。
target	string	エラーターゲット。

ConnectedWorkspace

ソリューションが接続されている OMS ワークスペースを表します。

名前	型	説明
id	string	接続された OMS ワークスペースの Azure リソース ID

ErrorAdditionalInfo

リソース管理エラーの追加情報。

名前	型	説明
info	object	追加情報。
type	string	追加情報の種類。

ExternalSecuritySolutionKind

種類を持つ Azure リソースについて説明します

名前	型	説明
kind	ExternalSecuritySolutionKind	外部ソリューションの種類