Skip to content

[AutoPR @azure/arm-frontdoor] AFD Waf Captcha Feature Preview 2025-01-01-preview #14243

New issue

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

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

Already on GitHub? Sign in to your account

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 4 additions & 5 deletions common/config/rush/pnpm-lock.yaml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion sdk/frontdoor/arm-frontdoor/LICENSE
Original file line number Diff line number Diff line change
Expand Up @@ -18,4 +18,4 @@ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
SOFTWARE.
10 changes: 3 additions & 7 deletions sdk/frontdoor/arm-frontdoor/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ FrontDoor Client

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

## Getting started
Expand Down Expand Up @@ -44,7 +44,6 @@ npm install @azure/identity
```

You will also need to **register a new AAD application and grant access to Azure FrontDoorManagement** by assigning the suitable role to your service principal (note: roles such as `"Owner"` will not grant the necessary permissions).
Set the values of the client ID, tenant ID, and client secret of the AAD application as environment variables: `AZURE_CLIENT_ID`, `AZURE_TENANT_ID`, `AZURE_CLIENT_SECRET`.

For more information about how to create an Azure AD Application check out [this guide](https://learn.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal).

Expand All @@ -64,16 +63,14 @@ For browser environments, use the `InteractiveBrowserCredential` from the `@azur
import { InteractiveBrowserCredential } from "@azure/identity";
import { FrontDoorManagementClient } from "@azure/arm-frontdoor";

const subscriptionId = "00000000-0000-0000-0000-000000000000";
const credential = new InteractiveBrowserCredential({
tenantId: "<YOUR_TENANT_ID>",
clientId: "<YOUR_CLIENT_ID>",
});
clientId: "<YOUR_CLIENT_ID>"
});
const client = new FrontDoorManagementClient(credential, subscriptionId);
```

### JavaScript Bundle

To use this client library in the browser, first you need to use a bundler. For details on how to do this, please refer to our [bundling documentation](https://aka.ms/AzureSDKBundling).

## Key concepts
Expand Down Expand Up @@ -109,7 +106,6 @@ If you'd like to contribute to this library, please read the [contributing guide
- [Microsoft Azure SDK for JavaScript](https://github.com/Azure/azure-sdk-for-js)



[azure_cli]: https://learn.microsoft.com/cli/azure
[azure_sub]: https://azure.microsoft.com/free/
[azure_sub]: https://azure.microsoft.com/free/
Expand Down
10 changes: 5 additions & 5 deletions sdk/frontdoor/arm-frontdoor/_meta.json
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
{
"commit": "b54ffc9278eff071455b1dbb4ad2e772afce885d",
"commit": "369da94c16ca6dc28552cab3f06b8fc23cde1d34",
"readme": "specification/frontdoor/resource-manager/readme.md",
"autorest_command": "autorest --version=3.9.7 --typescript --modelerfour.lenient-model-deduplication --azure-arm --head-as-boolean=true --license-header=MICROSOFT_MIT_NO_VERSION --generate-test --typescript-sdks-folder=D:\\Git\\azure-sdk-for-js ..\\azure-rest-api-specs\\specification\\frontdoor\\resource-manager\\readme.md --use=@autorest/[email protected].20 --generate-sample=true",
"autorest_command": "autorest --version=3.9.7 --typescript --modelerfour.lenient-model-deduplication --azure-arm --head-as-boolean=true --license-header=MICROSOFT_MIT_NO_VERSION --generate-test --typescript-sdks-folder=/mnt/vss/_work/1/s/azure-sdk-for-js ../azure-rest-api-specs/specification/frontdoor/resource-manager/readme.md --use=@autorest/typescript@^6.0.12",
"repository_url": "https://github.com/Azure/azure-rest-api-specs.git",
"release_tool": "@azure-tools/[email protected].5",
"use": "@autorest/[email protected].20"
}
"release_tool": "@azure-tools/[email protected].26",
"use": "@autorest/typescript@^6.0.12"
}
6 changes: 3 additions & 3 deletions sdk/frontdoor/arm-frontdoor/api-extractor.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
"mainEntryPointFilePath": "dist/esm/index.d.ts",
"mainEntryPointFilePath": "./dist-esm/src/index.d.ts",
"docModel": {
"enabled": true
},
Expand All @@ -11,7 +11,7 @@
"dtsRollup": {
"enabled": true,
"untrimmedFilePath": "",
"publicTrimmedFilePath": "dist/arm-frontdoor.d.ts"
"publicTrimmedFilePath": "./types/arm-frontdoor.d.ts"
},
"messages": {
"tsdocMessageReporting": {
Expand All @@ -28,4 +28,4 @@
}
}
}
}
}
32 changes: 13 additions & 19 deletions sdk/frontdoor/arm-frontdoor/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,47 +3,49 @@
"sdk-type": "mgmt",
"author": "Microsoft Corporation",
"description": "A generated SDK for FrontDoorManagementClient.",
"version": "5.3.1",
"version": "1.0.0-beta.1",
"engines": {
"node": ">=18.0.0"
},
"dependencies": {
"@azure/abort-controller": "^2.1.2",
"@azure/core-auth": "^1.9.0",
"@azure/core-client": "^1.9.2",
"@azure/core-client": "^1.9.3",
"@azure/core-lro": "^2.5.4",
"@azure/core-paging": "^1.6.2",
"@azure/core-rest-pipeline": "^1.18.2",
"@azure/core-rest-pipeline": "^1.19.1",
"tslib": "^2.8.1"
},
"keywords": [
"node",
"azure",
"typescript",
"browser",
"isomorphic",
"cloud"
"isomorphic"
],
"license": "MIT",
"main": "./dist/commonjs/index.js",
"module": "./dist/esm/index.js",
"module": "./dist-esm/src/index.js",
"types": "./dist/commonjs/index.d.ts",
"devDependencies": {
"@azure-tools/test-credential": "^2.0.0",
"@azure-tools/test-recorder": "^4.1.0",
"@azure-tools/test-utils-vitest": "^1.0.0",
"@azure/dev-tool": "^1.0.0",
"@azure/identity": "^4.6.0",
"@azure/identity": "^4.9.1",
"@azure/logger": "^1.1.4",
"@types/node": "^18.0.0",
"@vitest/browser": "^3.0.9",
"@vitest/coverage-istanbul": "^3.0.9",
"dotenv": "^16.0.0",
"playwright": "^1.50.1",
"playwright": "^1.52.0",
"typescript": "~5.8.2",
"vitest": "^3.0.9"
},
"repository": "github:Azure/azure-sdk-for-js",
"repository": {
"type": "git",
"url": "https://github.com/Azure/azure-sdk-for-js.git"
},
"bugs": {
"url": "https://github.com/Azure/azure-sdk-for-js/issues"
},
Expand All @@ -69,7 +71,7 @@
"integration-test:browser": "echo skipped",
"integration-test:node": "dev-tool run test:vitest --esm",
"lint": "echo skipped",
"minify": "echo skipped",
"minify": "dev-tool run vendored uglifyjs -c -m --comments --source-map \"content='./dist/index.js.map'\" -o ./dist/index.min.js ./dist/index.js",
"pack": "npm pack 2>&1",
"prepack": "npm run build",
"test": "npm run integration-test",
Expand All @@ -91,14 +93,6 @@
},
"autoPublish": true,
"homepage": "https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/frontdoor/arm-frontdoor",
"//sampleConfiguration": {
"productName": "",
"productSlugs": [
"azure"
],
"disableDocsMs": true,
"apiRefLink": "https://learn.microsoft.com/javascript/api/@azure/arm-frontdoor?view=azure-node-preview"
},
"type": "module",
"tshy": {
"project": "./tsconfig.src.json",
Expand Down Expand Up @@ -139,4 +133,4 @@
}
}
}
}
}
5 changes: 1 addition & 4 deletions sdk/frontdoor/arm-frontdoor/sample.env
Original file line number Diff line number Diff line change
@@ -1,4 +1 @@
# App registration secret for AAD authentication
AZURE_CLIENT_SECRET=
AZURE_CLIENT_ID=
AZURE_TENANT_ID=
# Feel free to add your own environment variables.
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ export class FrontDoorManagementClient extends coreClient.ServiceClient {
credential: credentials,
};

const packageDetails = `azsdk-js-arm-frontdoor/5.3.1`;
const packageDetails = `azsdk-js-arm-frontdoor/1.0.0-beta.1`;
const userAgentPrefix =
options.userAgentOptions && options.userAgentOptions.userAgentPrefix
? `${options.userAgentOptions.userAgentPrefix} ${packageDetails}`
Expand Down
4 changes: 4 additions & 0 deletions sdk/frontdoor/arm-frontdoor/src/lroImpl.ts
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,10 @@
* Code generated by Microsoft (R) AutoRest Code Generator.
* Changes may cause incorrect behavior and will be lost if the code is regenerated.
*/

// Copyright (c) Microsoft Corporation.
// Licensed under the MIT License.

import { AbortSignalLike } from "@azure/abort-controller";
import { LongRunningOperation, LroResponse } from "@azure/core-lro";

Expand Down
40 changes: 40 additions & 0 deletions sdk/frontdoor/arm-frontdoor/test/sampleTest.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
/*
* Copyright (c) Microsoft Corporation.
* Licensed under the MIT License.
*
* Code generated by Microsoft (R) AutoRest Code Generator.
* Changes may cause incorrect behavior and will be lost if the code is regenerated.
*/

import {
Recorder,
RecorderStartOptions,
} from "@azure-tools/test-recorder";

const replaceableVariables: Record<string, string> = {
AZURE_CLIENT_ID: "azure_client_id",
AZURE_CLIENT_SECRET: "azure_client_secret",
AZURE_TENANT_ID: "88888888-8888-8888-8888-888888888888",
SUBSCRIPTION_ID: "azure_subscription_id",
};

const recorderOptions: RecorderStartOptions = {
envSetupForPlayback: replaceableVariables,
};

describe("My test", () => {
let recorder: Recorder;

beforeEach(async (ctx) => {
recorder = new Recorder(ctx);
await recorder.start(recorderOptions);
});

afterEach(async () => {
await recorder.stop();
});

it("sample test", async function () {
console.log("Hi, I'm a test!");
});
});
19 changes: 15 additions & 4 deletions sdk/frontdoor/arm-frontdoor/test/snippets.spec.ts
Original file line number Diff line number Diff line change
@@ -1,15 +1,26 @@
// Copyright (c) Microsoft Corporation.
// Licensed under the MIT License.
/*
* Copyright (c) Microsoft Corporation.
* Licensed under the MIT License.
*
* Code generated by Microsoft (R) AutoRest Code Generator.
* Changes may cause incorrect behavior and will be lost if the code is regenerated.
*/

import { FrontDoorManagementClient } from "../src/index.js";
import { DefaultAzureCredential, InteractiveBrowserCredential } from "@azure/identity";
import {
DefaultAzureCredential,
InteractiveBrowserCredential,
} from "@azure/identity";
import { setLogLevel } from "@azure/logger";
import { describe, it } from "vitest";

describe("snippets", () => {
it("ReadmeSampleCreateClient_Node", async () => {
const subscriptionId = "00000000-0000-0000-0000-000000000000";
const client = new FrontDoorManagementClient(new DefaultAzureCredential(), subscriptionId);
const client = new FrontDoorManagementClient(
new DefaultAzureCredential(),
subscriptionId,
);
});

it("ReadmeSampleCreateClient_Browser", async () => {
Expand Down
5 changes: 4 additions & 1 deletion sdk/frontdoor/arm-frontdoor/tsconfig.browser.config.json
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
{
"extends": ["./tsconfig.test.json", "../../../tsconfig.browser.base.json"]
"extends": [
"./tsconfig.test.json",
"../../../tsconfig.browser.base.json"
]
}
5 changes: 1 addition & 4 deletions sdk/frontdoor/arm-frontdoor/tsconfig.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,8 @@
{
"path": "./tsconfig.src.json"
},
{
"path": "./tsconfig.samples.json"
},
{
"path": "./tsconfig.test.json"
}
]
}
}
4 changes: 3 additions & 1 deletion sdk/frontdoor/arm-frontdoor/tsconfig.samples.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,9 @@
"extends": "../../../tsconfig.samples.base.json",
"compilerOptions": {
"paths": {
"@azure/arm-frontdoor": ["./dist/esm"]
"@azure/arm-frontdoor": [
"./dist/esm"
]
}
}
}
5 changes: 4 additions & 1 deletion sdk/frontdoor/arm-frontdoor/tsconfig.test.json
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
{
"extends": ["./tsconfig.src.json", "../../../tsconfig.test.base.json"]
"extends": [
"./tsconfig.src.json",
"../../../tsconfig.test.base.json"
]
}
3 changes: 2 additions & 1 deletion sdk/frontdoor/arm-frontdoor/vitest.browser.config.ts
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@

// Copyright (c) Microsoft Corporation.
// Licensed under the MIT License.

Expand All @@ -8,7 +9,7 @@ export default mergeConfig(
viteConfig,
defineConfig({
test: {
include: ["dist-test/browser/test/**/*.spec.js"],
include: ["dist-test/browser/test/**/*.spec.js",],
testTimeout: 1200000,
hookTimeout: 1200000,
},
Expand Down
1 change: 1 addition & 0 deletions sdk/frontdoor/arm-frontdoor/vitest.config.ts
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@

// Copyright (c) Microsoft Corporation.
// Licensed under the MIT License.

Expand Down
6 changes: 5 additions & 1 deletion sdk/frontdoor/arm-frontdoor/vitest.esm.config.ts
Original file line number Diff line number Diff line change
@@ -1,8 +1,12 @@

// Copyright (c) Microsoft Corporation.
// Licensed under the MIT License.

import { mergeConfig } from "vitest/config";
import vitestConfig from "./vitest.config.ts";
import vitestEsmConfig from "../../../vitest.esm.shared.config.ts";

export default mergeConfig(vitestConfig, vitestEsmConfig);
export default mergeConfig(
vitestConfig,
vitestEsmConfig
);