Skip to content

Commit

Permalink
CodeGen from PR 15671 in Azure/azure-rest-api-specs
Browse files Browse the repository at this point in the history
update-typescript.md-for-resources (Azure#15671)

* update-typescript.md-for-resources

* update
  • Loading branch information
SDKAuto committed Aug 23, 2021
1 parent cadd8b2 commit f8fdeff
Show file tree
Hide file tree
Showing 15 changed files with 75 additions and 51 deletions.
2 changes: 1 addition & 1 deletion sdk/links/arm-links/LICENSE.txt
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
The MIT License (MIT)

Copyright (c) 2019 Microsoft
Copyright (c) 2021 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
9 changes: 3 additions & 6 deletions sdk/links/arm-links/README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
## Azure ManagementLinkClient SDK for JavaScript

This package contains an isomorphic SDK (runs both in Node.js and in browsers) for ManagementLinkClient.
This package contains an isomorphic SDK (runs both in node.js and in browsers) for ManagementLinkClient.

### Currently supported environments

- [LTS versions of Node.js](https://nodejs.org/about/releases/)
- Latest versions of Safari, Chrome, Edge, and Firefox.
- Latest versions of Safari, Chrome, Edge and Firefox.

### Prerequisites

Expand All @@ -21,7 +21,6 @@ Install both packages using the below command:
```bash
npm install --save @azure/arm-links @azure/identity
```

> **Note**: You may have used either `@azure/ms-rest-nodeauth` or `@azure/ms-rest-browserauth` in the past. These packages are in maintenance mode receiving critical bug fixes, but no new features.
If you are on a [Node.js that has LTS status](https://nodejs.org/about/releases/), or are writing a client side browser application, we strongly encourage you to upgrade to `@azure/identity` which uses the latest versions of Azure Active Directory and MSAL APIs and provides more authentication options.

Expand All @@ -37,7 +36,6 @@ If you are on a [Node.js that has LTS status](https://nodejs.org/about/releases/

In the below samples, we pass the credential and the Azure subscription id to instantiate the client.
Once the client is created, explore the operations on it either in your favorite editor or in our [API reference documentation](https://docs.microsoft.com/javascript/api) to get started.

#### nodejs - Authentication, client creation, and list operations as an example written in JavaScript.

##### Sample code
Expand All @@ -51,7 +49,6 @@ const subscriptionId = process.env["AZURE_SUBSCRIPTION_ID"];
// Please note that you can also use credentials from the `@azure/ms-rest-nodeauth` package instead.
const creds = new DefaultAzureCredential();
const client = new ManagementLinkClient(creds, subscriptionId);

client.operations.list().then((result) => {
console.log("The result is:");
console.log(result);
Expand Down Expand Up @@ -86,7 +83,7 @@ In browser applications, we recommend using the `InteractiveBrowserCredential` t
const credential = new InteractiveBrowserCredential(
{
clientId: "<client id for your Azure AD app>",
tenantId: "<optional tenant for your organization>"
tenant: "<optional tenant for your organization>"
});
const client = new Azure.ArmLinks.ManagementLinkClient(creds, subscriptionId);
client.operations.list().then((result) => {
Expand Down
14 changes: 7 additions & 7 deletions sdk/links/arm-links/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,10 @@
"description": "ManagementLinkClient Library with typescript type definitions for node.js and browser.",
"version": "1.1.1",
"dependencies": {
"@azure/ms-rest-azure-js": "^1.4.0",
"@azure/ms-rest-js": "^1.11.0",
"@azure/ms-rest-azure-js": "^2.1.0",
"@azure/ms-rest-js": "^2.2.0",
"@azure/core-auth": "^1.1.4",
"tslib": "^1.9.3"
"tslib": "^1.10.0"
},
"keywords": [
"node",
Expand All @@ -22,12 +22,12 @@
"types": "./esm/managementLinkClient.d.ts",
"devDependencies": {
"typescript": "^3.6.0",
"rollup": "^0.66.2",
"rollup-plugin-node-resolve": "^3.4.0",
"rollup": "^1.18.0",
"rollup-plugin-node-resolve": "^5.2.0",
"rollup-plugin-sourcemaps": "^0.4.2",
"uglify-js": "^3.4.9"
"uglify-js": "^3.6.0"
},
"homepage": "https://github.com/Azure/azure-sdk-for-js/tree/feature/v4/sdk/links/arm-links",
"homepage": "https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/links/arm-links",
"repository": {
"type": "git",
"url": "https://github.com/Azure/azure-sdk-for-js.git"
Expand Down
6 changes: 3 additions & 3 deletions sdk/links/arm-links/rollup.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -21,15 +21,15 @@ const config = {
"@azure/ms-rest-azure-js": "msRestAzure"
},
banner: `/*
* Copyright (c) Microsoft Corporation. All rights reserved.
* Licensed under the MIT License. See License.txt in the project root for license information.
* Copyright (c) Microsoft Corporation.
* Licensed under the MIT License.
*
* Code generated by Microsoft (R) AutoRest Code Generator.
* Changes may cause incorrect behavior and will be lost if the code is regenerated.
*/`
},
plugins: [
nodeResolve({ module: true }),
nodeResolve({ mainFields: ['module', 'main'] }),
sourcemaps()
]
};
Expand Down
5 changes: 2 additions & 3 deletions sdk/links/arm-links/src/managementLinkClient.ts
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
/*
* Copyright (c) Microsoft Corporation. All rights reserved.
* Licensed under the MIT License. See License.txt in the project root for
* license information.
* Copyright (c) Microsoft Corporation.
* Licensed under the MIT License.
*
* Code generated by Microsoft (R) AutoRest Code Generator.
* Changes may cause incorrect behavior and will be lost if the code is
Expand Down
7 changes: 3 additions & 4 deletions sdk/links/arm-links/src/managementLinkClientContext.ts
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
/*
* Copyright (c) Microsoft Corporation. All rights reserved.
* Licensed under the MIT License. See License.txt in the project root for
* license information.
* Copyright (c) Microsoft Corporation.
* Licensed under the MIT License.
*
* Code generated by Microsoft (R) AutoRest Code Generator.
* Changes may cause incorrect behavior and will be lost if the code is
Expand All @@ -10,8 +9,8 @@

import * as Models from "./models";
import * as msRest from "@azure/ms-rest-js";
import { TokenCredential } from "@azure/core-auth";
import * as msRestAzure from "@azure/ms-rest-azure-js";
import { TokenCredential } from "@azure/core-auth";

const packageName = "@azure/arm-links";
const packageVersion = "1.1.1";
Expand Down
26 changes: 24 additions & 2 deletions sdk/links/arm-links/src/models/index.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
/*
* Copyright (c) Microsoft Corporation. All rights reserved.
* Licensed under the MIT License. See License.txt in the project root for license information.
* Copyright (c) Microsoft Corporation.
* Licensed under the MIT License.
*
* Code generated by Microsoft (R) AutoRest Code Generator.
* Changes may cause incorrect behavior and will be lost if the code is regenerated.
Expand Down Expand Up @@ -123,6 +123,28 @@ export interface ResourceLinksListAtSourceScopeOptionalParams extends msRest.Req
filter?: string;
}

/**
* Optional Parameters.
*/
export interface ResourceLinksListAtSubscriptionNextOptionalParams extends msRest.RequestOptionsBase {
/**
* The filter to apply on the list resource links operation. The supported filter for list
* resource links is targetId. For example, $filter=targetId eq {value}
*/
filter?: string;
}

/**
* Optional Parameters.
*/
export interface ResourceLinksListAtSourceScopeNextOptionalParams extends msRest.RequestOptionsBase {
/**
* The filter to apply when getting resource links. To get links only at the specified scope (not
* below the scope), use Filter.atScope().
*/
filter?: string;
}

/**
* An interface representing ManagementLinkClientOptions.
*/
Expand Down
4 changes: 2 additions & 2 deletions sdk/links/arm-links/src/models/mappers.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
/*
* Copyright (c) Microsoft Corporation. All rights reserved.
* Licensed under the MIT License. See License.txt in the project root for license information.
* Copyright (c) Microsoft Corporation.
* Licensed under the MIT License.
*
* Code generated by Microsoft (R) AutoRest Code Generator.
* Changes may cause incorrect behavior and will be lost if the code is regenerated.
Expand Down
4 changes: 2 additions & 2 deletions sdk/links/arm-links/src/models/operationsMappers.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
/*
* Copyright (c) Microsoft Corporation. All rights reserved.
* Licensed under the MIT License. See License.txt in the project root for license information.
* Copyright (c) Microsoft Corporation.
* Licensed under the MIT License.
*
* Code generated by Microsoft (R) AutoRest Code Generator.
* Changes may cause incorrect behavior and will be lost if the code is regenerated.
Expand Down
5 changes: 2 additions & 3 deletions sdk/links/arm-links/src/models/parameters.ts
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
/*
* Copyright (c) Microsoft Corporation. All rights reserved.
* Licensed under the MIT License. See License.txt in the project root for
* license information.
* Copyright (c) Microsoft Corporation.
* Licensed under the MIT License.
*
* Code generated by Microsoft (R) AutoRest Code Generator.
* Changes may cause incorrect behavior and will be lost if the code is
Expand Down
4 changes: 2 additions & 2 deletions sdk/links/arm-links/src/models/resourceLinksMappers.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
/*
* Copyright (c) Microsoft Corporation. All rights reserved.
* Licensed under the MIT License. See License.txt in the project root for license information.
* Copyright (c) Microsoft Corporation.
* Licensed under the MIT License.
*
* Code generated by Microsoft (R) AutoRest Code Generator.
* Changes may cause incorrect behavior and will be lost if the code is regenerated.
Expand Down
5 changes: 2 additions & 3 deletions sdk/links/arm-links/src/operations/index.ts
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
/*
* Copyright (c) Microsoft Corporation. All rights reserved.
* Licensed under the MIT License. See License.txt in the project root for
* license information.
* Copyright (c) Microsoft Corporation.
* Licensed under the MIT License.
*
* Code generated by Microsoft (R) AutoRest Code Generator.
* Changes may cause incorrect behavior and will be lost if the code is
Expand Down
8 changes: 5 additions & 3 deletions sdk/links/arm-links/src/operations/operations.ts
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
/*
* Copyright (c) Microsoft Corporation. All rights reserved.
* Licensed under the MIT License. See License.txt in the project root for
* license information.
* Copyright (c) Microsoft Corporation.
* Licensed under the MIT License.
*
* Code generated by Microsoft (R) AutoRest Code Generator.
* Changes may cause incorrect behavior and will be lost if the code is
Expand Down Expand Up @@ -108,6 +107,9 @@ const listNextOperationSpec: msRest.OperationSpec = {
urlParameters: [
Parameters.nextPageLink
],
queryParameters: [
Parameters.apiVersion
],
headerParameters: [
Parameters.acceptLanguage
],
Expand Down
25 changes: 16 additions & 9 deletions sdk/links/arm-links/src/operations/resourceLinks.ts
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
/*
* Copyright (c) Microsoft Corporation. All rights reserved.
* Licensed under the MIT License. See License.txt in the project root for
* license information.
* Copyright (c) Microsoft Corporation.
* Licensed under the MIT License.
*
* Code generated by Microsoft (R) AutoRest Code Generator.
* Changes may cause incorrect behavior and will be lost if the code is
Expand Down Expand Up @@ -199,7 +198,7 @@ export class ResourceLinks {
* @param [options] The optional parameters
* @returns Promise<Models.ResourceLinksListAtSubscriptionNextResponse>
*/
listAtSubscriptionNext(nextPageLink: string, options?: msRest.RequestOptionsBase): Promise<Models.ResourceLinksListAtSubscriptionNextResponse>;
listAtSubscriptionNext(nextPageLink: string, options?: Models.ResourceLinksListAtSubscriptionNextOptionalParams): Promise<Models.ResourceLinksListAtSubscriptionNextResponse>;
/**
* @param nextPageLink The NextLink from the previous successful call to List operation.
* @param callback The callback
Expand All @@ -210,8 +209,8 @@ export class ResourceLinks {
* @param options The optional parameters
* @param callback The callback
*/
listAtSubscriptionNext(nextPageLink: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<Models.ResourceLinkResult>): void;
listAtSubscriptionNext(nextPageLink: string, options?: msRest.RequestOptionsBase | msRest.ServiceCallback<Models.ResourceLinkResult>, callback?: msRest.ServiceCallback<Models.ResourceLinkResult>): Promise<Models.ResourceLinksListAtSubscriptionNextResponse> {
listAtSubscriptionNext(nextPageLink: string, options: Models.ResourceLinksListAtSubscriptionNextOptionalParams, callback: msRest.ServiceCallback<Models.ResourceLinkResult>): void;
listAtSubscriptionNext(nextPageLink: string, options?: Models.ResourceLinksListAtSubscriptionNextOptionalParams | msRest.ServiceCallback<Models.ResourceLinkResult>, callback?: msRest.ServiceCallback<Models.ResourceLinkResult>): Promise<Models.ResourceLinksListAtSubscriptionNextResponse> {
return this.client.sendOperationRequest(
{
nextPageLink,
Expand All @@ -227,7 +226,7 @@ export class ResourceLinks {
* @param [options] The optional parameters
* @returns Promise<Models.ResourceLinksListAtSourceScopeNextResponse>
*/
listAtSourceScopeNext(nextPageLink: string, options?: msRest.RequestOptionsBase): Promise<Models.ResourceLinksListAtSourceScopeNextResponse>;
listAtSourceScopeNext(nextPageLink: string, options?: Models.ResourceLinksListAtSourceScopeNextOptionalParams): Promise<Models.ResourceLinksListAtSourceScopeNextResponse>;
/**
* @param nextPageLink The NextLink from the previous successful call to List operation.
* @param callback The callback
Expand All @@ -238,8 +237,8 @@ export class ResourceLinks {
* @param options The optional parameters
* @param callback The callback
*/
listAtSourceScopeNext(nextPageLink: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<Models.ResourceLinkResult>): void;
listAtSourceScopeNext(nextPageLink: string, options?: msRest.RequestOptionsBase | msRest.ServiceCallback<Models.ResourceLinkResult>, callback?: msRest.ServiceCallback<Models.ResourceLinkResult>): Promise<Models.ResourceLinksListAtSourceScopeNextResponse> {
listAtSourceScopeNext(nextPageLink: string, options: Models.ResourceLinksListAtSourceScopeNextOptionalParams, callback: msRest.ServiceCallback<Models.ResourceLinkResult>): void;
listAtSourceScopeNext(nextPageLink: string, options?: Models.ResourceLinksListAtSourceScopeNextOptionalParams | msRest.ServiceCallback<Models.ResourceLinkResult>, callback?: msRest.ServiceCallback<Models.ResourceLinkResult>): Promise<Models.ResourceLinksListAtSourceScopeNextResponse> {
return this.client.sendOperationRequest(
{
nextPageLink,
Expand Down Expand Up @@ -385,6 +384,10 @@ const listAtSubscriptionNextOperationSpec: msRest.OperationSpec = {
urlParameters: [
Parameters.nextPageLink
],
queryParameters: [
Parameters.filter,
Parameters.apiVersion
],
headerParameters: [
Parameters.acceptLanguage
],
Expand All @@ -406,6 +409,10 @@ const listAtSourceScopeNextOperationSpec: msRest.OperationSpec = {
urlParameters: [
Parameters.nextPageLink
],
queryParameters: [
Parameters.filter,
Parameters.apiVersion
],
headerParameters: [
Parameters.acceptLanguage
],
Expand Down
2 changes: 1 addition & 1 deletion sdk/links/arm-links/tsconfig.json
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
"esModuleInterop": true,
"allowSyntheticDefaultImports": true,
"forceConsistentCasingInFileNames": true,
"lib": ["es6"],
"lib": ["es6", "dom"],
"declaration": true,
"outDir": "./esm",
"importHelpers": true
Expand Down

0 comments on commit f8fdeff

Please sign in to comment.