External Security Solutions - Get

Referência

Serviço:: Defender for Cloud

Versão da API:: 2020-01-01

Obtém uma solução de segurança externa específica.

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
ascLocation	path	True	string	O local em que o ASC armazena os dados da assinatura. pode ser recuperado de Obter locais
externalSecuritySolutionsName	path	True	string	Nome de uma solução de segurança externa.
resourceGroupName	path	True	string	O nome do grupo de recursos na assinatura do usuário. O nome não diferencia maiúsculas de minúsculas. Padrão Regex: `^[-\w\._]+$`
subscriptionId	path	True	string	ID da assinatura do Azure Padrão Regex: `^[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}$`
api-version	query	True	string	Versão da API para a operação

Respostas

Nome	Tipo	Description
200 OK	ExternalSecuritySolution: CefExternalSecuritySolution AtaExternalSecuritySolution AadExternalSecuritySolution	OKEY
Other Status Codes	CloudError	Resposta de erro que descreve por que a operação falhou.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory

Tipo: oauth2
Flow: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Escopos

Nome	Description
user_impersonation	representar sua conta de usuário

Exemplos

Get external security solution

Solicitação de exemplo

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

Resposta de exemplo

Código de status:: 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"
}

Definições

Nome	Description
AadConnectivityState	Descreve um recurso do Azure com tipo
AadExternalSecuritySolution	Representa uma solução de proteção de identidade do AAD que envia logs para um workspace do OMS.
AadSolutionProperties	As propriedades da solução de segurança externa para soluções do AAD
AtaExternalSecuritySolution	Representa uma solução de segurança do ATA que envia logs para um workspace do OMS
AtaSolutionProperties	As propriedades da solução de segurança externa para soluções do ATA
CefExternalSecuritySolution	Representa uma solução de segurança que envia logs do CEF para um workspace do OMS
CefSolutionProperties	As propriedades da solução de segurança externa para soluções CEF
CloudError	Resposta de erro comum para todas as APIs do Azure Resource Manager retornarem detalhes de erro para operações com falha. (Isso também segue o formato de resposta de erro OData.).
CloudErrorBody	O detalhe do erro.
ConnectedWorkspace	Representa um workspace do OMS ao qual a solução está conectada
ErrorAdditionalInfo	As informações adicionais do erro de gerenciamento de recursos.
ExternalSecuritySolutionKind	Descreve um recurso do Azure com tipo

AadConnectivityState

Descreve um recurso do Azure com tipo

Nome	Tipo	Description
connectivityState	AadConnectivityState	O estado de conectividade da solução do AAD externo

AadExternalSecuritySolution

Representa uma solução de proteção de identidade do AAD que envia logs para um workspace do OMS.

Nome	Tipo	Description
id	string	ID do recurso
kind	ExternalSecuritySolutionKind	O tipo da solução externa
location	string	Local onde o recurso é armazenado
name	string	Nome do recurso
properties	AadSolutionProperties	As propriedades da solução de segurança externa para soluções do AAD
type	string	Tipo de recurso

AadSolutionProperties

As propriedades da solução de segurança externa para soluções do AAD

Nome	Tipo	Description
connectivityState	AadConnectivityState	O estado de conectividade da solução do AAD externo
deviceType	string
deviceVendor	string
workspace	ConnectedWorkspace	Representa um workspace do OMS ao qual a solução está conectada

AtaExternalSecuritySolution

Representa uma solução de segurança do ATA que envia logs para um workspace do OMS

Nome	Tipo	Description
id	string	ID do recurso
kind	ExternalSecuritySolutionKind	O tipo da solução externa
location	string	Local onde o recurso é armazenado
name	string	Nome do recurso
properties	AtaSolutionProperties	As propriedades da solução de segurança externa para soluções do ATA
type	string	Tipo de recurso

AtaSolutionProperties

As propriedades da solução de segurança externa para soluções do ATA

Nome	Tipo	Description
deviceType	string
deviceVendor	string
lastEventReceived	string
workspace	ConnectedWorkspace	Representa um workspace do OMS ao qual a solução está conectada

CefExternalSecuritySolution

Representa uma solução de segurança que envia logs do CEF para um workspace do OMS

Nome	Tipo	Description
id	string	ID do recurso
kind	ExternalSecuritySolutionKind	O tipo da solução externa
location	string	Local onde o recurso é armazenado
name	string	Nome do recurso
properties	CefSolutionProperties	As propriedades da solução de segurança externa para soluções CEF
type	string	Tipo de recurso

CefSolutionProperties

As propriedades da solução de segurança externa para soluções CEF

Nome	Tipo	Description
agent	string
deviceType	string
deviceVendor	string
hostname	string
lastEventReceived	string
workspace	ConnectedWorkspace	Representa um workspace do OMS ao qual a solução está conectada

CloudError

Resposta de erro comum para todas as APIs do Azure Resource Manager retornarem detalhes de erro para operações com falha. (Isso também segue o formato de resposta de erro OData.).

Nome	Tipo	Description
error.additionalInfo	ErrorAdditionalInfo[]	As informações adicionais do erro.
error.code	string	O código de erro.
error.details	CloudErrorBody[]	Os detalhes do erro.
error.message	string	A mensagem de erro.
error.target	string	O destino do erro.

CloudErrorBody

O detalhe do erro.

Nome	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	As informações adicionais do erro.
code	string	O código de erro.
details	CloudErrorBody[]	Os detalhes do erro.
message	string	A mensagem de erro.
target	string	O destino do erro.

ConnectedWorkspace

Representa um workspace do OMS ao qual a solução está conectada

Nome	Tipo	Description
id	string	ID de recurso do Azure do workspace do OMS conectado

ErrorAdditionalInfo

As informações adicionais do erro de gerenciamento de recursos.

Nome	Tipo	Description
info	object	As informações adicionais.
type	string	O tipo de informação adicional.

ExternalSecuritySolutionKind

Descreve um recurso do Azure com tipo

Nome	Tipo	Description
kind	ExternalSecuritySolutionKind	O tipo da solução externa

Compartilhar via

External Security Solutions - Get

Parâmetros de URI

Respostas

Segurança

azure_auth

Escopos

Exemplos

Get external security solution

Solicitação de exemplo

Resposta de exemplo

Definições

AadConnectivityState

AadExternalSecuritySolution

AadSolutionProperties

AtaExternalSecuritySolution

AtaSolutionProperties

CefExternalSecuritySolution

CefSolutionProperties

CloudError

CloudErrorBody

ConnectedWorkspace

ErrorAdditionalInfo

ExternalSecuritySolutionKind

Recursos adicionais