Skip to content
This repository has been archived by the owner on May 5, 2023. It is now read-only.

[AutoPR security/resource-manager] Azure Security Center - break-to-composite v1 #4744

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion lib/services/securityManagement/LICENSE.txt
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
The MIT License (MIT)

Copyright (c) 2018 Microsoft
Copyright (c) 2019 Microsoft

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
29 changes: 16 additions & 13 deletions lib/services/securityManagement/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,38 +3,41 @@ uid: azure-arm-security
summary: *content

---
# Microsoft Azure SDK for Node.js - SecurityCenter
**This SDK will be deprecated next year and will be replaced by a new TypeScript-based isomorphic SDK (found at https://github.com/Azure/azure-sdk-for-js) which works on Node.js and browsers.**
## Microsoft Azure SDK for Node.js - SecurityCenter

This project provides a Node.js package for accessing Azure. Right now it supports:
- **Node.js version 6.x.x or higher**

## Features
### Features


## How to Install
### How to Install

```bash
npm install azure-arm-security
```

## How to use
### How to use

### Authentication, client creation and list pricings as an example.
#### Authentication, client creation, and list pricings as an example.

```javascript
const msRestAzure = require("ms-rest-azure");
const SecurityCenter = require("azure-arm-security");
msRestAzure.interactiveLogin().then((creds) => {
const subscriptionId = "<Subscription_Id>";
const client = new SecurityCenter(creds, subscriptionId);
return client.pricings.list().then((result) => {
console.log("The result is:");
console.log(result);
});
const subscriptionId = "<Subscription_Id>";
const client = new SecurityCenter(creds, subscriptionId);

return client.pricings.list().then((result) => {
console.log("The result is:");
console.log(result);
});
}).catch((err) => {
console.log('An error occurred:');
console.dir(err, {depth: null, colors: true});
});

## Related projects
```
### Related projects

- [Microsoft Azure SDK for Node.js](https://github.com/Azure/azure-sdk-for-node)
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
class AadConnectivityState1 {
/**
* Create a AadConnectivityState1.
* @member {string} [connectivityState] The connectivity state of the
* @property {string} [connectivityState] The connectivity state of the
* external AAD solution . Possible values include: 'Discovered',
* 'NotLicensed', 'Connected'
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,13 +21,13 @@ const models = require('./index');
class AadExternalSecuritySolution extends models['ExternalSecuritySolution'] {
/**
* Create a AadExternalSecuritySolution.
* @member {object} [properties]
* @member {string} [properties.deviceVendor]
* @member {string} [properties.deviceType]
* @member {object} [properties.workspace]
* @member {string} [properties.workspace.id] Azure resource ID of the
* @property {object} [properties]
* @property {string} [properties.deviceVendor]
* @property {string} [properties.deviceType]
* @property {object} [properties.workspace]
* @property {string} [properties.workspace.id] Azure resource ID of the
* connected OMS workspace
* @member {string} [properties.connectivityState] Possible values include:
* @property {string} [properties.connectivityState] Possible values include:
* 'Discovered', 'NotLicensed', 'Connected'
*/
constructor() {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,12 +17,12 @@
class AadSolutionProperties {
/**
* Create a AadSolutionProperties.
* @member {string} [deviceVendor]
* @member {string} [deviceType]
* @member {object} [workspace]
* @member {string} [workspace.id] Azure resource ID of the connected OMS
* @property {string} [deviceVendor]
* @property {string} [deviceType]
* @property {object} [workspace]
* @property {string} [workspace.id] Azure resource ID of the connected OMS
* workspace
* @member {string} [connectivityState] The connectivity state of the
* @property {string} [connectivityState] The connectivity state of the
* external AAD solution . Possible values include: 'Discovered',
* 'NotLicensed', 'Connected'
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,8 @@ const models = require('./index');
class AdvancedThreatProtectionSetting extends models['Resource'] {
/**
* Create a AdvancedThreatProtectionSetting.
* @member {boolean} [isEnabled] Indicates whether Advanced Threat Protection
* is enabled.
* @property {boolean} [isEnabled] Indicates whether Advanced Threat
* Protection is enabled.
*/
constructor() {
super();
Expand Down
63 changes: 37 additions & 26 deletions lib/services/securityManagement/lib/models/alert.js
Original file line number Diff line number Diff line change
Expand Up @@ -20,42 +20,45 @@ const models = require('./index');
class Alert extends models['Resource'] {
/**
* Create a Alert.
* @member {string} [state] State of the alert (Active, Dismissed etc.)
* @member {date} [reportedTimeUtc] The time the incident was reported to
* @property {string} [state] State of the alert (Active, Dismissed etc.)
* @property {date} [reportedTimeUtc] The time the incident was reported to
* Microsoft.Security in UTC
* @member {string} [vendorName] Name of the vendor that discovered the
* @property {string} [vendorName] Name of the vendor that discovered the
* incident
* @member {string} [alertName] Name of the alert type
* @member {string} [alertDisplayName] Display name of the alert type
* @member {date} [detectedTimeUtc] The time the incident was detected by the
* vendor
* @member {string} [description] Description of the incident and what it
* @property {string} [alertName] Name of the alert type
* @property {string} [alertDisplayName] Display name of the alert type
* @property {date} [detectedTimeUtc] The time the incident was detected by
* the vendor
* @property {string} [description] Description of the incident and what it
* means
* @member {string} [remediationSteps] Recommended steps to reradiate the
* @property {string} [remediationSteps] Recommended steps to reradiate the
* incident
* @member {string} [actionTaken] The action that was taken as a response to
* the alert (Active, Blocked etc.)
* @member {string} [reportedSeverity] Estimated severity of this alert
* @member {string} [compromisedEntity] The entity that the incident happened
* on
* @member {string} [associatedResource] Azure resource ID of the associated
* resource
* @member {object} [extendedProperties]
* @member {string} [systemSource] The type of the alerted resource (Azure,
* @property {string} [actionTaken] The action that was taken as a response
* to the alert (Active, Blocked etc.)
* @property {string} [reportedSeverity] Estimated severity of this alert.
* Possible values include: 'Silent', 'Information', 'Low', 'High'
* @property {string} [compromisedEntity] The entity that the incident
* happened on
* @property {string} [associatedResource] Azure resource ID of the
* associated resource
* @property {object} [extendedProperties]
* @property {string} [systemSource] The type of the alerted resource (Azure,
* Non-Azure)
* @member {boolean} [canBeInvestigated] Whether this alert can be
* @property {boolean} [canBeInvestigated] Whether this alert can be
* investigated with Azure Security Center
* @member {array} [entities] objects that are related to this alerts
* @member {number} [confidenceScore] level of confidence we have on the
* @property {boolean} [isIncident] Whether this alert is for incident type
* or not (otherwise - single alert)
* @property {array} [entities] objects that are related to this alerts
* @property {number} [confidenceScore] level of confidence we have on the
* alert
* @member {array} [confidenceReasons] reasons the alert got the
* @property {array} [confidenceReasons] reasons the alert got the
* confidenceScore value
* @member {string} [subscriptionId] Azure subscription ID of the resource
* @property {string} [subscriptionId] Azure subscription ID of the resource
* that had the security alert or the subscription ID of the workspace that
* this resource reports to
* @member {string} [instanceId] Instance ID of the alert.
* @member {string} [workspaceArmId] Azure resource ID of the workspace that
* the alert was reported to.
* @property {string} [instanceId] Instance ID of the alert.
* @property {string} [workspaceArmId] Azure resource ID of the workspace
* that the alert was reported to.
*/
constructor() {
super();
Expand Down Expand Up @@ -225,6 +228,14 @@ class Alert extends models['Resource'] {
name: 'Boolean'
}
},
isIncident: {
required: false,
readOnly: true,
serializedName: 'properties.isIncident',
type: {
name: 'Boolean'
}
},
entities: {
required: false,
serializedName: 'properties.entities',
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,8 @@
class AlertConfidenceReason {
/**
* Create a AlertConfidenceReason.
* @member {string} [type] Type of confidence factor
* @member {string} [reason] description of the confidence reason
* @property {string} [type] Type of confidence factor
* @property {string} [reason] description of the confidence reason
*/
constructor() {
}
Expand Down
2 changes: 1 addition & 1 deletion lib/services/securityManagement/lib/models/alertEntity.js
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
class AlertEntity {
/**
* Create a AlertEntity.
* @member {string} [type] Type of entity
* @property {string} [type] Type of entity
*/
constructor() {
}
Expand Down
2 changes: 1 addition & 1 deletion lib/services/securityManagement/lib/models/alertList.js
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
class AlertList extends Array {
/**
* Create a AlertList.
* @member {string} [nextLink] The URI to fetch the next page.
* @property {string} [nextLink] The URI to fetch the next page.
*/
constructor() {
super();
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
class AllowedConnectionsList extends Array {
/**
* Create a AllowedConnectionsList.
* @member {string} [nextLink] The URI to fetch the next page.
* @property {string} [nextLink] The URI to fetch the next page.
*/
constructor() {
super();
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,13 +18,13 @@
class AllowedConnectionsResource {
/**
* Create a AllowedConnectionsResource.
* @member {string} [id] Resource Id
* @member {string} [name] Resource name
* @member {string} [type] Resource type
* @member {string} [location] Location where the resource is stored
* @member {date} [calculatedDateTime] The UTC time on which the allowed
* @property {string} [id] Resource Id
* @property {string} [name] Resource name
* @property {string} [type] Resource type
* @property {string} [location] Location where the resource is stored
* @property {date} [calculatedDateTime] The UTC time on which the allowed
* connections resource was calculated
* @member {array} [connectableResources] List of connectable resources
* @property {array} [connectableResources] List of connectable resources
*/
constructor() {
}
Expand Down
2 changes: 1 addition & 1 deletion lib/services/securityManagement/lib/models/ascLocation.js
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ const models = require('./index');
class AscLocation extends models['Resource'] {
/**
* Create a AscLocation.
* @member {object} [properties]
* @property {object} [properties]
*/
constructor() {
super();
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
class AscLocationList extends Array {
/**
* Create a AscLocationList.
* @member {string} [nextLink] The URI to fetch the next page.
* @property {string} [nextLink] The URI to fetch the next page.
*/
constructor() {
super();
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,8 @@ const models = require('./index');
class AtaExternalSecuritySolution extends models['ExternalSecuritySolution'] {
/**
* Create a AtaExternalSecuritySolution.
* @member {object} [properties]
* @member {string} [properties.lastEventReceived]
* @property {object} [properties]
* @property {string} [properties.lastEventReceived]
*/
constructor() {
super();
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ const models = require('./index');
class AtaSolutionProperties extends models['ExternalSecuritySolutionProperties'] {
/**
* Create a AtaSolutionProperties.
* @member {string} [lastEventReceived]
* @property {string} [lastEventReceived]
*/
constructor() {
super();
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ const models = require('./index');
class AutoProvisioningSetting extends models['Resource'] {
/**
* Create a AutoProvisioningSetting.
* @member {string} autoProvision Describes what kind of security agent
* @property {string} autoProvision Describes what kind of security agent
* provisioning action to take. Possible values include: 'On', 'Off'
*/
constructor() {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
class AutoProvisioningSettingList extends Array {
/**
* Create a AutoProvisioningSettingList.
* @member {string} [nextLink] The URI to fetch the next page.
* @property {string} [nextLink] The URI to fetch the next page.
*/
constructor() {
super();
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,10 +20,10 @@ const models = require('./index');
class CefExternalSecuritySolution extends models['ExternalSecuritySolution'] {
/**
* Create a CefExternalSecuritySolution.
* @member {object} [properties]
* @member {string} [properties.hostname]
* @member {string} [properties.agent]
* @member {string} [properties.lastEventReceived]
* @property {object} [properties]
* @property {string} [properties.hostname]
* @property {string} [properties.agent]
* @property {string} [properties.lastEventReceived]
*/
constructor() {
super();
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,9 +20,9 @@ const models = require('./index');
class CefSolutionProperties extends models['ExternalSecuritySolutionProperties'] {
/**
* Create a CefSolutionProperties.
* @member {string} [hostname]
* @member {string} [agent]
* @member {string} [lastEventReceived]
* @property {string} [hostname]
* @property {string} [agent]
* @property {string} [lastEventReceived]
*/
constructor() {
super();
Expand Down
6 changes: 3 additions & 3 deletions lib/services/securityManagement/lib/models/compliance.js
Original file line number Diff line number Diff line change
Expand Up @@ -20,12 +20,12 @@ const models = require('./index');
class Compliance extends models['Resource'] {
/**
* Create a Compliance.
* @member {date} [assessmentTimestampUtcDate] The timestamp when the
* @property {date} [assessmentTimestampUtcDate] The timestamp when the
* Compliance calculation was conducted.
* @member {number} [resourceCount] The resource count of the given
* @property {number} [resourceCount] The resource count of the given
* subscription for which the Compliance calculation was conducted (needed
* for Management Group Compliance calculation).
* @member {array} [assessmentResult] An array of segment, which is the
* @property {array} [assessmentResult] An array of segment, which is the
* actually the compliance assessment.
*/
constructor() {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
class ComplianceList extends Array {
/**
* Create a ComplianceList.
* @member {string} [nextLink] The URI to fetch the next page.
* @property {string} [nextLink] The URI to fetch the next page.
*/
constructor() {
super();
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,9 @@
class ComplianceSegment {
/**
* Create a ComplianceSegment.
* @member {string} [segmentType] The segment type, e.g. compliant,
* @property {string} [segmentType] The segment type, e.g. compliant,
* non-compliance, insufficient coverage, N/A, etc.
* @member {number} [percentage] The size (%) of the segment.
* @property {number} [percentage] The size (%) of the segment.
*/
constructor() {
}
Expand Down
Loading