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
448 changes: 1 addition & 447 deletions sdk/securityinsight/arm-securityinsight/CHANGELOG.md

Large diffs are not rendered by default.

16 changes: 8 additions & 8 deletions sdk/securityinsight/arm-securityinsight/README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
# Azure SecurityInsights client library for JavaScript
# Azure Service client library for JavaScript

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

API spec for Microsoft.SecurityInsights (Azure Security Insights) resource provider

[Source code](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/securityinsight/arm-securityinsight) |
[Package (NPM)](https://www.npmjs.com/package/@azure/arm-securityinsight) |
[API reference documentation](https://docs.microsoft.com/javascript/api/@azure/arm-securityinsight?view=azure-node-preview) |
[API reference documentation](https://docs.microsoft.com/javascript/api/@azure/arm-securityinsight) |
[Samples](https://github.com/Azure-Samples/azure-samples-js-management)

## Getting started
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-securityinsight` package

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

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

### Create and authenticate a `SecurityInsights`

To create a client object to access the Azure SecurityInsights API, you will need the `endpoint` of your Azure SecurityInsights resource and a `credential`. The Azure SecurityInsights client can use Azure Active Directory credentials to authenticate.
You can find the endpoint for your Azure SecurityInsights resource in the [Azure Portal][azure_portal].
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].

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 SecurityInsights** 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 Service** 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

### SecurityInsights

`SecurityInsights` is the primary interface for developers using the Azure SecurityInsights client library. Explore the methods on this client object to understand the different features of the Azure SecurityInsights service that you can access.
`SecurityInsights` 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.

## Troubleshooting

Expand Down
6 changes: 3 additions & 3 deletions sdk/securityinsight/arm-securityinsight/_meta.json
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
{
"commit": "64496bd64b0376dc4b45e3193a39f7bcdd4b28da",
"commit": "66a0bc41372eadefc35b8985dafe84bfdf064a68",
"readme": "specification/securityinsights/resource-manager/readme.md",
"autorest_command": "autorest --version=3.7.3 --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\\securityinsights\\resource-manager\\readme.md --use=@autorest/typescript@6.0.0-rc.1.20220707.1 --generate-sample=true",
"autorest_command": "autorest --version=3.7.3 --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/securityinsights/resource-manager/readme.md --use=@autorest/typescript@6.0.0-alpha.19.20220425.1",
"repository_url": "https://github.com/Azure/azure-rest-api-specs.git",
"release_tool": "@azure-tools/js-sdk-release-tools@2.4.0",
"use": "@autorest/typescript@6.0.0-rc.1.20220707.1"
"use": "@autorest/typescript@6.0.0-alpha.19.20220425.1"
}
17 changes: 4 additions & 13 deletions sdk/securityinsight/arm-securityinsight/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
"sdk-type": "mgmt",
"author": "Microsoft Corporation",
"description": "A generated SDK for SecurityInsights.",
"version": "1.0.0-beta.4",
"version": "1.0.0",
"engines": {
"node": ">=12.0.0"
},
Expand Down Expand Up @@ -41,8 +41,6 @@
"@azure-tools/test-recorder": "^2.0.0",
"@azure-tools/test-credential": "^1.0.0",
"mocha": "^7.1.1",
"@types/chai": "^4.2.8",
"chai": "^4.2.0",
"cross-env": "^7.0.2",
"@azure/dev-tool": "^1.0.0"
},
Expand Down Expand Up @@ -96,7 +94,8 @@
"unit-test:browser": "echo skipped",
"integration-test": "npm run integration-test:node && npm run integration-test:browser",
"integration-test:node": "dev-tool run test:node-ts-input -- --timeout 1200000 'test/*.ts'",
"integration-test:browser": "echo skipped"
"integration-test:browser": "echo skipped",
"docs": "echo skipped"
},
"sideEffects": false,
"//metadata": {
Expand All @@ -107,13 +106,5 @@
}
]
},
"autoPublish": true,
"//sampleConfiguration": {
"productName": "",
"productSlugs": [
"azure"
],
"disableDocsMs": true,
"apiRefLink": "https://docs.microsoft.com/javascript/api/@azure/arm-securityinsight?view=azure-node-preview"
}
"autoPublish": true
}
Loading