Skip to content
Merged
Show file tree
Hide file tree
Changes from 2 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 @@ -748,7 +748,7 @@
# PRLabel: %Mgmt
/sdk/managednetworkfabric/arm-managednetworkfabric/ @qiaozha @MaryGao @JialinHuang803

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

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

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

93 changes: 81 additions & 12 deletions sdk/managementgroups/arm-managementgroups/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,89 @@
# Release History

## 2.0.4 (Unreleased)
## 3.0.0-beta.1 (2026-05-25)
Compared with version 2.0.2

### Features Added
- Added operation ManagementGroupsOperations.createOrUpdate
- Added operation ManagementGroupsOperations.delete
- Added Interface CreateManagementGroupProperties
- Added Interface CreateOrUpdateSettingsProperties
- Added Interface DescendantInfoProperties
- Added Interface EntityInfoProperties
- Added Interface ErrorAdditionalInfo
- Added Interface ErrorDetail
- Added Interface HierarchySettingsProperties
- Added Interface ManagementGroupInfoProperties
- Added Interface ManagementGroupProperties
- Added Interface ManagementGroupsListDescendantsOptionalParams
- Added Interface ManagementGroupSubscriptionsListSubscriptionsUnderManagementGroupOptionalParams
- Added Interface OperationDisplay
- Added Interface PagedAsyncIterableIterator
- Added Interface PageSettings
- Added Interface ProxyResource
- Added Interface Resource
- Added Interface RestorePollerOptions
- Added Interface SimplePollerLike
- Added Interface SubscriptionUnderManagementGroupProperties
- Added Interface SystemData
- Interface DescendantInfo has a new optional parameter properties
- Interface EntityInfo has a new optional parameter properties
- Interface HierarchySettings has a new optional parameter systemData
- Interface ManagementGroup has a new optional parameter systemData
- Interface Operation has a new optional parameter actionType
- Interface Operation has a new optional parameter isDataAction
- Interface Operation has a new optional parameter origin
- Interface SubscriptionUnderManagementGroup has a new optional parameter systemData
- Added Type Alias ActionType
- Added Type Alias AzureSupportedClouds
- Added Type Alias CreatedByType
- Added Type Alias EntitySearchType
- Added Type Alias EntityViewParameterType
- Added Type Alias ManagementGroupExpandType
- Added Type Alias Origin
- Added Type Alias Permissions
- Added Enum AzureClouds
- Added Enum KnownActionType
- Added Enum KnownCreatedByType
- Added Enum KnownEntitySearchType
- Added Enum KnownEntityViewParameterType
- Added Enum KnownManagementGroupExpandType
- Added Enum KnownOrigin
- Added Enum KnownVersions

### Breaking Changes

### Bugs Fixed

### Other Changes

## 2.0.3 (2025-08-22)

### Other Changes

- Other fixes
- Operation ManagementGroups.beginDeleteAndWait has a new signature
- Removed Interface AzureAsyncOperationResults
- Removed Interface EntityHierarchyItem
- Removed Interface ErrorDetails
- Removed Interface ListSubscriptionUnderManagementGroup
- Removed Interface ManagementGroupsGetDescendantsOptionalParams
- Removed Interface ManagementGroupSubscriptionsGetSubscriptionsUnderManagementGroupOptionalParams
- Removed Interface OperationDisplayProperties
- Removed Interface OperationResults
- Type of parameter error of interface ErrorResponse is changed from ErrorDetails to ErrorDetail
- Interface DescendantInfo no longer has parameter displayName
- Interface DescendantInfo no longer has parameter parent
- Interface EntityInfo no longer has parameter displayName
- Interface EntityInfo no longer has parameter inheritedPermissions
- Interface EntityInfo no longer has parameter numberOfChildGroups
- Interface EntityInfo no longer has parameter numberOfChildren
- Interface EntityInfo no longer has parameter numberOfDescendants
- Interface EntityInfo no longer has parameter parent
- Interface EntityInfo no longer has parameter parentDisplayNameChain
- Interface EntityInfo no longer has parameter parentNameChain
- Interface EntityInfo no longer has parameter permissions
- Interface EntityInfo no longer has parameter tenantId
- Removed Type Alias Enum0
- Removed Type Alias Enum2
- Removed Type Alias Enum3
- Removed Type Alias Permissions_2
- Type alias "ManagementGroupChildType" has been changed
- Removed Enum KnownEnum0
- Removed Enum KnownEnum2
- Removed Enum KnownEnum3
- Removed Enum KnownManagementGroupChildType
- Removed Enum KnownPermissions

## 2.0.2 (2022-12-05)

Expand All @@ -40,4 +109,4 @@ To understand the detail of the change, please refer to [Changelog](https://aka.

To migrate the existing applications to the latest version, please refer to [Migration Guide](https://aka.ms/js-track2-migration-guide).

To learn more, please refer to our documentation [Quick Start](https://aka.ms/azsdk/js/mgmt/quickstart ).
To learn more, please refer to our documentation [Quick Start](https://aka.ms/azsdk/js/mgmt/quickstart).
2 changes: 1 addition & 1 deletion sdk/managementgroups/arm-managementgroups/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.
37 changes: 18 additions & 19 deletions sdk/managementgroups/arm-managementgroups/README.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,17 @@
# Azure ManagementGroupsApi client library for JavaScript
# Azure ManagementGroupsAPI client library for JavaScript

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

The Azure Management Groups API enables consolidation of multiple
subscriptions/resources into an organizational hierarchy and centrally
manage access control, policies, alerting and reporting for those resources.

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

## Getting started

Expand All @@ -26,27 +28,26 @@ See our [support policy](https://github.com/Azure/azure-sdk-for-js/blob/main/SUP

### Install the `@azure/arm-managementgroups` package

Install the Azure ManagementGroupsApi client library for JavaScript with `npm`:
Install the Azure ManagementGroupsAPI client library for JavaScript with `npm`:

```bash
npm install @azure/arm-managementgroups
```

### Create and authenticate a `ManagementGroupsAPI`

To create a client object to access the Azure ManagementGroupsApi API, you will need the `endpoint` of your Azure ManagementGroupsApi resource and a `credential`. The Azure ManagementGroupsApi client can use Azure Active Directory credentials to authenticate.
You can find the endpoint for your Azure ManagementGroupsApi resource in the [Azure Portal][azure_portal].
To create a client object to access the Azure ManagementGroupsAPI API, you will need the `endpoint` of your Azure ManagementGroupsAPI resource and a `credential`. The Azure ManagementGroupsAPI client can use Azure Active Directory credentials to authenticate.
You can find the endpoint for your Azure ManagementGroupsAPI 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:

```bash
npm install @azure/identity
```

You will also need to **register a new AAD application and grant access to Azure ManagementGroupsApi** 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`.
You will also need to **register a new AAD application and grant access to Azure ManagementGroupsAPI** by assigning the suitable role to your service principal (note: roles such as `"Owner"` will not grant the necessary permissions).

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 @@ -56,7 +57,7 @@ Using Node.js and Node-like environments, you can use the `DefaultAzureCredentia
import { ManagementGroupsAPI } from "@azure/arm-managementgroups";
import { DefaultAzureCredential } from "@azure/identity";

const client = new ManagementGroupsAPI(new DefaultAzureCredential(), subscriptionId);
const client = new ManagementGroupsAPI(new DefaultAzureCredential());
```

For browser environments, use the `InteractiveBrowserCredential` from the `@azure/identity` package to authenticate.
Expand All @@ -69,18 +70,18 @@ const credential = new InteractiveBrowserCredential({
tenantId: "<YOUR_TENANT_ID>",
clientId: "<YOUR_CLIENT_ID>",
});
const client = new ManagementGroupsAPI(credential, subscriptionId);
const client = new ManagementGroupsAPI(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

### ManagementGroupsAPI

`ManagementGroupsAPI` is the primary interface for developers using the Azure ManagementGroupsApi client library. Explore the methods on this client object to understand the different features of the Azure ManagementGroupsApi service that you can access.
`ManagementGroupsAPI` is the primary interface for developers using the Azure ManagementGroupsAPI client library. Explore the methods on this client object to understand the different features of the Azure ManagementGroupsAPI service that you can access.

## Troubleshooting

Expand All @@ -98,7 +99,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/managementgroups/arm-managementgroups/samples) directory for detailed examples on how to use this library.

## Contributing

Expand All @@ -108,8 +109,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/managementgroups/arm-managementgroups/_meta.json

This file was deleted.

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/managementgroups/arm-managementgroups/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/managementgroups/arm-managementgroups",
"Tag": "js/managementgroups/arm-managementgroups_d18ac896ed"
"Tag": "js/managementgroups/arm-managementgroups_baf00a10fd"
}
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-managementgroups": [
"../dist/esm"
]
"@azure/arm-managementgroups": ["../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"]
}
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"]
}
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"]
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
{
"extends": "../../../../eng/tsconfigs/test.browser.json",
"compilerOptions": {
"paths": {
"@azure/arm-managementgroups": ["../src/index.ts"],
"@azure/arm-managementgroups/*": ["../src/*"],
"$internal/*": ["../src/*"]
}
}
}
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-managementgroups": ["../src/index.ts"],
"@azure/arm-managementgroups/*": ["../src/*"],
"$internal/*": ["../src/*"]
}
}
}
6 changes: 3 additions & 3 deletions sdk/managementgroups/arm-managementgroups/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