Skip to content

[AutoPR @azure/arm-resourcehealth] Adding Metadata Tags attributes to Events APIs. #15677

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
20 changes: 13 additions & 7 deletions sdk/resourcehealth/arm-resourcehealth/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,21 @@
# Release History

## 4.1.0-beta.2 (Unreleased)

## 5.0.0 (2025-05-13)
### Features Added

### Breaking Changes

### Bugs Fixed
- Interface Event_2 has a new optional parameter eventTags
- Interface Event_2 has a new optional parameter isEventSensitive
- Interface Impact has a new optional parameter impactedServiceGuid
- Interface MetadataSupportedValueDetail has a new optional parameter previousId
- Interface MetadataSupportedValueDetail has a new optional parameter serviceGuid
- Interface Update has a new optional parameter eventTags

### Other Changes
### Breaking Changes

- Class MicrosoftResourceHealth has a new signature


## 4.1.0-beta.1 (2023-10-17)

### Features Added
Expand Down
2 changes: 1 addition & 1 deletion sdk/resourcehealth/arm-resourcehealth/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/resourcehealth/arm-resourcehealth/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ The Resource Health Client.

[Source code](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/resourcehealth/arm-resourcehealth) |
[Package (NPM)](https://www.npmjs.com/package/@azure/arm-resourcehealth) |
[API reference documentation](https://learn.microsoft.com/javascript/api/@azure/arm-resourcehealth?view=azure-node-preview) |
[API reference documentation](https://learn.microsoft.com/javascript/api/@azure/arm-resourcehealth) |
[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 MicrosoftResourceHealth** 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 { MicrosoftResourceHealth } from "@azure/arm-resourcehealth";

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 MicrosoftResourceHealth(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/resourcehealth/arm-resourcehealth/_meta.json
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
{
"commit": "0a25ea9680cf080b7d34e8c5f35f564425c6b1f7",
"commit": "37c875349517d082096817ef137ca9ef9d07f1c2",
"readme": "specification/resourcehealth/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\\resourcehealth\\resource-manager\\readme.md --use=@autorest/[email protected].9 --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/resourcehealth/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].2",
"use": "@autorest/[email protected].9"
}
"release_tool": "@azure-tools/[email protected].27",
"use": "@autorest/typescript@^6.0.12"
}
2 changes: 1 addition & 1 deletion sdk/resourcehealth/arm-resourcehealth/api-extractor.json
Original file line number Diff line number Diff line change
Expand Up @@ -28,4 +28,4 @@
}
}
}
}
}
56 changes: 28 additions & 28 deletions sdk/resourcehealth/arm-resourcehealth/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,47 +3,46 @@
"sdk-type": "mgmt",
"author": "Microsoft Corporation",
"description": "A generated SDK for MicrosoftResourceHealth.",
"version": "4.1.0-beta.2",
"version": "5.0.0",
"engines": {
"node": ">=18.0.0"
},
"dependencies": {
"@azure/core-auth": "^1.9.0",
"@azure/core-client": "^1.9.2",
"@azure/core-client": "^1.9.4",
"@azure/core-paging": "^1.6.2",
"@azure/core-rest-pipeline": "^1.19.0",
"@azure/core-rest-pipeline": "^1.20.0",
"tslib": "^2.8.1"
},
"keywords": [
"node",
"azure",
"typescript",
"browser",
"isomorphic"
"isomorphic",
"cloud"
],
"license": "MIT",
"main": "./dist/commonjs/index.js",
"module": "./dist/esm/index.js",
"types": "./dist/commonjs/index.d.ts",
"type": "module",
"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/logger": "^1.1.4",
"@azure/identity": "^4.9.1",
"@azure/logger": "^1.2.0",
"@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": {
"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 All @@ -56,20 +55,30 @@
],
"scripts": {
"build": "npm run clean && dev-tool run build-package && dev-tool run extract-api",
"build:browser": "echo skipped",
"build:node": "echo skipped",
"build:samples": "echo skipped.",
"check-format": "echo skipped",
"build:test": "echo skipped",
"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}\" ",
"clean": "dev-tool run vendored rimraf --glob dist dist-browser dist-esm test-dist temp types *.tgz *.log",
"execute:samples": "echo skipped",
"extract-api": "dev-tool run extract-api",
"format": "echo skipped",
"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}\" ",
"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": "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 test:node && npm run test:browser",
"test": "npm run integration-test",
"test:browser": "echo skipped",
"test:node": "dev-tool run test:vitest",
"test:node:esm": "dev-tool run test:vitest --esm",
"update-snippets": "dev-tool run update-snippets"
"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",
"test:node:esm": "dev-tool run test:vitest --esm"
},
"sideEffects": false,
"//metadata": {
Expand All @@ -81,16 +90,9 @@
]
},
"autoPublish": true,
"browser": "./dist/browser/index.js",
"react-native": "./dist/react-native/index.js",
"homepage": "https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/resourcehealth/arm-resourcehealth",
"//sampleConfiguration": {
"productName": "",
"productSlugs": [
"azure"
],
"disableDocsMs": true,
"apiRefLink": "https://learn.microsoft.com/javascript/api/@azure/arm-resourcehealth?view=azure-node-preview"
},
"type": "module",
"tshy": {
"project": "./tsconfig.src.json",
"exports": {
Expand All @@ -107,8 +109,6 @@
],
"selfLink": false
},
"browser": "./dist/browser/index.js",
"react-native": "./dist/react-native/index.js",
"exports": {
"./package.json": "./package.json",
".": {
Expand All @@ -130,4 +130,4 @@
}
}
}
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -234,15 +234,14 @@ export interface ErrorResponse {
// @public
interface Event_2 extends ProxyResource {
additionalInformation?: EventPropertiesAdditionalInformation;
argQuery?: string;
article?: EventPropertiesArticle;
description?: string;
duration?: number;
enableChatWithUs?: boolean;
enableMicrosoftSupport?: boolean;
eventLevel?: EventLevelValues;
eventSource?: EventSourceValues;
eventSubType?: EventSubTypeValues;
eventTags?: string[];
eventType?: EventTypeValues;
externalIncidentId?: string;
faqs?: Faq[];
Expand All @@ -252,12 +251,11 @@ interface Event_2 extends ProxyResource {
impactMitigationTime?: Date;
impactStartTime?: Date;
impactType?: string;
isEventSensitive?: boolean;
isHIR?: boolean;
lastUpdateTime?: Date;
level?: LevelValues;
links?: Link[];
maintenanceId?: string;
maintenanceType?: string;
platformInitiated?: boolean;
priority?: number;
reason?: string;
Expand Down Expand Up @@ -303,11 +301,6 @@ export type EventGetByTenantIdAndTrackingIdResponse = Event_2;
// @public
export interface EventImpactedResource extends ProxyResource {
info?: KeyValueItem[];
readonly maintenanceEndTime?: string;
readonly maintenanceStartTime?: string;
readonly resourceGroup?: string;
readonly resourceName?: string;
readonly status?: string;
readonly targetRegion?: string;
readonly targetResourceId?: string;
readonly targetResourceType?: string;
Expand Down Expand Up @@ -421,9 +414,6 @@ export type EventSourceValues = string;
// @public
export type EventStatusValues = string;

// @public
export type EventSubTypeValues = string;

// @public
export type EventTypeValues = string;

Expand All @@ -441,6 +431,7 @@ export function getContinuationToken(page: unknown): string | undefined;
export interface Impact {
impactedRegions?: ImpactedServiceRegion[];
impactedService?: string;
impactedServiceGuid?: string;
}

// @public
Expand Down Expand Up @@ -565,11 +556,6 @@ export enum KnownEventStatusValues {
Resolved = "Resolved"
}

// @public
export enum KnownEventSubTypeValues {
Retirement = "Retirement"
}

// @public
export enum KnownEventTypeValues {
EmergingIssues = "EmergingIssues",
Expand Down Expand Up @@ -695,7 +681,9 @@ export type MetadataListResponse = MetadataEntityListResult;
export interface MetadataSupportedValueDetail {
displayName?: string;
id?: string;
previousId?: string;
resourceTypes?: string[];
serviceGuid?: string;
}

// @public (undocumented)
Expand Down Expand Up @@ -895,6 +883,7 @@ export interface SystemData {

// @public
export interface Update {
eventTags?: string[];
summary?: string;
updateDateTime?: Date;
}
Expand Down
5 changes: 1 addition & 4 deletions sdk/resourcehealth/arm-resourcehealth/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.
Loading