Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[ReleasePR @azure/arm-subscriptions] update readme #20856

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
5 changes: 3 additions & 2 deletions sdk/subscription/arm-subscriptions/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ The subscription client

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

## Getting started
Expand Down Expand Up @@ -49,7 +49,8 @@ For more information about how to create an Azure AD Application check out [this
```javascript
const { SubscriptionClient } = require("@azure/arm-subscriptions");
const { DefaultAzureCredential } = require("@azure/identity");
const client = new SubscriptionClient(new DefaultAzureCredential());
const subscriptionId = "00000000-0000-0000-0000-000000000000";
const client = new SubscriptionClient(new DefaultAzureCredential(), subscriptionId);
```


Expand Down
7 changes: 4 additions & 3 deletions sdk/subscription/arm-subscriptions/_meta.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
{
"commit": "dc439efcfc15448824877603f66fc1578d1c71c5",
"commit": "907f54e29c515666bdd394cd064db2a2fdb0b1d7",
"readme": "specification/subscription/resource-manager/readme.md",
"autorest_command": "autorest --version=3.1.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/subscription/resource-manager/readme.md --use=@autorest/[email protected].20211217.1",
"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=/home/vsts/work/1/s/azure-sdk-for-js ../azure-rest-api-specs/specification/subscription/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/subscription/arm-subscriptions/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-subscriptions.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"
}
}
}
}
}
4 changes: 2 additions & 2 deletions sdk/subscription/arm-subscriptions/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 SubscriptionClient.",
"version": "5.0.1",
"version": "1.0.0-beta.1",
"engines": {
"node": ">=12.0.0"
},
Expand Down Expand Up @@ -99,4 +99,4 @@
},
"sideEffects": false,
"autoPublish": true
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -396,7 +396,7 @@ export type SubscriptionEnableResponse = EnabledSubscriptionId;

// @public
export interface SubscriptionListResult {
nextLink: string;
nextLink?: string;
value?: Subscription[];
}

Expand Down
2 changes: 1 addition & 1 deletion sdk/subscription/arm-subscriptions/src/models/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,7 @@ export interface SubscriptionListResult {
/** An array of subscriptions. */
value?: Subscription[];
/** The URL to get the next set of results. */
nextLink: string;
nextLink?: string;
}

/** Tenant Ids information. */
Expand Down
1 change: 0 additions & 1 deletion sdk/subscription/arm-subscriptions/src/models/mappers.ts
Original file line number Diff line number Diff line change
Expand Up @@ -181,7 +181,6 @@ export const SubscriptionListResult: coreClient.CompositeMapper = {
},
nextLink: {
serializedName: "nextLink",
required: true,
type: {
name: "String"
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ export class SubscriptionClient extends coreClient.ServiceClient {
credential: credentials
};

const packageDetails = `azsdk-js-arm-subscriptions/5.0.0`;
const packageDetails = `azsdk-js-arm-subscriptions/1.0.0-beta.1`;
const userAgentPrefix =
options.userAgentOptions && options.userAgentOptions.userAgentPrefix
? `${options.userAgentOptions.userAgentPrefix} ${packageDetails}`
Expand Down
16 changes: 12 additions & 4 deletions sdk/subscription/arm-subscriptions/tsconfig.json
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,19 @@
"esModuleInterop": true,
"allowSyntheticDefaultImports": true,
"forceConsistentCasingInFileNames": true,
"lib": ["es6", "dom"],
"lib": [
"es6",
"dom"
],
"declaration": true,
"outDir": "./dist-esm",
"importHelpers": true
},
"include": ["./src/**/*.ts", "./test/**/*.ts"],
"exclude": ["node_modules"]
}
"include": [
"./src/**/*.ts",
"./test/**/*.ts"
],
"exclude": [
"node_modules"
]
}
2 changes: 2 additions & 0 deletions sdk/subscription/ci.mgmt.yml
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ trigger:
- sdk/subscription/ci.mgmt.yml
- sdk/subscription/arm-subscription/
- sdk/subscription/arm-subscriptions-profile-2020-09-01-hybrid
- sdk/subscription/arm-subscriptions
pr:
branches:
include:
Expand All @@ -25,6 +26,7 @@ pr:
- sdk/subscription/ci.mgmt.yml
- sdk/subscription/arm-subscription/
- sdk/subscription/arm-subscriptions-profile-2020-09-01-hybrid
- sdk/subscription/arm-subscriptions
extends:
template: /eng/pipelines/templates/stages/archetype-sdk-client.yml
parameters:
Expand Down