External Security Solutions - Get

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:

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

Sample response

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