Rename hardcoded master links to use main
This commit is contained in:
Chidozie Ononiwu
Wes Haggard
Родитель
ac8d65c6a7
Коммит
a64747cf6a
|
|
@ -51,7 +51,7 @@ Rush provides many benefits:
|
|||
- When a change is made in a local dependency, Rush will detect that the dependency is dirty and will rebuild it if you attempt to build a project that consumes that dependency.
|
||||
- Rush runs project tasks in parallel, subject to the inter-project dependencies that it detects. It also performs incremental builds by default, not rebuilding anything unnecessary (unless you tell it to).
|
||||
|
||||
Not every library in the repository is managed by Rush yet, only those listed in the `projects` property in [rush.json](https://github.com/Azure/azure-sdk-for-js/blob/master/rush.json). Packages not managed by Rush can still be managed using `npm`.
|
||||
Not every library in the repository is managed by Rush yet, only those listed in the `projects` property in [rush.json](https://github.com/Azure/azure-sdk-for-js/blob/main/rush.json). Packages not managed by Rush can still be managed using `npm`.
|
||||
|
||||
## Setting up your environment
|
||||
|
||||
|
|
@ -91,7 +91,7 @@ To build packages managed by Rush:
|
|||
|
||||
To build packages not managed by Rush:
|
||||
|
||||
4. Navigate to the package directory as described in our [repository structure](https://github.com/Azure/azure-sdk/blob/master/docs/policies/repostructure.md)
|
||||
4. Navigate to the package directory as described in our [repository structure](https://github.com/Azure/azure-sdk/blob/main/docs/policies/repostructure.md)
|
||||
5. Install the package dependencies (`npm install`)
|
||||
6. Build the package (`npm run build`)
|
||||
|
||||
|
|
@ -134,7 +134,7 @@ By default, Rush only displays things written to `STDERR`. If you want to see th
|
|||
|
||||
If you want to run the tests of a specific project, go to that project's folder and execute `rushx test`. All of the tests will automatically run both in NodeJS and in the browser. To target these environments individually, you can run `rushx test:node` and `rushx test:browser`.
|
||||
|
||||
By default, these npm scripts run previously recorded tests. The recordings have been generated by using a custom recording library called [test-utils-recorder](https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/test-utils/recorder/README.md). We will examine how to run recorded tests and live tests in the following sections.
|
||||
By default, these npm scripts run previously recorded tests. The recordings have been generated by using a custom recording library called [test-utils-recorder](https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/test-utils/recorder/README.md). We will examine how to run recorded tests and live tests in the following sections.
|
||||
|
||||
#### Recorded tests
|
||||
|
||||
|
|
@ -152,7 +152,7 @@ The readme file in the `test` folder of each package lists the Azure resources a
|
|||
|
||||
> Note: Our projects use dotenv to allow you to use `.env` files to set environment variables. Find the `sample.env` file nearest to the project you want to test to see a template of the expected `.env` file.
|
||||
|
||||
You can create the necessary Azure resources on your own, or automate this process by using the script called `New-TestResources.ps1` which uses ARM templates defined in a file named `test-resources.json` that exists in each project's folder. Follow the steps in [`Example 1 of New-TestResources.ps1`](https://github.com/Azure/azure-sdk-for-js/blob/master/eng/common/TestResources/New-TestResources.ps1.md#example-1) to set up a service principal and deploy the live test resources.
|
||||
You can create the necessary Azure resources on your own, or automate this process by using the script called `New-TestResources.ps1` which uses ARM templates defined in a file named `test-resources.json` that exists in each project's folder. Follow the steps in [`Example 1 of New-TestResources.ps1`](https://github.com/Azure/azure-sdk-for-js/blob/main/eng/common/TestResources/New-TestResources.ps1.md#example-1) to set up a service principal and deploy the live test resources.
|
||||
|
||||
#### Regenerating recordings
|
||||
|
||||
|
|
@ -160,7 +160,7 @@ If you modify the network calls (both the number of calls or their shape) either
|
|||
|
||||
Regenerating the recordings has the same requirements as running the live tests. You will be using the same `test` npm script with the environment variables pointing to previously created Azure resources. The only difference is that the `TEST_MODE` environment variable needs to be set to `record`. When this process finishes without errors, the recordings will be updated.
|
||||
|
||||
For more information the recorder, please visit the [test-utils-recorder's readme](https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/test-utils/recorder/README.md).
|
||||
For more information the recorder, please visit the [test-utils-recorder's readme](https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/test-utils/recorder/README.md).
|
||||
|
||||
### Other NPM scripts
|
||||
|
||||
|
|
@ -239,20 +239,20 @@ We used to have a git hook that formats your changed files on commit but it was
|
|||
|
||||
### Enforcing Azure SDK design guidelines
|
||||
|
||||
Our libraries follow the [TypeScript SDK design guidelines](https://azure.github.io/azure-sdk/typescript_introduction.html) to enhance the productivity of developers connecting to Azure services. These guidelines are enforced by our custom [ESLint plugin](https://github.com/Azure/azure-sdk-for-js/tree/master/common/tools/eslint-plugin-azure-sdk). Follow these instruction to use the plugin:
|
||||
Our libraries follow the [TypeScript SDK design guidelines](https://azure.github.io/azure-sdk/typescript_introduction.html) to enhance the productivity of developers connecting to Azure services. These guidelines are enforced by our custom [ESLint plugin](https://github.com/Azure/azure-sdk-for-js/tree/main/common/tools/eslint-plugin-azure-sdk). Follow these instruction to use the plugin:
|
||||
|
||||
- [add `eslint` to your `devDependencies`](https://github.com/Azure/azure-sdk-for-js/blob/8ec9801c17b175573a115fc8b2d6cbaeb17b0b09/sdk/template/template/package.json#L106)
|
||||
- [add `eslint-plugin-azure-sdk` to your `devDependencies`](https://github.com/Azure/azure-sdk-for-js/blob/8ec9801c17b175573a115fc8b2d6cbaeb17b0b09/sdk/template/template/package.json#L93)
|
||||
- add a linting npm script as follows:
|
||||
- ["lint": "eslint package.json api-extractor.json src test --ext .ts"](https://github.com/Azure/azure-sdk-for-js/blob/8ec9801c17b175573a115fc8b2d6cbaeb17b0b09/sdk/template/template/package.json#L49)
|
||||
- ["lint": "eslint package.json api-extractor.json src test --ext .ts"](https://github.com/Azure/azure-sdk-for-js/blob/8ec9801c17b175573a115fc8b2d6cbaeb17b0b09/sdk/template/template/package.json#L49)
|
||||
|
||||
You can run the plugin by excuting `rushx lint` inside your package directory.
|
||||
|
||||
If the package is internal, it should not follow the design guidelines and in turn should not be linted by the plugin. In this case, use the [internal configuration file](https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/.eslintrc.internal.json) instead. For example: `"lint": "eslint --no-eslintrc -c ../../.eslintrc.internal.json package.json package.json src test --ext .ts"`
|
||||
|
||||
If the package is internal, it should not follow the design guidelines and in turn should not be linted by the plugin. In this case, use the [internal configuration file](https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/.eslintrc.internal.json) instead. For example: `"lint": "eslint --no-eslintrc -c ../../.eslintrc.internal.json package.json package.json src test --ext .ts"`
|
||||
|
||||
## Onboarding a new library
|
||||
|
||||
All libraries must follow our [repository structure](https://github.com/Azure/azure-sdk/blob/master/docs/policies/repostructure.md) (specifically, it must be located at `sdk/<servicename>/<packagename>`) and your library's `package.json` must contain the required scripts as documented [above](#other-npm-scripts).
|
||||
All libraries must follow our [repository structure](https://github.com/Azure/azure-sdk/blob/main/docs/policies/repostructure.md) (specifically, it must be located at `sdk/<servicename>/<packagename>`) and your library's `package.json` must contain the required scripts as documented [above](#other-npm-scripts).
|
||||
|
||||
The repository contains two different sets of libraries, each follows different rules for development and maintaining. The first type is generated automatically from the [swagger specifications](https://github.com/Azure/azure-rest-api-specs) and their code should not be edited by hand. Onboarding such library is just a matter of pushing its auto-generated directory to the right location in the repository.
|
||||
|
||||
|
|
|
|||
|
|
@ -35,11 +35,11 @@ Libraries which enable you to provision specific resources. They are responsible
|
|||
- For detailed documentation visit our [Azure SDK for JavaScript documentation](https://aka.ms/js-docs)
|
||||
- File an issue via [GitHub Issues](https://github.com/Azure/azure-sdk-for-js/issues)
|
||||
- Check [previous questions](https://stackoverflow.com/questions/tagged/azure-sdk-js) or ask new ones on StackOverflow using `azure-sdk-js` tag.
|
||||
- Read our [Support documentation](https://github.com/Azure/azure-sdk-for-js/blob/master/SUPPORT.md).
|
||||
- Read our [Support documentation](https://github.com/Azure/azure-sdk-for-js/blob/main/SUPPORT.md).
|
||||
|
||||
### Community
|
||||
|
||||
Try our [community resources](https://github.com/Azure/azure-sdk-for-js/blob/master/SUPPORT.md#community-resources).
|
||||
Try our [community resources](https://github.com/Azure/azure-sdk-for-js/blob/main/SUPPORT.md#community-resources).
|
||||
|
||||
### Reporting security issues and security bugs
|
||||
|
||||
|
|
@ -47,7 +47,7 @@ Security issues and bugs should be reported privately, via email, to the Microso
|
|||
|
||||
## Contributing
|
||||
|
||||
For details on contributing to this repository, see the [contributing guide](https://github.com/Azure/azure-sdk-for-js/blob/master/CONTRIBUTING.md).
|
||||
For details on contributing to this repository, see the [contributing guide](https://github.com/Azure/azure-sdk-for-js/blob/main/CONTRIBUTING.md).
|
||||
|
||||
This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit
|
||||
https://cla.microsoft.com.
|
||||
|
|
|
|||
|
|
@ -5,7 +5,7 @@ uses package dependencies, loads all packages into a single process, and
|
|||
executes code samples to ensure basic end to end scenarios work as expected.
|
||||
|
||||
Smoke Tests are meant to be run periodically in an Azure DevOps pipeline. See
|
||||
[`smoke-tests.yml`](https://github.com/Azure/azure-sdk-for-js/blob/master/common/smoke-test/smoke-tests.yml) to configure Smoke Tests in an Azure
|
||||
[`smoke-tests.yml`](https://github.com/Azure/azure-sdk-for-js/blob/main/common/smoke-test/smoke-tests.yml) to configure Smoke Tests in an Azure
|
||||
DevOps pipeline. When run in an Azure DevOps pipeline specify the `-CI` flag to
|
||||
ensure environment variables are properly set and error/warning messages are
|
||||
properly surfaced during the execution.
|
||||
|
|
@ -24,7 +24,7 @@ package.
|
|||
- PowerShell 7
|
||||
- [Azure Powershell cmdlets](https://docs.microsoft.com/powershell/azure/install-az-ps?view=azps-4.7.0)
|
||||
- Node 12.x
|
||||
- Azure SDK for JS [`dev-tool`](https://github.com/Azure/azure-sdk-for-js/blob/master/common/tools/dev-tool)
|
||||
- Azure SDK for JS [`dev-tool`](https://github.com/Azure/azure-sdk-for-js/blob/main/common/tools/dev-tool)
|
||||
|
||||
## Configuring Samples
|
||||
|
||||
|
|
|
|||
|
|
@ -13,14 +13,15 @@ It provides a place to centralize scripts, resources, and processes for developm
|
|||
`dev-tool` uses a command hierarchy. For example, at the time of writing, the command tree looks like this:
|
||||
|
||||
`dev-tool`
|
||||
- `about` (display command help and information)
|
||||
- `package`
|
||||
- `resolve` (display information about the project that owns a directory)
|
||||
- `samples`
|
||||
- `dev` (link samples to local sources for access to IntelliSense during development)
|
||||
- `prep` (prepare samples for local source-linked execution)
|
||||
- `run` (execute a sample or all samples within a directory)
|
||||
- `check-node-versions` (execute samples with different node versions, typically in preparation for release)
|
||||
|
||||
- `about` (display command help and information)
|
||||
- `package`
|
||||
- `resolve` (display information about the project that owns a directory)
|
||||
- `samples`
|
||||
- `dev` (link samples to local sources for access to IntelliSense during development)
|
||||
- `prep` (prepare samples for local source-linked execution)
|
||||
- `run` (execute a sample or all samples within a directory)
|
||||
- `check-node-versions` (execute samples with different node versions, typically in preparation for release)
|
||||
|
||||
The `dev-tool about` command will print some information about how to use the command. All commands additionally accept the `--help` argument, which will print information about the usage of that specific command. For example, to show help information for the `resolve` command above, issue the command `dev-tool package resolve --help`.
|
||||
|
||||
|
|
@ -40,6 +41,7 @@ To create a new leaf command in one of the existing sub-command, create a new Ty
|
|||
As an example, we can create a new `hello-world` command under the `dev-tool package` sub-command. The command will print out a string using the many different logging functions. It will accept an argument `--echo <string here>` that specifies the string to be printed.
|
||||
|
||||
`src/commands/package/hello-world.ts`
|
||||
|
||||
```typescript
|
||||
// Copyright (c) Microsoft Corporation.
|
||||
// Licensed under the MIT license
|
||||
|
|
@ -70,16 +72,17 @@ export default leafCommand(commandInfo, async (options) => {
|
|||
});
|
||||
```
|
||||
|
||||
(__Note__: using the `makeCommandInfo` function is required to have strong type-checking on the `options` parameter of the handler. The `options` field of `commandInfo` must have a very strong type, and `makeCommandInfo` takes care of ensuring that the type is as strongly specified as possible.)
|
||||
(**Note**: using the `makeCommandInfo` function is required to have strong type-checking on the `options` parameter of the handler. The `options` field of `commandInfo` must have a very strong type, and `makeCommandInfo` takes care of ensuring that the type is as strongly specified as possible.)
|
||||
|
||||
As a last step, add a mapping for the `"hello-world"` command to the sub-command map in `src/commands/package/index.ts`. This will allow the command to resolve:
|
||||
|
||||
`src/commands/package/index.ts`
|
||||
|
||||
```typescript
|
||||
// ...
|
||||
|
||||
export default subCommand(commandInfo, {
|
||||
"hello-world": () => import("./hello-world"),
|
||||
"hello-world": () => import("./hello-world")
|
||||
// ... rest of the sub-commands still here
|
||||
});
|
||||
```
|
||||
|
|
@ -101,6 +104,7 @@ As an example, we can convert the `hello-world` example above into a branching c
|
|||
Instead of creating a single file `hello-world.ts`, we will instead create a folder `src/commands/hello` and two ts files: `src/commands/hello/index.ts` and `src/commands/hello/world.ts`. In `src/commands/hello/index.ts`, we can define our new sub-command:
|
||||
|
||||
`src/commands/hello/index.ts`
|
||||
|
||||
```typescript
|
||||
// Copyright (c) Microsoft Corporation.
|
||||
// Licensed under the MIT license
|
||||
|
|
@ -114,11 +118,12 @@ export default subCommand(commandInfo, {
|
|||
});
|
||||
```
|
||||
|
||||
(__Note__: Since we don't have any arguments or options to add to the sub-command, the `options` argument to `makeCommandInfo` is omitted (since the sub-command just delegates to its child commands, we wouldn't be able to use any options in this parent command anyway).)
|
||||
(**Note**: Since we don't have any arguments or options to add to the sub-command, the `options` argument to `makeCommandInfo` is omitted (since the sub-command just delegates to its child commands, we wouldn't be able to use any options in this parent command anyway).)
|
||||
|
||||
This simple file establishes the mapping from the command name `"world"` to our new command module `src/commands/hello/world.ts`. The contents of `world.ts` are very similar to the previous `hello-world.ts` module, but we will change the `name` field of `commandInfo` and the argument to `createPrinter`:
|
||||
|
||||
`src/commands/hello/world.ts`
|
||||
|
||||
```typescript
|
||||
// Copyright (c) Microsoft Corporation.
|
||||
// Licensed under the MIT license
|
||||
|
|
@ -130,27 +135,29 @@ const log = createPrinter("world");
|
|||
|
||||
export const commandInfo = makeCommandInfo("world", "print a lovely message", {
|
||||
echo: {
|
||||
kind: "string",
|
||||
description: "override the message to be printed",
|
||||
default: "Hello world!"
|
||||
}});
|
||||
kind: "string",
|
||||
description: "override the message to be printed",
|
||||
default: "Hello world!"
|
||||
}
|
||||
});
|
||||
|
||||
export default leafCommand(commandInfo, async (options) => {
|
||||
// Demonstrate the colorized command output.
|
||||
log("Normal:", options.echo);
|
||||
log.success("Success:", options.echo);
|
||||
log.info("Info:", options.echo);
|
||||
log.warn("Warn:", options.echo);
|
||||
log.error("Error:", options.echo);
|
||||
log.debug("Debug:", options.echo);
|
||||
// Demonstrate the colorized command output.
|
||||
log("Normal:", options.echo);
|
||||
log.success("Success:", options.echo);
|
||||
log.info("Info:", options.echo);
|
||||
log.warn("Warn:", options.echo);
|
||||
log.error("Error:", options.echo);
|
||||
log.debug("Debug:", options.echo);
|
||||
|
||||
return true;
|
||||
return true;
|
||||
});
|
||||
```
|
||||
|
||||
The final step is to add a mapping to our new subcommand to the`baseCommands` map root `src/commands/index.ts` file:
|
||||
|
||||
`src/commands/index.ts`
|
||||
|
||||
```typescript
|
||||
// ...
|
||||
|
||||
|
|
@ -158,14 +165,14 @@ The final step is to add a mapping to our new subcommand to the`baseCommands` ma
|
|||
* All of dev-tool's base commands and the modules that define them
|
||||
*/
|
||||
export const baseCommands = {
|
||||
"hello": () => import("./hello")
|
||||
hello: () => import("./hello")
|
||||
// ... all other sub-commands still here
|
||||
} as const;
|
||||
|
||||
// ...
|
||||
```
|
||||
|
||||
(__Note__: If we were adding our `hello` command to another sub-command rather than the root, we would just add it to that sub-command's `index.ts` instead of the root `src/commands/index.ts`, similar to how we added `hello-world` to `src/commands/package/index.ts` in the previous example.)
|
||||
(**Note**: If we were adding our `hello` command to another sub-command rather than the root, we would just add it to that sub-command's `index.ts` instead of the root `src/commands/index.ts`, similar to how we added `hello-world` to `src/commands/package/index.ts` in the previous example.)
|
||||
|
||||
### Understanding the Options Type
|
||||
|
||||
|
|
@ -181,7 +188,7 @@ Each variant supports an optional `shortName` field that specifies a one-letter
|
|||
|
||||
### Final Developer Notes
|
||||
|
||||
- Using the `subCommand` and `leafCommand` helpers is not required. If a command module exports any function with the signature `(...args: string[]) => Promise<boolean>` as its default export, it will run when the command is invoked and will be given the arguments passed in the parameters. __However__, only `subCommand` and `leafCommand` provide automatic argument parsing and handling of `--help`. The functions used to provide this behavior are located in the `src/util/commandBuilder.ts` module.
|
||||
- Using the `subCommand` and `leafCommand` helpers is not required. If a command module exports any function with the signature `(...args: string[]) => Promise<boolean>` as its default export, it will run when the command is invoked and will be given the arguments passed in the parameters. **However**, only `subCommand` and `leafCommand` provide automatic argument parsing and handling of `--help`. The functions used to provide this behavior are located in the `src/util/commandBuilder.ts` module.
|
||||
- Some additional helper modules can be found in `src/util` such as `resolveProject.ts` which walks up the directory hierarchy and finds the absolute path of the nearest SDK package directory (useful for commands like `samples` which always operate relative to the package directory)
|
||||
- The tool runs using the `transpileOnly` option in the `ts-node` configuration, meaning it does not perform run-time type-checking. The build step of the package will run type-checking using `tsc`, so to check the tool's code for type errors, simply use `rushx build`.
|
||||
|
||||
|
|
@ -199,4 +206,4 @@ This project has adopted the [Microsoft Open Source Code of Conduct](https://ope
|
|||
For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or
|
||||
contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments.
|
||||
|
||||
If you'd like to contribute to this library, please read the [contributing guide](https://github.com/Azure/azure-sdk-for-js/blob/master/CONTRIBUTING.md) to learn more about how to build and test the code.
|
||||
If you'd like to contribute to this library, please read the [contributing guide](https://github.com/Azure/azure-sdk-for-js/blob/main/CONTRIBUTING.md) to learn more about how to build and test the code.
|
||||
|
|
|
|||
|
|
@ -76,48 +76,48 @@ Some rules (see table below) are fixable using the `--fix` ESLint option (added
|
|||
|
||||
### Rules
|
||||
|
||||
| Rule | Default | Fixable | Release |
|
||||
| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------- | ------------------ | ------- |
|
||||
| [**github-source-headers**]https://github.com/Azure/azure-sdk-for-js/blob/master/common/tools/eslint-plugin-azure-sdk/docs/rules/github-source-headers.md) | :triangular_flag_on_post: | :heavy_check_mark: | `1.1.0` |
|
||||
| [**ts-apisurface-standardized-verbs**](https://github.com/Azure/azure-sdk-for-js/blob/master/common/tools/eslint-plugin-azure-sdk/docs/rules/ts-apisurface-standardized-verbs.md) | :triangular_flag_on_post: | :x: | `1.2.0` |
|
||||
| [**ts-apisurface-supportcancellation**](https://github.com/Azure/azure-sdk-for-js/blob/master/common/tools/eslint-plugin-azure-sdk/docs/rules/ts-apisurface-supportcancellation.md) | :triangular_flag_on_post: | :x: | `1.2.0` |
|
||||
| [**ts-config-allowsyntheticdefaultimports**](https://github.com/Azure/azure-sdk-for-js/blob/master/common/tools/eslint-plugin-azure-sdk/docs/rules/ts-config-allowsyntheticdefaultimports.md) | :triangular_flag_on_post: | :heavy_check_mark: | `1.0.0` |
|
||||
| [**ts-config-declaration**](https://github.com/Azure/azure-sdk-for-js/blob/master/common/tools/eslint-plugin-azure-sdk/docs/rules/ts-config-declaration.md) | :triangular_flag_on_post: | :heavy_check_mark: | `1.0.0` |
|
||||
| [**ts-config-esmoduleinterop**](https://github.com/Azure/azure-sdk-for-js/blob/master/common/tools/eslint-plugin-azure-sdk/docs/rules/ts-config-esmoduleinterop.md) | :triangular_flag_on_post: | :heavy_check_mark: | `1.0.0` |
|
||||
| [**ts-config-exclude**](https://github.com/Azure/azure-sdk-for-js/blob/master/common/tools/eslint-plugin-azure-sdk/docs/rules/ts-config-exclude.md) | :triangular_flag_on_post: | :heavy_check_mark: | `1.0.0` |
|
||||
| [**ts-config-forceconsistentcasinginfilenames**](https://github.com/Azure/azure-sdk-for-js/blob/master/common/tools/eslint-plugin-azure-sdk/docs/rules/ts-config-forceconsistentcasinginfilenames.md) | :triangular_flag_on_post: | :heavy_check_mark: | `1.0.0` |
|
||||
| [**ts-config-importhelpers**](https://github.com/Azure/azure-sdk-for-js/blob/master/common/tools/eslint-plugin-azure-sdk/docs/rules/ts-config-importhelpers.md) | :triangular_flag_on_post: | :heavy_check_mark: | `1.0.0` |
|
||||
| [**ts-config-lib**](https://github.com/Azure/azure-sdk-for-js/blob/master/common/tools/eslint-plugin-azure-sdk/docs/rules/ts-config-lib.md) | :triangular_flag_on_post: | :heavy_check_mark: | `1.0.0` |
|
||||
| [**ts-config-module**](https://github.com/Azure/azure-sdk-for-js/blob/master/common/tools/eslint-plugin-azure-sdk/docs/rules/ts-config-module.md) | :triangular_flag_on_post: | :heavy_check_mark: | `1.0.0` |
|
||||
| [**ts-config-moduleresolution**](https://github.com/Azure/azure-sdk-for-js/blob/master/common/tools/eslint-plugin-azure-sdk/docs/rules/ts-config-moduleresolution.md) | :triangular_flag_on_post: | :heavy_check_mark: | `1.1.0` |
|
||||
| [**ts-config-no-experimentaldecorators**](https://github.com/Azure/azure-sdk-for-js/blob/master/common/tools/eslint-plugin-azure-sdk/docs/rules/ts-config-no-experimentaldecorators.md) | :triangular_flag_on_post: | :heavy_check_mark: | `1.0.0` |
|
||||
| [**ts-config-sourcemap**](https://github.com/Azure/azure-sdk-for-js/blob/master/common/tools/eslint-plugin-azure-sdk/docs/rules/ts-config-sourcemap.md) | :triangular_flag_on_post: | :heavy_check_mark: | `1.0.0` |
|
||||
| [**ts-config-strict**](https://github.com/Azure/azure-sdk-for-js/blob/master/common/tools/eslint-plugin-azure-sdk/docs/rules/ts-config-strict.md) | :triangular_flag_on_post: | :heavy_check_mark: | `1.0.0` |
|
||||
| [**ts-config-target**](https://github.com/Azure/azure-sdk-for-js/blob/master/common/tools/eslint-plugin-azure-sdk/docs/rules/ts-config-target.md) | :triangular_flag_on_post: | :x: | `1.1.0` |
|
||||
| [**ts-doc-internal**](https://github.com/Azure/azure-sdk-for-js/blob/master/common/tools/eslint-plugin-azure-sdk/docs/rules/ts-doc-internal.md) | :triangular_flag_on_post: | :x: | `1.1.0` |
|
||||
| [**ts-error-handling**](https://github.com/Azure/azure-sdk-for-js/blob/master/common/tools/eslint-plugin-azure-sdk/docs/rules/ts-error-handling.md) | :heavy_multiplication_x: | :x: | `1.1.0` |
|
||||
| [**ts-modules-only-named**](https://github.com/Azure/azure-sdk-for-js/blob/master/common/tools/eslint-plugin-azure-sdk/docs/rules/ts-modules-only-named.md) | :triangular_flag_on_post: | :x: | `1.1.0` |
|
||||
| [**ts-naming-drop-noun**](https://github.com/Azure/azure-sdk-for-js/blob/master/common/tools/eslint-plugin-azure-sdk/docs/rules/ts-naming-drop-noun.md) | :triangular_flag_on_post: | :x: | `1.2.0` |
|
||||
| [**ts-naming-options**](https://github.com/Azure/azure-sdk-for-js/blob/master/common/tools/eslint-plugin-azure-sdk/docs/rules/ts-naming-options.md) | :triangular_flag_on_post: | :x: | `1.2.0` |
|
||||
| [**ts-naming-subclients**](https://github.com/Azure/azure-sdk-for-js/blob/master/common/tools/eslint-plugin-azure-sdk/docs/rules/ts-naming-subclients.md) | :triangular_flag_on_post: | :x: | `1.2.0` |
|
||||
| [**ts-no-const-enums**](https://github.com/Azure/azure-sdk-for-js/blob/master/common/tools/eslint-plugin-azure-sdk/docs/rules/ts-no-const-enums.md) | :warning: | :heavy_check_mark: | `1.1.0` |
|
||||
| [**ts-no-window**](https://github.com/Azure/azure-sdk-for-js/blob/master/common/tools/eslint-plugin-azure-sdk/docs/rules/ts-no-window.md) | :triangular_flag_on_post: | :heavy_check_mark: | `3.1.0` |
|
||||
| [**ts-no-namespaces**](https://github.com/Azure/azure-sdk-for-js/blob/master/common/tools/eslint-plugin-azure-sdk/docs/rules/ts-no-namespaces.md) | :triangular_flag_on_post: | :x: | `1.2.0` |
|
||||
| [**ts-package-json-author**](https://github.com/Azure/azure-sdk-for-js/blob/master/common/tools/eslint-plugin-azure-sdk/docs/rules/ts-package-json-author.md) | :triangular_flag_on_post: | :heavy_check_mark: | `1.0.0` |
|
||||
| [**ts-package-json-bugs**](https://github.com/Azure/azure-sdk-for-js/blob/master/common/tools/eslint-plugin-azure-sdk/docs/rules/ts-package-json-bugs.md) | :triangular_flag_on_post: | :heavy_check_mark: | `1.0.0` |
|
||||
| [**ts-package-json-engine-is-present**](https://github.com/Azure/azure-sdk-for-js/blob/master/common/tools/eslint-plugin-azure-sdk/docs/rules/ts-package-json-engine-is-present.md) | :triangular_flag_on_post: | :heavy_check_mark: | `1.1.0` |
|
||||
| [**ts-package-json-files-required**](https://github.com/Azure/azure-sdk-for-js/blob/master/common/tools/eslint-plugin-azure-sdk/docs/rules/ts-package-json-files-required.md) | :triangular_flag_on_post: | :heavy_check_mark: | `1.1.0` |
|
||||
| [**ts-package-json-homepage**](https://github.com/Azure/azure-sdk-for-js/blob/master/common/tools/eslint-plugin-azure-sdk/docs/rules/ts-package-json-homepage.md) | :triangular_flag_on_post: | :x: | `1.0.0` |
|
||||
| [**ts-package-json-keywords**](https://github.com/Azure/azure-sdk-for-js/blob/master/common/tools/eslint-plugin-azure-sdk/docs/rules/ts-package-json-keywords.md) | :triangular_flag_on_post: | :heavy_check_mark: | `1.0.0` |
|
||||
| [**ts-package-json-license**](https://github.com/Azure/azure-sdk-for-js/blob/master/common/tools/eslint-plugin-azure-sdk/docs/rules/ts-package-json-license.md) | :triangular_flag_on_post: | :heavy_check_mark: | `1.0.0` |
|
||||
| [**ts-package-json-main-is-cjs**](https://github.com/Azure/azure-sdk-for-js/blob/master/common/tools/eslint-plugin-azure-sdk/docs/rules/ts-package-json-main-is-cjs.md) | :triangular_flag_on_post: | :heavy_check_mark: | `1.1.0` |
|
||||
| [**ts-package-json-module**](https://github.com/Azure/azure-sdk-for-js/blob/master/common/tools/eslint-plugin-azure-sdk/docs/rules/ts-package-json-module.md) | :triangular_flag_on_post: | :heavy_check_mark: | `1.1.0` |
|
||||
| [**ts-package-json-name**](https://github.com/Azure/azure-sdk-for-js/blob/master/common/tools/eslint-plugin-azure-sdk/docs/rules/ts-package-json-name.md) | :triangular_flag_on_post: | :x: | `1.0.0` |
|
||||
| [**ts-package-json-repo**](https://github.com/Azure/azure-sdk-for-js/blob/master/common/tools/eslint-plugin-azure-sdk/docs/rules/ts-package-json-repo.md) | :triangular_flag_on_post: | :heavy_check_mark: | `1.0.0` |
|
||||
| [**ts-package-json-required-scripts**](https://github.com/Azure/azure-sdk-for-js/blob/master/common/tools/eslint-plugin-azure-sdk/docs/rules/ts-package-json-required-scripts.md) | :triangular_flag_on_post: | :x: | `1.0.0` |
|
||||
| [**ts-package-json-sideeffects**](https://github.com/Azure/azure-sdk-for-js/blob/master/common/tools/eslint-plugin-azure-sdk/docs/rules/ts-package-json-sideeffects.md) | :triangular_flag_on_post: | :heavy_check_mark: | `1.0.0` |
|
||||
| [**ts-package-json-types**](https://github.com/Azure/azure-sdk-for-js/blob/master/common/tools/eslint-plugin-azure-sdk/docs/rules/ts-package-json-types.md) | :triangular_flag_on_post: | :x: | `1.1.0` |
|
||||
| [**ts-pagination-list**](https://github.com/Azure/azure-sdk-for-js/blob/master/common/tools/eslint-plugin-azure-sdk/docs/rules/ts-pagination-list.md) | :triangular_flag_on_post: | :x: | `1.2.0` |
|
||||
| [**ts-use-interface-parameters**](https://github.com/Azure/azure-sdk-for-js/blob/master/common/tools/eslint-plugin-azure-sdk/docs/rules/ts-use-interface-parameters.md) | :warning: | :x: | `1.1.0` |
|
||||
| [**ts-use-promises**](https://github.com/Azure/azure-sdk-for-js/blob/master/common/tools/eslint-plugin-azure-sdk/docs/rules/ts-use-promises.md) | :triangular_flag_on_post: | :x: | `1.1.0` |
|
||||
| [**ts-versioning-semver**](https://github.com/Azure/azure-sdk-for-js/blob/master/common/tools/eslint-plugin-azure-sdk/docs/rules/ts-versioning-semver.md) | :triangular_flag_on_post: | :x: | `1.1.0` |
|
||||
| Rule | Default | Fixable | Release |
|
||||
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------- | ------------------ | ------- |
|
||||
| [**github-source-headers**]https://github.com/Azure/azure-sdk-for-js/blob/main/common/tools/eslint-plugin-azure-sdk/docs/rules/github-source-headers.md) | :triangular_flag_on_post: | :heavy_check_mark: | `1.1.0` |
|
||||
| [**ts-apisurface-standardized-verbs**](https://github.com/Azure/azure-sdk-for-js/blob/main/common/tools/eslint-plugin-azure-sdk/docs/rules/ts-apisurface-standardized-verbs.md) | :triangular_flag_on_post: | :x: | `1.2.0` |
|
||||
| [**ts-apisurface-supportcancellation**](https://github.com/Azure/azure-sdk-for-js/blob/main/common/tools/eslint-plugin-azure-sdk/docs/rules/ts-apisurface-supportcancellation.md) | :triangular_flag_on_post: | :x: | `1.2.0` |
|
||||
| [**ts-config-allowsyntheticdefaultimports**](https://github.com/Azure/azure-sdk-for-js/blob/main/common/tools/eslint-plugin-azure-sdk/docs/rules/ts-config-allowsyntheticdefaultimports.md) | :triangular_flag_on_post: | :heavy_check_mark: | `1.0.0` |
|
||||
| [**ts-config-declaration**](https://github.com/Azure/azure-sdk-for-js/blob/main/common/tools/eslint-plugin-azure-sdk/docs/rules/ts-config-declaration.md) | :triangular_flag_on_post: | :heavy_check_mark: | `1.0.0` |
|
||||
| [**ts-config-esmoduleinterop**](https://github.com/Azure/azure-sdk-for-js/blob/main/common/tools/eslint-plugin-azure-sdk/docs/rules/ts-config-esmoduleinterop.md) | :triangular_flag_on_post: | :heavy_check_mark: | `1.0.0` |
|
||||
| [**ts-config-exclude**](https://github.com/Azure/azure-sdk-for-js/blob/main/common/tools/eslint-plugin-azure-sdk/docs/rules/ts-config-exclude.md) | :triangular_flag_on_post: | :heavy_check_mark: | `1.0.0` |
|
||||
| [**ts-config-forceconsistentcasinginfilenames**](https://github.com/Azure/azure-sdk-for-js/blob/main/common/tools/eslint-plugin-azure-sdk/docs/rules/ts-config-forceconsistentcasinginfilenames.md) | :triangular_flag_on_post: | :heavy_check_mark: | `1.0.0` |
|
||||
| [**ts-config-importhelpers**](https://github.com/Azure/azure-sdk-for-js/blob/main/common/tools/eslint-plugin-azure-sdk/docs/rules/ts-config-importhelpers.md) | :triangular_flag_on_post: | :heavy_check_mark: | `1.0.0` |
|
||||
| [**ts-config-lib**](https://github.com/Azure/azure-sdk-for-js/blob/main/common/tools/eslint-plugin-azure-sdk/docs/rules/ts-config-lib.md) | :triangular_flag_on_post: | :heavy_check_mark: | `1.0.0` |
|
||||
| [**ts-config-module**](https://github.com/Azure/azure-sdk-for-js/blob/main/common/tools/eslint-plugin-azure-sdk/docs/rules/ts-config-module.md) | :triangular_flag_on_post: | :heavy_check_mark: | `1.0.0` |
|
||||
| [**ts-config-moduleresolution**](https://github.com/Azure/azure-sdk-for-js/blob/main/common/tools/eslint-plugin-azure-sdk/docs/rules/ts-config-moduleresolution.md) | :triangular_flag_on_post: | :heavy_check_mark: | `1.1.0` |
|
||||
| [**ts-config-no-experimentaldecorators**](https://github.com/Azure/azure-sdk-for-js/blob/main/common/tools/eslint-plugin-azure-sdk/docs/rules/ts-config-no-experimentaldecorators.md) | :triangular_flag_on_post: | :heavy_check_mark: | `1.0.0` |
|
||||
| [**ts-config-sourcemap**](https://github.com/Azure/azure-sdk-for-js/blob/main/common/tools/eslint-plugin-azure-sdk/docs/rules/ts-config-sourcemap.md) | :triangular_flag_on_post: | :heavy_check_mark: | `1.0.0` |
|
||||
| [**ts-config-strict**](https://github.com/Azure/azure-sdk-for-js/blob/main/common/tools/eslint-plugin-azure-sdk/docs/rules/ts-config-strict.md) | :triangular_flag_on_post: | :heavy_check_mark: | `1.0.0` |
|
||||
| [**ts-config-target**](https://github.com/Azure/azure-sdk-for-js/blob/main/common/tools/eslint-plugin-azure-sdk/docs/rules/ts-config-target.md) | :triangular_flag_on_post: | :x: | `1.1.0` |
|
||||
| [**ts-doc-internal**](https://github.com/Azure/azure-sdk-for-js/blob/main/common/tools/eslint-plugin-azure-sdk/docs/rules/ts-doc-internal.md) | :triangular_flag_on_post: | :x: | `1.1.0` |
|
||||
| [**ts-error-handling**](https://github.com/Azure/azure-sdk-for-js/blob/main/common/tools/eslint-plugin-azure-sdk/docs/rules/ts-error-handling.md) | :heavy_multiplication_x: | :x: | `1.1.0` |
|
||||
| [**ts-modules-only-named**](https://github.com/Azure/azure-sdk-for-js/blob/main/common/tools/eslint-plugin-azure-sdk/docs/rules/ts-modules-only-named.md) | :triangular_flag_on_post: | :x: | `1.1.0` |
|
||||
| [**ts-naming-drop-noun**](https://github.com/Azure/azure-sdk-for-js/blob/main/common/tools/eslint-plugin-azure-sdk/docs/rules/ts-naming-drop-noun.md) | :triangular_flag_on_post: | :x: | `1.2.0` |
|
||||
| [**ts-naming-options**](https://github.com/Azure/azure-sdk-for-js/blob/main/common/tools/eslint-plugin-azure-sdk/docs/rules/ts-naming-options.md) | :triangular_flag_on_post: | :x: | `1.2.0` |
|
||||
| [**ts-naming-subclients**](https://github.com/Azure/azure-sdk-for-js/blob/main/common/tools/eslint-plugin-azure-sdk/docs/rules/ts-naming-subclients.md) | :triangular_flag_on_post: | :x: | `1.2.0` |
|
||||
| [**ts-no-const-enums**](https://github.com/Azure/azure-sdk-for-js/blob/main/common/tools/eslint-plugin-azure-sdk/docs/rules/ts-no-const-enums.md) | :warning: | :heavy_check_mark: | `1.1.0` |
|
||||
| [**ts-no-window**](https://github.com/Azure/azure-sdk-for-js/blob/main/common/tools/eslint-plugin-azure-sdk/docs/rules/ts-no-window.md) | :triangular_flag_on_post: | :heavy_check_mark: | `3.1.0` |
|
||||
| [**ts-no-namespaces**](https://github.com/Azure/azure-sdk-for-js/blob/main/common/tools/eslint-plugin-azure-sdk/docs/rules/ts-no-namespaces.md) | :triangular_flag_on_post: | :x: | `1.2.0` |
|
||||
| [**ts-package-json-author**](https://github.com/Azure/azure-sdk-for-js/blob/main/common/tools/eslint-plugin-azure-sdk/docs/rules/ts-package-json-author.md) | :triangular_flag_on_post: | :heavy_check_mark: | `1.0.0` |
|
||||
| [**ts-package-json-bugs**](https://github.com/Azure/azure-sdk-for-js/blob/main/common/tools/eslint-plugin-azure-sdk/docs/rules/ts-package-json-bugs.md) | :triangular_flag_on_post: | :heavy_check_mark: | `1.0.0` |
|
||||
| [**ts-package-json-engine-is-present**](https://github.com/Azure/azure-sdk-for-js/blob/main/common/tools/eslint-plugin-azure-sdk/docs/rules/ts-package-json-engine-is-present.md) | :triangular_flag_on_post: | :heavy_check_mark: | `1.1.0` |
|
||||
| [**ts-package-json-files-required**](https://github.com/Azure/azure-sdk-for-js/blob/main/common/tools/eslint-plugin-azure-sdk/docs/rules/ts-package-json-files-required.md) | :triangular_flag_on_post: | :heavy_check_mark: | `1.1.0` |
|
||||
| [**ts-package-json-homepage**](https://github.com/Azure/azure-sdk-for-js/blob/main/common/tools/eslint-plugin-azure-sdk/docs/rules/ts-package-json-homepage.md) | :triangular_flag_on_post: | :x: | `1.0.0` |
|
||||
| [**ts-package-json-keywords**](https://github.com/Azure/azure-sdk-for-js/blob/main/common/tools/eslint-plugin-azure-sdk/docs/rules/ts-package-json-keywords.md) | :triangular_flag_on_post: | :heavy_check_mark: | `1.0.0` |
|
||||
| [**ts-package-json-license**](https://github.com/Azure/azure-sdk-for-js/blob/main/common/tools/eslint-plugin-azure-sdk/docs/rules/ts-package-json-license.md) | :triangular_flag_on_post: | :heavy_check_mark: | `1.0.0` |
|
||||
| [**ts-package-json-main-is-cjs**](https://github.com/Azure/azure-sdk-for-js/blob/main/common/tools/eslint-plugin-azure-sdk/docs/rules/ts-package-json-main-is-cjs.md) | :triangular_flag_on_post: | :heavy_check_mark: | `1.1.0` |
|
||||
| [**ts-package-json-module**](https://github.com/Azure/azure-sdk-for-js/blob/main/common/tools/eslint-plugin-azure-sdk/docs/rules/ts-package-json-module.md) | :triangular_flag_on_post: | :heavy_check_mark: | `1.1.0` |
|
||||
| [**ts-package-json-name**](https://github.com/Azure/azure-sdk-for-js/blob/main/common/tools/eslint-plugin-azure-sdk/docs/rules/ts-package-json-name.md) | :triangular_flag_on_post: | :x: | `1.0.0` |
|
||||
| [**ts-package-json-repo**](https://github.com/Azure/azure-sdk-for-js/blob/main/common/tools/eslint-plugin-azure-sdk/docs/rules/ts-package-json-repo.md) | :triangular_flag_on_post: | :heavy_check_mark: | `1.0.0` |
|
||||
| [**ts-package-json-required-scripts**](https://github.com/Azure/azure-sdk-for-js/blob/main/common/tools/eslint-plugin-azure-sdk/docs/rules/ts-package-json-required-scripts.md) | :triangular_flag_on_post: | :x: | `1.0.0` |
|
||||
| [**ts-package-json-sideeffects**](https://github.com/Azure/azure-sdk-for-js/blob/main/common/tools/eslint-plugin-azure-sdk/docs/rules/ts-package-json-sideeffects.md) | :triangular_flag_on_post: | :heavy_check_mark: | `1.0.0` |
|
||||
| [**ts-package-json-types**](https://github.com/Azure/azure-sdk-for-js/blob/main/common/tools/eslint-plugin-azure-sdk/docs/rules/ts-package-json-types.md) | :triangular_flag_on_post: | :x: | `1.1.0` |
|
||||
| [**ts-pagination-list**](https://github.com/Azure/azure-sdk-for-js/blob/main/common/tools/eslint-plugin-azure-sdk/docs/rules/ts-pagination-list.md) | :triangular_flag_on_post: | :x: | `1.2.0` |
|
||||
| [**ts-use-interface-parameters**](https://github.com/Azure/azure-sdk-for-js/blob/main/common/tools/eslint-plugin-azure-sdk/docs/rules/ts-use-interface-parameters.md) | :warning: | :x: | `1.1.0` |
|
||||
| [**ts-use-promises**](https://github.com/Azure/azure-sdk-for-js/blob/main/common/tools/eslint-plugin-azure-sdk/docs/rules/ts-use-promises.md) | :triangular_flag_on_post: | :x: | `1.1.0` |
|
||||
| [**ts-versioning-semver**](https://github.com/Azure/azure-sdk-for-js/blob/main/common/tools/eslint-plugin-azure-sdk/docs/rules/ts-versioning-semver.md) | :triangular_flag_on_post: | :x: | `1.1.0` |
|
||||
|
|
|
|||
|
|
@ -1,7 +1,6 @@
|
|||
pr:
|
||||
branches:
|
||||
include:
|
||||
- master
|
||||
- main
|
||||
|
||||
paths:
|
||||
|
|
|
|||
|
|
@ -8,13 +8,13 @@ Requires `homepage` in `package.json` to be set to the library's readme.
|
|||
|
||||
```json
|
||||
{
|
||||
"homepage": "https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/servicebus/service-bus/README.md"
|
||||
"homepage": "https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/servicebus/service-bus/README.md"
|
||||
}
|
||||
```
|
||||
|
||||
```json
|
||||
{
|
||||
"homepage": "https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/servicebus/service-bus/"
|
||||
"homepage": "https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/servicebus/service-bus/"
|
||||
}
|
||||
```
|
||||
|
||||
|
|
@ -22,7 +22,7 @@ Requires `homepage` in `package.json` to be set to the library's readme.
|
|||
|
||||
```json
|
||||
{
|
||||
"homepage": "https://github.com/Azure/azure-sdk-for-js/blob/master/README.md"
|
||||
"homepage": "https://github.com/Azure/azure-sdk-for-js/blob/main/README.md"
|
||||
}
|
||||
```
|
||||
|
||||
|
|
@ -34,7 +34,7 @@ Requires `homepage` in `package.json` to be set to the library's readme.
|
|||
|
||||
```json
|
||||
{
|
||||
"homepage": "https://github.com/Azure/azure-sdk-for-java/blob/master/sdk/servicebus/service-bus/README.md"
|
||||
"homepage": "https://github.com/Azure/azure-sdk-for-java/blob/main/sdk/servicebus/service-bus/README.md"
|
||||
}
|
||||
```
|
||||
|
||||
|
|
|
|||
|
|
@ -484,4 +484,4 @@ This will emit a compiled version of `index.html`, as well as any included scrip
|
|||
|
||||
## Examples
|
||||
|
||||
For real working examples of using each bundler with both TypeScript and JavaScript, please look at the [samples/Bundling](https://github.com/Azure/azure-sdk-for-js/tree/master/samples/Bundling) folder in this repository.
|
||||
For real working examples of using each bundler with both TypeScript and JavaScript, please look at the [samples/Bundling](https://github.com/Azure/azure-sdk-for-js/tree/main/samples/Bundling) folder in this repository.
|
||||
|
|
|
|||
|
|
@ -24,7 +24,7 @@ platform needs two things: a tenant and an app registration created for that
|
|||
tenant.
|
||||
|
||||
A "tenant" is basically instance of Azure Active Directory associated with your
|
||||
Azure account. You can follow the instructions on [this quick start guide for
|
||||
Azure account. You can follow the instructions on [this quick start guide for
|
||||
setting up a
|
||||
tenant](https://docs.microsoft.com/azure/active-directory/develop/quickstart-create-new-tenant)
|
||||
to check if you have AAD tenant already or, if not, create one.
|
||||
|
|
@ -34,7 +34,7 @@ quickstart guide for app
|
|||
registrations](https://docs.microsoft.com/azure/active-directory/develop/quickstart-register-app).
|
||||
Your app registration holds the configuration for how your application will
|
||||
authenticate users and services, so it's very important to it set up correctly
|
||||
before using any of the credential types below. The section on each credential
|
||||
before using any of the credential types below. The section on each credential
|
||||
will indicate which configuration settings it needs and how to use them.
|
||||
|
||||
### Should my App be Single or Multi Tenant?
|
||||
|
|
@ -58,18 +58,18 @@ personal Microsoft accounts after it's already created.
|
|||
## Understanding the Credential Types
|
||||
|
||||
Microsoft identity platform provides a variety of authentication flows that
|
||||
serve different use cases and application types. A primary differentiator
|
||||
serve different use cases and application types. A primary differentiator
|
||||
between these flows is whether the "client" that initiates the flow is running
|
||||
on a user device or on a system managed by the application developer (like a web
|
||||
server). The [Microsoft Authentication
|
||||
server). The [Microsoft Authentication
|
||||
Library](https://docs.microsoft.com/azure/active-directory/develop/msal-client-applications)
|
||||
documentation describes this distinction as _public_ versus _confidential_
|
||||
clients.
|
||||
|
||||
Most of the credential types are strictly public or confidential as they serve a
|
||||
specific purpose, like authenticating a backend service for use with storage
|
||||
APIs. Some credentials may be both public or confidential depending on how you
|
||||
configure them. For example, the [authorization code
|
||||
APIs. Some credentials may be both public or confidential depending on how you
|
||||
configure them. For example, the [authorization code
|
||||
flow](https://docs.microsoft.com/azure/active-directory/develop/v2-oauth2-auth-code-flow)
|
||||
can be initiated from a mobile application _or_ from within a web application
|
||||
running in a server.
|
||||
|
|
@ -88,9 +88,9 @@ credential for your application:
|
|||
- If not, use the `EnvironmentCredential`
|
||||
|
||||
- **Do you want your application to pick the appropriate credential type based on the
|
||||
environment?**
|
||||
environment?**
|
||||
|
||||
- Use the `DefaultAzureCredential`
|
||||
- Use the `DefaultAzureCredential`
|
||||
|
||||
- **Is the application deployed to a user device or running in the browser?**
|
||||
|
||||
|
|
@ -109,16 +109,16 @@ The identity platform provides an authorization model for Azure services with
|
|||
permissions](https://docs.microsoft.com/azure/active-directory/develop/v2-permissions-and-consent#troubleshooting-permissions-and-consent):
|
||||
|
||||
- **Application permissions** authorize an application to access resources
|
||||
directly. Administrator consent must be granted to your application.
|
||||
directly. Administrator consent must be granted to your application.
|
||||
- **Delegated permissions** authorize an application to access resources on
|
||||
behalf of a specific user. The user may grant permission to your application
|
||||
behalf of a specific user. The user may grant permission to your application
|
||||
unless the permission requires administrator consent.
|
||||
|
||||
If you are only using _confidential credentials_ you should only need to be
|
||||
concerned with application permissions. If you will be authenticating users
|
||||
concerned with application permissions. If you will be authenticating users
|
||||
with a _public credential_, you must configure API permissions for the Azure
|
||||
service you need to access (Key Vault, Storage, etc) so that user accounts can
|
||||
be authorized to use them through your application. The [quick start guide for
|
||||
be authorized to use them through your application. The [quick start guide for
|
||||
configuring API
|
||||
permissions](https://docs.microsoft.com/azure/active-directory/develop/quickstart-configure-app-access-web-apis)
|
||||
explains how to do this in detail.
|
||||
|
|
@ -128,19 +128,19 @@ explains how to do this in detail.
|
|||
When a user is being authenticated to access a service that is configured with
|
||||
delegated permissions, they may be presented with a consent screen that asks
|
||||
whether they want to grant your application permission to access resources on
|
||||
their behalf. An example of this consent flow can be found in the [consent
|
||||
their behalf. An example of this consent flow can be found in the [consent
|
||||
framework documentation
|
||||
page](https://docs.microsoft.com/azure/active-directory/develop/consent-framework).
|
||||
|
||||
An administrator can also grant consent for your application on behalf of all
|
||||
users. In this case, users may never see a consent screen. If you'd like to
|
||||
users. In this case, users may never see a consent screen. If you'd like to
|
||||
make it easy for an administrator to grant access to all users, follow the
|
||||
instructions in the [admin consent endpoint request
|
||||
documentation](https://docs.microsoft.com/azure/active-directory/develop/v2-permissions-and-consent#request-the-permissions-from-a-directory-admin).
|
||||
|
||||
There are some cases where a user may not be allowed to grant consent to an
|
||||
application. When this occurs, the user may have to speak with an administrator
|
||||
to have the permissions granted on their behalf. The [user consent
|
||||
application. When this occurs, the user may have to speak with an administrator
|
||||
to have the permissions granted on their behalf. The [user consent
|
||||
troubleshooting
|
||||
page](https://docs.microsoft.com/azure/active-directory/manage-apps/application-sign-in-unexpected-user-consent-error)
|
||||
provides more details on the consent errors a user might encounter.
|
||||
|
|
@ -175,7 +175,7 @@ on which credential you are using.
|
|||
|
||||
The `UsernamePasswordCredential` follows the [resource owner password credential
|
||||
flow](https://docs.microsoft.com/azure/active-directory/develop/v2-oauth-ropc)
|
||||
to authenticate public or confidential clients. To use this credential, you
|
||||
to authenticate public or confidential clients. To use this credential, you
|
||||
will need the `tenantId` and `clientId` of your app and a `username` and
|
||||
`password` of the user you are authenticating.
|
||||
|
||||
|
|
@ -187,19 +187,19 @@ This credential type supports multi-tenant app registrations so you may pass
|
|||
`organizations` as the `tenantId` to enable users from any organizational tenant
|
||||
to authenticate.
|
||||
|
||||
Generally speaking, we *do not* recommend using this credential type when other
|
||||
more secure credential types are available. Handling the user's password
|
||||
Generally speaking, we _do not_ recommend using this credential type when other
|
||||
more secure credential types are available. Handling the user's password
|
||||
directly is a major security risk.
|
||||
|
||||
> NOTE: This credential type does not work with personal Microsoft accounts or
|
||||
> multi-factor authentication at this time. See the
|
||||
> multi-factor authentication at this time. See the
|
||||
> [documentation](https://docs.microsoft.com/azure/active-directory/develop/v2-oauth-ropc)
|
||||
> for more information.
|
||||
|
||||
### EnvironmentCredential
|
||||
|
||||
The `EnvironmentCredential` looks for well-known environment variable names to
|
||||
determine how it should authenticate. It effectively acts as a wrapper for the
|
||||
determine how it should authenticate. It effectively acts as a wrapper for the
|
||||
`ClientSecretCredential`, `ClientCertificateCredential` or
|
||||
`UsernamePasswordCredential` depending on which environment variables are
|
||||
present.
|
||||
|
|
@ -210,7 +210,7 @@ Containers, etc.
|
|||
|
||||
In all cases, the `AZURE_TENANT_ID` and `AZURE_CLIENT_ID` environment variables
|
||||
are expected to be present to use this credential as they identify your
|
||||
application. The following environment variables will then be tried in order:
|
||||
application. The following environment variables will then be tried in order:
|
||||
|
||||
- `AZURE_CLIENT_SECRET` - A client secret to be used with
|
||||
`ClientSecretCredential`
|
||||
|
|
@ -231,7 +231,7 @@ machines, App Services, Functions, Container Services, [and
|
|||
more](https://docs.microsoft.com/azure/active-directory/managed-identities-azure-resources/services-support-managed-identities).
|
||||
|
||||
One important distinction of this credential compared to the others is that it
|
||||
_does not require an app registration_. This authentication scheme relates to
|
||||
_does not require an app registration_. This authentication scheme relates to
|
||||
the actual Azure resources to which your code is deployed rather than the
|
||||
application itself.
|
||||
|
||||
|
|
@ -251,13 +251,13 @@ to other Azure services through role assignments.
|
|||
|
||||
If you have configured your resource to use a system-assigned identity, you can
|
||||
just create an instance of `ManagedIdentityCredential` without any
|
||||
configuration. For user-assigned identities, you must provide the `clientId` of
|
||||
configuration. For user-assigned identities, you must provide the `clientId` of
|
||||
the managed identity you wish to use for authentication.
|
||||
|
||||
More information on configuring and using managed identities can be found in the
|
||||
[Managed identities for Azure
|
||||
resources](https://docs.microsoft.com/azure/active-directory/managed-identities-azure-resources/overview)
|
||||
documentation. There is also a [list of Azure
|
||||
documentation. There is also a [list of Azure
|
||||
services](https://docs.microsoft.com/azure/active-directory/managed-identities-azure-resources/services-support-managed-identities#azure-services-that-support-azure-ad-authentication)
|
||||
that have been tested to confirm support for managed identity authentication.
|
||||
|
||||
|
|
@ -265,7 +265,7 @@ that have been tested to confirm support for managed identity authentication.
|
|||
|
||||
The `InteractiveBrowserCredential` follows the [implicit grant
|
||||
flow](https://docs.microsoft.com/azure/active-directory/develop/v2-oauth2-implicit-grant-flow)
|
||||
which enables authentication for clients that run completely in the browser. It
|
||||
which enables authentication for clients that run completely in the browser. It
|
||||
is primarily useful for single-page web applications (SPAs) which need to
|
||||
authenticate to access Azure resources and APIs directly.
|
||||
|
||||
|
|
@ -274,8 +274,8 @@ configured with both the **Access tokens** and **ID tokens** options checked und
|
|||
**Implicit grant** in the **Authentication** page.
|
||||
|
||||
You will also need to add a redirect URI in the **Redirect URIs** section of the
|
||||
**Authentication** page for your app registration. The redirect URI must point
|
||||
to the URI of your web application. You must also make sure to specify the same
|
||||
**Authentication** page for your app registration. The redirect URI must point
|
||||
to the URI of your web application. You must also make sure to specify the same
|
||||
URI in the `redirectUri` field of the `InteractiveBrowserCredentialOptions` when
|
||||
creating an `InteractiveBrowserCredential`.
|
||||
|
||||
|
|
@ -302,15 +302,14 @@ which enables server-hosted web applications, native desktop and mobile
|
|||
applications, and web APIs to access resources on the user's behalf.
|
||||
|
||||
This credential requires that the developer have an HTTP(S) endpoint exposed
|
||||
which can receive the authentication response redirect. The URI at which you
|
||||
which can receive the authentication response redirect. The URI at which you
|
||||
host this endpoint must be added to the **Redirect URIs** list on the
|
||||
**Authentication** page of your app registration. If you are developing
|
||||
**Authentication** page of your app registration. If you are developing
|
||||
locally, you can also add a redirect URI for your development endpoint
|
||||
(e.g. `http://localhost:8080/authresponse`).
|
||||
|
||||
A complete example of hosting your own authentication response endpoint can be
|
||||
found in the [`authorization code
|
||||
sample`](https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/identity/identity/samples/manual/authorizationCodeSample.ts).
|
||||
found in the [`authorization code sample`](https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/identity/identity/samples/manual/authorizationCodeSample.ts).
|
||||
|
||||
### DefaultAzureCredential
|
||||
|
||||
|
|
|
|||
|
|
@ -3,7 +3,6 @@ trigger: none
|
|||
pr:
|
||||
branches:
|
||||
include:
|
||||
- master
|
||||
- main
|
||||
paths:
|
||||
include:
|
||||
|
|
|
|||
|
|
@ -1,7 +1,6 @@
|
|||
trigger:
|
||||
branches:
|
||||
include:
|
||||
- master
|
||||
- main
|
||||
paths:
|
||||
include:
|
||||
|
|
|
|||
|
|
@ -1,7 +1,6 @@
|
|||
pr:
|
||||
branches:
|
||||
include:
|
||||
- master
|
||||
- main
|
||||
- '*-preview'
|
||||
paths:
|
||||
|
|
|
|||
|
|
@ -6,7 +6,7 @@ Versioning tools make updating package versions easier. These tools target packa
|
|||
|
||||
### increment.js
|
||||
|
||||
Increment the version number after a release according to [version policies](https://github.com/Azure/azure-sdk/blob/master/docs/policies/releases.md#incrementing-after-release). Uses the current version in package.json to determine the next version.
|
||||
Increment the version number after a release according to [version policies](https://github.com/Azure/azure-sdk/blob/main/docs/policies/releases.md#incrementing-after-release). Uses the current version in package.json to determine the next version.
|
||||
|
||||
```bash
|
||||
node increment.js --artifact-name azure-tempate
|
||||
|
|
@ -94,5 +94,4 @@ const irrelevantVersion = "1.0.0"
|
|||
|
||||
In the above example we see a `packageVersion` that we want to replace and an `irrelevantVersion` that, if replaced, would cause problems with how the code operates. In this case, one would set the prefix to `packageVersion`. The tool matches the prefix on the line and handles any characters between the prefix and a version string (i.e. assignment operators like `=` or `:` in the case of a mapping).
|
||||
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -21,7 +21,7 @@ The Azure SDK repository is organized in the following folder structure, with th
|
|||
|
||||
## Getting Started Samples
|
||||
|
||||
Each package folder contains a package-specific `README.md` file. Most of these `README` files contain samples illustrating basic usage of the the APIs contained in the package. For example, you can find the Getting Started samples for the `@azure/storage-blob` package [here](https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/storage/storage-blob#examples).
|
||||
Each package folder contains a package-specific `README.md` file. Most of these `README` files contain samples illustrating basic usage of the the APIs contained in the package. For example, you can find the Getting Started samples for the `@azure/storage-blob` package [here](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/storage/storage-blob#examples).
|
||||
|
||||
## Package Samples and How-To Guides
|
||||
|
||||
|
|
@ -29,7 +29,7 @@ Each package folder contains a subfolder called `samples` with additional code s
|
|||
|
||||
## Global Samples
|
||||
|
||||
Samples that apply to every package or to no package in particular are located in subdirectories within the root `/samples` directory. For example, the [`/samples/Bundling`](https://github.com/Azure/azure-sdk-for-js/tree/master/samples/Bundling) directory contains sample code illustrating how to configure package bundling tools to work with the Azure SDK for JS packages:
|
||||
Samples that apply to every package or to no package in particular are located in subdirectories within the root `/samples` directory. For example, the [`/samples/Bundling`](https://github.com/Azure/azure-sdk-for-js/tree/main/samples/Bundling) directory contains sample code illustrating how to configure package bundling tools to work with the Azure SDK for JS packages:
|
||||
|
||||
- `/samples/Bundling`
|
||||
- `/parcel` (samples for using the SDK packages with parcel)
|
||||
|
|
@ -40,7 +40,7 @@ Samples that apply to every package or to no package in particular are located i
|
|||
|
||||
(The `rollup` and `webpack` directories also have `js` and `ts` subdirectories for JavaScript and TypeScript respectively.)
|
||||
|
||||
For more information on package bundling, see [`/documentation/Bundling.md`](https://github.com/Azure/azure-sdk-for-js/blob/master/documentation/Bundling.md).
|
||||
For more information on package bundling, see [`/documentation/Bundling.md`](https://github.com/Azure/azure-sdk-for-js/blob/main/documentation/Bundling.md).
|
||||
|
||||
## Sample Applications
|
||||
|
||||
|
|
|
|||
|
|
@ -105,10 +105,10 @@ const result = await client.path("/farmers/{farmerId}", farmerId).patch({
|
|||
name: "Contoso Farmer",
|
||||
description: "Your custom farmer description here",
|
||||
status: "Active",
|
||||
properties: { foo: "bar", "numeric one": 1, "1": "numeric key" },
|
||||
properties: { foo: "bar", "numeric one": 1, "1": "numeric key" }
|
||||
},
|
||||
// Set the content-type of the request
|
||||
contentType: "application/merge-patch+json",
|
||||
contentType: "application/merge-patch+json"
|
||||
});
|
||||
|
||||
if (result.status !== "200" && result.status !== "201") {
|
||||
|
|
@ -174,7 +174,7 @@ import { setLogLevel } from "@azure/logger";
|
|||
setLogLevel("info");
|
||||
```
|
||||
|
||||
For more detailed instructions on how to enable logs, you can look at the [@azure/logger package docs](https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/core/logger).
|
||||
For more detailed instructions on how to enable logs, you can look at the [@azure/logger package docs](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/core/logger).
|
||||
|
||||
## Next steps
|
||||
|
||||
|
|
@ -184,7 +184,7 @@ For more extensive documentation on the FarmBeats, see the [FarmBeats documentat
|
|||
|
||||
## Contributing
|
||||
|
||||
If you'd like to contribute to this library, please read the [contributing guide](https://github.com/Azure/azure-sdk-for-js/blob/master/CONTRIBUTING.md) to learn more about how to build and test the code.
|
||||
If you'd like to contribute to this library, please read the [contributing guide](https://github.com/Azure/azure-sdk-for-js/blob/main/CONTRIBUTING.md) to learn more about how to build and test the code.
|
||||
|
||||
## Related projects
|
||||
|
||||
|
|
@ -193,16 +193,16 @@ If you'd like to contribute to this library, please read the [contributing guide
|
|||
|
||||
|
||||
[product_documentation]: https://docs.microsoft.com/azure/industry/agriculture/overview-azure-farmbeats
|
||||
[rest_client]: https://github.com/Azure/azure-sdk-for-js/blob/master/documentation/rest-clients.md
|
||||
[source_code]: https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/agrifood/agrifood-farming-rest
|
||||
[rest_client]: https://github.com/Azure/azure-sdk-for-js/blob/main/documentation/rest-clients.md
|
||||
[source_code]: https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/agrifood/agrifood-farming-rest
|
||||
[npm]: https://www.npmjs.com/org/azure-rest
|
||||
[ref_docs]: https://azure.github.io/azure-sdk-for-js
|
||||
[azure_subscription]: https://azure.microsoft.com/free/
|
||||
[farmbeats_resource]: https://docs.microsoft.com/azure/industry/agriculture/install-azure-farmbeats
|
||||
[authenticate_with_token]: https://docs.microsoft.com/azure/cognitive-services/authentication?tabs=powershell#authenticate-with-an-authentication-token
|
||||
[azure_identity_credentials]: https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/identity/identity#credentials
|
||||
[azure_identity_credentials]: https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/identity/identity#credentials
|
||||
[azure_identity_npm]: https://www.npmjs.com/package/@azure/identity
|
||||
[default_azure_credential]: https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/identity/identity#defaultazurecredential
|
||||
[default_azure_credential]: https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/identity/identity#defaultazurecredential
|
||||
[install_farmbeats]: https://aka.ms/FarmBeatsInstallDocumentationPaaS
|
||||
[farm_hierarchy]: https://aka.ms/FarmBeatsFarmHierarchyDocs
|
||||
[scenes]: https://aka.ms/FarmBeatsSatellitePaaSDocumentation
|
||||
|
|
|
|||
|
|
@ -58,10 +58,10 @@ npx cross-env FARMBEATS_ENDPOINT="<farmbeats endpoint>" node deleteFarmer.js
|
|||
|
||||
Take a look at our [API Documentation][apiref] for more information about the APIs that are available in the clients.
|
||||
|
||||
[deletefarmer]: https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/agrifood/agrifood-farming-rest/samples/v1/javascript/deleteFarmer.js
|
||||
[listfarmers]: https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/agrifood/agrifood-farming-rest/samples/v1/javascript/listFarmers.js
|
||||
[createfarmer]: https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/agrifood/agrifood-farming-rest/samples/v1/javascript/createFarmer.js
|
||||
[deletefarmer]: https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/agrifood/agrifood-farming-rest/samples/v1/javascript/deleteFarmer.js
|
||||
[listfarmers]: https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/agrifood/agrifood-farming-rest/samples/v1/javascript/listFarmers.js
|
||||
[createfarmer]: https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/agrifood/agrifood-farming-rest/samples/v1/javascript/createFarmer.js
|
||||
[apiref]: https://docs.microsoft.com/javascript
|
||||
[freesub]: https://azure.microsoft.com/free/
|
||||
[createinstance_azurefarmbeatsserviceinstance]: https://docs.microsoft.com/azure/industry/agriculture/install-azure-farmbeats
|
||||
[package]: https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/agrifood/agrifood-farming-rest/README.md
|
||||
[package]: https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/agrifood/agrifood-farming-rest/README.md
|
||||
|
|
|
|||
|
|
@ -70,11 +70,11 @@ npx cross-env FARMBEATS_ENDPOINT="<farmbeats endpoint>" node dist/deleteFarmer.j
|
|||
|
||||
Take a look at our [API Documentation][apiref] for more information about the APIs that are available in the clients.
|
||||
|
||||
[deletefarmer]: https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/agrifood/agrifood-farming-rest/samples/v1/typescript/src/deleteFarmer.ts
|
||||
[listfarmers]: https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/agrifood/agrifood-farming-rest/samples/v1/typescript/src/listFarmers.ts
|
||||
[createfarmer]: https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/agrifood/agrifood-farming-rest/samples/v1/typescript/src/createFarmer.ts
|
||||
[deletefarmer]: https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/agrifood/agrifood-farming-rest/samples/v1/typescript/src/deleteFarmer.ts
|
||||
[listfarmers]: https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/agrifood/agrifood-farming-rest/samples/v1/typescript/src/listFarmers.ts
|
||||
[createfarmer]: https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/agrifood/agrifood-farming-rest/samples/v1/typescript/src/createFarmer.ts
|
||||
[apiref]: https://docs.microsoft.com/javascript
|
||||
[freesub]: https://azure.microsoft.com/free/
|
||||
[createinstance_azurefarmbeatsserviceinstance]: https://docs.microsoft.com/azure/industry/agriculture/install-azure-farmbeats
|
||||
[package]: https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/agrifood/agrifood-farming-rest/README.md
|
||||
[package]: https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/agrifood/agrifood-farming-rest/README.md
|
||||
[typescript]: https://www.typescriptlang.org/docs/home.html
|
||||
|
|
|
|||
|
|
@ -3,7 +3,6 @@
|
|||
trigger:
|
||||
branches:
|
||||
include:
|
||||
- master
|
||||
- main
|
||||
- release/*
|
||||
- hotfix/*
|
||||
|
|
@ -14,7 +13,6 @@ trigger:
|
|||
pr:
|
||||
branches:
|
||||
include:
|
||||
- master
|
||||
- main
|
||||
- feature/*
|
||||
- release/*
|
||||
|
|
|
|||
|
|
@ -2,11 +2,11 @@
|
|||
|
||||
[Azure AnomalyDetector](https://azure.microsoft.com/services/cognitive-services/anomaly-detector/) API enables you to monitor and detect abnormalities in your time series data with machine learning.
|
||||
|
||||
[Source code](https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/anomalydetector/ai-anomaly-detector/) |
|
||||
[Source code](https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/anomalydetector/ai-anomaly-detector/) |
|
||||
[Package (NPM)](https://www.npmjs.com/package/@azure/ai-anomaly-detector) |
|
||||
[API reference documentation](https://docs.microsoft.com/javascript/api/@azure/ai-anomaly-detector) |
|
||||
[Product documentation](https://docs.microsoft.com/azure/cognitive-services/anomaly-detector/) |
|
||||
[Samples](https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/anomalydetector/ai-anomaly-detector/samples)
|
||||
[Samples](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/anomalydetector/ai-anomaly-detector/samples)
|
||||
|
||||
## Key concepts
|
||||
|
||||
|
|
@ -153,7 +153,7 @@ main().catch((err) => {
|
|||
});
|
||||
```
|
||||
|
||||
More Samples can be found [here](https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/anomalydetector/ai-anomaly-detector/samples)
|
||||
More Samples can be found [here](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/anomalydetector/ai-anomaly-detector/samples)
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
|
|
@ -167,12 +167,12 @@ import { setLogLevel } from "@azure/logger";
|
|||
setLogLevel("info");
|
||||
```
|
||||
|
||||
For more detailed instructions on how to enable logs, you can look at the [@azure/logger package docs](https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/core/logger).
|
||||
For more detailed instructions on how to enable logs, you can look at the [@azure/logger package docs](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/core/logger).
|
||||
|
||||
## Next steps
|
||||
|
||||
Please take a look at the
|
||||
[samples](https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/anomalydetector/ai-anomaly-detector/samples)
|
||||
[samples](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/anomalydetector/ai-anomaly-detector/samples)
|
||||
directory for detailed examples on how to use this library.
|
||||
|
||||
## Contributing
|
||||
|
|
@ -189,4 +189,4 @@ This project has adopted the [Microsoft Open Source Code of Conduct](https://ope
|
|||
For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or
|
||||
contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments.
|
||||
|
||||
If you'd like to contribute to this library, please read the [contributing guide](https://github.com/Azure/azure-sdk-for-js/blob/master/CONTRIBUTING.md) to learn more about how to build and test the code.
|
||||
If you'd like to contribute to this library, please read the [contributing guide](https://github.com/Azure/azure-sdk-for-js/blob/main/CONTRIBUTING.md) to learn more about how to build and test the code.
|
||||
|
|
|
|||
|
|
@ -59,10 +59,10 @@ npx cross-env API_KEY="<api key>" ENDPOINT="<endpoint>" node sample_detect_chang
|
|||
|
||||
Take a look at our [API Documentation][apiref] for more information about the APIs that are available in the clients.
|
||||
|
||||
[sample_detect_change_point]: https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/anomalydetector/ai-anomaly-detector/samples/v3/javascript/sample_detect_change_point.js
|
||||
[sample_detect_entire_series_anomaly]: https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/anomalydetector/ai-anomaly-detector/samples/v3/javascript/sample_detect_entire_series_anomaly.js
|
||||
[sample_detect_last_point_anomaly]: https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/anomalydetector/ai-anomaly-detector/samples/v3/javascript/sample_detect_last_point_anomaly.js
|
||||
[sample_detect_change_point]: https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/anomalydetector/ai-anomaly-detector/samples/v3/javascript/sample_detect_change_point.js
|
||||
[sample_detect_entire_series_anomaly]: https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/anomalydetector/ai-anomaly-detector/samples/v3/javascript/sample_detect_entire_series_anomaly.js
|
||||
[sample_detect_last_point_anomaly]: https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/anomalydetector/ai-anomaly-detector/samples/v3/javascript/sample_detect_last_point_anomaly.js
|
||||
[apiref]: https://docs.microsoft.com/javascript/api/@azure/ai-anomaly-detector
|
||||
[freesub]: https://azure.microsoft.com/free/
|
||||
[createinstance_azureanomalydetectorinstance]: https://docs.microsoft.com/azure/cognitive-services/anomaly-detector/quickstarts/client-libraries?tabs=windows&pivots=programming-language-javascript
|
||||
[package]: https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/anomalydetector/ai-anomaly-detector/README.md
|
||||
[package]: https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/anomalydetector/ai-anomaly-detector/README.md
|
||||
|
|
|
|||
|
|
@ -71,11 +71,11 @@ npx cross-env API_KEY="<api key>" ENDPOINT="<endpoint>" node dist/sample_detect_
|
|||
|
||||
Take a look at our [API Documentation][apiref] for more information about the APIs that are available in the clients.
|
||||
|
||||
[sample_detect_change_point]: https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/anomalydetector/ai-anomaly-detector/samples/v3/typescript/src/sample_detect_change_point.ts
|
||||
[sample_detect_entire_series_anomaly]: https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/anomalydetector/ai-anomaly-detector/samples/v3/typescript/src/sample_detect_entire_series_anomaly.ts
|
||||
[sample_detect_last_point_anomaly]: https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/anomalydetector/ai-anomaly-detector/samples/v3/typescript/src/sample_detect_last_point_anomaly.ts
|
||||
[sample_detect_change_point]: https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/anomalydetector/ai-anomaly-detector/samples/v3/typescript/src/sample_detect_change_point.ts
|
||||
[sample_detect_entire_series_anomaly]: https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/anomalydetector/ai-anomaly-detector/samples/v3/typescript/src/sample_detect_entire_series_anomaly.ts
|
||||
[sample_detect_last_point_anomaly]: https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/anomalydetector/ai-anomaly-detector/samples/v3/typescript/src/sample_detect_last_point_anomaly.ts
|
||||
[apiref]: https://docs.microsoft.com/javascript/api/@azure/ai-anomaly-detector
|
||||
[freesub]: https://azure.microsoft.com/free/
|
||||
[createinstance_azureanomalydetectorinstance]: https://docs.microsoft.com/azure/cognitive-services/anomaly-detector/quickstarts/client-libraries?tabs=windows&pivots=programming-language-javascript
|
||||
[package]: https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/anomalydetector/ai-anomaly-detector/README.md
|
||||
[package]: https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/anomalydetector/ai-anomaly-detector/README.md
|
||||
[typescript]: https://www.typescriptlang.org/docs/home.html
|
||||
|
|
|
|||
|
|
@ -4,7 +4,6 @@
|
|||
trigger:
|
||||
branches:
|
||||
include:
|
||||
- master
|
||||
- main
|
||||
- release/*
|
||||
- hotfix/*
|
||||
|
|
@ -16,7 +15,6 @@ trigger:
|
|||
pr:
|
||||
branches:
|
||||
include:
|
||||
- master
|
||||
- main
|
||||
- feature/*
|
||||
- release/*
|
||||
|
|
|
|||
|
|
@ -8,11 +8,11 @@ Use the client library for App Configuration to:
|
|||
- Tag keys with labels
|
||||
- Replay settings from any point in time
|
||||
|
||||
[Source code](https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/appconfiguration/app-configuration/) |
|
||||
[Source code](https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/appconfiguration/app-configuration/) |
|
||||
[Package (NPM)](https://www.npmjs.com/package/@azure/app-configuration) |
|
||||
[API reference documentation](https://docs.microsoft.com/javascript/api/@azure/app-configuration) |
|
||||
[Product documentation](https://docs.microsoft.com/azure/azure-app-configuration/) |
|
||||
[Samples](https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/appconfiguration/app-configuration/samples)
|
||||
[Samples](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/appconfiguration/app-configuration/samples)
|
||||
|
||||
## Getting started
|
||||
|
||||
|
|
@ -49,7 +49,7 @@ Authentication via service principal is done by:
|
|||
- Setting appropriate RBAC rules on your AppConfiguration resource.
|
||||
More information on App Configuration roles can be found [here](https://docs.microsoft.com/azure/azure-app-configuration/concept-enable-rbac#azure-built-in-roles-for-azure-app-configuration).
|
||||
|
||||
Using [DefaultAzureCredential](https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/identity/identity/README.md#defaultazurecredential)
|
||||
Using [DefaultAzureCredential](https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/identity/identity/README.md#defaultazurecredential)
|
||||
|
||||
```javascript
|
||||
const azureIdentity = require("@azure/identity");
|
||||
|
|
@ -62,7 +62,7 @@ const client = new appConfig.AppConfigurationClient(
|
|||
);
|
||||
```
|
||||
|
||||
More information about `@azure/identity` can be found [here](https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/identity/identity/README.md)
|
||||
More information about `@azure/identity` can be found [here](https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/identity/identity/README.md)
|
||||
|
||||
#### Authenticating with a connection string
|
||||
|
||||
|
|
@ -153,20 +153,20 @@ run().catch((err) => console.log("ERROR:", err));
|
|||
|
||||
The following samples show you the various ways you can interact with App Configuration:
|
||||
|
||||
- [`helloworld.ts`](https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/appconfiguration/app-configuration/samples/v1/typescript/src/helloworld.ts) - Get, set, and delete configuration values.
|
||||
- [`helloworldWithLabels.ts`](https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/appconfiguration/app-configuration/samples/v1/typescript/src/helloworldWithLabels.ts) - Use labels to add additional dimensions to your settings for scenarios like beta vs production.
|
||||
- [`optimisticConcurrencyViaEtag.ts`](https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/appconfiguration/app-configuration/samples/v1/typescript/src/optimisticConcurrencyViaEtag.ts) - Set values using etags to prevent accidental overwrites.
|
||||
- [`setReadOnlySample.ts`](https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/appconfiguration/app-configuration/samples/v1/typescript/src/setReadOnlySample.ts) - Marking settings as read-only to prevent modification.
|
||||
- [`getSettingOnlyIfChanged.ts`](https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/appconfiguration/app-configuration/samples/v1/typescript/src/getSettingOnlyIfChanged.ts) - Get a setting only if it changed from the last time you got it.
|
||||
- [`listRevisions.ts`](https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/appconfiguration/app-configuration/samples/v1/typescript/src/listRevisions.ts) - List the revisions of a key, allowing you to see previous values and when they were set.
|
||||
- [`secretReference.ts`](https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/appconfiguration/app-configuration/samples/v1/typescript/src/secretReference.ts) - SecretReference represents a configuration setting that references as KeyVault secret.
|
||||
- [`featureFlag.ts`](https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/appconfiguration/app-configuration/samples/v1/typescript/src/featureFlag.ts) - Feature flags are settings that follow specific JSON schema for the value.
|
||||
- [`helloworld.ts`](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/appconfiguration/app-configuration/samples/v1/typescript/src/helloworld.ts) - Get, set, and delete configuration values.
|
||||
- [`helloworldWithLabels.ts`](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/appconfiguration/app-configuration/samples/v1/typescript/src/helloworldWithLabels.ts) - Use labels to add additional dimensions to your settings for scenarios like beta vs production.
|
||||
- [`optimisticConcurrencyViaEtag.ts`](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/appconfiguration/app-configuration/samples/v1/typescript/src/optimisticConcurrencyViaEtag.ts) - Set values using etags to prevent accidental overwrites.
|
||||
- [`setReadOnlySample.ts`](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/appconfiguration/app-configuration/samples/v1/typescript/src/setReadOnlySample.ts) - Marking settings as read-only to prevent modification.
|
||||
- [`getSettingOnlyIfChanged.ts`](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/appconfiguration/app-configuration/samples/v1/typescript/src/getSettingOnlyIfChanged.ts) - Get a setting only if it changed from the last time you got it.
|
||||
- [`listRevisions.ts`](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/appconfiguration/app-configuration/samples/v1/typescript/src/listRevisions.ts) - List the revisions of a key, allowing you to see previous values and when they were set.
|
||||
- [`secretReference.ts`](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/appconfiguration/app-configuration/samples/v1/typescript/src/secretReference.ts) - SecretReference represents a configuration setting that references as KeyVault secret.
|
||||
- [`featureFlag.ts`](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/appconfiguration/app-configuration/samples/v1/typescript/src/featureFlag.ts) - Feature flags are settings that follow specific JSON schema for the value.
|
||||
|
||||
More in-depth examples can be found in the [samples](https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/appconfiguration/app-configuration/samples/v1/) folder on GitHub.
|
||||
More in-depth examples can be found in the [samples](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/appconfiguration/app-configuration/samples/v1/) folder on GitHub.
|
||||
|
||||
## Contributing
|
||||
|
||||
If you'd like to contribute to this library, please read the [contributing guide](https://github.com/Azure/azure-sdk-for-js/blob/master/CONTRIBUTING.md) to learn more about how to build and test the code.
|
||||
If you'd like to contribute to this library, please read the [contributing guide](https://github.com/Azure/azure-sdk-for-js/blob/main/CONTRIBUTING.md) to learn more about how to build and test the code.
|
||||
|
||||
This module's tests are a mixture of live and unit tests, which require you to have an Azure App Configuration instance. To execute the tests you'll need to run:
|
||||
|
||||
|
|
@ -177,7 +177,7 @@ This module's tests are a mixture of live and unit tests, which require you to h
|
|||
4. `cd sdk\appconfiguration\app-configuration`
|
||||
5. `npm run test`.
|
||||
|
||||
View our [tests](https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/appconfiguration/app-configuration/test)
|
||||
View our [tests](https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/appconfiguration/app-configuration/test)
|
||||
folder for more details.
|
||||
|
||||
## Related projects
|
||||
|
|
|
|||
|
|
@ -95,5 +95,5 @@ Take a look at our [Samples][samples] for more information about the APIs that a
|
|||
[react]: https://create-react-app.dev/
|
||||
[typescript]: https://www.typescriptlang.org/docs/home.html
|
||||
[freesub]: https://azure.microsoft.com/free
|
||||
[samples]: https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/appconfiguration/app-configuration/samples/v1/typescript
|
||||
[identity]: https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/identity/identity/README.md
|
||||
[samples]: https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/appconfiguration/app-configuration/samples/v1/typescript
|
||||
[identity]: https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/identity/identity/README.md
|
||||
|
|
|
|||
|
|
@ -64,16 +64,16 @@ npx cross-env APPCONFIG_CONNECTION_STRING="<appconfig connection string>" node h
|
|||
|
||||
Take a look at our [API Documentation][apiref] for more information about the APIs that are available in the clients.
|
||||
|
||||
[helloworld]: https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/appconfiguration/app-configuration/samples/v1/javascript/helloworld.js
|
||||
[helloworldwithlabels]: https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/appconfiguration/app-configuration/samples/v1/javascript/helloworldWithLabels.js
|
||||
[optimisticconcurrencyviaetag]: https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/appconfiguration/app-configuration/samples/v1/javascript/optimisticConcurrencyViaEtag.js
|
||||
[setreadonlysample]: https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/appconfiguration/app-configuration/samples/v1/javascript/setReadOnlySample.js
|
||||
[getsettingonlyifchanged]: https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/appconfiguration/app-configuration/samples/v1/javascript/getSettingOnlyIfChanged.js
|
||||
[listconfigurationsettings]: https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/appconfiguration/app-configuration/samples/v1/javascript/listConfigurationSettings.js
|
||||
[listrevisions]: https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/appconfiguration/app-configuration/samples/v1/javascript/listRevisions.js
|
||||
[secretreference]: https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/appconfiguration/app-configuration/samples/v1/javascript/secretReference.js
|
||||
[featureflag]: https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/appconfiguration/app-configuration/samples/v1/javascript/featureFlag.js
|
||||
[helloworld]: https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/appconfiguration/app-configuration/samples/v1/javascript/helloworld.js
|
||||
[helloworldwithlabels]: https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/appconfiguration/app-configuration/samples/v1/javascript/helloworldWithLabels.js
|
||||
[optimisticconcurrencyviaetag]: https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/appconfiguration/app-configuration/samples/v1/javascript/optimisticConcurrencyViaEtag.js
|
||||
[setreadonlysample]: https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/appconfiguration/app-configuration/samples/v1/javascript/setReadOnlySample.js
|
||||
[getsettingonlyifchanged]: https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/appconfiguration/app-configuration/samples/v1/javascript/getSettingOnlyIfChanged.js
|
||||
[listconfigurationsettings]: https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/appconfiguration/app-configuration/samples/v1/javascript/listConfigurationSettings.js
|
||||
[listrevisions]: https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/appconfiguration/app-configuration/samples/v1/javascript/listRevisions.js
|
||||
[secretreference]: https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/appconfiguration/app-configuration/samples/v1/javascript/secretReference.js
|
||||
[featureflag]: https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/appconfiguration/app-configuration/samples/v1/javascript/featureFlag.js
|
||||
[apiref]: https://docs.microsoft.com/javascript/api/@azure/app-configuration
|
||||
[freesub]: https://azure.microsoft.com/free/
|
||||
[createinstance_azureappconfigurationaccount]: https://docs.microsoft.com/azure/azure-app-configuration/quickstart-aspnet-core-app?tabs=core5x#create-an-app-configuration-store
|
||||
[package]: https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/appconfiguration/app-configuration/README.md
|
||||
[package]: https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/appconfiguration/app-configuration/README.md
|
||||
|
|
|
|||
|
|
@ -76,17 +76,17 @@ npx cross-env APPCONFIG_CONNECTION_STRING="<appconfig connection string>" node d
|
|||
|
||||
Take a look at our [API Documentation][apiref] for more information about the APIs that are available in the clients.
|
||||
|
||||
[helloworld]: https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/appconfiguration/app-configuration/samples/v1/typescript/src/helloworld.ts
|
||||
[helloworldwithlabels]: https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/appconfiguration/app-configuration/samples/v1/typescript/src/helloworldWithLabels.ts
|
||||
[optimisticconcurrencyviaetag]: https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/appconfiguration/app-configuration/samples/v1/typescript/src/optimisticConcurrencyViaEtag.ts
|
||||
[setreadonlysample]: https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/appconfiguration/app-configuration/samples/v1/typescript/src/setReadOnlySample.ts
|
||||
[getsettingonlyifchanged]: https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/appconfiguration/app-configuration/samples/v1/typescript/src/getSettingOnlyIfChanged.ts
|
||||
[listconfigurationsettings]: https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/appconfiguration/app-configuration/samples/v1/typescript/src/listConfigurationSettings.ts
|
||||
[listrevisions]: https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/appconfiguration/app-configuration/samples/v1/typescript/src/listRevisions.ts
|
||||
[secretreference]: https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/appconfiguration/app-configuration/samples/v1/typescript/src/secretReference.ts
|
||||
[featureflag]: https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/appconfiguration/app-configuration/samples/v1/typescript/src/featureFlag.ts
|
||||
[helloworld]: https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/appconfiguration/app-configuration/samples/v1/typescript/src/helloworld.ts
|
||||
[helloworldwithlabels]: https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/appconfiguration/app-configuration/samples/v1/typescript/src/helloworldWithLabels.ts
|
||||
[optimisticconcurrencyviaetag]: https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/appconfiguration/app-configuration/samples/v1/typescript/src/optimisticConcurrencyViaEtag.ts
|
||||
[setreadonlysample]: https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/appconfiguration/app-configuration/samples/v1/typescript/src/setReadOnlySample.ts
|
||||
[getsettingonlyifchanged]: https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/appconfiguration/app-configuration/samples/v1/typescript/src/getSettingOnlyIfChanged.ts
|
||||
[listconfigurationsettings]: https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/appconfiguration/app-configuration/samples/v1/typescript/src/listConfigurationSettings.ts
|
||||
[listrevisions]: https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/appconfiguration/app-configuration/samples/v1/typescript/src/listRevisions.ts
|
||||
[secretreference]: https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/appconfiguration/app-configuration/samples/v1/typescript/src/secretReference.ts
|
||||
[featureflag]: https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/appconfiguration/app-configuration/samples/v1/typescript/src/featureFlag.ts
|
||||
[apiref]: https://docs.microsoft.com/javascript/api/@azure/app-configuration
|
||||
[freesub]: https://azure.microsoft.com/free/
|
||||
[createinstance_azureappconfigurationaccount]: https://docs.microsoft.com/azure/azure-app-configuration/quickstart-aspnet-core-app?tabs=core5x#create-an-app-configuration-store
|
||||
[package]: https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/appconfiguration/app-configuration/README.md
|
||||
[package]: https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/appconfiguration/app-configuration/README.md
|
||||
[typescript]: https://www.typescriptlang.org/docs/home.html
|
||||
|
|
|
|||
|
|
@ -1,8 +1,8 @@
|
|||
# Testing
|
||||
|
||||
To test this project, make sure to build it by following our [building instructions](https://github.com/Azure/azure-sdk-for-js/blob/master/CONTRIBUTING.md#building), then follow the [testing instructions](https://github.com/Azure/azure-sdk-for-js/blob/master/CONTRIBUTING.md#testing).
|
||||
To test this project, make sure to build it by following our [building instructions](https://github.com/Azure/azure-sdk-for-js/blob/main/CONTRIBUTING.md#building), then follow the [testing instructions](https://github.com/Azure/azure-sdk-for-js/blob/main/CONTRIBUTING.md#testing).
|
||||
|
||||
You can use existing Azure resources for the live tests, or generate new ones by using our [New-TestResources.ps1](https://github.com/Azure/azure-sdk-for-js/blob/master/eng/common/TestResources/New-TestResources.ps1) script, which will use an [ARM template](https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/appconfiguration/test-resources.json) that already has all of the the necessary configurations.
|
||||
You can use existing Azure resources for the live tests, or generate new ones by using our [New-TestResources.ps1](https://github.com/Azure/azure-sdk-for-js/blob/main/eng/common/TestResources/New-TestResources.ps1) script, which will use an [ARM template](https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/appconfiguration/test-resources.json) that already has all of the the necessary configurations.
|
||||
|
||||
The Azure resource that is used by the tests in this project is:
|
||||
|
||||
|
|
|
|||
|
|
@ -3,7 +3,6 @@
|
|||
trigger:
|
||||
branches:
|
||||
include:
|
||||
- master
|
||||
- main
|
||||
- release/*
|
||||
- hotfix/*
|
||||
|
|
@ -14,7 +13,6 @@ trigger:
|
|||
pr:
|
||||
branches:
|
||||
include:
|
||||
- master
|
||||
- main
|
||||
- feature/*
|
||||
- release/*
|
||||
|
|
|
|||
|
|
@ -87,7 +87,7 @@ Use the [Azure CLI][azure_cli] snippet below to create/get client secret credent
|
|||
$Env:AZURE_TENANT_ID="tenant-ID"
|
||||
```
|
||||
|
||||
For more information about the Azure Identity APIs and how to use them, see [Azure Identity client library](https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/identity/identity)
|
||||
For more information about the Azure Identity APIs and how to use them, see [Azure Identity client library](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/identity/identity)
|
||||
|
||||
## Key concepts
|
||||
|
||||
|
|
@ -277,7 +277,7 @@ Use `get_signing_certificates` to retrieve the certificates which can be used to
|
|||
|
||||
## Troubleshooting
|
||||
|
||||
Most Attestation service operations will raise exceptions defined in [Azure Core](https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/core/README.md). The attestation service APIs will throw a `HttpResponseError` on failure with helpful error codes. Many of these errors are recoverable.
|
||||
Most Attestation service operations will raise exceptions defined in [Azure Core](https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/core/README.md). The attestation service APIs will throw a `HttpResponseError` on failure with helpful error codes. Many of these errors are recoverable.
|
||||
|
||||
```ts
|
||||
<Fill this in>
|
||||
|
|
@ -293,7 +293,7 @@ import { setLogLevel } from "@azure/logger";
|
|||
setLogLevel("info");
|
||||
```
|
||||
|
||||
For more detailed instructions on how to enable logs, you can look at the [@azure/logger package docs](https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/core/logger).
|
||||
For more detailed instructions on how to enable logs, you can look at the [@azure/logger package docs](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/core/logger).
|
||||
|
||||
Additional troubleshooting information for the MAA service can be found [here](https://docs.microsoft.com/azure/attestation/troubleshoot-guide)
|
||||
|
||||
|
|
@ -318,7 +318,7 @@ If you encounter any bugs or have suggestions, please file an issue in the
|
|||
section of the project.
|
||||
|
||||
<!-- LINKS -->
|
||||
[source_code]: https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/attestation/attestation
|
||||
[source_code]: https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/attestation/attestation
|
||||
[azure_identity]: https://azuresdkdocs.blob.core.windows.net/$web/javascript/azure-identity/2.0.0-beta.3/index.html
|
||||
[DefaultAzureCredential]: https://azuresdkdocs.blob.core.windows.net/$web/javascript/azure-identity/2.0.0-beta.3/classes/defaultazurecredential.html
|
||||
[attestation_policy_result]:https://azuresdkdocs.blob.core.windows.net/$web/javascript/azure-attestation/1.0.0-beta.2/interfaces/policyresult.html
|
||||
|
|
@ -338,7 +338,7 @@ section of the project.
|
|||
[json_web_token]: https://tools.ietf.org/html/rfc7519
|
||||
[JWK]: https://tools.ietf.org/html/rfc7517
|
||||
[base64url_encoding]: https://tools.ietf.org/html/rfc4648#section-5
|
||||
[contributing]: https://github.com/Azure/azure-sdk-for-js/blob/master/CONTRIBUTING.md
|
||||
[contributing]: https://github.com/Azure/azure-sdk-for-js/blob/main/CONTRIBUTING.md
|
||||
[coc_faq]: https://opensource.microsoft.com/codeofconduct/faq/
|
||||
|
||||
## Related projects
|
||||
|
|
|
|||
|
|
@ -3,7 +3,6 @@
|
|||
trigger:
|
||||
branches:
|
||||
include:
|
||||
- master
|
||||
- main
|
||||
- release/*
|
||||
- hotfix/*
|
||||
|
|
@ -14,7 +13,6 @@ trigger:
|
|||
pr:
|
||||
branches:
|
||||
include:
|
||||
- master
|
||||
- main
|
||||
- feature/*
|
||||
- release/*
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
# Contributing Guide
|
||||
|
||||
This a contributing guide made specifically for the Azure Communication Services SDK. The Azure SDK repo also has a contributing guide that might help you in some other general processes this guide assumes you have done. If you haven't checked that one out yet, you can find it [here](https://github.com/Azure/azure-sdk-for-js/blob/master/CONTRIBUTING.md)
|
||||
This a contributing guide made specifically for the Azure Communication Services SDK. The Azure SDK repo also has a contributing guide that might help you in some other general processes this guide assumes you have done. If you haven't checked that one out yet, you can find it [here](https://github.com/Azure/azure-sdk-for-js/blob/main/CONTRIBUTING.md)
|
||||
|
||||
The Azure Communication Services SDK for JS currently consists of six different packages. While each package has its own set of environment variables to make their tests run successfully, all of them follow a similar structure that allows a smooth onboarding process.
|
||||
|
||||
|
|
@ -14,7 +14,7 @@ Once the package has been built, let's jump on how to run the tests to see that
|
|||
|
||||
## Testing
|
||||
|
||||
Make sure to check out the general contributing guide the Azure SDK repo has for a more in-depth look at testing and setting up your dev environment. You can check out the contributing file [here](https://github.com/Azure/azure-sdk-for-js/blob/master/CONTRIBUTING.md)
|
||||
Make sure to check out the general contributing guide the Azure SDK repo has for a more in-depth look at testing and setting up your dev environment. You can check out the contributing file [here](https://github.com/Azure/azure-sdk-for-js/blob/main/CONTRIBUTING.md)
|
||||
|
||||
When you go inside the package you are working with, you will see folders called `recordings\browsers` and `recordings\node`. In JS we performs tests in the node and browser environments. Each folder contains, as its name suggests, recordings of successful calls to the API that allow us to run the tests in PLAYBACK mode and remove the necessity of hitting the actual resources every time we may want to test.
|
||||
|
||||
|
|
|
|||
|
|
@ -3,7 +3,6 @@
|
|||
trigger:
|
||||
branches:
|
||||
include:
|
||||
- master
|
||||
- main
|
||||
- release/*
|
||||
- hotfix/*
|
||||
|
|
@ -14,7 +13,6 @@ trigger:
|
|||
pr:
|
||||
branches:
|
||||
include:
|
||||
- master
|
||||
- main
|
||||
- feature/*
|
||||
- release/*
|
||||
|
|
|
|||
|
|
@ -210,7 +210,7 @@ In this quickstart you learned how to:
|
|||
|
||||
## Contributing
|
||||
|
||||
If you'd like to contribute to this library, please read the [contributing guide](https://github.com/Azure/azure-sdk-for-js/blob/master/CONTRIBUTING.md) to learn more about how to build and test the code.
|
||||
If you'd like to contribute to this library, please read the [contributing guide](https://github.com/Azure/azure-sdk-for-js/blob/main/CONTRIBUTING.md) to learn more about how to build and test the code.
|
||||
|
||||
[azure_cli]: https://docs.microsoft.com/cli/azure
|
||||
[azure_sub]: https://azure.microsoft.com/free/
|
||||
|
|
|
|||
|
|
@ -58,10 +58,10 @@ npx cross-env COMMUNICATION_CONNECTION_STRING="<communication connection string>
|
|||
|
||||
Take a look at our [API Documentation][apiref] for more information about the APIs that are available in the clients.
|
||||
|
||||
[messageoperations]: https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/communication/communication-chat/samples/v1/javascript/messageOperations.js
|
||||
[participantsoperations]: https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/communication/communication-chat/samples/v1/javascript/participantsOperations.js
|
||||
[threadoperations]: https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/communication/communication-chat/samples/v1/javascript/threadOperations.js
|
||||
[messageoperations]: https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/communication/communication-chat/samples/v1/javascript/messageOperations.js
|
||||
[participantsoperations]: https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/communication/communication-chat/samples/v1/javascript/participantsOperations.js
|
||||
[threadoperations]: https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/communication/communication-chat/samples/v1/javascript/threadOperations.js
|
||||
[apiref]: https://docs.microsoft.com/javascript/api/@azure/communication-chat
|
||||
[freesub]: https://azure.microsoft.com/free/
|
||||
[createinstance_azurecommunicationservicesaccount]: https://docs.microsoft.com/azure/communication-services/quickstarts/create-communication-resource
|
||||
[package]: https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/communication/communication-chat/README.md
|
||||
[package]: https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/communication/communication-chat/README.md
|
||||
|
|
|
|||
|
|
@ -70,11 +70,11 @@ npx cross-env COMMUNICATION_CONNECTION_STRING="<communication connection string>
|
|||
|
||||
Take a look at our [API Documentation][apiref] for more information about the APIs that are available in the clients.
|
||||
|
||||
[messageoperations]: https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/communication/communication-chat/samples/v1/typescript/src/messageOperations.ts
|
||||
[participantsoperations]: https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/communication/communication-chat/samples/v1/typescript/src/participantsOperations.ts
|
||||
[threadoperations]: https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/communication/communication-chat/samples/v1/typescript/src/threadOperations.ts
|
||||
[messageoperations]: https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/communication/communication-chat/samples/v1/typescript/src/messageOperations.ts
|
||||
[participantsoperations]: https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/communication/communication-chat/samples/v1/typescript/src/participantsOperations.ts
|
||||
[threadoperations]: https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/communication/communication-chat/samples/v1/typescript/src/threadOperations.ts
|
||||
[apiref]: https://docs.microsoft.com/javascript/api/@azure/communication-chat
|
||||
[freesub]: https://azure.microsoft.com/free/
|
||||
[createinstance_azurecommunicationservicesaccount]: https://docs.microsoft.com/azure/communication-services/quickstarts/create-communication-resource
|
||||
[package]: https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/communication/communication-chat/README.md
|
||||
[package]: https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/communication/communication-chat/README.md
|
||||
[typescript]: https://www.typescriptlang.org/docs/home.html
|
||||
|
|
|
|||
|
|
@ -1,8 +1,8 @@
|
|||
# Testing
|
||||
|
||||
To test this project, make sure to build it by following our [building instructions](https://github.com/Azure/azure-sdk-for-js/blob/master/CONTRIBUTING.md#building), then follow the [testing instructions](https://github.com/Azure/azure-sdk-for-js/blob/master/CONTRIBUTING.md#testing).
|
||||
To test this project, make sure to build it by following our [building instructions](https://github.com/Azure/azure-sdk-for-js/blob/main/CONTRIBUTING.md#building), then follow the [testing instructions](https://github.com/Azure/azure-sdk-for-js/blob/main/CONTRIBUTING.md#testing).
|
||||
|
||||
You can use existing Azure resources for the live tests, or generate new ones by using our [New-TestResources.ps1](https://github.com/Azure/azure-sdk-for-js/blob/master/eng/common/TestResources/New-TestResources.ps1) script, which will use an [ARM template](https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/textanalytics/test-resources.json) that already has all of the the necessary configurations.
|
||||
You can use existing Azure resources for the live tests, or generate new ones by using our [New-TestResources.ps1](https://github.com/Azure/azure-sdk-for-js/blob/main/eng/common/TestResources/New-TestResources.ps1) script, which will use an [ARM template](https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/textanalytics/test-resources.json) that already has all of the the necessary configurations.
|
||||
|
||||
The Azure resource that is used by the tests in this project is:
|
||||
|
||||
|
|
|
|||
|
|
@ -83,7 +83,7 @@ const tokenCredential = new AzureCommunicationTokenCredential({
|
|||
|
||||
## Contributing
|
||||
|
||||
If you'd like to contribute to this library, please read the [contributing guide](https://github.com/Azure/azure-sdk-for-js/blob/master/CONTRIBUTING.md) to learn more about how to build and test the code.
|
||||
If you'd like to contribute to this library, please read the [contributing guide](https://github.com/Azure/azure-sdk-for-js/blob/main/CONTRIBUTING.md) to learn more about how to build and test the code.
|
||||
|
||||
## Related projects
|
||||
|
||||
|
|
|
|||
|
|
@ -16,7 +16,7 @@
|
|||
- `CommunicationIdentityClient` method `createUserWithToken` renamed to `createUserAndToken`.
|
||||
- Renamed `CommunicationIdentityOptions` to `CommunicationIdentityClientOptions`.
|
||||
- Removed `_response` from returned models.
|
||||
- Removed `dist-browser` from the output folders. To bundle the Azure SDK libraries, please read our bundling guide: [link](https://github.com/Azure/azure-sdk-for-js/blob/master/documentation/Bundling.md).
|
||||
- Removed `dist-browser` from the output folders. To bundle the Azure SDK libraries, please read our bundling guide: [link](https://github.com/Azure/azure-sdk-for-js/blob/main/documentation/Bundling.md).
|
||||
|
||||
## 1.0.0-beta.4 (2021-02-09)
|
||||
|
||||
|
|
|
|||
|
|
@ -128,12 +128,12 @@ await client.deleteUser(user);
|
|||
## Next steps
|
||||
|
||||
Please take a look at the
|
||||
[samples](https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/communication/communication-identity/samples)
|
||||
[samples](https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/communication/communication-identity/samples)
|
||||
directory for detailed examples on how to use this library.
|
||||
|
||||
## Contributing
|
||||
|
||||
If you'd like to contribute to this library, please read the [contributing guide](https://github.com/Azure/azure-sdk-for-js/blob/master/CONTRIBUTING.md) to learn more about how to build and test the code.
|
||||
If you'd like to contribute to this library, please read the [contributing guide](https://github.com/Azure/azure-sdk-for-js/blob/main/CONTRIBUTING.md) to learn more about how to build and test the code.
|
||||
|
||||
## Related projects
|
||||
|
||||
|
|
|
|||
|
|
@ -57,9 +57,9 @@ npx cross-env COMMUNICATION_CONNECTION_STRING="<communication connection string>
|
|||
|
||||
Take a look at our [API Documentation][apiref] for more information about the APIs that are available in the clients.
|
||||
|
||||
[issuetoken]: https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/communication/communication-identity/samples/v1/javascript/issueToken.js
|
||||
[revoketokens]: https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/communication/communication-identity/samples/v1/javascript/revokeTokens.js
|
||||
[issuetoken]: https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/communication/communication-identity/samples/v1/javascript/issueToken.js
|
||||
[revoketokens]: https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/communication/communication-identity/samples/v1/javascript/revokeTokens.js
|
||||
[apiref]: https://docs.microsoft.com/javascript/api/@azure/communication-identity
|
||||
[freesub]: https://azure.microsoft.com/free/
|
||||
[createinstance_azurecommunicationservicesaccount]: https://docs.microsoft.com/azure/communication-services/quickstarts/create-communication-resource
|
||||
[package]: https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/communication/communication-identity/README.md
|
||||
[package]: https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/communication/communication-identity/README.md
|
||||
|
|
|
|||
|
|
@ -69,10 +69,10 @@ npx cross-env COMMUNICATION_CONNECTION_STRING="<communication connection string>
|
|||
|
||||
Take a look at our [API Documentation][apiref] for more information about the APIs that are available in the clients.
|
||||
|
||||
[issuetoken]: https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/communication/communication-identity/samples/v1/typescript/src/issueToken.ts
|
||||
[revoketokens]: https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/communication/communication-identity/samples/v1/typescript/src/revokeTokens.ts
|
||||
[issuetoken]: https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/communication/communication-identity/samples/v1/typescript/src/issueToken.ts
|
||||
[revoketokens]: https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/communication/communication-identity/samples/v1/typescript/src/revokeTokens.ts
|
||||
[apiref]: https://docs.microsoft.com/javascript/api/@azure/communication-identity
|
||||
[freesub]: https://azure.microsoft.com/free/
|
||||
[createinstance_azurecommunicationservicesaccount]: https://docs.microsoft.com/azure/communication-services/quickstarts/create-communication-resource
|
||||
[package]: https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/communication/communication-identity/README.md
|
||||
[package]: https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/communication/communication-identity/README.md
|
||||
[typescript]: https://www.typescriptlang.org/docs/home.html
|
||||
|
|
|
|||
|
|
@ -1,8 +1,8 @@
|
|||
# Testing
|
||||
|
||||
To test this project, make sure to build it by following our [building instructions](https://github.com/Azure/azure-sdk-for-js/blob/master/CONTRIBUTING.md#building), then follow the [testing instructions](https://github.com/Azure/azure-sdk-for-js/blob/master/CONTRIBUTING.md#testing).
|
||||
To test this project, make sure to build it by following our [building instructions](https://github.com/Azure/azure-sdk-for-js/blob/main/CONTRIBUTING.md#building), then follow the [testing instructions](https://github.com/Azure/azure-sdk-for-js/blob/main/CONTRIBUTING.md#testing).
|
||||
|
||||
You can use existing Azure resources for the live tests, or generate new ones by using our [New-TestResources.ps1](https://github.com/Azure/azure-sdk-for-js/blob/master/eng/common/TestResources/New-TestResources.ps1) script, which will use an [ARM template](https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/communication/test-resources.json) that already has all of the the necessary configurations.
|
||||
You can use existing Azure resources for the live tests, or generate new ones by using our [New-TestResources.ps1](https://github.com/Azure/azure-sdk-for-js/blob/main/eng/common/TestResources/New-TestResources.ps1) script, which will use an [ARM template](https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/communication/test-resources.json) that already has all of the the necessary configurations.
|
||||
|
||||
The Azure resource that is used by the tests in this project is:
|
||||
|
||||
|
|
|
|||
|
|
@ -100,7 +100,7 @@ const config = relayClient.getRelayConfiguration(user);
|
|||
|
||||
## Contributing
|
||||
|
||||
If you'd like to contribute to this library, please read the [contributing guide](https://github.com/Azure/azure-sdk-for-js/blob/master/CONTRIBUTING.md) to learn more about how to build and test the code.
|
||||
If you'd like to contribute to this library, please read the [contributing guide](https://github.com/Azure/azure-sdk-for-js/blob/main/CONTRIBUTING.md) to learn more about how to build and test the code.
|
||||
|
||||
## Related projects
|
||||
|
||||
|
|
|
|||
|
|
@ -56,7 +56,7 @@ npx cross-env COMMUNICATION_CONNECTION_STRING="<communication connection string>
|
|||
|
||||
Take a look at our [API Documentation][apiref] for more information about the APIs that are available in the clients.
|
||||
|
||||
[getrelayconfiguration]: https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/communication/communication-network-traversal/samples/v1/javascript/getRelayConfiguration.js
|
||||
[getrelayconfiguration]: https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/communication/communication-network-traversal/samples/v1/javascript/getRelayConfiguration.js
|
||||
[freesub]: https://azure.microsoft.com/free/
|
||||
[createinstance_azurecommunicationservicesaccount]: https://docs.microsoft.com/azure/communication-services/quickstarts/create-communication-resource
|
||||
[package]: https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/communication/communication-network-traversal/README.md
|
||||
[package]: https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/communication/communication-network-traversal/README.md
|
||||
|
|
|
|||
|
|
@ -68,8 +68,8 @@ npx cross-env COMMUNICATION_CONNECTION_STRING="<communication connection string>
|
|||
|
||||
Take a look at our [API Documentation][apiref] for more information about the APIs that are available in the clients.
|
||||
|
||||
[getrelayconfiguration]: https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/communication/communication-network-traversal/samples/v1/typescript/src/getRelayConfiguration.ts
|
||||
[getrelayconfiguration]: https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/communication/communication-network-traversal/samples/v1/typescript/src/getRelayConfiguration.ts
|
||||
[freesub]: https://azure.microsoft.com/free/
|
||||
[createinstance_azurecommunicationservicesaccount]: https://docs.microsoft.com/azure/communication-services/quickstarts/create-communication-resource
|
||||
[package]: https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/communication/communication-network-traversal/README.md
|
||||
[package]: https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/communication/communication-network-traversal/README.md
|
||||
[typescript]: https://www.typescriptlang.org/docs/home.html
|
||||
|
|
|
|||
|
|
@ -1,8 +1,8 @@
|
|||
# Testing
|
||||
|
||||
To test this project, make sure to build it by following our [building instructions](https://github.com/Azure/azure-sdk-for-js/blob/master/CONTRIBUTING.md#building), then follow the [testing instructions](https://github.com/Azure/azure-sdk-for-js/blob/master/CONTRIBUTING.md#testing).
|
||||
To test this project, make sure to build it by following our [building instructions](https://github.com/Azure/azure-sdk-for-js/blob/main/CONTRIBUTING.md#building), then follow the [testing instructions](https://github.com/Azure/azure-sdk-for-js/blob/main/CONTRIBUTING.md#testing).
|
||||
|
||||
You can use existing Azure resources for the live tests, or generate new ones by using our [New-TestResources.ps1](https://github.com/Azure/azure-sdk-for-js/blob/master/eng/common/TestResources/New-TestResources.ps1) script, which will use an [ARM template](https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/communication/test-resources.json) that already has all of the the necessary configurations.
|
||||
You can use existing Azure resources for the live tests, or generate new ones by using our [New-TestResources.ps1](https://github.com/Azure/azure-sdk-for-js/blob/main/eng/common/TestResources/New-TestResources.ps1) script, which will use an [ARM template](https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/communication/test-resources.json) that already has all of the the necessary configurations.
|
||||
|
||||
The Azure resource that is used by the tests in this project is:
|
||||
|
||||
|
|
|
|||
|
|
@ -21,4 +21,4 @@ The Azure Communication Phone Numbers Client library contains code which facilit
|
|||
|
||||
### Breaking Changes
|
||||
|
||||
- Removed `dist-browser` from the output folders. To bundle the Azure SDK libraries, please read our bundling guide: [link](https://github.com/Azure/azure-sdk-for-js/blob/master/documentation/Bundling.md)
|
||||
- Removed `dist-browser` from the output folders. To bundle the Azure SDK libraries, please read our bundling guide: [link](https://github.com/Azure/azure-sdk-for-js/blob/main/documentation/Bundling.md)
|
||||
|
|
|
|||
|
|
@ -291,12 +291,12 @@ main();
|
|||
## Next steps
|
||||
|
||||
Please take a look at the
|
||||
[samples](https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/communication/communication-phone-numbers/samples)
|
||||
[samples](https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/communication/communication-phone-numbers/samples)
|
||||
directory for detailed examples on how to use this library.
|
||||
|
||||
## Contributing
|
||||
|
||||
If you'd like to contribute to this library, please read the [contributing guide](https://github.com/Azure/azure-sdk-for-js/blob/master/CONTRIBUTING.md) to learn more about how to build and test the code.
|
||||
If you'd like to contribute to this library, please read the [contributing guide](https://github.com/Azure/azure-sdk-for-js/blob/main/CONTRIBUTING.md) to learn more about how to build and test the code.
|
||||
|
||||
## Related projects
|
||||
|
||||
|
|
@ -306,8 +306,8 @@ If you'd like to contribute to this library, please read the [contributing guide
|
|||
[azure_sub]: https://azure.microsoft.com/free/
|
||||
[azure_portal]: https://portal.azure.com
|
||||
[azure_powershell]: https://docs.microsoft.com/powershell/module/az.communication/new-azcommunicationservice
|
||||
[defaultazurecredential]: https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/identity/identity#defaultazurecredential
|
||||
[azure_identity]: https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/identity/identity
|
||||
[azure_identity_readme]: https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/identity/identity/README.md
|
||||
[defaultazurecredential]: https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/identity/identity#defaultazurecredential
|
||||
[azure_identity]: https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/identity/identity
|
||||
[azure_identity_readme]: https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/identity/identity/README.md
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -60,12 +60,12 @@ npx cross-env COMMUNICATION_SAMPLES_CONNECTION_STRING="<communication samples co
|
|||
|
||||
Take a look at our [API Documentation][apiref] for more information about the APIs that are available in the clients.
|
||||
|
||||
[getpurchasedphonenumber]: https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/communication/communication-phone-numbers/samples/v1/javascript/getPurchasedPhoneNumber.js
|
||||
[getpurchasedphonenumbers]: https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/communication/communication-phone-numbers/samples/v1/javascript/getPurchasedPhoneNumbers.js
|
||||
[purchasephonenumber]: https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/communication/communication-phone-numbers/samples/v1/javascript/purchasePhoneNumber.js
|
||||
[releasephonenumber]: https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/communication/communication-phone-numbers/samples/v1/javascript/releasePhoneNumber.js
|
||||
[updatephonenumbercapabilities]: https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/communication/communication-phone-numbers/samples/v1/javascript/updatePhoneNumberCapabilities.js
|
||||
[getpurchasedphonenumber]: https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/communication/communication-phone-numbers/samples/v1/javascript/getPurchasedPhoneNumber.js
|
||||
[getpurchasedphonenumbers]: https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/communication/communication-phone-numbers/samples/v1/javascript/getPurchasedPhoneNumbers.js
|
||||
[purchasephonenumber]: https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/communication/communication-phone-numbers/samples/v1/javascript/purchasePhoneNumber.js
|
||||
[releasephonenumber]: https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/communication/communication-phone-numbers/samples/v1/javascript/releasePhoneNumber.js
|
||||
[updatephonenumbercapabilities]: https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/communication/communication-phone-numbers/samples/v1/javascript/updatePhoneNumberCapabilities.js
|
||||
[apiref]: https://docs.microsoft.com/javascript/api/@azure/communication-phone-numbers
|
||||
[freesub]: https://azure.microsoft.com/free/
|
||||
[createinstance_azurecommunicationservicesaccount]: https://docs.microsoft.com/azure/communication-services/quickstarts/create-communication-resource
|
||||
[package]: https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/communication/communication-phone-numbers/README.md
|
||||
[package]: https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/communication/communication-phone-numbers/README.md
|
||||
|
|
|
|||
|
|
@ -72,13 +72,13 @@ npx cross-env COMMUNICATION_SAMPLES_CONNECTION_STRING="<communication samples co
|
|||
|
||||
Take a look at our [API Documentation][apiref] for more information about the APIs that are available in the clients.
|
||||
|
||||
[getpurchasedphonenumber]: https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/communication/communication-phone-numbers/samples/v1/typescript/src/getPurchasedPhoneNumber.ts
|
||||
[getpurchasedphonenumbers]: https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/communication/communication-phone-numbers/samples/v1/typescript/src/getPurchasedPhoneNumbers.ts
|
||||
[purchasephonenumber]: https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/communication/communication-phone-numbers/samples/v1/typescript/src/purchasePhoneNumber.ts
|
||||
[releasephonenumber]: https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/communication/communication-phone-numbers/samples/v1/typescript/src/releasePhoneNumber.ts
|
||||
[updatephonenumbercapabilities]: https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/communication/communication-phone-numbers/samples/v1/typescript/src/updatePhoneNumberCapabilities.ts
|
||||
[getpurchasedphonenumber]: https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/communication/communication-phone-numbers/samples/v1/typescript/src/getPurchasedPhoneNumber.ts
|
||||
[getpurchasedphonenumbers]: https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/communication/communication-phone-numbers/samples/v1/typescript/src/getPurchasedPhoneNumbers.ts
|
||||
[purchasephonenumber]: https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/communication/communication-phone-numbers/samples/v1/typescript/src/purchasePhoneNumber.ts
|
||||
[releasephonenumber]: https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/communication/communication-phone-numbers/samples/v1/typescript/src/releasePhoneNumber.ts
|
||||
[updatephonenumbercapabilities]: https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/communication/communication-phone-numbers/samples/v1/typescript/src/updatePhoneNumberCapabilities.ts
|
||||
[apiref]: https://docs.microsoft.com/javascript/api/@azure/communication-phone-numbers
|
||||
[freesub]: https://azure.microsoft.com/free/
|
||||
[createinstance_azurecommunicationservicesaccount]: https://docs.microsoft.com/azure/communication-services/quickstarts/create-communication-resource
|
||||
[package]: https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/communication/communication-phone-numbers/README.md
|
||||
[package]: https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/communication/communication-phone-numbers/README.md
|
||||
[typescript]: https://www.typescriptlang.org/docs/home.html
|
||||
|
|
|
|||
|
|
@ -1,8 +1,8 @@
|
|||
# Testing
|
||||
|
||||
To test this project, make sure to build it by following our [building instructions](https://github.com/Azure/azure-sdk-for-js/blob/master/CONTRIBUTING.md#building), then follow the [testing instructions](https://github.com/Azure/azure-sdk-for-js/blob/master/CONTRIBUTING.md#testing).
|
||||
To test this project, make sure to build it by following our [building instructions](https://github.com/Azure/azure-sdk-for-js/blob/main/CONTRIBUTING.md#building), then follow the [testing instructions](https://github.com/Azure/azure-sdk-for-js/blob/main/CONTRIBUTING.md#testing).
|
||||
|
||||
You can use existing Azure resources for the live tests, or generate new ones by using our [New-TestResources.ps1](https://github.com/Azure/azure-sdk-for-js/blob/master/eng/common/TestResources/New-TestResources.ps1) script, which will use an [ARM template](https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/communication/test-resources.json) that already has all of the the necessary configurations.
|
||||
You can use existing Azure resources for the live tests, or generate new ones by using our [New-TestResources.ps1](https://github.com/Azure/azure-sdk-for-js/blob/main/eng/common/TestResources/New-TestResources.ps1) script, which will use an [ARM template](https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/communication/test-resources.json) that already has all of the the necessary configurations.
|
||||
|
||||
The Azure resource that is used by the tests in this project is:
|
||||
|
||||
|
|
|
|||
|
|
@ -135,13 +135,13 @@ try {
|
|||
|
||||
## Next steps
|
||||
|
||||
- Please take a look at the [samples](https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/communication/communication-sms/samples) directory for detailed examples on how to use this library.
|
||||
- Please take a look at the [samples](https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/communication/communication-sms/samples) directory for detailed examples on how to use this library.
|
||||
- [Read more about SMS in Azure Communication Services][next_steps]
|
||||
- For a basic guide on how to configure Delivery Reporting for your SMS messages please refer to the [Handle SMS Events quickstart][handle_sms_events].
|
||||
|
||||
## Contributing
|
||||
|
||||
If you'd like to contribute to this library, please read the [contributing guide](https://github.com/Azure/azure-sdk-for-js/blob/master/CONTRIBUTING.md) to learn more about how to build and test the code.
|
||||
If you'd like to contribute to this library, please read the [contributing guide](https://github.com/Azure/azure-sdk-for-js/blob/main/CONTRIBUTING.md) to learn more about how to build and test the code.
|
||||
|
||||
## Related projects
|
||||
|
||||
|
|
@ -151,11 +151,11 @@ If you'd like to contribute to this library, please read the [contributing guide
|
|||
[azure_sub]: https://azure.microsoft.com/free/
|
||||
[azure_portal]: https://portal.azure.com
|
||||
[azure_powershell]: https://docs.microsoft.com/powershell/module/az.communication/new-azcommunicationservice
|
||||
[defaultazurecredential]: https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/identity/identity#defaultazurecredential
|
||||
[azure_identity]: https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/identity/identity
|
||||
[defaultazurecredential]: https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/identity/identity#defaultazurecredential
|
||||
[azure_identity]: https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/identity/identity
|
||||
[get_phone_number_az_portal]: https://docs.microsoft.com/azure/communication-services/quickstarts/telephony-sms/get-phone-number
|
||||
[azure_communication-phone-numbers]: https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/communication/communication-phone-numbers
|
||||
[azure_communication-phone-numbers_readme]: https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/communication/communication-phone-numbers/README.md
|
||||
[azure_communication-phone-numbers]: https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/communication/communication-phone-numbers
|
||||
[azure_communication-phone-numbers_readme]: https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/communication/communication-phone-numbers/README.md
|
||||
[handle_sms_events]: https://docs.microsoft.com/azure/communication-services/quickstarts/telephony-sms/handle-sms-events
|
||||
[next_steps]: https://docs.microsoft.com/azure/communication-services/quickstarts/telephony-sms/send?pivots=programming-language-javascript
|
||||
|
||||
|
|
|
|||
|
|
@ -58,10 +58,10 @@ npx cross-env COMMUNICATION_SAMPLES_CONNECTION_STRING="<communication samples co
|
|||
|
||||
Take a look at our [API Documentation][apiref] for more information about the APIs that are available in the clients.
|
||||
|
||||
[sendsms]: https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/communication/communication-sms/samples/v1/javascript/sendSms.js
|
||||
[sendsmswithoptions]: https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/communication/communication-sms/samples/v1/javascript/sendSmsWithOptions.js
|
||||
[usingaadauth]: https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/communication/communication-sms/samples/v1/javascript/usingAadAuth.js
|
||||
[sendsms]: https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/communication/communication-sms/samples/v1/javascript/sendSms.js
|
||||
[sendsmswithoptions]: https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/communication/communication-sms/samples/v1/javascript/sendSmsWithOptions.js
|
||||
[usingaadauth]: https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/communication/communication-sms/samples/v1/javascript/usingAadAuth.js
|
||||
[apiref]: https://docs.microsoft.com/javascript/api/@azure/communication-sms
|
||||
[freesub]: https://azure.microsoft.com/free/
|
||||
[createinstance_azurecommunicationservicesaccount]: https://docs.microsoft.com/azure/communication-services/quickstarts/create-communication-resource
|
||||
[package]: https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/communication/communication-sms/README.md
|
||||
[package]: https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/communication/communication-sms/README.md
|
||||
|
|
|
|||
|
|
@ -70,11 +70,11 @@ npx cross-env COMMUNICATION_SAMPLES_CONNECTION_STRING="<communication samples co
|
|||
|
||||
Take a look at our [API Documentation][apiref] for more information about the APIs that are available in the clients.
|
||||
|
||||
[sendsms]: https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/communication/communication-sms/samples/v1/typescript/src/sendSms.ts
|
||||
[sendsmswithoptions]: https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/communication/communication-sms/samples/v1/typescript/src/sendSmsWithOptions.ts
|
||||
[usingaadauth]: https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/communication/communication-sms/samples/v1/typescript/src/usingAadAuth.ts
|
||||
[sendsms]: https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/communication/communication-sms/samples/v1/typescript/src/sendSms.ts
|
||||
[sendsmswithoptions]: https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/communication/communication-sms/samples/v1/typescript/src/sendSmsWithOptions.ts
|
||||
[usingaadauth]: https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/communication/communication-sms/samples/v1/typescript/src/usingAadAuth.ts
|
||||
[apiref]: https://docs.microsoft.com/javascript/api/@azure/communication-sms
|
||||
[freesub]: https://azure.microsoft.com/free/
|
||||
[createinstance_azurecommunicationservicesaccount]: https://docs.microsoft.com/azure/communication-services/quickstarts/create-communication-resource
|
||||
[package]: https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/communication/communication-sms/README.md
|
||||
[package]: https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/communication/communication-sms/README.md
|
||||
[typescript]: https://www.typescriptlang.org/docs/home.html
|
||||
|
|
|
|||
|
|
@ -1,8 +1,8 @@
|
|||
# Testing
|
||||
|
||||
To test this project, make sure to build it by following our [building instructions](https://github.com/Azure/azure-sdk-for-js/blob/master/CONTRIBUTING.md#building), then follow the [testing instructions](https://github.com/Azure/azure-sdk-for-js/blob/master/CONTRIBUTING.md#testing).
|
||||
To test this project, make sure to build it by following our [building instructions](https://github.com/Azure/azure-sdk-for-js/blob/main/CONTRIBUTING.md#building), then follow the [testing instructions](https://github.com/Azure/azure-sdk-for-js/blob/main/CONTRIBUTING.md#testing).
|
||||
|
||||
You can use existing Azure resources for the live tests, or generate new ones by using our [New-TestResources.ps1](https://github.com/Azure/azure-sdk-for-js/blob/master/eng/common/TestResources/New-TestResources.ps1) script, which will use an [ARM template](https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/textanalytics/test-resources.json) that already has all of the the necessary configurations.
|
||||
You can use existing Azure resources for the live tests, or generate new ones by using our [New-TestResources.ps1](https://github.com/Azure/azure-sdk-for-js/blob/main/eng/common/TestResources/New-TestResources.ps1) script, which will use an [ARM template](https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/textanalytics/test-resources.json) that already has all of the the necessary configurations.
|
||||
|
||||
The Azure resource that is used by the tests in this project is:
|
||||
|
||||
|
|
|
|||
|
|
@ -3,7 +3,6 @@
|
|||
trigger:
|
||||
branches:
|
||||
include:
|
||||
- master
|
||||
- main
|
||||
- release/*
|
||||
- hotfix/*
|
||||
|
|
@ -14,7 +13,6 @@ trigger:
|
|||
pr:
|
||||
branches:
|
||||
include:
|
||||
- master
|
||||
- main
|
||||
- feature/*
|
||||
- release/*
|
||||
|
|
|
|||
|
|
@ -157,15 +157,15 @@ import { setLogLevel } from "@azure/logger";
|
|||
setLogLevel("info");
|
||||
```
|
||||
|
||||
For more detailed instructions on how to enable logs, you can look at the [@azure/logger package docs](https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/core/logger).
|
||||
For more detailed instructions on how to enable logs, you can look at the [@azure/logger package docs](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/core/logger).
|
||||
|
||||
## Next steps
|
||||
|
||||
Please take a look at the [samples](https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/confidentialledger/confidential-ledger-rest/samples) directory for detailed examples on how to use this library.
|
||||
Please take a look at the [samples](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/confidentialledger/confidential-ledger-rest/samples) directory for detailed examples on how to use this library.
|
||||
|
||||
## Contributing
|
||||
|
||||
If you'd like to contribute to this library, please read the [contributing guide](https://github.com/Azure/azure-sdk-for-js/blob/master/CONTRIBUTING.md) to learn more about how to build and test the code.
|
||||
If you'd like to contribute to this library, please read the [contributing guide](https://github.com/Azure/azure-sdk-for-js/blob/main/CONTRIBUTING.md) to learn more about how to build and test the code.
|
||||
|
||||
## Related projects
|
||||
|
||||
|
|
@ -178,11 +178,11 @@ If you'd like to contribute to this library, please read the [contributing guide
|
|||
[ccf]: https://github.com/Microsoft/CCF
|
||||
[azure_confidential_computing]: https://azure.microsoft.com/solutions/confidential-compute
|
||||
[confidential_ledger_docs]: https://aka.ms/confidentialledger-servicedocs
|
||||
[rest_client]: https://github.com/Azure/azure-sdk-for-js/blob/master/documentation/rest-clients.md
|
||||
[source_code]: https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/confidentialledger/confidential-ledger-rest
|
||||
[rest_client]: https://github.com/Azure/azure-sdk-for-js/blob/main/documentation/rest-clients.md
|
||||
[source_code]: https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/confidentialledger/confidential-ledger-rest
|
||||
[confidentialledger_npm]: https://www.npmjs.com/package/@azure-rest/confidential-ledger
|
||||
[ref_docs]: https://azure.github.io/azure-sdk-for-js
|
||||
[azure_sub]: https://azure.microsoft.com/free/
|
||||
[azure_identity_credentials]: https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/identity/identity#credentials
|
||||
[default_azure_credential]: https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/identity/identity#defaultazurecredential
|
||||
[azure_identity_credentials]: https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/identity/identity#credentials
|
||||
[default_azure_credential]: https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/identity/identity#defaultazurecredential
|
||||
[azure_resource_manager]: https://docs.microsoft.com/azure/azure-resource-manager/management/overview
|
||||
|
|
|
|||
|
|
@ -56,9 +56,9 @@ npx cross-env USER_CERT="<user cert>" USER_CERT_KEY="<user cert key>" ENDPOINT="
|
|||
|
||||
Take a look at our [API Documentation][apiref] for more information about the APIs that are available in the clients.
|
||||
|
||||
[getenclavequotescert]: https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/confidentialledger/confidential-ledger-rest/samples/v1/javascript/getEnclaveQuotesCert.js
|
||||
[getenclavequotesaad]: https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/confidentialledger/confidential-ledger-rest/samples/v1/javascript/getEnclaveQuotesAAD.js
|
||||
[getenclavequotescert]: https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/confidentialledger/confidential-ledger-rest/samples/v1/javascript/getEnclaveQuotesCert.js
|
||||
[getenclavequotesaad]: https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/confidentialledger/confidential-ledger-rest/samples/v1/javascript/getEnclaveQuotesAAD.js
|
||||
[apiref]: https://docs.microsoft.com/javascript/api/?term=confidential-ledger
|
||||
[freesub]: https://azure.microsoft.com/free/
|
||||
[createinstance_azureconfidentialcompute]: https://azure.microsoft.com/solutions/confidential-compute
|
||||
[package]: https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/confidentialledger/confidential-ledger-rest/README.md
|
||||
[package]: https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/confidentialledger/confidential-ledger-rest/README.md
|
||||
|
|
|
|||
|
|
@ -68,10 +68,10 @@ npx cross-env USER_CERT="<user cert>" USER_CERT_KEY="<user cert key>" ENDPOINT="
|
|||
|
||||
Take a look at our [API Documentation][apiref] for more information about the APIs that are available in the clients.
|
||||
|
||||
[getenclavequotescert]: https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/confidentialledger/confidential-ledger-rest/samples/v1/typescript/src/getEnclaveQuotesCert.ts
|
||||
[getenclavequotesaad]: https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/confidentialledger/confidential-ledger-rest/samples/v1/typescript/src/getEnclaveQuotesAAD.ts
|
||||
[getenclavequotescert]: https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/confidentialledger/confidential-ledger-rest/samples/v1/typescript/src/getEnclaveQuotesCert.ts
|
||||
[getenclavequotesaad]: https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/confidentialledger/confidential-ledger-rest/samples/v1/typescript/src/getEnclaveQuotesAAD.ts
|
||||
[apiref]: https://docs.microsoft.com/javascript/api/?term=confidential-ledger
|
||||
[freesub]: https://azure.microsoft.com/free/
|
||||
[createinstance_azureconfidentialcompute]: https://azure.microsoft.com/solutions/confidential-compute
|
||||
[package]: https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/confidentialledger/confidential-ledger-rest/README.md
|
||||
[package]: https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/confidentialledger/confidential-ledger-rest/README.md
|
||||
[typescript]: https://www.typescriptlang.org/docs/home.html
|
||||
|
|
|
|||
|
|
@ -3,7 +3,6 @@
|
|||
trigger:
|
||||
branches:
|
||||
include:
|
||||
- master
|
||||
- main
|
||||
- release/*
|
||||
- hotfix/*
|
||||
|
|
@ -14,7 +13,6 @@ trigger:
|
|||
pr:
|
||||
branches:
|
||||
include:
|
||||
- master
|
||||
- main
|
||||
- feature/*
|
||||
- release/*
|
||||
|
|
|
|||
|
|
@ -233,7 +233,7 @@ Please take a look at the [samples][samples] directory for detailed examples tha
|
|||
|
||||
## Contributing
|
||||
|
||||
If you'd like to contribute to this library, please read the [contributing guide](https://github.com/Azure/azure-sdk-for-js/blob/master/CONTRIBUTING.md) to learn more about how to build and test the code.
|
||||
If you'd like to contribute to this library, please read the [contributing guide](https://github.com/Azure/azure-sdk-for-js/blob/main/CONTRIBUTING.md) to learn more about how to build and test the code.
|
||||
|
||||
## Related projects
|
||||
|
||||
|
|
@ -243,12 +243,12 @@ If you'd like to contribute to this library, please read the [contributing guide
|
|||
|
||||
[azure_sub]: https://azure.microsoft.com/free/
|
||||
[acr_resource]: https://ms.portal.azure.com/#create/Microsoft.ContainerRegistry
|
||||
[source]: https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/containerregistry/container-registry/
|
||||
[source]: https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/containerregistry/container-registry/
|
||||
[package]: https://www.npmjs.com/package/@azure/container-registry
|
||||
[api_docs]: https://docs.microsoft.com/javascript/api/@azure/container-registry
|
||||
[rest_docs]: https://docs.microsoft.com/rest/api/containerregistry/
|
||||
[product_docs]: https://docs.microsoft.com/azure/container-registry/
|
||||
[samples]: https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/containerregistry/container-registry/samples
|
||||
[samples]: https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/containerregistry/container-registry/samples
|
||||
[container_registry_docs]: https://docs.microsoft.com/azure/container-registry/container-registry-intro
|
||||
[container_registry_create_ps]: https://docs.microsoft.com/azure/container-registry/container-registry-get-started-powershell
|
||||
[container_registry_create_cli]: https://docs.microsoft.com/azure/container-registry/container-registry-get-started-azure-cli
|
||||
|
|
@ -256,5 +256,5 @@ If you'd like to contribute to this library, please read the [contributing guide
|
|||
[container_registry_concepts]: https://docs.microsoft.com/azure/container-registry/container-registry-concepts
|
||||
[azure_cli]: https://docs.microsoft.com/cli/azure
|
||||
[azure_sub]: https://azure.microsoft.com/free/
|
||||
[identity]: https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/identity/identity/README.md
|
||||
[identity]: https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/identity/identity/README.md
|
||||
[az_sdk_js]: https://github.com/Azure/azure-sdk-for-js
|
||||
|
|
|
|||
|
|
@ -60,12 +60,12 @@ npx cross-env CONTAINER_REGISTRY_ENDPOINT="<container registry endpoint>" node c
|
|||
|
||||
Take a look at our [API Documentation][apiref] for more information about the APIs that are available in the clients.
|
||||
|
||||
[containerregistryclient]: https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/containerregistry/container-registry/samples/v1/javascript/containerRegistryClient.js
|
||||
[anonymouslisttags]: https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/containerregistry/container-registry/samples/v1/javascript/anonymousListTags.js
|
||||
[deleteimages]: https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/containerregistry/container-registry/samples/v1/javascript/deleteImages.js
|
||||
[repositoryandartifact]: https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/containerregistry/container-registry/samples/v1/javascript/repositoryAndArtifact.js
|
||||
[setimageproperties]: https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/containerregistry/container-registry/samples/v1/javascript/setImageProperties.js
|
||||
[containerregistryclient]: https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/containerregistry/container-registry/samples/v1/javascript/containerRegistryClient.js
|
||||
[anonymouslisttags]: https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/containerregistry/container-registry/samples/v1/javascript/anonymousListTags.js
|
||||
[deleteimages]: https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/containerregistry/container-registry/samples/v1/javascript/deleteImages.js
|
||||
[repositoryandartifact]: https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/containerregistry/container-registry/samples/v1/javascript/repositoryAndArtifact.js
|
||||
[setimageproperties]: https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/containerregistry/container-registry/samples/v1/javascript/setImageProperties.js
|
||||
[apiref]: https://docs.microsoft.com/javascript/api/@azure/container-registry
|
||||
[freesub]: https://azure.microsoft.com/free/
|
||||
[createinstance_azurecontainerregistry]: https://docs.microsoft.com/azure/container-registry/container-registry-get-started-portal
|
||||
[package]: https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/containerregistry/container-registry/README.md
|
||||
[package]: https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/containerregistry/container-registry/README.md
|
||||
|
|
|
|||
|
|
@ -72,13 +72,13 @@ npx cross-env CONTAINER_REGISTRY_ENDPOINT="<container registry endpoint>" node d
|
|||
|
||||
Take a look at our [API Documentation][apiref] for more information about the APIs that are available in the clients.
|
||||
|
||||
[containerregistryclient]: https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/containerregistry/container-registry/samples/v1/typescript/src/containerRegistryClient.ts
|
||||
[anonymouslisttags]: https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/containerregistry/container-registry/samples/v1/typescript/src/anonymousListTags.ts
|
||||
[deleteimages]: https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/containerregistry/container-registry/samples/v1/typescript/src/deleteImages.ts
|
||||
[repositoryandartifact]: https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/containerregistry/container-registry/samples/v1/typescript/src/repositoryAndArtifact.ts
|
||||
[setimageproperties]: https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/containerregistry/container-registry/samples/v1/typescript/src/setImageProperties.ts
|
||||
[containerregistryclient]: https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/containerregistry/container-registry/samples/v1/typescript/src/containerRegistryClient.ts
|
||||
[anonymouslisttags]: https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/containerregistry/container-registry/samples/v1/typescript/src/anonymousListTags.ts
|
||||
[deleteimages]: https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/containerregistry/container-registry/samples/v1/typescript/src/deleteImages.ts
|
||||
[repositoryandartifact]: https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/containerregistry/container-registry/samples/v1/typescript/src/repositoryAndArtifact.ts
|
||||
[setimageproperties]: https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/containerregistry/container-registry/samples/v1/typescript/src/setImageProperties.ts
|
||||
[apiref]: https://docs.microsoft.com/javascript/api/@azure/container-registry
|
||||
[freesub]: https://azure.microsoft.com/free/
|
||||
[createinstance_azurecontainerregistry]: https://docs.microsoft.com/azure/container-registry/container-registry-get-started-portal
|
||||
[package]: https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/containerregistry/container-registry/README.md
|
||||
[package]: https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/containerregistry/container-registry/README.md
|
||||
[typescript]: https://www.typescriptlang.org/docs/home.html
|
||||
|
|
|
|||
|
|
@ -6,7 +6,7 @@ These packages are generally not used directly by consumers, but are used as dep
|
|||
|
||||
## Core "v1" and Core "v2"
|
||||
|
||||
The package `@azure/core-http` is heavily based on `@azure/ms-rest-js` and inherited legacy API surface and concepts that sometimes conflicted with our design principles. A full explanation is available here: https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/core/core-rest-pipeline/documentation/core2.md
|
||||
The package `@azure/core-http` is heavily based on `@azure/ms-rest-js` and inherited legacy API surface and concepts that sometimes conflicted with our design principles. A full explanation is available here: https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/core/core-rest-pipeline/documentation/core2.md
|
||||
|
||||
For the purposes of this document, understand that "core v1" refers to the package `@azure/core-http` and is considered legacy. "Core v2" refers to the packages `@azure/core-rest-pipeline`, `@azure/core-client`, and `@azure/core-xml`.
|
||||
|
||||
|
|
@ -20,7 +20,7 @@ Many service operations require client libraries to make one or more HTTP calls
|
|||
|
||||
The `Pipeline` is what manages these common behaviors, which are grouped into items called `PipelinePolicy`s. Each client library configures its own `Pipeline` using a set of standard `PipelineOptions`.
|
||||
|
||||
For more information, refer to https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/core/core-rest-pipeline#key-concepts
|
||||
For more information, refer to https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/core/core-rest-pipeline#key-concepts
|
||||
|
||||
### ServiceClient
|
||||
|
||||
|
|
@ -28,7 +28,7 @@ Client libraries come in two flavors: authored and generated. Generated clients
|
|||
|
||||
`ServiceClient` is the base class of all generated clients. It builds on top of the HTTP Pipeline in order to make requests to services.
|
||||
|
||||
For more information, refer to https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/core/core-client#key-concepts
|
||||
For more information, refer to https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/core/core-client#key-concepts
|
||||
|
||||
### Accessing raw HTTP responses
|
||||
|
||||
|
|
@ -55,7 +55,7 @@ console.log(item._response.parsedHeaders);
|
|||
|
||||
### Authentication
|
||||
|
||||
Authentication is handled by [@azure/identity](https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/identity/identity/). In most cases this is as simple as passing `DefaultAzureCredential` to a client that takes a `TokenCredential` as a means of authentication.
|
||||
Authentication is handled by [@azure/identity](https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/identity/identity/). In most cases this is as simple as passing `DefaultAzureCredential` to a client that takes a `TokenCredential` as a means of authentication.
|
||||
|
||||
```ts
|
||||
const { KeyClient } = require("@azure/keyvault-keys");
|
||||
|
|
@ -72,7 +72,7 @@ Note that `DefaultAzureCredential` does not work for applications that are runni
|
|||
|
||||
Client libraries follow our [design guidelines for pagination](https://azure.github.io/azure-sdk/typescript_design.html#ts-pagination). This is largely hand-authored today in convenience clients, but code generation is improving to support this pattern inside generated clients as well.
|
||||
|
||||
The standard interfaces for pagination are provided by [@azure/core-paging](https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/core/core-paging).
|
||||
The standard interfaces for pagination are provided by [@azure/core-paging](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/core/core-paging).
|
||||
|
||||
Basic code for iterating through all entries of a paged API looks something like:
|
||||
|
||||
|
|
@ -96,7 +96,7 @@ for await (let page of client.listSecrets().byPage({ maxPageSize: 2 })) {
|
|||
|
||||
Client libraries follow our [design guidelines for Long Running Operations (LROs)](https://azure.github.io/azure-sdk/typescript_design.html#ts-lro). This ensures all LROs follow a similar pattern to remain **consistent** across clients.
|
||||
|
||||
To assist with implementing pollers correctly, primitives are provided by [@azure/core-lro](https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/core/core-lro). These primitives help implement `Poller` objects which are used to manage `PollOperation`s that contain `PollOperationState`.
|
||||
To assist with implementing pollers correctly, primitives are provided by [@azure/core-lro](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/core/core-lro). These primitives help implement `Poller` objects which are used to manage `PollOperation`s that contain `PollOperationState`.
|
||||
|
||||
In essence, a `Poller` handles the work of continously checking the server for updates to the LRO on a developer's behalf. `Poller`s are highly customizable, and consumers are able to decide when to poll manually if needed.
|
||||
|
||||
|
|
@ -118,9 +118,9 @@ const rehydratedPoller = await client.beginDeleteKey(keyName, { resumeFrom: seri
|
|||
|
||||
### Tracing
|
||||
|
||||
Client libraries have preliminary support for [OpenTelemetry](https://opentelemetry.io/). This functionality is mostly managed by [@azure/core-tracing](https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/core/core-tracing)
|
||||
Client libraries have preliminary support for [OpenTelemetry](https://opentelemetry.io/). This functionality is mostly managed by [@azure/core-tracing](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/core/core-tracing)
|
||||
|
||||
Each client library internally does the work to create a new OpenTelemetry `Span` for each service operation, making sure to end the `Span` after the result is returned back to the consumer. Many clients use a helper method called [createSpan](https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/textanalytics/ai-text-analytics/src/tracing.ts) to create the new `Span`.
|
||||
Each client library internally does the work to create a new OpenTelemetry `Span` for each service operation, making sure to end the `Span` after the result is returned back to the consumer. Many clients use a helper method called [createSpan](https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/textanalytics/ai-text-analytics/src/tracing.ts) to create the new `Span`.
|
||||
|
||||
When `tracingOptions.tracingContext` is set on an operation, a default request policy will automatically create a span for each HTTP request that is issued.
|
||||
|
||||
|
|
@ -136,7 +136,7 @@ const result = await blobClient.download(undefined, undefined, {
|
|||
|
||||
### Logging
|
||||
|
||||
Logging in client libraries is provided by [@azure/logger](https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/core/logger).
|
||||
Logging in client libraries is provided by [@azure/logger](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/core/logger).
|
||||
|
||||
AzureLogger provides the ability to easily set a global log level (either programmatically or through an environment variable) and log output can be redirected by simply overriding the default `log` method:
|
||||
|
||||
|
|
@ -161,4 +161,4 @@ A convenience client extends the shape of a generated client in ways that make i
|
|||
|
||||
## AMQP and Message-based Clients
|
||||
|
||||
More information can be found in [@azure/amqp](https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/core/core-amqp)
|
||||
More information can be found in [@azure/amqp](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/core/core-amqp)
|
||||
|
|
|
|||
|
|
@ -99,6 +99,6 @@ If you run into issues while using this library, please feel free to [file an is
|
|||
|
||||
## Contributing
|
||||
|
||||
If you'd like to contribute to this library, please read the [contributing guide](https://github.com/Azure/azure-sdk-for-js/blob/master/CONTRIBUTING.md) to learn more about how to build and test the code.
|
||||
If you'd like to contribute to this library, please read the [contributing guide](https://github.com/Azure/azure-sdk-for-js/blob/main/CONTRIBUTING.md) to learn more about how to build and test the code.
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -3,7 +3,6 @@
|
|||
trigger:
|
||||
branches:
|
||||
include:
|
||||
- master
|
||||
- main
|
||||
- release/*
|
||||
- hotfix/*
|
||||
|
|
@ -19,7 +18,6 @@ trigger:
|
|||
pr:
|
||||
branches:
|
||||
include:
|
||||
- master
|
||||
- main
|
||||
- feature/*
|
||||
- release/*
|
||||
|
|
|
|||
|
|
@ -161,7 +161,7 @@ We are cleaning the public API surface by
|
|||
## 1.0.1 (2020-02-06)
|
||||
|
||||
- Updated to use the latest version of the `rhea` package.
|
||||
This update improves support for [bundling](https://github.com/Azure/azure-sdk-for-js/blob/master/documentation/Bundling.md) this library.
|
||||
This update improves support for [bundling](https://github.com/Azure/azure-sdk-for-js/blob/main/documentation/Bundling.md) this library.
|
||||
|
||||
## 1.0.0 (2020-01-08)
|
||||
|
||||
|
|
|
|||
|
|
@ -112,7 +112,7 @@ When you submit a pull request, a CLA-bot will automatically determine whether y
|
|||
a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions
|
||||
provided by the bot. You will only need to do this once across all repos using our CLA.
|
||||
|
||||
If you'd like to contribute to this library, please read the [contributing guide](https://github.com/Azure/azure-sdk-for-js/blob/master/CONTRIBUTING.md) to learn more about how to build and test the code.
|
||||
If you'd like to contribute to this library, please read the [contributing guide](https://github.com/Azure/azure-sdk-for-js/blob/main/CONTRIBUTING.md) to learn more about how to build and test the code.
|
||||
|
||||
This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
|
||||
For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or
|
||||
|
|
|
|||
|
|
@ -41,6 +41,6 @@ Log an issue at https://github.com/Azure/azure-sdk-for-js/issues
|
|||
|
||||
## Contributing
|
||||
|
||||
If you'd like to contribute to this library, please read the [contributing guide](https://github.com/Azure/azure-sdk-for-js/blob/master/CONTRIBUTING.md) to learn more about how to build and test the code.
|
||||
If you'd like to contribute to this library, please read the [contributing guide](https://github.com/Azure/azure-sdk-for-js/blob/main/CONTRIBUTING.md) to learn more about how to build and test the code.
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -73,6 +73,6 @@ If you run into issues while using this library, please feel free to [file an is
|
|||
|
||||
## Contributing
|
||||
|
||||
If you'd like to contribute to this library, please read the [contributing guide](https://github.com/Azure/azure-sdk-for-js/blob/master/CONTRIBUTING.md) to learn more about how to build and test the code.
|
||||
If you'd like to contribute to this library, please read the [contributing guide](https://github.com/Azure/azure-sdk-for-js/blob/main/CONTRIBUTING.md) to learn more about how to build and test the code.
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -30,6 +30,6 @@ If you run into issues while using this library, please feel free to [file an is
|
|||
|
||||
## Contributing
|
||||
|
||||
If you'd like to contribute to this library, please read the [contributing guide](https://github.com/Azure/azure-sdk-for-js/blob/master/CONTRIBUTING.md) to learn more about how to build and test the code.
|
||||
If you'd like to contribute to this library, please read the [contributing guide](https://github.com/Azure/azure-sdk-for-js/blob/main/CONTRIBUTING.md) to learn more about how to build and test the code.
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -28,7 +28,7 @@
|
|||
### Breaking Changes
|
||||
|
||||
- If the response body is empty and the mapper for it says it is nullable, then a null is returned.
|
||||
- Updated @azure/core-tracing to version `1.0.0-preview.11`. See [@azure/core-tracing CHANGELOG](https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/core/core-tracing/CHANGELOG.md) for details about breaking changes with tracing.
|
||||
- Updated @azure/core-tracing to version `1.0.0-preview.11`. See [@azure/core-tracing CHANGELOG](https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/core/core-tracing/CHANGELOG.md) for details about breaking changes with tracing.
|
||||
|
||||
## 1.0.0 (2021-03-15)
|
||||
|
||||
|
|
|
|||
|
|
@ -48,6 +48,6 @@ If you run into issues while using this library, please feel free to [file an is
|
|||
|
||||
## Contributing
|
||||
|
||||
If you'd like to contribute to this library, please read the [contributing guide](https://github.com/Azure/azure-sdk-for-js/blob/master/CONTRIBUTING.md) to learn more about how to build and test the code.
|
||||
If you'd like to contribute to this library, please read the [contributing guide](https://github.com/Azure/azure-sdk-for-js/blob/main/CONTRIBUTING.md) to learn more about how to build and test the code.
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -33,6 +33,6 @@ If you run into issues while using this library, please feel free to [file an is
|
|||
|
||||
## Contributing
|
||||
|
||||
If you'd like to contribute to this library, please read the [contributing guide](https://github.com/Azure/azure-sdk-for-js/blob/master/CONTRIBUTING.md) to learn more about how to build and test the code.
|
||||
If you'd like to contribute to this library, please read the [contributing guide](https://github.com/Azure/azure-sdk-for-js/blob/main/CONTRIBUTING.md) to learn more about how to build and test the code.
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -34,7 +34,7 @@
|
|||
|
||||
### Breaking Changes
|
||||
|
||||
- Updated @azure/core-tracing to version `1.0.0-preview.11`. See [@azure/core-tracing CHANGELOG](https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/core/core-tracing/CHANGELOG.md) for details about breaking changes with tracing.
|
||||
- Updated @azure/core-tracing to version `1.0.0-preview.11`. See [@azure/core-tracing CHANGELOG](https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/core/core-tracing/CHANGELOG.md) for details about breaking changes with tracing.
|
||||
|
||||
## 1.2.3 (2021-02-04)
|
||||
|
||||
|
|
|
|||
|
|
@ -19,7 +19,7 @@ This package is primarily used in generated code and not meant to be consumed di
|
|||
|
||||
## Key concepts
|
||||
|
||||
You can find an explanation of how this repository's code works by going to our [architecture overview](https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/core/core-http/docs/architectureOverview.md).
|
||||
You can find an explanation of how this repository's code works by going to our [architecture overview](https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/core/core-http/docs/architectureOverview.md).
|
||||
|
||||
## Examples
|
||||
|
||||
|
|
@ -27,7 +27,7 @@ Examples can be found in the `samples` folder.
|
|||
|
||||
## Next steps
|
||||
|
||||
- Build this library (`core-http`). For more information on how to build project in this repo, please refer to the [Contributing Guide](https://github.com/Azure/azure-sdk-for-js/blob/master/CONTRIBUTING.md).
|
||||
- Build this library (`core-http`). For more information on how to build project in this repo, please refer to the [Contributing Guide](https://github.com/Azure/azure-sdk-for-js/blob/main/CONTRIBUTING.md).
|
||||
|
||||
- The code in `samples\node-sample.ts` shows how to create a `ServiceClient` instance with a test `TokenCredential` implementation and use the client instance to perform a `GET` operation from the Azure management service endpoint for subscriptions. To run the code, first obtain an access token to the Azure management service.
|
||||
|
||||
|
|
@ -61,7 +61,7 @@ node node-sample.js
|
|||
### Browser
|
||||
|
||||
- Set values of `subscriptionId` and `token` variable in `samples/index.js`
|
||||
- Follow the instructions of [JavaScript Bundling Guide using Parcel](https://github.com/Azure/azure-sdk-for-js/blob/master/documentation/Bundling.md#using-parcel) to build and run the code in the browser.
|
||||
- Follow the instructions of [JavaScript Bundling Guide using Parcel](https://github.com/Azure/azure-sdk-for-js/blob/main/documentation/Bundling.md#using-parcel) to build and run the code in the browser.
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
|
|
@ -69,6 +69,6 @@ If you run into issues while using this library, please feel free to [file an is
|
|||
|
||||
## Contributing
|
||||
|
||||
If you'd like to contribute to this library, please read the [contributing guide](https://github.com/Azure/azure-sdk-for-js/blob/master/CONTRIBUTING.md) to learn more about how to build and test the code.
|
||||
If you'd like to contribute to this library, please read the [contributing guide](https://github.com/Azure/azure-sdk-for-js/blob/main/CONTRIBUTING.md) to learn more about how to build and test the code.
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -13,7 +13,7 @@
|
|||
|
||||
### Breaking Changes
|
||||
|
||||
- Updated @azure/core-tracing to version `1.0.0-preview.11`. See [@azure/core-tracing CHANGELOG](https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/core/core-tracing/CHANGELOG.md) for details about breaking changes with tracing.
|
||||
- Updated @azure/core-tracing to version `1.0.0-preview.11`. See [@azure/core-tracing CHANGELOG](https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/core/core-tracing/CHANGELOG.md) for details about breaking changes with tracing.
|
||||
|
||||
## 1.0.3 (2021-01-07)
|
||||
|
||||
|
|
|
|||
|
|
@ -6,7 +6,7 @@
|
|||
|
||||
`@azure/core-lro` is made following our [Long Running Operations guidelines](https://azure.github.io/azure-sdk/typescript_design.html#ts-lro)
|
||||
|
||||
[Source code](https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/core/core-lro) | [Package (npm)](https://www.npmjs.com/package/@azure/core-lro) | [API Reference Documentation](https://docs.microsoft.com/javascript/api/@azure/core-lro) | [Samples](https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/core/core-lro/samples)
|
||||
[Source code](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/core/core-lro) | [Package (npm)](https://www.npmjs.com/package/@azure/core-lro) | [API Reference Documentation](https://docs.microsoft.com/javascript/api/@azure/core-lro) | [Samples](https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/core/core-lro/samples)
|
||||
|
||||
## Getting started
|
||||
|
||||
|
|
@ -55,8 +55,8 @@ for more information.
|
|||
|
||||
You will be able to find some working examples of an implementation of an operation and a poller in:
|
||||
|
||||
- [The `@azure/core-lro` samples](https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/core/core-lro/samples).
|
||||
- [The `@azure/core-lro` tests](https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/core/core-lro/test).
|
||||
- [The `@azure/core-lro` samples](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/core/core-lro/samples).
|
||||
- [The `@azure/core-lro` tests](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/core/core-lro/test).
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
|
|
@ -64,15 +64,15 @@ You will be able to find some working examples of an implementation of an operat
|
|||
|
||||
Logs can be added at the discretion of the library implementing the Long Running Operation poller.
|
||||
Packages inside of [azure-sdk-for-js](https://github.com/Azure/azure-sdk-for-js) use
|
||||
[@azure/logger](https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/core/logger).
|
||||
[@azure/logger](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/core/logger).
|
||||
|
||||
## Next steps
|
||||
|
||||
Please take a look at the [samples](https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/core/core-lro/samples) directory for detailed examples on how to use this library.
|
||||
Please take a look at the [samples](https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/core/core-lro/samples) directory for detailed examples on how to use this library.
|
||||
|
||||
## Contributing
|
||||
|
||||
If you'd like to contribute to this library, please read the [contributing guide](https://github.com/Azure/azure-sdk-for-js/blob/master/CONTRIBUTING.md) to learn more about how to build and test the code.
|
||||
If you'd like to contribute to this library, please read the [contributing guide](https://github.com/Azure/azure-sdk-for-js/blob/main/CONTRIBUTING.md) to learn more about how to build and test the code.
|
||||
|
||||
### Testing
|
||||
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ In this folder you will be able to see a simple sample file implementing a `Poll
|
|||
|
||||
The sample file:
|
||||
|
||||
- [typescript/samplesClient.ts](https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/core/core-lro/samples/typescript/samplesClient.ts)
|
||||
- [typescript/samplesClient.ts](https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/core/core-lro/samples/typescript/samplesClient.ts)
|
||||
|
||||
## Guide on implementing a LRO method
|
||||
|
||||
|
|
@ -73,7 +73,7 @@ A guide on how to write them follows.
|
|||
|
||||
The `update` method defines how to request the remote service for updates on the status of the long running operation.
|
||||
|
||||
It optionally receives an object with an `abortSignal` property, from [@azure/abort-controller](https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/core/abort-controller)'s `AbortSignalLike`.
|
||||
It optionally receives an object with an `abortSignal` property, from [@azure/abort-controller](https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/core/abort-controller)'s `AbortSignalLike`.
|
||||
|
||||
A more advanced use allows passing in a `fireProgress` function, which, if called, is responsible for triggering the
|
||||
poller's `onProgress` callbacks.
|
||||
|
|
@ -112,7 +112,7 @@ async function update(
|
|||
|
||||
The operation's `cancel` method should attempt to cancel the pending operation, if it's allowed by the remote service. Otherwise, it should throw.
|
||||
|
||||
It only optionally receives an object with an `abortSignal` property, from [@azure/abort-controller](https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/core/abort-controller)'s `AbortSignalLike`.
|
||||
It only optionally receives an object with an `abortSignal` property, from [@azure/abort-controller](https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/core/abort-controller)'s `AbortSignalLike`.
|
||||
|
||||
It returns a promise that should be resolved with an updated version of the poller's operation.
|
||||
|
||||
|
|
|
|||
|
|
@ -56,6 +56,6 @@ Log an issue at https://github.com/Azure/azure-sdk-for-js/issues
|
|||
|
||||
## Contributing
|
||||
|
||||
If you'd like to contribute to this library, please read the [contributing guide](https://github.com/Azure/azure-sdk-for-js/blob/master/CONTRIBUTING.md) to learn more about how to build and test the code.
|
||||
If you'd like to contribute to this library, please read the [contributing guide](https://github.com/Azure/azure-sdk-for-js/blob/main/CONTRIBUTING.md) to learn more about how to build and test the code.
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -35,7 +35,7 @@
|
|||
|
||||
### Breaking Changes
|
||||
|
||||
- Updated @azure/core-tracing to version `1.0.0-preview.11`. See [@azure/core-tracing CHANGELOG](https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/core/core-tracing/CHANGELOG.md) for details about breaking changes with tracing.
|
||||
- Updated @azure/core-tracing to version `1.0.0-preview.11`. See [@azure/core-tracing CHANGELOG](https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/core/core-tracing/CHANGELOG.md) for details about breaking changes with tracing.
|
||||
|
||||
## 1.0.2 (2021-03-25)
|
||||
|
||||
|
|
|
|||
|
|
@ -85,7 +85,7 @@ const customPolicy = {
|
|||
};
|
||||
```
|
||||
|
||||
Most policies only concern themselves with either the request or the response, but there are some exceptions such as the [LogPolicy](https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/core/core-rest-pipeline/src/policies/logPolicy.ts) which logs information from each.
|
||||
Most policies only concern themselves with either the request or the response, but there are some exceptions such as the [LogPolicy](https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/core/core-rest-pipeline/src/policies/logPolicy.ts) which logs information from each.
|
||||
|
||||
### Pipelines
|
||||
|
||||
|
|
@ -149,6 +149,6 @@ If you run into issues while using this library, please feel free to [file an is
|
|||
|
||||
## Contributing
|
||||
|
||||
If you'd like to contribute to this library, please read the [contributing guide](https://github.com/Azure/azure-sdk-for-js/blob/master/CONTRIBUTING.md) to learn more about how to build and test the code.
|
||||
If you'd like to contribute to this library, please read the [contributing guide](https://github.com/Azure/azure-sdk-for-js/blob/main/CONTRIBUTING.md) to learn more about how to build and test the code.
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -39,6 +39,6 @@ node node-sample.js
|
|||
|
||||
Take a look at our [API Documentation][apiref] for more information about the APIs that are available in the clients.
|
||||
|
||||
[node-sample]: https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/core/core-rest-pipeline/samples/v1/javascript/node-sample.js
|
||||
[node-sample]: https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/core/core-rest-pipeline/samples/v1/javascript/node-sample.js
|
||||
[apiref]: https://docs.microsoft.com/javascript/api/@azure/core-rest-pipeline
|
||||
[package]: https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/core/core-rest-pipeline/README.md
|
||||
[package]: https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/core/core-rest-pipeline/README.md
|
||||
|
|
|
|||
|
|
@ -51,7 +51,7 @@ node dist/node-sample.js
|
|||
|
||||
Take a look at our [API Documentation][apiref] for more information about the APIs that are available in the clients.
|
||||
|
||||
[node-sample]: https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/core/core-rest-pipeline/samples/v1/typescript/src/node-sample.ts
|
||||
[node-sample]: https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/core/core-rest-pipeline/samples/v1/typescript/src/node-sample.ts
|
||||
[apiref]: https://docs.microsoft.com/javascript/api/@azure/core-rest-pipeline
|
||||
[package]: https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/core/core-rest-pipeline/README.md
|
||||
[package]: https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/core/core-rest-pipeline/README.md
|
||||
[typescript]: https://www.typescriptlang.org/docs/home.html
|
||||
|
|
|
|||
|
|
@ -67,6 +67,6 @@ If you run into issues while using this library, please feel free to [file an is
|
|||
|
||||
## Contributing
|
||||
|
||||
If you'd like to contribute to this library, please read the [contributing guide](https://github.com/Azure/azure-sdk-for-js/blob/master/CONTRIBUTING.md) to learn more about how to build and test the code.
|
||||
If you'd like to contribute to this library, please read the [contributing guide](https://github.com/Azure/azure-sdk-for-js/blob/main/CONTRIBUTING.md) to learn more about how to build and test the code.
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -30,6 +30,6 @@ If you run into issues while using this library, please feel free to [file an is
|
|||
|
||||
## Contributing
|
||||
|
||||
If you'd like to contribute to this library, please read the [contributing guide](https://github.com/Azure/azure-sdk-for-js/blob/master/CONTRIBUTING.md) to learn more about how to build and test the code.
|
||||
If you'd like to contribute to this library, please read the [contributing guide](https://github.com/Azure/azure-sdk-for-js/blob/main/CONTRIBUTING.md) to learn more about how to build and test the code.
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -30,6 +30,6 @@ If you run into issues while using this library, please feel free to [file an is
|
|||
|
||||
## Contributing
|
||||
|
||||
If you'd like to contribute to this library, please read the [contributing guide](https://github.com/Azure/azure-sdk-for-js/blob/master/CONTRIBUTING.md) to learn more about how to build and test the code.
|
||||
If you'd like to contribute to this library, please read the [contributing guide](https://github.com/Azure/azure-sdk-for-js/blob/main/CONTRIBUTING.md) to learn more about how to build and test the code.
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -83,6 +83,6 @@ If you run into issues while using this library, please feel free to [file an is
|
|||
|
||||
## Contributing
|
||||
|
||||
If you'd like to contribute to this library, please read the [contributing guide](https://github.com/Azure/azure-sdk-for-js/blob/master/CONTRIBUTING.md) to learn more about how to build and test the code.
|
||||
If you'd like to contribute to this library, please read the [contributing guide](https://github.com/Azure/azure-sdk-for-js/blob/main/CONTRIBUTING.md) to learn more about how to build and test the code.
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -3,7 +3,6 @@
|
|||
trigger:
|
||||
branches:
|
||||
include:
|
||||
- master
|
||||
- main
|
||||
- release/*
|
||||
- hotfix/*
|
||||
|
|
@ -14,7 +13,6 @@ trigger:
|
|||
pr:
|
||||
branches:
|
||||
include:
|
||||
- master
|
||||
- main
|
||||
- feature/*
|
||||
- release/*
|
||||
|
|
|
|||
|
|
@ -233,7 +233,7 @@ For more extensive documentation on the Cosmos DB service, see the [Azure Cosmos
|
|||
- [Welcome to Azure Cosmos DB](https://docs.microsoft.com/azure/cosmos-db/community)
|
||||
- [Quick start](https://docs.microsoft.com/azure/cosmos-db/sql-api-nodejs-get-started)
|
||||
- [Tutorial](https://docs.microsoft.com/azure/cosmos-db/sql-api-nodejs-application)
|
||||
- [Samples](https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/cosmosdb/cosmos/samples)
|
||||
- [Samples](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/cosmosdb/cosmos/samples)
|
||||
- [Introduction to Resource Model of Azure Cosmos DB Service](https://docs.microsoft.com/azure/cosmos-db/sql-api-resources)
|
||||
- [Introduction to SQL API of Azure Cosmos DB Service](https://docs.microsoft.com/azure/cosmos-db/sql-api-sql-query)
|
||||
- [Partitioning](https://docs.microsoft.com/azure/cosmos-db/sql-api-partition-data)
|
||||
|
|
@ -241,7 +241,7 @@ For more extensive documentation on the Cosmos DB service, see the [Azure Cosmos
|
|||
|
||||
## Contributing
|
||||
|
||||
If you'd like to contribute to this library, please read the [contributing guide](https://github.com/Azure/azure-sdk-for-js/blob/master/CONTRIBUTING.md) to learn more about how to build and test the code.
|
||||
If you'd like to contribute to this library, please read the [contributing guide](https://github.com/Azure/azure-sdk-for-js/blob/main/CONTRIBUTING.md) to learn more about how to build and test the code.
|
||||
|
||||
|
||||
|
||||
|
|
@ -263,7 +263,7 @@ If you'd like to contribute to this library, please read the [contributing guide
|
|||
[cosmos_item]: https://docs.microsoft.com/azure/cosmos-db/databases-containers-items#azure-cosmos-items
|
||||
[cosmos_request_units]: https://docs.microsoft.com/azure/cosmos-db/request-units
|
||||
[cosmos_resources]: https://docs.microsoft.com/azure/cosmos-db/databases-containers-items
|
||||
[cosmos_samples]: https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/cosmosdb/cosmos/samples
|
||||
[cosmos_samples]: https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/cosmosdb/cosmos/samples
|
||||
[cosmos_sql_queries]: https://docs.microsoft.com/azure/cosmos-db/how-to-sql-query
|
||||
[cosmos_ttl]: https://docs.microsoft.com/azure/cosmos-db/time-to-live
|
||||
[npm]: https://www.npmjs.com/package/@azure/cosmos
|
||||
|
|
|
|||
|
|
@ -3,7 +3,6 @@
|
|||
trigger:
|
||||
branches:
|
||||
include:
|
||||
- master
|
||||
- main
|
||||
- release/*
|
||||
- hotfix/*
|
||||
|
|
@ -14,7 +13,6 @@ trigger:
|
|||
pr:
|
||||
branches:
|
||||
include:
|
||||
- master
|
||||
- main
|
||||
- feature/*
|
||||
- release/*
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
|
||||
The library provides access to the Device Update for IoT Hub service that enables customers to publish updates for their IoT devices to the cloud, and then deploy these updates to their devices (approve updates to groups of devices managed and provisioned in IoT Hub).
|
||||
|
||||
[Source code](https://github.com/Azure/azure-sdk-for-js/tree/master/sdk) | [Product documentation](https://docs.microsoft.com/azure/iot-hub-device-update/understand-device-update)
|
||||
[Source code](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk) | [Product documentation](https://docs.microsoft.com/azure/iot-hub-device-update/understand-device-update)
|
||||
|
||||
## Getting started
|
||||
|
||||
|
|
@ -36,7 +36,7 @@ You can learn more about Device Update for IoT Hub by visiting [Device Update fo
|
|||
|
||||
## Examples
|
||||
|
||||
You can familiarize yourself with different APIs using [Samples](https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/deviceupdate/iot-device-update/samples).
|
||||
You can familiarize yourself with different APIs using [Samples](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/deviceupdate/iot-device-update/samples).
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
|
|
@ -50,15 +50,15 @@ import { setLogLevel } from "@azure/logger";
|
|||
setLogLevel("info");
|
||||
```
|
||||
|
||||
For more detailed instructions on how to enable logs, you can look at the [@azure/logger package docs](https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/core/logger).
|
||||
For more detailed instructions on how to enable logs, you can look at the [@azure/logger package docs](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/core/logger).
|
||||
|
||||
## Next steps
|
||||
|
||||
Get started with our [Device Update for IoT Hub samples](https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/deviceupdate/iot-device-update/samples)
|
||||
Get started with our [Device Update for IoT Hub samples](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/deviceupdate/iot-device-update/samples)
|
||||
|
||||
## Contributing
|
||||
|
||||
If you'd like to contribute to this library, please read the [contributing guide](https://github.com/Azure/azure-sdk-for-js/blob/master/CONTRIBUTING.md) to learn more about how to build and test the code.
|
||||
If you'd like to contribute to this library, please read the [contributing guide](https://github.com/Azure/azure-sdk-for-js/blob/main/CONTRIBUTING.md) to learn more about how to build and test the code.
|
||||
|
||||
## Related projects
|
||||
|
||||
|
|
|
|||
|
|
@ -56,8 +56,8 @@ npx cross-env ACCOUNT_ENDPOINT="<account endpoint>" INSTANCE_ID="<instance id>"
|
|||
|
||||
Take a look at our [API Documentation][apiref] for more information about the APIs that are available in the clients.
|
||||
|
||||
[updates]: https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/deviceupdate/iot-device-update/samples/v1/javascript/updates.js
|
||||
[updates]: https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/deviceupdate/iot-device-update/samples/v1/javascript/updates.js
|
||||
[apiref]: https://docs.microsoft.com/javascript/api/@azure/iot-device-update
|
||||
[freesub]: https://azure.microsoft.com/free/
|
||||
[createinstance_azuredeviceupdateforiothubinstance]: https://docs.microsoft.com/azure/iot-hub-device-update/understand-device-update
|
||||
[package]: https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/deviceupdate/iot-device-update/README.md
|
||||
[package]: https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/deviceupdate/iot-device-update/README.md
|
||||
|
|
|
|||
|
|
@ -68,9 +68,9 @@ npx cross-env ACCOUNT_ENDPOINT="<account endpoint>" INSTANCE_ID="<instance id>"
|
|||
|
||||
Take a look at our [API Documentation][apiref] for more information about the APIs that are available in the clients.
|
||||
|
||||
[updates]: https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/deviceupdate/iot-device-update/samples/v1/typescript/src/updates.ts
|
||||
[updates]: https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/deviceupdate/iot-device-update/samples/v1/typescript/src/updates.ts
|
||||
[apiref]: https://docs.microsoft.com/javascript/api/@azure/iot-device-update
|
||||
[freesub]: https://azure.microsoft.com/free/
|
||||
[createinstance_azuredeviceupdateforiothubinstance]: https://docs.microsoft.com/azure/iot-hub-device-update/understand-device-update
|
||||
[package]: https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/deviceupdate/iot-device-update/README.md
|
||||
[package]: https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/deviceupdate/iot-device-update/README.md
|
||||
[typescript]: https://www.typescriptlang.org/docs/home.html
|
||||
|
|
|
|||
|
|
@ -3,7 +3,6 @@
|
|||
trigger:
|
||||
branches:
|
||||
include:
|
||||
- master
|
||||
- main
|
||||
- release/*
|
||||
- hotfix/*
|
||||
|
|
@ -14,7 +13,6 @@ trigger:
|
|||
pr:
|
||||
branches:
|
||||
include:
|
||||
- master
|
||||
- main
|
||||
- feature/*
|
||||
- release/*
|
||||
|
|
|
|||
|
|
@ -32,7 +32,7 @@ To use this client library in the browser, first you need to use a bundler. For
|
|||
|
||||
Azure Digital Twins doesn't currently support Cross-Origin Resource Sharing (CORS).
|
||||
As a result, this library cannot be used to make direct calls to the template service from a browser.
|
||||
Please refer to [this document](https://github.com/Azure/azure-sdk-for-js/blob/master/samples/cors/ts/README.md) for guidance.
|
||||
Please refer to [this document](https://github.com/Azure/azure-sdk-for-js/blob/main/samples/cors/ts/README.md) for guidance.
|
||||
|
||||
## Key concepts
|
||||
|
||||
|
|
@ -321,7 +321,7 @@ const response = await serviceClient.publishComponentTelemetry(
|
|||
### Additional Examples
|
||||
|
||||
Additional examples can be found in the
|
||||
[samples directory](https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/digitaltwins/digital-twins-core/samples).
|
||||
[samples directory](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/digitaltwins/digital-twins-core/samples).
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
|
|
@ -335,16 +335,16 @@ import { setLogLevel } from "@azure/logger";
|
|||
setLogLevel("info");
|
||||
```
|
||||
|
||||
For more detailed instructions on how to enable logs, you can look at the [@azure/logger package docs](https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/core/logger).
|
||||
For more detailed instructions on how to enable logs, you can look at the [@azure/logger package docs](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/core/logger).
|
||||
|
||||
## Next steps
|
||||
|
||||
- Take a look at the [samples](https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/digitaltwins/digital-twins-core/samples) directory for detailed examples that demonstrate how to use the client libraries.
|
||||
- Take a look at the [samples](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/digitaltwins/digital-twins-core/samples) directory for detailed examples that demonstrate how to use the client libraries.
|
||||
- Explore the Azure Digital Twins [documentation](https://docs.microsoft.com/azure/digital-twins/)
|
||||
|
||||
## Contributing
|
||||
|
||||
If you'd like to contribute to this library, please read the [contributing guide](https://github.com/Azure/azure-sdk-for-js/blob/master/CONTRIBUTING.md) to learn more about how to build and test the code.
|
||||
If you'd like to contribute to this library, please read the [contributing guide](https://github.com/Azure/azure-sdk-for-js/blob/main/CONTRIBUTING.md) to learn more about how to build and test the code.
|
||||
|
||||
## Related projects
|
||||
|
||||
|
|
|
|||
|
|
@ -73,25 +73,25 @@ npx cross-env AZURE_DIGITALTWINS_URL="<azure digitaltwins url>" node dt_componen
|
|||
|
||||
Take a look at our [API Documentation][apiref] for more information about the APIs that are available in the clients.
|
||||
|
||||
[dt_component_lifecycle]: https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/digitaltwins/digital-twins-core/samples/v1/javascript/dt_component_lifecycle.js
|
||||
[dt_create_digitaltwins_service_client]: https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/digitaltwins/digital-twins-core/samples/v1/javascript/dt_create_digitaltwins_service_client.js
|
||||
[dt_digitaltwins_delete]: https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/digitaltwins/digital-twins-core/samples/v1/javascript/dt_digitaltwins_delete.js
|
||||
[dt_digitaltwins_get]: https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/digitaltwins/digital-twins-core/samples/v1/javascript/dt_digitaltwins_get.js
|
||||
[dt_digitaltwins_lifecycle]: https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/digitaltwins/digital-twins-core/samples/v1/javascript/dt_digitaltwins_lifecycle.js
|
||||
[dt_digitaltwins_query]: https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/digitaltwins/digital-twins-core/samples/v1/javascript/dt_digitaltwins_query.js
|
||||
[dt_event_routes_get]: https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/digitaltwins/digital-twins-core/samples/v1/javascript/dt_event_routes_get.js
|
||||
[dt_event_routes_list]: https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/digitaltwins/digital-twins-core/samples/v1/javascript/dt_event_routes_list.js
|
||||
[dt_incoming_relationships_list]: https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/digitaltwins/digital-twins-core/samples/v1/javascript/dt_incoming_relationships_list.js
|
||||
[dt_models_delete]: https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/digitaltwins/digital-twins-core/samples/v1/javascript/dt_models_delete.js
|
||||
[dt_models_get]: https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/digitaltwins/digital-twins-core/samples/v1/javascript/dt_models_get.js
|
||||
[dt_models_lifecycle]: https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/digitaltwins/digital-twins-core/samples/v1/javascript/dt_models_lifecycle.js
|
||||
[dt_models_list]: https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/digitaltwins/digital-twins-core/samples/v1/javascript/dt_models_list.js
|
||||
[dt_publish_component_telemetry]: https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/digitaltwins/digital-twins-core/samples/v1/javascript/dt_publish_component_telemetry.js
|
||||
[dt_publish_telemetry]: https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/digitaltwins/digital-twins-core/samples/v1/javascript/dt_publish_telemetry.js
|
||||
[dt_relationships_get]: https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/digitaltwins/digital-twins-core/samples/v1/javascript/dt_relationships_get.js
|
||||
[dt_relationships_list]: https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/digitaltwins/digital-twins-core/samples/v1/javascript/dt_relationships_list.js
|
||||
[dt_scenario]: https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/digitaltwins/digital-twins-core/samples/v1/javascript/dt_scenario.js
|
||||
[dt_component_lifecycle]: https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/digitaltwins/digital-twins-core/samples/v1/javascript/dt_component_lifecycle.js
|
||||
[dt_create_digitaltwins_service_client]: https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/digitaltwins/digital-twins-core/samples/v1/javascript/dt_create_digitaltwins_service_client.js
|
||||
[dt_digitaltwins_delete]: https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/digitaltwins/digital-twins-core/samples/v1/javascript/dt_digitaltwins_delete.js
|
||||
[dt_digitaltwins_get]: https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/digitaltwins/digital-twins-core/samples/v1/javascript/dt_digitaltwins_get.js
|
||||
[dt_digitaltwins_lifecycle]: https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/digitaltwins/digital-twins-core/samples/v1/javascript/dt_digitaltwins_lifecycle.js
|
||||
[dt_digitaltwins_query]: https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/digitaltwins/digital-twins-core/samples/v1/javascript/dt_digitaltwins_query.js
|
||||
[dt_event_routes_get]: https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/digitaltwins/digital-twins-core/samples/v1/javascript/dt_event_routes_get.js
|
||||
[dt_event_routes_list]: https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/digitaltwins/digital-twins-core/samples/v1/javascript/dt_event_routes_list.js
|
||||
[dt_incoming_relationships_list]: https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/digitaltwins/digital-twins-core/samples/v1/javascript/dt_incoming_relationships_list.js
|
||||
[dt_models_delete]: https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/digitaltwins/digital-twins-core/samples/v1/javascript/dt_models_delete.js
|
||||
[dt_models_get]: https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/digitaltwins/digital-twins-core/samples/v1/javascript/dt_models_get.js
|
||||
[dt_models_lifecycle]: https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/digitaltwins/digital-twins-core/samples/v1/javascript/dt_models_lifecycle.js
|
||||
[dt_models_list]: https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/digitaltwins/digital-twins-core/samples/v1/javascript/dt_models_list.js
|
||||
[dt_publish_component_telemetry]: https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/digitaltwins/digital-twins-core/samples/v1/javascript/dt_publish_component_telemetry.js
|
||||
[dt_publish_telemetry]: https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/digitaltwins/digital-twins-core/samples/v1/javascript/dt_publish_telemetry.js
|
||||
[dt_relationships_get]: https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/digitaltwins/digital-twins-core/samples/v1/javascript/dt_relationships_get.js
|
||||
[dt_relationships_list]: https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/digitaltwins/digital-twins-core/samples/v1/javascript/dt_relationships_list.js
|
||||
[dt_scenario]: https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/digitaltwins/digital-twins-core/samples/v1/javascript/dt_scenario.js
|
||||
[apiref]: https://docs.microsoft.com/javascript/api/@azure/digital-twins-core
|
||||
[freesub]: https://azure.microsoft.com/free/
|
||||
[createinstance_azuredigitaltwinsinstance]: https://docs.microsoft.com/azure/digital-twins/how-to-set-up-instance-portal
|
||||
[package]: https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/digitaltwins/digital-twins-core/README.md
|
||||
[package]: https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/digitaltwins/digital-twins-core/README.md
|
||||
|
|
|
|||
|
|
@ -85,26 +85,26 @@ npx cross-env AZURE_DIGITALTWINS_URL="<azure digitaltwins url>" node dist/dt_com
|
|||
|
||||
Take a look at our [API Documentation][apiref] for more information about the APIs that are available in the clients.
|
||||
|
||||
[dt_component_lifecycle]: https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/digitaltwins/digital-twins-core/samples/v1/typescript/src/dt_component_lifecycle.ts
|
||||
[dt_create_digitaltwins_service_client]: https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/digitaltwins/digital-twins-core/samples/v1/typescript/src/dt_create_digitaltwins_service_client.ts
|
||||
[dt_digitaltwins_delete]: https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/digitaltwins/digital-twins-core/samples/v1/typescript/src/dt_digitaltwins_delete.ts
|
||||
[dt_digitaltwins_get]: https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/digitaltwins/digital-twins-core/samples/v1/typescript/src/dt_digitaltwins_get.ts
|
||||
[dt_digitaltwins_lifecycle]: https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/digitaltwins/digital-twins-core/samples/v1/typescript/src/dt_digitaltwins_lifecycle.ts
|
||||
[dt_digitaltwins_query]: https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/digitaltwins/digital-twins-core/samples/v1/typescript/src/dt_digitaltwins_query.ts
|
||||
[dt_event_routes_get]: https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/digitaltwins/digital-twins-core/samples/v1/typescript/src/dt_event_routes_get.ts
|
||||
[dt_event_routes_list]: https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/digitaltwins/digital-twins-core/samples/v1/typescript/src/dt_event_routes_list.ts
|
||||
[dt_incoming_relationships_list]: https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/digitaltwins/digital-twins-core/samples/v1/typescript/src/dt_incoming_relationships_list.ts
|
||||
[dt_models_delete]: https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/digitaltwins/digital-twins-core/samples/v1/typescript/src/dt_models_delete.ts
|
||||
[dt_models_get]: https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/digitaltwins/digital-twins-core/samples/v1/typescript/src/dt_models_get.ts
|
||||
[dt_models_lifecycle]: https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/digitaltwins/digital-twins-core/samples/v1/typescript/src/dt_models_lifecycle.ts
|
||||
[dt_models_list]: https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/digitaltwins/digital-twins-core/samples/v1/typescript/src/dt_models_list.ts
|
||||
[dt_publish_component_telemetry]: https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/digitaltwins/digital-twins-core/samples/v1/typescript/src/dt_publish_component_telemetry.ts
|
||||
[dt_publish_telemetry]: https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/digitaltwins/digital-twins-core/samples/v1/typescript/src/dt_publish_telemetry.ts
|
||||
[dt_relationships_get]: https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/digitaltwins/digital-twins-core/samples/v1/typescript/src/dt_relationships_get.ts
|
||||
[dt_relationships_list]: https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/digitaltwins/digital-twins-core/samples/v1/typescript/src/dt_relationships_list.ts
|
||||
[dt_scenario]: https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/digitaltwins/digital-twins-core/samples/v1/typescript/src/dt_scenario.ts
|
||||
[dt_component_lifecycle]: https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/digitaltwins/digital-twins-core/samples/v1/typescript/src/dt_component_lifecycle.ts
|
||||
[dt_create_digitaltwins_service_client]: https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/digitaltwins/digital-twins-core/samples/v1/typescript/src/dt_create_digitaltwins_service_client.ts
|
||||
[dt_digitaltwins_delete]: https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/digitaltwins/digital-twins-core/samples/v1/typescript/src/dt_digitaltwins_delete.ts
|
||||
[dt_digitaltwins_get]: https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/digitaltwins/digital-twins-core/samples/v1/typescript/src/dt_digitaltwins_get.ts
|
||||
[dt_digitaltwins_lifecycle]: https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/digitaltwins/digital-twins-core/samples/v1/typescript/src/dt_digitaltwins_lifecycle.ts
|
||||
[dt_digitaltwins_query]: https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/digitaltwins/digital-twins-core/samples/v1/typescript/src/dt_digitaltwins_query.ts
|
||||
[dt_event_routes_get]: https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/digitaltwins/digital-twins-core/samples/v1/typescript/src/dt_event_routes_get.ts
|
||||
[dt_event_routes_list]: https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/digitaltwins/digital-twins-core/samples/v1/typescript/src/dt_event_routes_list.ts
|
||||
[dt_incoming_relationships_list]: https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/digitaltwins/digital-twins-core/samples/v1/typescript/src/dt_incoming_relationships_list.ts
|
||||
[dt_models_delete]: https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/digitaltwins/digital-twins-core/samples/v1/typescript/src/dt_models_delete.ts
|
||||
[dt_models_get]: https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/digitaltwins/digital-twins-core/samples/v1/typescript/src/dt_models_get.ts
|
||||
[dt_models_lifecycle]: https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/digitaltwins/digital-twins-core/samples/v1/typescript/src/dt_models_lifecycle.ts
|
||||
[dt_models_list]: https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/digitaltwins/digital-twins-core/samples/v1/typescript/src/dt_models_list.ts
|
||||
[dt_publish_component_telemetry]: https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/digitaltwins/digital-twins-core/samples/v1/typescript/src/dt_publish_component_telemetry.ts
|
||||
[dt_publish_telemetry]: https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/digitaltwins/digital-twins-core/samples/v1/typescript/src/dt_publish_telemetry.ts
|
||||
[dt_relationships_get]: https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/digitaltwins/digital-twins-core/samples/v1/typescript/src/dt_relationships_get.ts
|
||||
[dt_relationships_list]: https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/digitaltwins/digital-twins-core/samples/v1/typescript/src/dt_relationships_list.ts
|
||||
[dt_scenario]: https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/digitaltwins/digital-twins-core/samples/v1/typescript/src/dt_scenario.ts
|
||||
[apiref]: https://docs.microsoft.com/javascript/api/@azure/digital-twins-core
|
||||
[freesub]: https://azure.microsoft.com/free/
|
||||
[createinstance_azuredigitaltwinsinstance]: https://docs.microsoft.com/azure/digital-twins/how-to-set-up-instance-portal
|
||||
[package]: https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/digitaltwins/digital-twins-core/README.md
|
||||
[package]: https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/digitaltwins/digital-twins-core/README.md
|
||||
[typescript]: https://www.typescriptlang.org/docs/home.html
|
||||
|
|
|
|||
|
|
@ -14,11 +14,11 @@ Use the client library to:
|
|||
| Apply custom translation | Translate documents using general and [custom translation](https://docs.microsoft.com/azure/cognitive-services/translator/customization#custom-translator) models. |
|
||||
| Apply custom glossaries | Translate documents using custom glossaries. |
|
||||
|
||||
[Source code](https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/documenttranslator/ai-document-translator-rest/) |
|
||||
[Source code](https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/documenttranslator/ai-document-translator-rest/) |
|
||||
[Package (NPM)](https://www.npmjs.com/package/@azure-rest/ai-document-translator) |
|
||||
[API reference documentation](https://docs.microsoft.com/azure/cognitive-services/translator/document-translation/overview) |
|
||||
[Product documentation](https://docs.microsoft.com/azure/cognitive-services/translator/document-translation/overview) |
|
||||
[Samples](https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/documenttranslator/ai-document-translator-rest/samples)
|
||||
[Samples](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/documenttranslator/ai-document-translator-rest/samples)
|
||||
|
||||
## Getting started
|
||||
|
||||
|
|
@ -188,8 +188,8 @@ See the service documentation for all [supported languages][supported_languages]
|
|||
|
||||
Please refer to the samples folder to see code samples, including:
|
||||
|
||||
- [List Supported Formats](https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/documenttranslator/ai-document-translator-rest/samples/v1/typescript/src/listFormats.ts)
|
||||
- [Translate documents](https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/documenttranslator/ai-document-translator-rest/samples/v1/typescript/src/translateFromBlob.ts)
|
||||
- [List Supported Formats](https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/documenttranslator/ai-document-translator-rest/samples/v1/typescript/src/listFormats.ts)
|
||||
- [Translate documents](https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/documenttranslator/ai-document-translator-rest/samples/v1/typescript/src/translateFromBlob.ts)
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
|
|
@ -203,15 +203,15 @@ import { setLogLevel } from "@azure/logger";
|
|||
setLogLevel("info");
|
||||
```
|
||||
|
||||
For more detailed instructions on how to enable logs, you can look at the [@azure/logger package docs](https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/core/logger).
|
||||
For more detailed instructions on how to enable logs, you can look at the [@azure/logger package docs](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/core/logger).
|
||||
|
||||
## Next steps
|
||||
|
||||
Please take a look at the [samples](https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/documenttranslator/ai-document-translator-rest/samples) directory for detailed examples on how to use this library.
|
||||
Please take a look at the [samples](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/documenttranslator/ai-document-translator-rest/samples) directory for detailed examples on how to use this library.
|
||||
|
||||
## Contributing
|
||||
|
||||
If you'd like to contribute to this library, please read the [contributing guide](https://github.com/Azure/azure-sdk-for-js/blob/master/CONTRIBUTING.md) to learn more about how to build and test the code.
|
||||
If you'd like to contribute to this library, please read the [contributing guide](https://github.com/Azure/azure-sdk-for-js/blob/main/CONTRIBUTING.md) to learn more about how to build and test the code.
|
||||
|
||||
## Related projects
|
||||
|
||||
|
|
@ -223,10 +223,10 @@ If you'd like to contribute to this library, please read the [contributing guide
|
|||
[azure_sub]: https://azure.microsoft.com/free/
|
||||
[translator_resource]: https://ms.portal.azure.com/#create/Microsoft.CognitiveServicesTextTranslation
|
||||
[azure_portal]: https://portal.azure.com
|
||||
[azure_identity]: https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/identity/identity
|
||||
[azure_identity]: https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/identity/identity
|
||||
[cognitive_auth]: https://docs.microsoft.com/azure/cognitive-services/authentication
|
||||
[register_aad_app]: https://docs.microsoft.com/azure/cognitive-services/authentication#assign-a-role-to-a-service-principal
|
||||
[defaultazurecredential]: https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/identity/identity#defaultazurecredential
|
||||
[defaultazurecredential]: https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/identity/identity#defaultazurecredential
|
||||
[azure_cli_create_dt_resource]: https://docs.microsoft.com/azure/cognitive-services/cognitive-services-apis-create-account-cli?tabs=windows
|
||||
[azure_portal_get_endpoint]: https://docs.microsoft.com/azure/cognitive-services/translator/document-translation/get-started-with-document-translation?tabs=csharp#get-your-custom-domain-name-and-subscription-key
|
||||
[source_containers]: https://docs.microsoft.com/azure/cognitive-services/translator/document-translation/get-started-with-document-translation?tabs=csharp#create-your-azure-blob-storage-containers
|
||||
|
|
|
|||
|
|
@ -59,9 +59,9 @@ npx cross-env ENDPOINT="<endpoint>" DOCUMENT_TRANSLATOR_API_KEY="<document trans
|
|||
|
||||
Take a look at our [API Documentation][apiref] for more information about the APIs that are available in the clients.
|
||||
|
||||
[listformats]: https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/documenttranslator/ai-document-translator-rest/samples/v1/javascript/listFormats.js
|
||||
[translatefromblob]: https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/documenttranslator/ai-document-translator-rest/samples/v1/javascript/translateFromBlob.js
|
||||
[listformats]: https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/documenttranslator/ai-document-translator-rest/samples/v1/javascript/listFormats.js
|
||||
[translatefromblob]: https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/documenttranslator/ai-document-translator-rest/samples/v1/javascript/translateFromBlob.js
|
||||
[apiref]: https://docs.microsoft.com/azure/cognitive-services/translator/document-translation/overview
|
||||
[freesub]: https://azure.microsoft.com/free/
|
||||
[createinstance_azurecognitiveservicesinstance]: https://docs.microsoft.com/azure/cognitive-services/cognitive-services-apis-create-account
|
||||
[package]: https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/documenttranslator/ai-document-translator-rest/README.md
|
||||
[package]: https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/documenttranslator/ai-document-translator-rest/README.md
|
||||
|
|
|
|||
Некоторые файлы не были показаны из-за слишком большого количества измененных файлов Показать больше
Загрузка…
Ссылка в новой задаче