Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
52 changes: 52 additions & 0 deletions sdk/connectedcache/arm-connectedcache/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,57 @@
# Release History

## 1.0.0-beta.2 (2025-05-06)
Compared with version 1.0.0-beta.1

### Features Added

- Added operation EnterpriseMccCacheNodesOperationsOperations.getCacheNodeAutoUpdateHistory
- Added operation EnterpriseMccCacheNodesOperationsOperations.getCacheNodeMccIssueDetailsHistory
- Added operation EnterpriseMccCacheNodesOperationsOperations.getCacheNodeTlsCertificateHistory
- Added operation IspCacheNodesOperationsOperations.getCacheNodeAutoUpdateHistory
- Added operation IspCacheNodesOperationsOperations.getCacheNodeMccIssueDetailsHistory
- Added Interface EnterpriseMccCacheNodesOperationsGetCacheNodeAutoUpdateHistoryOptionalParams
- Added Interface EnterpriseMccCacheNodesOperationsGetCacheNodeMccIssueDetailsHistoryOptionalParams
- Added Interface EnterpriseMccCacheNodesOperationsGetCacheNodeTlsCertificateHistoryOptionalParams
- Added Interface ErrorResponse
- Added Interface IspCacheNodesOperationsGetCacheNodeAutoUpdateHistoryOptionalParams
- Added Interface IspCacheNodesOperationsGetCacheNodeMccIssueDetailsHistoryOptionalParams
- Added Interface MccCacheNodeAutoUpdateHistory
- Added Interface MccCacheNodeAutoUpdateHistoryProperties
- Added Interface MccCacheNodeAutoUpdateInfo
- Added Interface MccCacheNodeIssueHistory
- Added Interface MccCacheNodeIssueHistoryProperties
- Added Interface MccCacheNodeTlsCertificate
- Added Interface MccCacheNodeTlsCertificateHistory
- Added Interface MccCacheNodeTlsCertificateProperties
- Added Interface MccIssue
- Interface AdditionalCacheNodeProperties has a new optional parameter creationMethod
- Interface AdditionalCacheNodeProperties has a new optional parameter currentTlsCertificate
- Interface AdditionalCacheNodeProperties has a new optional parameter issuesCount
- Interface AdditionalCacheNodeProperties has a new optional parameter issuesList
- Interface AdditionalCacheNodeProperties has a new optional parameter lastAutoUpdateInfo
- Interface AdditionalCacheNodeProperties has a new optional parameter tlsStatus
- Interface CacheNodeInstallProperties has a new optional parameter driveConfiguration
- Interface CacheNodeInstallProperties has a new optional parameter proxyUrlConfiguration
- Interface CacheNodeInstallProperties has a new optional parameter tlsCertificateProvisioningKey
- Enum KnownConfigurationState has a new value NotConfiguredIp
- Enum KnownVersions has a new value V20230501Preview
- Enum KnownVersions has a new value V20241130Preview

### Breaking Changes

- Removed operation group CacheNodesOperationsOperations
- Removed operation group EnterpriseCustomerOperationsOperations
- Interface AdditionalCacheNodeProperties no longer has parameter proxyUrl
- Interface AdditionalCacheNodeProperties no longer has parameter updateCycleType
- Interface AdditionalCustomerProperties no longer has parameter peeringDbLastUpdateTime
- Class ConnectedCacheClient no longer has parameter cacheNodesOperations
- Class ConnectedCacheClient no longer has parameter enterpriseCustomerOperations
- Removed Enum KnownCycleType
- Enum KnownConfigurationState no longer has value NotConfigured_Ip
- Enum KnownVersions no longer has value v2023_05_01_preview


## 1.0.0-beta.1 (2024-11-19)

### Features Added
Expand Down
2 changes: 1 addition & 1 deletion sdk/connectedcache/arm-connectedcache/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.
14 changes: 9 additions & 5 deletions sdk/connectedcache/arm-connectedcache/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,10 @@ Microsoft Connected Cache Rest Api version 2023-05-01-preview

Key links:

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

## Getting started

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

You will also need to **register a new AAD application and grant access to Azure ConnectedCache** 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 +65,15 @@ For browser environments, use the `InteractiveBrowserCredential` from the `@azur
import { InteractiveBrowserCredential } from "@azure/identity";
import { ConnectedCacheClient } from "@azure/arm-connectedcache";

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 ConnectedCacheClient(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 @@ -96,6 +96,10 @@ 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/main/sdk/core/logger).

## Next steps

Please take a look at the [samples](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/connectedcache/arm-connectedcache/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/main/CONTRIBUTING.md) to learn more about how to build and test the code.
Expand Down
6 changes: 0 additions & 6 deletions sdk/connectedcache/arm-connectedcache/assets.json

This file was deleted.

14 changes: 14 additions & 0 deletions sdk/connectedcache/arm-connectedcache/eslint.config.mjs
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
import azsdkEslint from "@azure/eslint-plugin-azure-sdk";

export default azsdkEslint.config([
{
rules: {
"@azure/azure-sdk/ts-modules-only-named": "warn",
"@azure/azure-sdk/ts-package-json-types": "warn",
"@azure/azure-sdk/ts-package-json-engine-is-present": "warn",
"@azure/azure-sdk/ts-package-json-files-required": "off",
"@azure/azure-sdk/ts-package-json-main-is-cjs": "off",
"tsdoc/syntax": "warn",
},
},
]);
63 changes: 45 additions & 18 deletions sdk/connectedcache/arm-connectedcache/package.json
Original file line number Diff line number Diff line change
@@ -1,18 +1,18 @@
{
"name": "@azure/arm-connectedcache",
"version": "1.0.0-beta.1",
"version": "1.0.0-beta.2",
"description": "A generated SDK for ConnectedCacheClient.",
"engines": {
"node": ">=18.0.0"
},
"sideEffects": false,
"autoPublish": false,
"tshy": {
"project": "./tsconfig.src.json",
"exports": {
"./package.json": "./package.json",
".": "./src/index.ts",
"./models": "./src/models/index.ts"
"./models": "./src/models/index.ts",
"./api": "./src/api/index.ts"
},
"dialects": [
"esm",
Expand All @@ -22,7 +22,8 @@
"browser",
"react-native"
],
"selfLink": false
"selfLink": false,
"project": "./tsconfig.src.json"
},
"type": "module",
"keywords": [
Expand All @@ -47,6 +48,7 @@
"bugs": {
"url": "https://github.com/Azure/azure-sdk-for-js/issues"
},
"homepage": "https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/connectedcache/arm-connectedcache/README.md",
"prettier": "@azure/eslint-plugin-azure-sdk/prettier.json",
"//metadata": {
"constantPaths": [
Expand All @@ -61,9 +63,9 @@
"@azure/abort-controller": "^2.1.2",
"@azure/core-auth": "^1.9.0",
"@azure/core-lro": "^3.1.0",
"@azure/core-rest-pipeline": "^1.18.2",
"@azure/core-util": "^1.11.0",
"@azure/logger": "^1.1.4",
"@azure/core-rest-pipeline": "^1.20.0",
"@azure/core-util": "^1.12.0",
"@azure/logger": "^1.2.0",
"tslib": "^2.8.1"
},
"devDependencies": {
Expand All @@ -72,32 +74,39 @@
"@azure-tools/test-utils-vitest": "^1.0.0",
"@azure/dev-tool": "^1.0.0",
"@azure/eslint-plugin-azure-sdk": "^3.0.0",
"@azure/identity": "^4.6.0",
"@azure/identity": "^4.9.1",
"@types/node": "^18.0.0",
"@vitest/browser": "^3.0.9",
"@vitest/coverage-istanbul": "^3.0.9",
"dotenv": "^16.0.0",
"eslint": "^9.9.0",
"playwright": "^1.49.1",
"playwright": "^1.52.0",
"typescript": "~5.8.2",
"vitest": "^3.0.9"
},
"scripts": {
"build": "npm run clean && dev-tool run build-package && dev-tool run extract-api",
"build:samples": "tsc -p tsconfig.samples.json && dev-tool samples publish -f",
"build:test": "npm run clean && dev-tool run build-package && dev-tool run build-test",
"check-format": "dev-tool run vendored prettier --list-different --config ../../../.prettierrc.json --ignore-path ../../../.prettierignore \"src/**/*.{ts,cts,mts}\" \"test/**/*.{ts,cts,mts}\" \"*.{js,cjs,mjs,json}\" \"samples-dev/*.ts\"",
"clean": "dev-tool run vendored rimraf --glob dist dist-browser dist-esm test-dist temp types *.tgz *.log",
"execute:samples": "dev-tool samples run samples-dev",
"extract-api": "dev-tool run vendored rimraf review && dev-tool run extract-api",
"format": "dev-tool run vendored prettier --write --config ../../../.prettierrc.json --ignore-path ../../../.prettierignore \"src/**/*.{ts,cts,mts}\" \"test/**/*.{ts,cts,mts}\" \"*.{js,cjs,mjs,json}\" \"samples-dev/*.ts\"",
"generate:client": "echo skipped",
"lint": "echo skipped",
"lint:fix": "echo skipped",
"integration-test": "npm run integration-test:node && npm run integration-test:browser",
"integration-test:browser": "echo skipped",
"integration-test:node": "dev-tool run test:vitest --esm",
"lint": "eslint package.json api-extractor.json src test",
"lint:fix": "eslint package.json api-extractor.json src test --fix --fix-type [problem,suggestion]",
"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",
"test": "npm run test:node && npm run test:browser",
"test:browser": "echo skipped",
"test:node": "dev-tool run test:vitest",
"test:node:esm": "dev-tool run test:vitest --esm",
"test": "npm run clean && dev-tool run build-package && npm run unit-test:node && dev-tool run bundle && npm run unit-test:browser && npm run integration-test",
"test:browser": "npm run clean && npm run build:test && npm run unit-test:browser && npm run integration-test:browser",
"test:node": "npm run clean && dev-tool run build-package && npm run unit-test:node && npm run integration-test:node",
"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"
},
"//sampleConfiguration": {
Expand All @@ -108,6 +117,8 @@
"disableDocsMs": true,
"apiRefLink": "https://learn.microsoft.com/javascript/api/@azure/arm-connectedcache?view=azure-node-preview"
},
"browser": "./dist/browser/index.js",
"react-native": "./dist/react-native/index.js",
"exports": {
"./package.json": "./package.json",
".": {
Expand Down Expand Up @@ -145,11 +156,27 @@
"types": "./dist/commonjs/models/index.d.ts",
"default": "./dist/commonjs/models/index.js"
}
},
"./api": {
"browser": {
"types": "./dist/browser/api/index.d.ts",
"default": "./dist/browser/api/index.js"
},
"react-native": {
"types": "./dist/react-native/api/index.d.ts",
"default": "./dist/react-native/api/index.js"
},
"import": {
"types": "./dist/esm/api/index.d.ts",
"default": "./dist/esm/api/index.js"
},
"require": {
"types": "./dist/commonjs/api/index.d.ts",
"default": "./dist/commonjs/api/index.js"
}
}
},
"main": "./dist/commonjs/index.js",
"types": "./dist/commonjs/index.d.ts",
"module": "./dist/esm/index.js",
"browser": "./dist/browser/index.js",
"react-native": "./dist/react-native/index.js"
"module": "./dist/esm/index.js"
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
## API Report File for "@azure/arm-connectedcache"

> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).

```ts

import { Client } from '@azure-rest/core-client';
import { ClientOptions } from '@azure-rest/core-client';
import { TokenCredential } from '@azure/core-auth';

// @public
export interface ConnectedCacheClientOptionalParams extends ClientOptions {
apiVersion?: string;
}

// @public
export interface ConnectedCacheContext extends Client {
apiVersion: string;
subscriptionId: string;
}

// @public
export function createConnectedCache(credential: TokenCredential, subscriptionId: string, options?: ConnectedCacheClientOptionalParams): ConnectedCacheContext;

// (No @packageDocumentation comment for this package)

```
Loading