Skip to content
Merged
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
2 changes: 1 addition & 1 deletion .github/CODEOWNERS
Original file line number Diff line number Diff line change
Expand Up @@ -952,7 +952,7 @@
# PRLabel: %Mgmt
/sdk/servicefabricmesh/arm-servicefabricmesh/ @qiaozha @MaryGao @JialinHuang803

# PRLabel: %Mgmt
# PRLabel: %Mgmt %mgmt-review-needed
/sdk/selfhelp/arm-selfhelp/ @qiaozha @MaryGao @JialinHuang803

# PRLabel: %Mgmt
Expand Down
31 changes: 20 additions & 11 deletions pnpm-lock.yaml

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

124 changes: 113 additions & 11 deletions sdk/selfhelp/arm-selfhelp/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,21 +1,123 @@
# Release History

## 2.0.0-beta.7 (Unreleased)
## 2.0.0-beta.7 (2026-05-28)
Compared with version 1.0.0

### Features Added
- Added operation group CheckNameAvailabilityOperations
- Added operation group DiscoverySolutionNLPOperations
- Added operation group SimplifiedSolutionsOperations
- Added operation group SolutionOperations
- Added operation group SolutionSelfHelpOperations
- Added operation group TroubleshootersOperations
- Added operation DiagnosticsOperations.create
- Added Interface AutomatedCheckResult
- Added Interface CheckNameAvailabilityCheckAvailabilityOptionalParams
- Added Interface ClassificationService
- Added Interface ContinueRequestBody
- Added Interface DiagnosticResourceProperties
- Added Interface DiscoveryNlpRequest
- Added Interface DiscoveryNlpResponse
- Added Interface DiscoverySolutionNLPDiscoverSolutionsBySubscriptionOptionalParams
- Added Interface DiscoverySolutionNLPDiscoverSolutionsOptionalParams
- Added Interface ExtensionResource
- Added Interface Filter
- Added Interface FilterGroup
- Added Interface MetricsBasedChart
- Added Interface NlpSolutions
- Added Interface PagedAsyncIterableIterator
- Added Interface PageSettings
- Added Interface ReplacementMaps
- Added Interface ReplacementMapsSelfHelp
- Added Interface ResponseOption
- Added Interface ResponseValidationProperties
- Added Interface RestartTroubleshooterResponse
- Added Interface RestorePollerOptions
- Added Interface SearchResult
- Added Interface Section
- Added Interface SectionSelfHelp
- Added Interface SimplePollerLike
- Added Interface SimplifiedSolutionsCreateOptionalParams
- Added Interface SimplifiedSolutionsGetOptionalParams
- Added Interface SimplifiedSolutionsResource
- Added Interface SimplifiedSolutionsResourceProperties
- Added Interface SolutionCreateOptionalParams
- Added Interface SolutionGetOptionalParams
- Added Interface SolutionMetadataProperties
- Added Interface SolutionNlpMetadataResource
- Added Interface SolutionPatchRequestBody
- Added Interface SolutionResource
- Added Interface SolutionResourceProperties
- Added Interface SolutionResourceSelfHelp
- Added Interface Solutions
- Added Interface SolutionsDiagnostic
- Added Interface SolutionSelfHelpGetOptionalParams
- Added Interface SolutionsResourcePropertiesSelfHelp
- Added Interface SolutionsTroubleshooters
- Added Interface SolutionUpdateOptionalParams
- Added Interface SolutionWarmUpOptionalParams
- Added Interface SolutionWarmUpRequestBody
- Added Interface Step
- Added Interface StepInput
- Added Interface TriggerCriterion
- Added Interface TroubleshooterInstanceProperties
- Added Interface TroubleshooterResource
- Added Interface TroubleshooterResponse
- Added Interface TroubleshootersContinueOptionalParams
- Added Interface TroubleshootersCreateOptionalParams
- Added Interface TroubleshootersEndOptionalParams
- Added Interface TroubleshootersGetOptionalParams
- Added Interface TroubleshootersRestartOptionalParams
- Added Interface Video
- Added Interface VideoGroup
- Added Interface VideoGroupVideo
- Added Interface WebResult
- Interface SolutionMetadataResource has a new optional parameter solutions
- Added Type Alias AggregationType
- Added Type Alias AutomatedCheckResultType
- Added Type Alias AzureSupportedClouds
- Added Type Alias Confidence
- Added Type Alias DiagnosticProvisioningState
- Added Type Alias ExecutionStatus
- Added Type Alias Name
- Added Type Alias QuestionContentType
- Added Type Alias QuestionType
- Added Type Alias ResultType
- Added Type Alias SolutionProvisioningState
- Added Type Alias SolutionType
- Added Type Alias TroubleshooterProvisioningState
- Added Type Alias Type
- Added Type Alias ValidationScope
- Added Enum AzureClouds
- Added Enum KnownAggregationType
- Added Enum KnownAutomatedCheckResultType
- Added Enum KnownConfidence
- Added Enum KnownDiagnosticProvisioningState
- Added Enum KnownExecutionStatus
- Added Enum KnownName
- Added Enum KnownQuestionContentType
- Added Enum KnownQuestionType
- Added Enum KnownResultType
- Added Enum KnownSolutionProvisioningState
- Added Enum KnownSolutionType
- Added Enum KnownTroubleshooterProvisioningState
- Added Enum KnownType
- Added Enum KnownValidationScope
- Added Enum KnownVersions

### Breaking Changes
- Removed operation Diagnostics.checkNameAvailability
- Operation DiscoverySolution.list has a new signature
- Removed Interface DiagnosticsCheckNameAvailabilityOptionalParams
- Removed Interface DiscoveryResponse
- Interface SolutionMetadataResource no longer has parameter description
- Interface SolutionMetadataResource no longer has parameter requiredParameterSets
- Interface SolutionMetadataResource no longer has parameter solutionId
- Interface SolutionMetadataResource no longer has parameter solutionType
- Removed Type Alias ProvisioningState
- Removed Enum KnownProvisioningState

### Bugs Fixed

### Other Changes

## 2.0.0-beta.6 (2025-08-22)

### Other Changes

- Other fixes


## 2.0.0-beta.5 (2024-06-26)
Compared with version 1.0.0

Expand Down
2 changes: 1 addition & 1 deletion sdk/selfhelp/arm-selfhelp/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.
23 changes: 9 additions & 14 deletions sdk/selfhelp/arm-selfhelp/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,12 @@ This package contains an isomorphic SDK (runs both in Node.js and in browsers) f

Help RP provider

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

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

## Getting started

Expand Down Expand Up @@ -35,7 +37,7 @@ npm install @azure/arm-selfhelp
To create a client object to access the Azure HelpRP API, you will need the `endpoint` of your Azure HelpRP resource and a `credential`. The Azure HelpRP client can use Azure Active Directory credentials to authenticate.
You can find the endpoint for your Azure HelpRP resource in the [Azure Portal][azure_portal].

You can authenticate with Azure Active Directory using a credential from the [@azure/identity][azure_identity] library or [an existing AAD Token](https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/identity/identity/samples/AzureIdentityExamples.md#authenticating-with-a-pre-fetched-access-token).
You can authenticate with Azure Active Directory using a credential from the [@azure/identity][azure_identity] library or [an existing AAD Token](https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/identity/identity/samples/AzureIdentityExamples.md#authenticating-with-a-pre-fetched-access-token).

To use the [DefaultAzureCredential][defaultazurecredential] provider shown below, or other credential providers provided with the Azure SDK, please install the `@azure/identity` package:

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

You will also need to **register a new AAD application and grant access to Azure HelpRP** 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 @@ -54,7 +55,6 @@ Using Node.js and Node-like environments, you can use the `DefaultAzureCredentia
import { HelpRP } from "@azure/arm-selfhelp";
import { DefaultAzureCredential } from "@azure/identity";

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

Expand All @@ -64,16 +64,15 @@ For browser environments, use the `InteractiveBrowserCredential` from the `@azur
import { InteractiveBrowserCredential } from "@azure/identity";
import { HelpRP } from "@azure/arm-selfhelp";

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

### 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 @@ -98,7 +97,7 @@ For more detailed instructions on how to enable logs, you can look at the [@azur

## Next steps

Please take a look at the [samples](https://github.com/Azure-Samples/azure-samples-js-management) directory for detailed examples on how to use this library.
Please take a look at the [samples](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/selfhelp/arm-selfhelp/samples) directory for detailed examples on how to use this library.

## Contributing

Expand All @@ -108,10 +107,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/
[azure_portal]: https://portal.azure.com
[azure_identity]: https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/identity/identity
Expand Down
8 changes: 0 additions & 8 deletions sdk/selfhelp/arm-selfhelp/_meta.json

This file was deleted.

4 changes: 1 addition & 3 deletions sdk/selfhelp/arm-selfhelp/api-extractor.json
Original file line number Diff line number Diff line change
@@ -1,3 +1 @@
{
"extends": "../../../api-extractor-base.json"
}
{ "extends": "../../../api-extractor-base.json" }
2 changes: 1 addition & 1 deletion sdk/selfhelp/arm-selfhelp/assets.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,5 @@
"AssetsRepo": "Azure/azure-sdk-assets",
"AssetsRepoPrefixPath": "js",
"TagPrefix": "js/selfhelp/arm-selfhelp",
"Tag": "js/selfhelp/arm-selfhelp_8081492142"
"Tag": "js/selfhelp/arm-selfhelp_c4a6df79fb"
}
4 changes: 1 addition & 3 deletions sdk/selfhelp/arm-selfhelp/config/tsconfig.samples.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,7 @@
"extends": "../../../../eng/tsconfigs/samples.json",
"compilerOptions": {
"paths": {
"@azure/arm-selfhelp": [
"../dist/esm"
]
"@azure/arm-selfhelp": ["../dist/esm"]
}
}
}
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@
{
"extends": "../../../../eng/tsconfigs/src.browser.json",
"include": [
"../src/index.ts"
]
"include": ["../src/index.ts"]
}
4 changes: 1 addition & 3 deletions sdk/selfhelp/arm-selfhelp/config/tsconfig.src.cjs.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@
{
"extends": "../../../../eng/tsconfigs/src.cjs.json",
"include": [
"../src/index.ts"
]
"include": ["../src/index.ts"]
}
4 changes: 1 addition & 3 deletions sdk/selfhelp/arm-selfhelp/config/tsconfig.src.esm.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@
{
"extends": "../../../../eng/tsconfigs/src.esm.json",
"include": [
"../src/index.ts"
]
"include": ["../src/index.ts"]
}
10 changes: 10 additions & 0 deletions sdk/selfhelp/arm-selfhelp/config/tsconfig.test.browser.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
{
"extends": "../../../../eng/tsconfigs/test.browser.json",
"compilerOptions": {
"paths": {
"@azure/arm-selfhelp": ["../src/index.ts"],
"@azure/arm-selfhelp/*": ["../src/*"],
"$internal/*": ["../src/*"]
}
}
}
9 changes: 8 additions & 1 deletion sdk/selfhelp/arm-selfhelp/config/tsconfig.test.node.json
Original file line number Diff line number Diff line change
@@ -1,3 +1,10 @@
{
"extends": "../../../../eng/tsconfigs/test.node.json"
"extends": "../../../../eng/tsconfigs/test.node.json",
"compilerOptions": {
"paths": {
"@azure/arm-selfhelp": ["../src/index.ts"],
"@azure/arm-selfhelp/*": ["../src/*"],
"$internal/*": ["../src/*"]
}
}
}
6 changes: 3 additions & 3 deletions sdk/selfhelp/arm-selfhelp/eslint.config.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,9 @@ export default [
"@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"
}
}
"tsdoc/syntax": "warn",
},
},
]),
{
files: ["src/**/*.ts", "src/**/*.mts", "test/**/*.ts"],
Expand Down
Loading
Loading