Skip to content

Improve TSDoc documentation for Azure Cloud helpers #3474

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.

Sign up for GitHub

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

Merged
MaryGao merged 3 commits into from
Aug 27, 2025
Merged

Improve TSDoc documentation for Azure Cloud helpers #3474

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
953c9ce
Initial plan
Copilot Aug 26, 2025
83b7a66
Improve TSDoc documentation for Azure Cloud helpers with @enum, @para…
Copilot Aug 26, 2025
9ff6ac9
Fix CI error: Update generated NetworkAnalytics.Management package files
Copilot Aug 26, 2025
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
11 changes: 10 additions & 1 deletion ...agement/generated/typespec-ts/sdk/test/arm-test/src/static-helpers/cloudSettingHelpers.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,10 @@
// Copyright (c) Microsoft Corporation.
// Licensed under the MIT License.

/** An enum to describe Azure Cloud. */
/**
* An enum to describe Azure Cloud environments.
* @enum {string}
*/
export enum AzureClouds {
/** Azure public cloud, which is the default cloud for Azure SDKs. */
AZURE_PUBLIC_CLOUD = "AZURE_PUBLIC_CLOUD",
Expand All @@ -14,6 +17,12 @@ export enum AzureClouds {
/** The supported values for cloud setting as a string literal type */
export type AzureSupportedClouds = `${AzureClouds}`;

/**
* Gets the Azure Resource Manager endpoint URL for the specified cloud setting.
* @param cloudSetting - The Azure cloud environment setting. Use one of the AzureClouds enum values.
* @returns The ARM endpoint URL for the specified cloud, or undefined if cloudSetting is undefined.
* @throws {Error} Throws an error if an unknown cloud setting is provided.
*/
export function getArmEndpoint(
cloudSetting?: AzureSupportedClouds,
): string | undefined {
Expand Down
11 changes: 10 additions & 1 deletion packages/typespec-ts/static/static-helpers/cloudSettingHelpers.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,7 @@
/** An enum to describe Azure Cloud. */
/**
* An enum to describe Azure Cloud environments.
* @enum {string}
*/
export enum AzureClouds {
/** Azure public cloud, which is the default cloud for Azure SDKs. */
AZURE_PUBLIC_CLOUD = "AZURE_PUBLIC_CLOUD",
Expand All @@ -11,6 +14,12 @@ export enum AzureClouds {
/** The supported values for cloud setting as a string literal type */
export type AzureSupportedClouds = `${AzureClouds}`;

/**
* Gets the Azure Resource Manager endpoint URL for the specified cloud setting.
* @param cloudSetting - The Azure cloud environment setting. Use one of the AzureClouds enum values.
* @returns The ARM endpoint URL for the specified cloud, or undefined if cloudSetting is undefined.
* @throws {Error} Throws an error if an unknown cloud setting is provided.
*/
export function getArmEndpoint(
cloudSetting?: AzureSupportedClouds
): string | undefined {
Expand Down
Loading
⚡