Skip to content
New issue

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

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

Already on GitHub? Sign in to your account

[AutoPR @azure/arm-cdn] Add new Cdn Preview API version: 2025-01-01-preview #13853

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
20 changes: 10 additions & 10 deletions common/config/rush/pnpm-lock.yaml

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

68 changes: 61 additions & 7 deletions sdk/cdn/arm-cdn/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,69 @@
# Release History

## 9.1.1 (Unreleased)

## 10.0.0 (2025-02-27)
### Features Added

### Breaking Changes
- Added operation Profiles.beginCdnCanMigrateToAfd
- Added operation Profiles.beginCdnCanMigrateToAfdAndWait
- Added operation Profiles.beginCdnMigrateToAfd
- Added operation Profiles.beginCdnMigrateToAfdAndWait
- Added operation Profiles.beginMigrationAbort
- Added operation Profiles.beginMigrationAbortAndWait
- Added Interface CdnMigrationToAfdParameters
- Added Interface CertificateSourceParameters
- Added Interface DeliveryRuleAction
- Added Interface DeliveryRuleActionParameters
- Added Interface DeliveryRuleConditionParameters
- Added Interface ErrorResponseAutoGenerated
- Added Interface MigrationEndpointMapping
- Added Interface ProfilesCdnCanMigrateToAfdHeaders
- Added Interface ProfilesCdnCanMigrateToAfdOptionalParams
- Added Interface ProfilesCdnMigrateToAfdHeaders
- Added Interface ProfilesCdnMigrateToAfdOptionalParams
- Added Interface ProfilesMigrationAbortHeaders
- Added Interface ProfilesMigrationAbortOptionalParams
- Added Type Alias CertificateSourceParametersType
- Added Type Alias CertificateSourceParametersUnion
- Added Type Alias DeliveryRuleActionName
- Added Type Alias DeliveryRuleActionParametersType
- Added Type Alias DeliveryRuleActionParametersUnion
- Added Type Alias DeliveryRuleActionUnion
- Added Type Alias DeliveryRuleConditionParametersType
- Added Type Alias DeliveryRuleConditionParametersUnion
- Added Type Alias IsDeviceMatchValue
- Added Type Alias KeyVaultSigningKeyParametersType
- Added Type Alias ProfilesCdnCanMigrateToAfdResponse
- Added Type Alias ProfilesCdnMigrateToAfdResponse
- Added Type Alias ProfilesMigrationAbortResponse
- Added Type Alias RequestMethodMatchValue
- Added Type Alias RequestSchemeMatchValue
- Added Enum KnownCertificateSourceParametersType
- Added Enum KnownDeliveryRuleActionName
- Added Enum KnownDeliveryRuleActionParametersType
- Added Enum KnownDeliveryRuleConditionParametersType
- Added Enum KnownIsDeviceMatchValue
- Added Enum KnownKeyVaultSigningKeyParametersType
- Added Enum KnownRequestMethodMatchValue
- Added Enum KnownRequestSchemeMatchValue

### Bugs Fixed

### Other Changes
### Breaking Changes

- Parameter secretVersion of interface UrlSigningKeyParameters is now required
- Type of parameter actions of interface DeliveryRule is changed from DeliveryRuleActionAutoGeneratedUnion[] to DeliveryRuleActionUnion[]
- Type of parameter matchValues of interface IsDeviceMatchConditionParameters is changed from IsDeviceMatchConditionParametersMatchValuesItem[] to IsDeviceMatchValue[]
- Type of parameter typeName of interface KeyVaultSigningKeyParameters is changed from "KeyVaultSigningKeyParameters" to KeyVaultSigningKeyParametersType
- Type of parameter matchValues of interface RequestMethodMatchConditionParameters is changed from RequestMethodMatchConditionParametersMatchValuesItem[] to RequestMethodMatchValue[]
- Type of parameter matchValues of interface RequestSchemeMatchConditionParameters is changed from RequestSchemeMatchConditionParametersMatchValuesItem[] to RequestSchemeMatchValue[]
- Type of parameter actions of interface Rule is changed from DeliveryRuleActionAutoGeneratedUnion[] to DeliveryRuleActionUnion[]
- Type of parameter actions of interface RuleUpdateParameters is changed from DeliveryRuleActionAutoGeneratedUnion[] to DeliveryRuleActionUnion[]
- Type of parameter actions of interface RuleUpdatePropertiesParameters is changed from DeliveryRuleActionAutoGeneratedUnion[] to DeliveryRuleActionUnion[]
- Removed Enum KnownDeliveryRuleAction
- Removed Enum KnownIsDeviceMatchConditionParametersMatchValuesItem
- Removed Enum KnownRequestMethodMatchConditionParametersMatchValuesItem
- Removed Enum KnownRequestSchemeMatchConditionParametersMatchValuesItem


## 9.1.0 (2024-04-08)

### Features Added
Expand Down
8 changes: 4 additions & 4 deletions sdk/cdn/arm-cdn/LICENSE
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
Copyright (c) Microsoft Corporation.
The MIT License (MIT)

MIT License
Copyright (c) 2025 Microsoft

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand All @@ -12,10 +12,10 @@ furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED *AS IS*, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
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.
38 changes: 14 additions & 24 deletions sdk/cdn/arm-cdn/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,36 +44,27 @@ npm install @azure/identity
```

You will also need to **register a new AAD application and grant access to Azure CdnManagement** 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).

Using Node.js and Node-like environments, you can use the `DefaultAzureCredential` class to authenticate the client.

```ts snippet:ReadmeSampleCreateClient_Node
import { CdnManagementClient } from "@azure/arm-cdn";
import { DefaultAzureCredential } from "@azure/identity";
```javascript
const { CdnManagementClient } = require("@azure/arm-cdn");
const { DefaultAzureCredential } = require("@azure/identity");
// For client-side applications running in the browser, use InteractiveBrowserCredential instead of DefaultAzureCredential. See https://aka.ms/azsdk/js/identity/examples for more details.

const subscriptionId = "00000000-0000-0000-0000-000000000000";
const client = new CdnManagementClient(new DefaultAzureCredential(), subscriptionId);
```

For browser environments, use the `InteractiveBrowserCredential` from the `@azure/identity` package to authenticate.

```ts snippet:ReadmeSampleCreateClient_Browser
import { InteractiveBrowserCredential } from "@azure/identity";
import { CdnManagementClient } from "@azure/arm-cdn";

const subscriptionId = "00000000-0000-0000-0000-000000000000";
const credential = new InteractiveBrowserCredential({
tenantId: "<YOUR_TENANT_ID>",
clientId: "<YOUR_CLIENT_ID>",
});
const client = new CdnManagementClient(credential, subscriptionId);
// For client-side applications running in the browser, use this code instead:
// const credential = new InteractiveBrowserCredential({
// tenantId: "<YOUR_TENANT_ID>",
// clientId: "<YOUR_CLIENT_ID>"
// });
// const client = new CdnManagementClient(credential, subscriptionId);
```

### JavaScript Bundle

### 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 All @@ -88,9 +79,8 @@ To use this client library in the browser, first you need to use a bundler. For

Enabling logging may help uncover useful information about failures. In order to see a log of HTTP requests and responses, set the `AZURE_LOG_LEVEL` environment variable to `info`. Alternatively, logging can be enabled at runtime by calling `setLogLevel` in the `@azure/logger`:

```ts snippet:SetLogLevel
import { setLogLevel } from "@azure/logger";

```javascript
const { setLogLevel } = require("@azure/logger");
setLogLevel("info");
```

Expand All @@ -108,7 +98,7 @@ 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)


![Impressions](https://azure-sdk-impressions.azurewebsites.net/api/impressions/azure-sdk-for-js%2Fsdk%2Fcdn%2Farm-cdn%2FREADME.png)

[azure_cli]: https://learn.microsoft.com/cli/azure
[azure_sub]: https://azure.microsoft.com/free/
Expand Down
8 changes: 4 additions & 4 deletions sdk/cdn/arm-cdn/_meta.json
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
{
"commit": "835b124ff8160d23823c0e770b4989ca79e7418c",
"commit": "ba3633d80c40c8b0ace4f6e3207d337b99cdde9e",
"readme": "specification/cdn/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\\cdn\\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/cdn/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].4",
"use": "@autorest/[email protected].20"
"release_tool": "@azure-tools/[email protected].21",
"use": "@autorest/typescript@^6.0.12"
}
6 changes: 3 additions & 3 deletions sdk/cdn/arm-cdn/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-cdn.d.ts"
"publicTrimmedFilePath": "./types/arm-cdn.d.ts"
},
"messages": {
"tsdocMessageReporting": {
Expand All @@ -28,4 +28,4 @@
}
}
}
}
}
41 changes: 17 additions & 24 deletions sdk/cdn/arm-cdn/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,47 +3,48 @@
"sdk-type": "mgmt",
"author": "Microsoft Corporation",
"description": "A generated SDK for CdnManagementClient.",
"version": "9.1.1",
"version": "10.0.0",
"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-lro": "^2.7.2",
"@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.0",
"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.5.0",
"@azure/logger": "^1.1.4",
"@azure/identity": "^4.7.0",
"@types/node": "^18.0.0",
"@vitest/browser": "^3.0.3",
"@vitest/coverage-istanbul": "^3.0.3",
"@vitest/browser": "^3.0.6",
"@vitest/coverage-istanbul": "^3.0.6",
"dotenv": "^16.0.0",
"playwright": "^1.49.1",
"typescript": "~5.7.2",
"vitest": "^3.0.3"
"playwright": "^1.50.1",
"typescript": "~5.6.2",
"vitest": "^3.0.6"
},
"repository": {
"type": "git",
"url": "https://github.com/Azure/azure-sdk-for-js.git"
},
"repository": "github:Azure/azure-sdk-for-js",
"bugs": {
"url": "https://github.com/Azure/azure-sdk-for-js/issues"
},
Expand Down Expand Up @@ -78,7 +79,7 @@
"unit-test": "npm run unit-test:node && npm run unit-test:browser",
"unit-test:browser": "echo skipped",
"unit-test:node": "dev-tool run test:vitest",
"update-snippets": "dev-tool run update-snippets"
"update-snippets": "echo skipped"
},
"sideEffects": false,
"//metadata": {
Expand All @@ -91,14 +92,6 @@
},
"autoPublish": true,
"homepage": "https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/cdn/arm-cdn",
"//sampleConfiguration": {
"productName": "",
"productSlugs": [
"azure"
],
"disableDocsMs": true,
"apiRefLink": "https://learn.microsoft.com/javascript/api/@azure/arm-cdn?view=azure-node-preview"
},
"type": "module",
"tshy": {
"project": "./tsconfig.src.json",
Expand Down Expand Up @@ -139,4 +132,4 @@
}
}
}
}
}
Loading