Package-level declarations

Types

data class AdaptiveApplicationControlIssueSummaryResponse(val issue: String? = null, val numberOfVms: Double? = null)

Represents a summary of the alerts of the machine group

Link copied to clipboard
data class AdditionalWorkspacesPropertiesResponse(val dataTypes: List<String>? = null, val type: String? = null, val workspace: String? = null)

Properties of the additional workspaces.

Link copied to clipboard
data class AllowlistCustomAlertRuleResponse(val allowlistValues: List<String>, val description: String, val displayName: String, val isEnabled: Boolean, val ruleType: String, val valueType: String)

A custom alert rule that checks if a value (depends on the custom alert type) is allowed.

Link copied to clipboard
data class AssessmentLinksResponse(val azurePortalUri: String)

Links relevant to the assessment

Link copied to clipboard
data class AssessmentStatusResponse(val cause: String? = null, val code: String, val description: String? = null)

The result of the assessment

Link copied to clipboard
data class AssignedComponentItemResponse(val key: String? = null)

describe the properties of a security assessment object reference (by key)

Link copied to clipboard
data class AssignedStandardItemResponse(val id: String? = null)

describe the properties of a of a security standard object reference

data class AssignmentPropertiesResponseAdditionalData(val exemptionCategory: String? = null)

Additional data about the assignment

Link copied to clipboard
data class AutomationActionEventHubResponse(val actionType: String, val connectionString: String? = null, val eventHubResourceId: String? = null, val sasPolicyName: String)

The target Event Hub to which event data will be exported. To learn more about Microsoft Defender for Cloud continuous export capabilities, visit https://aka.ms/ASCExportLearnMore

Link copied to clipboard
data class AutomationActionLogicAppResponse(val actionType: String, val logicAppResourceId: String? = null, val uri: String? = null)

The logic app action that should be triggered. To learn more about Microsoft Defender for Cloud's Workflow Automation capabilities, visit https://aka.ms/ASCWorkflowAutomationLearnMore

Link copied to clipboard
data class AutomationActionWorkspaceResponse(val actionType: String, val workspaceResourceId: String? = null)

The Log Analytics Workspace to which event data will be exported. Security alerts data will reside in the 'SecurityAlert' table and the assessments data will reside in the 'SecurityRecommendation' table (under the 'Security'/'SecurityCenterFree' solutions). Note that in order to view the data in the workspace, the Security Center Log Analytics free/standard solution needs to be enabled on that workspace. To learn more about Microsoft Defender for Cloud continuous export capabilities, visit https://aka.ms/ASCExportLearnMore

Link copied to clipboard

A rule set which evaluates all its rules upon an event interception. Only when all the included rules in the rule set will be evaluated as 'true', will the event trigger the defined actions.

Link copied to clipboard
data class AutomationScopeResponse(val description: String? = null, val scopePath: String? = null)

A single automation scope.

Link copied to clipboard
data class AutomationSourceResponse(val eventSource: String? = null, val ruleSets: List<AutomationRuleSetResponse>? = null)

The source event types which evaluate the security automation set of rules. For example - security alerts and security assessments. To learn more about the supported security events data models schemas - please visit https://aka.ms/ASCAutomationSchemas.

Link copied to clipboard
data class AutomationTriggeringRuleResponse(val expectedValue: String? = null, val operator: String? = null, val propertyJPath: String? = null, val propertyType: String? = null)

A rule which is evaluated upon event interception. The rule is configured by comparing a specific value from the event model to an expected value. This comparison is done by using one of the supported operators set.

data class AwAssumeRoleAuthenticationDetailsPropertiesResponse(val accountId: String, val authenticationProvisioningState: String, val authenticationType: String, val awsAssumeRoleArn: String, val awsExternalId: String, val grantedPermissions: List<String>)

AWS cloud account connector based assume role, the role enables delegating access to your AWS resources. The role is composed of role Amazon Resource Name (ARN) and external ID. For more details, refer to Creating a Role to Delegate Permissions to an IAM User (write only)

data class AwsCredsAuthenticationDetailsPropertiesResponse(val accountId: String, val authenticationProvisioningState: String, val authenticationType: String, val awsAccessKeyId: String, val awsSecretAccessKey: String, val grantedPermissions: List<String>)

AWS cloud account connector based credentials, the credentials is composed of access key ID and secret key, for more details, refer to Creating an IAM User in Your AWS Account (write only)

Link copied to clipboard
data class AzureResourceDetailsResponse(val id: String, val source: String)

Details of the Azure resource that was assessed

Link copied to clipboard
data class CspmMonitorAwsOfferingResponse(val description: String, val nativeCloudConnection: CspmMonitorAwsOfferingResponseNativeCloudConnection? = null, val offeringType: String)

The CSPM monitoring for AWS offering configurations

data class CspmMonitorAwsOfferingResponseNativeCloudConnection(val cloudRoleArn: String? = null)

The native cloud connection configuration

Link copied to clipboard

The Defender for Containers AWS offering configurations

The cloudwatch to kinesis connection configuration

data class DefenderForContainersAwsOfferingResponseKinesisToS3(val cloudRoleArn: String? = null)

The kinesis to s3 connection configuration

The kubernetes to scuba connection configuration

The kubernetes service connection configuration

Link copied to clipboard
data class DefenderForServersAwsOfferingResponse(val arcAutoProvisioning: DefenderForServersAwsOfferingResponseArcAutoProvisioning? = null, val defenderForServers: DefenderForServersAwsOfferingResponseDefenderForServers? = null, val description: String, val offeringType: String)

The Defender for Servers AWS offering configurations

The ARC autoprovisioning configuration

The Defender for servers connection configuration

data class DefenderForServersAwsOfferingResponseServicePrincipalSecretMetadata(val expiryDate: String? = null, val parameterNameInStore: String? = null, val parameterStoreRegion: String? = null)

Metadata of Service Principal secret for autoprovisioning

Link copied to clipboard
data class DenylistCustomAlertRuleResponse(val denylistValues: List<String>, val description: String, val displayName: String, val isEnabled: Boolean, val ruleType: String, val valueType: String)

A custom alert rule that checks if a value (depends on the custom alert type) is denied.

Link copied to clipboard
data class GcpCredentialsDetailsPropertiesResponse(val authProviderX509CertUrl: String, val authUri: String, val authenticationProvisioningState: String, val authenticationType: String, val clientEmail: String, val clientId: String, val clientX509CertUrl: String, val grantedPermissions: List<String>, val organizationId: String, val privateKey: String, val privateKeyId: String, val projectId: String, val tokenUri: String, val type: String)

GCP cloud account connector based service to service credentials, the credentials are composed of the organization ID and a JSON API key (write only)

Link copied to clipboard
data class GetAdaptiveApplicationControlResult(val configurationStatus: String, val enforcementMode: String? = null, val id: String, val issues: List<AdaptiveApplicationControlIssueSummaryResponse>, val location: String, val name: String, val pathRecommendations: List<PathRecommendationResponse>? = null, val protectionMode: ProtectionModeResponse? = null, val recommendationStatus: String, val sourceSystem: String, val type: String, val vmRecommendations: List<VmRecommendationResponse>? = null)
Link copied to clipboard
data class GetAdvancedThreatProtectionResult(val id: String, val isEnabled: Boolean? = null, val name: String, val type: String)

The Advanced Threat Protection resource.

Link copied to clipboard
data class GetAlertsSuppressionRuleResult(val alertType: String, val comment: String? = null, val expirationDateUtc: String? = null, val id: String, val lastModifiedUtc: String, val name: String, val reason: String, val state: String, val suppressionAlertsScope: SuppressionAlertsScopeResponse? = null, val type: String)

Describes the suppression rule

Link copied to clipboard
data class GetApplicationResult(val description: String? = null, val displayName: String? = null, val id: String, val name: String, val sourceResourceType: String, val type: String)

Security Application over a given scope

data class GetAssessmentMetadataInSubscriptionResult(val assessmentType: String, val categories: List<String>? = null, val description: String? = null, val displayName: String, val id: String, val implementationEffort: String? = null, val name: String, val partnerData: SecurityAssessmentMetadataPartnerDataResponse? = null, val policyDefinitionId: String, val preview: Boolean? = null, val remediationDescription: String? = null, val severity: String, val threats: List<String>? = null, val type: String, val userImpact: String? = null)

Security assessment metadata

Link copied to clipboard
data class GetAssessmentResult(val additionalData: Map<String, String>? = null, val displayName: String, val id: String, val links: AssessmentLinksResponse, val metadata: SecurityAssessmentMetadataPropertiesResponse? = null, val name: String, val partnersData: SecurityAssessmentPartnerDataResponse? = null, val resourceDetails: Any, val status: AssessmentStatusResponse, val type: String)

Security assessment on a resource

Link copied to clipboard
data class GetAssignmentResult(val additionalData: AssignmentPropertiesResponseAdditionalData? = null, val assignedComponent: AssignedComponentItemResponse? = null, val assignedStandard: AssignedStandardItemResponse? = null, val description: String? = null, val displayName: String? = null, val effect: String? = null, val etag: String? = null, val expiresOn: String? = null, val id: String, val kind: String? = null, val location: String? = null, val metadata: Any? = null, val name: String, val scope: String? = null, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val type: String)

Security Assignment on a resource group over a given scope

Link copied to clipboard
data class GetAutomationResult(val actions: List<Any>? = null, val description: String? = null, val etag: String? = null, val id: String, val isEnabled: Boolean? = null, val kind: String? = null, val location: String? = null, val name: String, val scopes: List<AutomationScopeResponse>? = null, val sources: List<AutomationSourceResponse>? = null, val tags: Map<String, String>? = null, val type: String)

The security automation resource.

Link copied to clipboard
data class GetConnectorResult(val authenticationDetails: Any? = null, val hybridComputeSettings: HybridComputeSettingsPropertiesResponse? = null, val id: String, val name: String, val type: String)

The connector setting

Link copied to clipboard
data class GetCustomAssessmentAutomationResult(val assessmentKey: String? = null, val compressedQuery: String? = null, val description: String? = null, val displayName: String? = null, val id: String, val name: String, val remediationDescription: String? = null, val severity: String? = null, val supportedCloud: String? = null, val systemData: SystemDataResponse, val type: String)

Custom Assessment Automation

Link copied to clipboard
data class GetCustomEntityStoreAssignmentResult(val entityStoreDatabaseLink: String? = null, val id: String, val name: String, val principal: String? = null, val systemData: SystemDataResponse, val type: String)

Custom entity store assignment

Link copied to clipboard
data class GetDeviceSecurityGroupResult(val allowlistRules: List<AllowlistCustomAlertRuleResponse>? = null, val denylistRules: List<DenylistCustomAlertRuleResponse>? = null, val id: String, val name: String, val thresholdRules: List<ThresholdCustomAlertRuleResponse>? = null, val timeWindowRules: List<TimeWindowCustomAlertRuleResponse>? = null, val type: String)

The device security group resource

Link copied to clipboard
data class GetIngestionSettingResult(val id: String, val name: String, val type: String)

Configures how to correlate scan data and logs with resources associated with the subscription.

Link copied to clipboard
data class GetIotSecuritySolutionResult(val additionalWorkspaces: List<AdditionalWorkspacesPropertiesResponse>? = null, val autoDiscoveredResources: List<String>, val disabledDataSources: List<String>? = null, val displayName: String, val export: List<String>? = null, val id: String, val iotHubs: List<String>, val location: String? = null, val name: String, val recommendationsConfiguration: List<RecommendationConfigurationPropertiesResponse>? = null, val status: String? = null, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val type: String, val unmaskedIpLoggingStatus: String? = null, val userDefinedResources: UserDefinedResourcesPropertiesResponse? = null, val workspace: String? = null)

IoT Security solution configuration and resource information.

Link copied to clipboard
data class GetJitNetworkAccessPolicyResult(val id: String, val kind: String? = null, val location: String, val name: String, val provisioningState: String, val requests: List<JitNetworkAccessRequestResponse>? = null, val type: String, val virtualMachines: List<JitNetworkAccessPolicyVirtualMachineResponse>)
Link copied to clipboard
data class GetSecurityConnectorApplicationResult(val description: String? = null, val displayName: String? = null, val id: String, val name: String, val sourceResourceType: String, val type: String)

Security Application over a given scope

Link copied to clipboard
data class GetSecurityConnectorResult(val cloudName: String? = null, val etag: String? = null, val hierarchyIdentifier: String? = null, val id: String, val kind: String? = null, val location: String? = null, val name: String, val offerings: List<Any>? = null, val organizationalData: SecurityConnectorPropertiesResponseOrganizationalData? = null, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val type: String)

The security connector resource.

Link copied to clipboard
data class GetSecurityContactResult(val alertNotifications: SecurityContactPropertiesResponseAlertNotifications? = null, val emails: String? = null, val id: String, val name: String, val notificationsByRole: SecurityContactPropertiesResponseNotificationsByRole? = null, val phone: String? = null, val type: String)

Contact details and configurations for notifications coming from Microsoft Defender for Cloud.

Link copied to clipboard
data class GetServerVulnerabilityAssessmentResult(val id: String, val name: String, val provisioningState: String, val type: String)

Describes the server vulnerability assessment details on a resource

data class GetSqlVulnerabilityAssessmentBaselineRuleResult(val id: String, val name: String, val properties: RuleResultsPropertiesResponse, val type: String)

Rule results.

Link copied to clipboard
data class GetStandardResult(val category: String? = null, val components: List<StandardComponentPropertiesResponse>? = null, val description: String? = null, val displayName: String? = null, val etag: String? = null, val id: String, val kind: String? = null, val location: String? = null, val name: String, val standardType: String, val supportedClouds: List<String>? = null, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val type: String)

Security Standard on a resource

Link copied to clipboard
data class GetWorkspaceSettingResult(val id: String, val name: String, val scope: String, val type: String, val workspaceId: String)

Configures where to store the OMS agent data for workspaces under a scope

Link copied to clipboard
data class HybridComputeSettingsPropertiesResponse(val autoProvision: String, val hybridComputeProvisioningState: String, val proxyServer: ProxyServerPropertiesResponse? = null, val region: String? = null, val resourceGroupName: String? = null, val servicePrincipal: ServicePrincipalPropertiesResponse? = null)

Settings for hybrid compute management

Link copied to clipboard
data class InformationProtectionAwsOfferingResponse(val description: String, val informationProtection: InformationProtectionAwsOfferingResponseInformationProtection? = null, val offeringType: String)

The information protection for AWS offering configurations

The native cloud connection configuration

Link copied to clipboard
data class IngestionConnectionStringResponse(val location: String, val value: String)

Connection string for ingesting security data and logs

data class JitNetworkAccessPolicyVirtualMachineResponse(val id: String, val ports: List<JitNetworkAccessPortRuleResponse>, val publicIpAddress: String? = null)
Link copied to clipboard
data class JitNetworkAccessPortRuleResponse(val allowedSourceAddressPrefix: String? = null, val allowedSourceAddressPrefixes: List<String>? = null, val maxRequestAccessDuration: String, val number: Int, val protocol: String)
Link copied to clipboard
data class JitNetworkAccessRequestPortResponse(val allowedSourceAddressPrefix: String? = null, val allowedSourceAddressPrefixes: List<String>? = null, val endTimeUtc: String, val mappedPort: Int? = null, val number: Int, val status: String, val statusReason: String)
Link copied to clipboard
data class JitNetworkAccessRequestResponse(val justification: String? = null, val requestor: String, val startTimeUtc: String, val virtualMachines: List<JitNetworkAccessRequestVirtualMachineResponse>)

Connection string for ingesting security data and logs

Link copied to clipboard

Configures how to correlate scan data and logs with resources associated with the subscription.

Link copied to clipboard
data class OnPremiseResourceDetailsResponse(val machineName: String, val source: String, val sourceComputerId: String, val vmuuid: String, val workspaceId: String)

Details of the On Premise resource that was assessed

Link copied to clipboard
data class OnPremiseSqlResourceDetailsResponse(val databaseName: String, val machineName: String, val serverName: String, val source: String, val sourceComputerId: String, val vmuuid: String, val workspaceId: String)

Details of the On Premise Sql resource that was assessed

Link copied to clipboard
data class PathRecommendationResponse(val action: String? = null, val common: Boolean? = null, val configurationStatus: String? = null, val fileType: String? = null, val path: String? = null, val publisherInfo: PublisherInfoResponse? = null, val type: String? = null, val userSids: List<String>? = null, val usernames: List<UserRecommendationResponse>? = null)

Represents a path that is recommended to be allowed and its properties

Link copied to clipboard
data class ProtectionModeResponse(val exe: String? = null, val executable: String? = null, val msi: String? = null, val script: String? = null)

The protection mode of the collection/file types. Exe/Msi/Script are used for Windows, Executable is used for Linux.

Link copied to clipboard
data class ProxyServerPropertiesResponse(val ip: String? = null, val port: String? = null)

For a non-Azure machine that is not connected directly to the internet, specify a proxy server that the non-Azure machine can use.

Link copied to clipboard
data class PublisherInfoResponse(val binaryName: String? = null, val productName: String? = null, val publisherName: String? = null, val version: String? = null)

Represents the publisher information of a process/rule

data class RecommendationConfigurationPropertiesResponse(val name: String, val recommendationType: String, val status: String)

The type of IoT Security recommendation.

Link copied to clipboard
data class RuleResultsPropertiesResponse(val results: List<List<String>>? = null)

Rule results properties.

Link copied to clipboard
data class ScopeElementResponse(val field: String? = null)

A more specific scope used to identify the alerts to suppress.

data class SecurityAssessmentMetadataPartnerDataResponse(val partnerName: String, val productName: String? = null, val secret: String)

Describes the partner that created the assessment

data class SecurityAssessmentMetadataPropertiesResponse(val assessmentType: String, val categories: List<String>? = null, val description: String? = null, val displayName: String, val implementationEffort: String? = null, val partnerData: SecurityAssessmentMetadataPartnerDataResponse? = null, val policyDefinitionId: String, val preview: Boolean? = null, val remediationDescription: String? = null, val severity: String, val threats: List<String>? = null, val userImpact: String? = null)

Describes properties of an assessment metadata.

Link copied to clipboard
data class SecurityAssessmentPartnerDataResponse(val partnerName: String, val secret: String)

Data regarding 3rd party partner integration

data class SecurityConnectorPropertiesResponseOrganizationalData(val excludedAccountIds: List<String>? = null, val organizationMembershipType: String? = null, val parentHierarchyId: String? = null, val stacksetName: String? = null)

The multi cloud account's organizational data

data class SecurityContactPropertiesResponseAlertNotifications(val minimalSeverity: String? = null, val state: String? = null)

Defines whether to send email notifications about new security alerts

data class SecurityContactPropertiesResponseNotificationsByRole(val roles: List<String>? = null, val state: String? = null)

Defines whether to send email notifications from Microsoft Defender for Cloud to persons with specific RBAC roles on the subscription.

Link copied to clipboard
data class ServicePrincipalPropertiesResponse(val applicationId: String? = null, val secret: String? = null)

Details of the service principal.

Link copied to clipboard
data class StandardComponentPropertiesResponse(val key: String? = null)

Describes properties of an component as related to the standard

Link copied to clipboard
data class SystemDataResponse(val createdAt: String? = null, val createdBy: String? = null, val createdByType: String? = null, val lastModifiedAt: String? = null, val lastModifiedBy: String? = null, val lastModifiedByType: String? = null)

Metadata pertaining to creation and last modification of the resource.

Link copied to clipboard
data class ThresholdCustomAlertRuleResponse(val description: String, val displayName: String, val isEnabled: Boolean, val maxThreshold: Int, val minThreshold: Int, val ruleType: String)

A custom alert rule that checks if a value (depends on the custom alert type) is within the given range.

Link copied to clipboard
data class TimeWindowCustomAlertRuleResponse(val description: String, val displayName: String, val isEnabled: Boolean, val maxThreshold: Int, val minThreshold: Int, val ruleType: String, val timeWindowSize: String)

A custom alert rule that checks if the number of activities (depends on the custom alert type) in a time window is within the given range.

Link copied to clipboard
data class UserDefinedResourcesPropertiesResponse(val query: String, val querySubscriptions: List<String>)

Properties of the IoT Security solution's user defined resources.

Link copied to clipboard
data class UserRecommendationResponse(val recommendationAction: String? = null, val username: String? = null)

Represents a user that is recommended to be allowed for a certain rule

Link copied to clipboard
data class VmRecommendationResponse(val configurationStatus: String? = null, val enforcementSupport: String? = null, val recommendationAction: String? = null, val resourceId: String? = null)

Represents a machine that is part of a machine group