Skip to content
Closed
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
33 changes: 17 additions & 16 deletions sdk/security/arm-security/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,6 @@
# Release History

## 6.0.0-beta.2 (Unreleased)

### Features Added

### Breaking Changes

### Bugs Fixed

### Other Changes

## 6.0.0-beta.1 (2022-09-14)

## 6.0.0-beta.2 (2022-11-03)

**Features**

Expand Down Expand Up @@ -66,7 +56,7 @@
- Added Interface AutoProvisioningSetting
- Added Interface AwAssumeRoleAuthenticationDetailsProperties
- Added Interface AwsCredsAuthenticationDetailsProperties
- Added Interface AWSEnvironmentData
- Added Interface AwsEnvironmentData
- Added Interface AwsOrganizationalData
- Added Interface AwsOrganizationalDataMaster
- Added Interface AwsOrganizationalDataMember
Expand All @@ -91,9 +81,13 @@
- Added Interface CustomAssessmentAutomationRequest
- Added Interface CustomEntityStoreAssignment
- Added Interface DataExportSettings
- Added Interface DefenderCspmAwsOffering
- Added Interface DefenderCspmAwsOfferingVmScanners
- Added Interface DefenderCspmAwsOfferingVmScannersConfiguration
- Added Interface DefenderCspmGcpOffering
- Added Interface DefenderFoDatabasesAwsOffering
- Added Interface DefenderFoDatabasesAwsOfferingArcAutoProvisioning
- Added Interface DefenderFoDatabasesAwsOfferingArcAutoProvisioningServicePrincipalSecretMetadata
- Added Interface DefenderFoDatabasesAwsOfferingRds
- Added Interface DefenderForContainersAwsOffering
- Added Interface DefenderForContainersAwsOfferingContainerVulnerabilityAssessment
- Added Interface DefenderForContainersAwsOfferingContainerVulnerabilityAssessmentTask
Expand All @@ -102,8 +96,9 @@
- Added Interface DefenderForContainersGcpOfferingNativeCloudConnection
- Added Interface DefenderForDatabasesGcpOffering
- Added Interface DefenderForDatabasesGcpOfferingArcAutoProvisioning
- Added Interface DefenderForDatabasesGcpOfferingArcAutoProvisioningConfiguration
- Added Interface DefenderForDatabasesGcpOfferingDefenderForDatabasesArcAutoProvisioning
- Added Interface DefenderForDevOpsAzureDevOpsOffering
- Added Interface DefenderForDevOpsGithubOffering
- Added Interface DefenderForServersAwsOffering
- Added Interface DefenderForServersAwsOfferingMdeAutoProvisioning
- Added Interface DefenderForServersAwsOfferingSubPlan
Expand All @@ -113,7 +108,6 @@
- Added Interface DefenderForServersAwsOfferingVmScannersConfiguration
- Added Interface DefenderForServersGcpOffering
- Added Interface DefenderForServersGcpOfferingArcAutoProvisioning
- Added Interface DefenderForServersGcpOfferingArcAutoProvisioningConfiguration
- Added Interface DefenderForServersGcpOfferingDefenderForServers
- Added Interface DefenderForServersGcpOfferingMdeAutoProvisioning
- Added Interface DefenderForServersGcpOfferingSubPlan
Expand Down Expand Up @@ -240,6 +234,7 @@
- Added Type Alias ApplicationsListResponse
- Added Type Alias ApplicationSourceResourceType
- Added Type Alias AwsOrganizationalDataUnion
- Added Type Alias ConnectionType
- Added Type Alias EnvironmentDataUnion
- Added Type Alias EnvironmentType
- Added Type Alias GcpOrganizationalDataUnion
Expand Down Expand Up @@ -305,16 +300,22 @@
- Enum KnownOfferingType has a new value CspmMonitorAzureDevOps
- Enum KnownOfferingType has a new value CspmMonitorGcp
- Enum KnownOfferingType has a new value CspmMonitorGithub
- Enum KnownOfferingType has a new value DefenderCspmAws
- Enum KnownOfferingType has a new value DefenderCspmGcp
- Enum KnownOfferingType has a new value DefenderForContainersGcp
- Enum KnownOfferingType has a new value DefenderForDatabasesAws
- Enum KnownOfferingType has a new value DefenderForDatabasesGcp
- Enum KnownOfferingType has a new value DefenderForDevOpsAzureDevOps
- Enum KnownOfferingType has a new value DefenderForDevOpsGithub
- Enum KnownOfferingType has a new value DefenderForServersGcp
- Enum KnownSettingName has a new value WdatpUnifiedSolution

**Breaking Changes**

- Removed operation Alerts.simulate
- Removed operation SecurityContacts.update
- Operation AllowedConnections.get has a new signature
- Interface DefenderForServersAwsOfferingArcAutoProvisioning no longer has parameter servicePrincipalSecretMetadata
- Removed Enum KnownAlertNotifications
- Removed Enum KnownAlertsToAdmins

Expand Down
14 changes: 7 additions & 7 deletions sdk/security/arm-security/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Azure Service client library for JavaScript
# Azure SecurityCenter client library for JavaScript

This package contains an isomorphic SDK (runs both in Node.js and in browsers) for Azure Service client.
This package contains an isomorphic SDK (runs both in Node.js and in browsers) for Azure SecurityCenter client.

API spec for Microsoft.Security (Azure Security Center) resource provider

Expand All @@ -24,16 +24,16 @@ See our [support policy](https://github.com/Azure/azure-sdk-for-js/blob/main/SUP

### Install the `@azure/arm-security` package

Install the Azure Service client library for JavaScript with `npm`:
Install the Azure SecurityCenter client library for JavaScript with `npm`:

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

### Create and authenticate a `SecurityCenter`

To create a client object to access the Azure Service API, you will need the `endpoint` of your Azure Service resource and a `credential`. The Azure Service client can use Azure Active Directory credentials to authenticate.
You can find the endpoint for your Azure Service resource in the [Azure Portal][azure_portal].
To create a client object to access the Azure SecurityCenter API, you will need the `endpoint` of your Azure SecurityCenter resource and a `credential`. The Azure SecurityCenter client can use Azure Active Directory credentials to authenticate.
You can find the endpoint for your Azure SecurityCenter resource in the [Azure Portal][azure_portal].

You can authenticate with Azure Active Directory using a credential from the [@azure/identity][azure_identity] library or [an existing AAD Token](https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/identity/identity/samples/AzureIdentityExamples.md#authenticating-with-a-pre-fetched-access-token).

Expand All @@ -43,7 +43,7 @@ To use the [DefaultAzureCredential][defaultazurecredential] provider shown below
npm install @azure/identity
```

You will also need to **register a new AAD application and grant access to Azure Service** by assigning the suitable role to your service principal (note: roles such as `"Owner"` will not grant the necessary permissions).
You will also need to **register a new AAD application and grant access to Azure SecurityCenter** by assigning the suitable role to your service principal (note: roles such as `"Owner"` will not grant the necessary permissions).
Set the values of the client ID, tenant ID, and client secret of the AAD application as environment variables: `AZURE_CLIENT_ID`, `AZURE_TENANT_ID`, `AZURE_CLIENT_SECRET`.

For more information about how to create an Azure AD Application check out [this guide](https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal).
Expand Down Expand Up @@ -72,7 +72,7 @@ To use this client library in the browser, first you need to use a bundler. For

### SecurityCenter

`SecurityCenter` is the primary interface for developers using the Azure Service client library. Explore the methods on this client object to understand the different features of the Azure Service service that you can access.
`SecurityCenter` is the primary interface for developers using the Azure SecurityCenter client library. Explore the methods on this client object to understand the different features of the Azure SecurityCenter service that you can access.

## Troubleshooting

Expand Down
8 changes: 4 additions & 4 deletions sdk/security/arm-security/_meta.json
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
{
"commit": "af1be2677e619e483210064ff658e62ec25053aa",
"commit": "f3204698625c0aa0b4c1ebf4cfa1a8bcc890a134",
"readme": "specification/security/resource-manager/readme.md",
"autorest_command": "autorest --version=3.8.4 --typescript --modelerfour.lenient-model-deduplication --azure-arm --head-as-boolean=true --license-header=MICROSOFT_MIT_NO_VERSION --generate-test --typescript-sdks-folder=D:\\Git\\azure-sdk-for-js ..\\azure-rest-api-specs\\specification\\security\\resource-manager\\readme.md --use=@autorest/[email protected].1.20220727.1 --generate-sample=true",
"autorest_command": "autorest --version=3.8.4 --typescript --modelerfour.lenient-model-deduplication --azure-arm --head-as-boolean=true --license-header=MICROSOFT_MIT_NO_VERSION --generate-test --typescript-sdks-folder=/mnt/vss/_work/1/s/azure-sdk-for-js ../azure-rest-api-specs/specification/security/resource-manager/readme.md --use=@autorest/[email protected].2",
"repository_url": "https://github.com/Azure/azure-rest-api-specs.git",
"release_tool": "@azure-tools/js-sdk-release-tools@2.4.2",
"use": "@autorest/[email protected].1.20220727.1"
"release_tool": "@azure-tools/js-sdk-release-tools@2.5.0",
"use": "@autorest/[email protected].2"
}
12 changes: 2 additions & 10 deletions sdk/security/arm-security/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -109,13 +109,5 @@
}
]
},
"autoPublish": true,
"//sampleConfiguration": {
"productName": "",
"productSlugs": [
"azure"
],
"disableDocsMs": true,
"apiRefLink": "https://docs.microsoft.com/javascript/api/@azure/arm-security?view=azure-node-preview"
}
}
"autoPublish": true
}
84 changes: 52 additions & 32 deletions sdk/security/arm-security/review/arm-security.api.md
Original file line number Diff line number Diff line change
Expand Up @@ -995,7 +995,7 @@ export interface AwsCredsAuthenticationDetailsProperties extends AuthenticationD
}

// @public
export interface AWSEnvironmentData extends EnvironmentData {
export interface AwsEnvironmentData extends EnvironmentData {
environmentType: "AwsAccount";
organizationalData?: AwsOrganizationalDataUnion;
}
Expand Down Expand Up @@ -1113,11 +1113,11 @@ export type CloudName = string;
// @public
export interface CloudOffering {
readonly description?: string;
offeringType: "CspmMonitorAws" | "DefenderForContainersAws" | "DefenderForServersAws" | "DefenderForDatabasesAws" | "InformationProtectionAws" | "CspmMonitorGcp" | "DefenderForServersGcp" | "DefenderForDatabasesGcp" | "DefenderForContainersGcp" | "CspmMonitorGithub" | "CspmMonitorAzureDevOps";
offeringType: "CspmMonitorAws" | "DefenderForContainersAws" | "DefenderForServersAws" | "DefenderForDatabasesAws" | "InformationProtectionAws" | "CspmMonitorGcp" | "DefenderForServersGcp" | "DefenderForDatabasesGcp" | "DefenderForContainersGcp" | "CspmMonitorGithub" | "CspmMonitorAzureDevOps" | "DefenderCspmAws" | "DefenderCspmGcp" | "DefenderForDevOpsGithub" | "DefenderForDevOpsAzureDevOps";
}

// @public (undocumented)
export type CloudOfferingUnion = CloudOffering | CspmMonitorAwsOffering | DefenderForContainersAwsOffering | DefenderForServersAwsOffering | DefenderFoDatabasesAwsOffering | InformationProtectionAwsOffering | CspmMonitorGcpOffering | DefenderForServersGcpOffering | DefenderForDatabasesGcpOffering | DefenderForContainersGcpOffering | CspmMonitorGithubOffering | CspmMonitorAzureDevOpsOffering;
export type CloudOfferingUnion = CloudOffering | CspmMonitorAwsOffering | DefenderForContainersAwsOffering | DefenderForServersAwsOffering | DefenderFoDatabasesAwsOffering | InformationProtectionAwsOffering | CspmMonitorGcpOffering | DefenderForServersGcpOffering | DefenderForDatabasesGcpOffering | DefenderForContainersGcpOffering | CspmMonitorGithubOffering | CspmMonitorAzureDevOpsOffering | DefenderCspmAwsOffering | DefenderCspmGcpOffering | DefenderForDevOpsGithubOffering | DefenderForDevOpsAzureDevOpsOffering;

// @public
export interface Compliance extends Resource {
Expand Down Expand Up @@ -1543,24 +1543,49 @@ export interface DataExportSettings extends Setting {
// @public
export type DataSource = string;

// @public
export interface DefenderCspmAwsOffering extends CloudOffering {
offeringType: "DefenderCspmAws";
vmScanners?: DefenderCspmAwsOfferingVmScanners;
}

// @public
export interface DefenderCspmAwsOfferingVmScanners {
configuration?: DefenderCspmAwsOfferingVmScannersConfiguration;
enabled?: boolean;
}

// @public
export interface DefenderCspmAwsOfferingVmScannersConfiguration {
cloudRoleArn?: string;
exclusionTags?: {
[propertyName: string]: string;
};
scanningMode?: ScanningMode;
}

// @public
export interface DefenderCspmGcpOffering extends CloudOffering {
offeringType: "DefenderCspmGcp";
}

// @public
export interface DefenderFoDatabasesAwsOffering extends CloudOffering {
arcAutoProvisioning?: DefenderFoDatabasesAwsOfferingArcAutoProvisioning;
offeringType: "DefenderForDatabasesAws";
rds?: DefenderFoDatabasesAwsOfferingRds;
}

// @public
export interface DefenderFoDatabasesAwsOfferingArcAutoProvisioning {
cloudRoleArn?: string;
enabled?: boolean;
servicePrincipalSecretMetadata?: DefenderFoDatabasesAwsOfferingArcAutoProvisioningServicePrincipalSecretMetadata;
}

// @public
export interface DefenderFoDatabasesAwsOfferingArcAutoProvisioningServicePrincipalSecretMetadata {
expiryDate?: Date;
parameterNameInStore?: string;
parameterStoreRegion?: string;
export interface DefenderFoDatabasesAwsOfferingRds {
cloudRoleArn?: string;
enabled?: boolean;
}

// @public
Expand Down Expand Up @@ -1639,22 +1664,25 @@ export interface DefenderForDatabasesGcpOffering extends CloudOffering {

// @public
export interface DefenderForDatabasesGcpOfferingArcAutoProvisioning {
configuration?: DefenderForDatabasesGcpOfferingArcAutoProvisioningConfiguration;
enabled?: boolean;
}

// @public
export interface DefenderForDatabasesGcpOfferingArcAutoProvisioningConfiguration {
agentOnboardingServiceAccountNumericId?: string;
clientId?: string;
}

// @public
export interface DefenderForDatabasesGcpOfferingDefenderForDatabasesArcAutoProvisioning {
serviceAccountEmailAddress?: string;
workloadIdentityProviderId?: string;
}

// @public
export interface DefenderForDevOpsAzureDevOpsOffering extends CloudOffering {
offeringType: "DefenderForDevOpsAzureDevOps";
}

// @public
export interface DefenderForDevOpsGithubOffering extends CloudOffering {
offeringType: "DefenderForDevOpsGithub";
}

// @public
export interface DefenderForServersAwsOffering extends CloudOffering {
arcAutoProvisioning?: DefenderForServersAwsOfferingArcAutoProvisioning;
Expand All @@ -1670,14 +1698,6 @@ export interface DefenderForServersAwsOffering extends CloudOffering {
export interface DefenderForServersAwsOfferingArcAutoProvisioning {
cloudRoleArn?: string;
enabled?: boolean;
servicePrincipalSecretMetadata?: DefenderForServersAwsOfferingArcAutoProvisioningServicePrincipalSecretMetadata;
}

// @public
export interface DefenderForServersAwsOfferingArcAutoProvisioningServicePrincipalSecretMetadata {
expiryDate?: string;
parameterNameInStore?: string;
parameterStoreRegion?: string;
}

// @public
Expand Down Expand Up @@ -1716,7 +1736,9 @@ export interface DefenderForServersAwsOfferingVmScanners {
// @public
export interface DefenderForServersAwsOfferingVmScannersConfiguration {
cloudRoleArn?: string;
exclusionTags?: Record<string, unknown>;
exclusionTags?: {
[propertyName: string]: string;
};
scanningMode?: ScanningMode;
}

Expand All @@ -1732,16 +1754,9 @@ export interface DefenderForServersGcpOffering extends CloudOffering {

// @public
export interface DefenderForServersGcpOfferingArcAutoProvisioning {
configuration?: DefenderForServersGcpOfferingArcAutoProvisioningConfiguration;
enabled?: boolean;
}

// @public
export interface DefenderForServersGcpOfferingArcAutoProvisioningConfiguration {
agentOnboardingServiceAccountNumericId?: string;
clientId?: string;
}

// @public
export interface DefenderForServersGcpOfferingDefenderForServers {
serviceAccountEmailAddress?: string;
Expand Down Expand Up @@ -1916,7 +1931,7 @@ export interface EnvironmentData {
}

// @public (undocumented)
export type EnvironmentDataUnion = EnvironmentData | AWSEnvironmentData | GcpProjectEnvironmentData | GithubScopeEnvironmentData | AzureDevOpsScopeEnvironmentData;
export type EnvironmentDataUnion = EnvironmentData | AwsEnvironmentData | GcpProjectEnvironmentData | GithubScopeEnvironmentData | AzureDevOpsScopeEnvironmentData;

// @public
export type EnvironmentType = string;
Expand Down Expand Up @@ -2994,6 +3009,7 @@ export enum KnownAlertStatus {
// @public
export enum KnownApplicationConditionOperator {
Contains = "Contains",
Equals = "Equals",
In = "In"
}

Expand Down Expand Up @@ -3276,10 +3292,14 @@ export enum KnownOfferingType {
CspmMonitorAzureDevOps = "CspmMonitorAzureDevOps",
CspmMonitorGcp = "CspmMonitorGcp",
CspmMonitorGithub = "CspmMonitorGithub",
DefenderCspmAws = "DefenderCspmAws",
DefenderCspmGcp = "DefenderCspmGcp",
DefenderForContainersAws = "DefenderForContainersAws",
DefenderForContainersGcp = "DefenderForContainersGcp",
DefenderForDatabasesAws = "DefenderForDatabasesAws",
DefenderForDatabasesGcp = "DefenderForDatabasesGcp",
DefenderForDevOpsAzureDevOps = "DefenderForDevOpsAzureDevOps",
DefenderForDevOpsGithub = "DefenderForDevOpsGithub",
DefenderForServersAws = "DefenderForServersAws",
DefenderForServersGcp = "DefenderForServersGcp",
InformationProtectionAws = "InformationProtectionAws"
Expand Down
Loading