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-appconfiguration] AppConfiguration 2024-06-01-preview #13339

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
19 changes: 9 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.

42 changes: 42 additions & 0 deletions sdk/appconfiguration/arm-appconfiguration/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,47 @@
# Release History

## 4.2.0-beta.1 (2025-01-17)
Compared with version 4.1.0

### Features Added

- Added operation ConfigurationStores.generateSasToken
- Added operation ConfigurationStores.resetSasKind
- Added Interface ConfigurationStoresDeleteHeaders
- Added Interface ConfigurationStoresGenerateSasTokenOptionalParams
- Added Interface ConfigurationStoresPurgeDeletedHeaders
- Added Interface ConfigurationStoresResetSasKindOptionalParams
- Added Interface ExperimentationProperties
- Added Interface KeyValuesDeleteHeaders
- Added Interface KvSasTokenScope
- Added Interface PrivateEndpointConnectionsDeleteHeaders
- Added Interface ResetSasKindParameters
- Added Interface SasKindInfo
- Added Interface SasProperties
- Added Interface SasTokenGenerationParameters
- Added Interface SasTokenGenerationResult
- Added Interface SasTokenScope
- Added Interface SnapshotSasTokenScope
- Added Interface TelemetryProperties
- Added Type Alias ConfigurationStoresGenerateSasTokenResponse
- Added Type Alias ConfigurationStoresResetSasKindResponse
- Added Type Alias ResourceType
- Added Type Alias SasKind
- Added Type Alias SasStatus
- Added Type Alias SasTokenScopeUnion
- Interface ConfigurationStore has a new optional parameter experimentation
- Interface ConfigurationStore has a new optional parameter sas
- Interface ConfigurationStore has a new optional parameter telemetry
- Interface ConfigurationStoreUpdateParameters has a new optional parameter experimentation
- Interface ConfigurationStoreUpdateParameters has a new optional parameter sas
- Interface ConfigurationStoreUpdateParameters has a new optional parameter telemetry
- Interface ReplicasDeleteHeaders has a new optional parameter location
- Interface ReplicasDeleteHeaders has a new optional parameter retryAfter
- Added Enum KnownResourceType
- Added Enum KnownSasKind
- Added Enum KnownSasStatus


## 4.1.0 (2024-11-11)

### Features Added
Expand Down
2 changes: 1 addition & 1 deletion sdk/appconfiguration/arm-appconfiguration/LICENSE
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
The MIT License (MIT)

Copyright (c) 2024 Microsoft
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 Down
38 changes: 16 additions & 22 deletions sdk/appconfiguration/arm-appconfiguration/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,11 @@

This package contains an isomorphic SDK (runs both in Node.js and in browsers) for Azure AppConfigurationManagement client.



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

## Getting started
Expand Down Expand Up @@ -42,34 +44,27 @@ npm install @azure/identity
```

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

```ts snippet:ReadmeSampleCreateClient_Node
import { AppConfigurationManagementClient } from "@azure/arm-appconfiguration";
import { DefaultAzureCredential } from "@azure/identity";
```javascript
const { AppConfigurationManagementClient } = require("@azure/arm-appconfiguration");
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 AppConfigurationManagementClient(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 { AppConfigurationManagementClient } from "@azure/arm-appconfiguration";

const subscriptionId = "00000000-0000-0000-0000-000000000000";
const credential = new InteractiveBrowserCredential({
tenantId: "<YOUR_TENANT_ID>",
clientId: "<YOUR_CLIENT_ID>",
});
const client = new AppConfigurationManagementClient(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 AppConfigurationManagementClient(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 @@ -84,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 Down
8 changes: 4 additions & 4 deletions sdk/appconfiguration/arm-appconfiguration/_meta.json
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
{
"commit": "2d4992bd73955a93f972ba6c476e980e7e16a992",
"commit": "59520d60c18c672e3db61339c64d94f5054b74ea",
"readme": "specification/appconfiguration/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\\appconfiguration\\resource-manager\\readme.md --use=@autorest/typescript@6.0.27 --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/appconfiguration/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/js-sdk-release-tools@2.7.15",
"use": "@autorest/typescript@6.0.27"
"release_tool": "@azure-tools/js-sdk-release-tools@2.7.18",
"use": "@autorest/typescript@^6.0.12"
}
6 changes: 3 additions & 3 deletions sdk/appconfiguration/arm-appconfiguration/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-appconfiguration.d.ts"
"publicTrimmedFilePath": "./types/arm-appconfiguration.d.ts"
},
"messages": {
"tsdocMessageReporting": {
Expand All @@ -28,4 +28,4 @@
}
}
}
}
}
19 changes: 6 additions & 13 deletions sdk/appconfiguration/arm-appconfiguration/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
"sdk-type": "mgmt",
"author": "Microsoft Corporation",
"description": "A generated SDK for AppConfigurationManagementClient.",
"version": "4.1.0",
"version": "4.2.0-beta.1",
"engines": {
"node": ">=18.0.0"
},
Expand All @@ -25,7 +25,7 @@
],
"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",
Expand All @@ -38,7 +38,8 @@
"@vitest/coverage-istanbul": "^2.1.8",
"dotenv": "^16.0.0",
"playwright": "^1.49.1",
"typescript": "~5.7.2",
"tsx": "^4.7.1",
"typescript": "~5.6.2",
"vitest": "^2.1.8"
},
"repository": {
Expand Down Expand Up @@ -79,7 +80,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 @@ -92,14 +93,6 @@
},
"autoPublish": true,
"homepage": "https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/appconfiguration/arm-appconfiguration",
"//sampleConfiguration": {
"productName": "",
"productSlugs": [
"azure"
],
"disableDocsMs": true,
"apiRefLink": "https://learn.microsoft.com/javascript/api/@azure/arm-appconfiguration?view=azure-node-preview"
},
"type": "module",
"tshy": {
"project": "./tsconfig.src.json",
Expand Down Expand Up @@ -140,4 +133,4 @@
}
}
}
}
}
Loading
Loading