Skip to content

Commit

Permalink
CodeGen from PR 18645 in Azure/azure-rest-api-specs
Browse files Browse the repository at this point in the history
Merge 7b5cd6f59e3a76be5c810ccb9380efa0bbd928cd into b9d36b704e582a2bd5677fedc813607e73963469
  • Loading branch information
SDKAuto committed Apr 13, 2022
1 parent 7e55e3b commit 1b16cb2
Show file tree
Hide file tree
Showing 69 changed files with 36,131 additions and 658 deletions.
871 changes: 871 additions & 0 deletions sdk/machinelearning/arm-workspaces/CHANGELOG.md

Large diffs are not rendered by default.

24 changes: 12 additions & 12 deletions sdk/machinelearning/arm-workspaces/README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# Azure Machine Learning Workspaces Management 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 Machine Learning Workspaces Management client.
This package contains an isomorphic SDK (runs both in Node.js and in browsers) for Azure Service client.

These APIs allow end users to operate on Azure Machine Learning Workspace resources. They support CRUD operations for Azure Machine Learning Workspaces.
These APIs allow end users to operate on Azure Machine Learning Workspace resources.

[Source code](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/machinelearning/arm-workspaces) |
[Package (NPM)](https://www.npmjs.com/package/@azure/arm-workspaces) |
Expand All @@ -22,16 +22,16 @@ These APIs allow end users to operate on Azure Machine Learning Workspace resour

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

Install the Azure Machine Learning Workspaces Management client library for JavaScript with `npm`:
Install the Azure Service client library for JavaScript with `npm`:

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

### Create and authenticate a `MachineLearningWorkspacesManagementClient`
### Create and authenticate a `AzureMachineLearningWorkspaces`

To create a client object to access the Azure Machine Learning Workspaces Management API, you will need the `endpoint` of your Azure Machine Learning Workspaces Management resource and a `credential`. The Azure Machine Learning Workspaces Management client can use Azure Active Directory credentials to authenticate.
You can find the endpoint for your Azure Machine Learning Workspaces Management 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 @@ -41,16 +41,16 @@ 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 Machine Learning Workspaces Management** 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).

```javascript
const { MachineLearningWorkspacesManagementClient } = require("@azure/arm-workspaces");
const { AzureMachineLearningWorkspaces } = require("@azure/arm-workspaces");
const { DefaultAzureCredential } = require("@azure/identity");
const subscriptionId = "00000000-0000-0000-0000-000000000000";
const client = new MachineLearningWorkspacesManagementClient(new DefaultAzureCredential(), subscriptionId);
const client = new AzureMachineLearningWorkspaces(new DefaultAzureCredential(), subscriptionId);
```


Expand All @@ -59,9 +59,9 @@ To use this client library in the browser, first you need to use a bundler. For

## Key concepts

### MachineLearningWorkspacesManagementClient
### AzureMachineLearningWorkspaces

`MachineLearningWorkspacesManagementClient` is the primary interface for developers using the Azure Machine Learning Workspaces Management client library. Explore the methods on this client object to understand the different features of the Azure Machine Learning Workspaces Management service that you can access.
`AzureMachineLearningWorkspaces` 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
7 changes: 4 additions & 3 deletions sdk/machinelearning/arm-workspaces/_meta.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
{
"commit": "184b23b63ee3a79fb41ca3aa55a31a8d9e636772",
"commit": "91b159d73aa7bc4462fc09b1e104edad4f883d69",
"readme": "specification/machinelearning/resource-manager/readme.md",
"autorest_command": "autorest --version=3.7.3 --typescript --modelerfour.lenient-model-deduplication --head-as-boolean=true --license-header=MICROSOFT_MIT_NO_VERSION --generate-test --typescript-sdks-folder=D:\\mydev\\azure-sdk-for-js ../azure-rest-api-specs/specification/machinelearning/resource-manager/readme.md --use=@autorest/[email protected].20220114.1 --generate-sample=true",
"autorest_command": "autorest --version=3.7.3 --typescript --modelerfour.lenient-model-deduplication --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/machinelearning/resource-manager/readme.md --use=@autorest/[email protected].20220105.1",
"repository_url": "https://github.com/Azure/azure-rest-api-specs.git",
"use": "@autorest/[email protected]"
"release_tool": "@azure-tools/[email protected]",
"use": "@autorest/[email protected]"
}
25 changes: 19 additions & 6 deletions sdk/machinelearning/arm-workspaces/api-extractor.json
Original file line number Diff line number Diff line change
@@ -1,18 +1,31 @@
{
"$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
"mainEntryPointFilePath": "./dist-esm/src/index.d.ts",
"docModel": { "enabled": true },
"apiReport": { "enabled": true, "reportFolder": "./review" },
"docModel": {
"enabled": true
},
"apiReport": {
"enabled": true,
"reportFolder": "./review"
},
"dtsRollup": {
"enabled": true,
"untrimmedFilePath": "",
"publicTrimmedFilePath": "./types/arm-workspaces.d.ts"
},
"messages": {
"tsdocMessageReporting": { "default": { "logLevel": "none" } },
"tsdocMessageReporting": {
"default": {
"logLevel": "none"
}
},
"extractorMessageReporting": {
"ae-missing-release-tag": { "logLevel": "none" },
"ae-unresolved-link": { "logLevel": "none" }
"ae-missing-release-tag": {
"logLevel": "none"
},
"ae-unresolved-link": {
"logLevel": "none"
}
}
}
}
}
40 changes: 19 additions & 21 deletions sdk/machinelearning/arm-workspaces/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,17 +2,27 @@
"name": "@azure/arm-workspaces",
"sdk-type": "mgmt",
"author": "Microsoft Corporation",
"description": "A generated SDK for MachineLearningWorkspacesManagementClient.",
"version": "1.0.0",
"engines": { "node": ">=12.0.0" },
"description": "A generated SDK for AzureMachineLearningWorkspaces.",
"version": "2.0.0",
"engines": {
"node": ">=12.0.0"
},
"dependencies": {
"@azure/core-lro": "^2.2.0",
"@azure/abort-controller": "^1.0.0",
"@azure/core-paging": "^1.2.0",
"@azure/core-client": "^1.0.0",
"@azure/core-auth": "^1.3.0",
"@azure/core-rest-pipeline": "^1.1.0",
"tslib": "^2.2.0"
},
"keywords": ["node", "azure", "typescript", "browser", "isomorphic"],
"keywords": [
"node",
"azure",
"typescript",
"browser",
"isomorphic"
],
"license": "MIT",
"main": "./dist/index.js",
"module": "./dist-esm/src/index.js",
Expand All @@ -39,7 +49,9 @@
"type": "git",
"url": "https://github.com/Azure/azure-sdk-for-js.git"
},
"bugs": { "url": "https://github.com/Azure/azure-sdk-for-js/issues" },
"bugs": {
"url": "https://github.com/Azure/azure-sdk-for-js/issues"
},
"files": [
"dist/**/*.js",
"dist/**/*.js.map",
Expand Down Expand Up @@ -86,19 +98,5 @@
"docs": "echo skipped"
},
"sideEffects": false,
"//metadata": {
"constantPaths": [
{
"path": "src/MachineLearningWorkspacesManagementClient.ts",
"prefix": "packageDetails"
}
]
},
"autoPublish": true,
"//sampleConfiguration": {
"productName": "",
"productSlugs": ["azure"],
"disableDocsMs": true,
"apiRefLink": "https://docs.microsoft.com/javascript/api/@azure/arm-workspaces?view=azure-node-preview"
}
}
"autoPublish": true
}
Loading

0 comments on commit 1b16cb2

Please sign in to comment.