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
79 changes: 40 additions & 39 deletions common/config/rush/pnpm-lock.yaml

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

109 changes: 102 additions & 7 deletions sdk/maintenance/arm-maintenance/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,110 @@
# Release History

## 1.0.0-beta.3 (Unreleased)


## 1.0.0-beta.3 (2025-05-12)
Compared with version 1.0.0-beta.2

### Features Added

### Breaking Changes
- Added operation group ApplyUpdateForResourceGroupOperationGroupOperations
- Added operation group ApplyUpdateOperationGroupOperations
- Added operation group ApplyUpdatesOperationGroupOperations
- Added operation group ConfigurationAssignmentForResourceGroupOperationGroupOperations
- Added operation group ConfigurationAssignmentOperationGroupOperations
- Added operation group MaintenanceConfigurationOperationGroupOperations
- Added operation group ScheduledEventOperationGroupOperations
- Added operation group UpdatesOperationGroupOperations
- Added operation ConfigurationAssignmentsForSubscriptionsOperations.list
- Added Interface ApplyUpdateForResourceGroupOperationGroupListOptionalParams
- Added Interface ApplyUpdateOperationGroupCreateOrUpdateOrCancelOptionalParams
- Added Interface ApplyUpdateOperationGroupGetOptionalParams
- Added Interface ApplyUpdateOperationGroupListOptionalParams
- Added Interface ApplyUpdateProperties
- Added Interface ApplyUpdatesOperationGroupCreateOrUpdateOptionalParams
- Added Interface ApplyUpdatesOperationGroupCreateOrUpdateParentOptionalParams
- Added Interface ConfigurationAssignmentForResourceGroupOperationGroupListOptionalParams
- Added Interface ConfigurationAssignmentOperationGroupCreateOrUpdateOptionalParams
- Added Interface ConfigurationAssignmentOperationGroupDeleteOptionalParams
- Added Interface ConfigurationAssignmentOperationGroupGetOptionalParams
- Added Interface ConfigurationAssignmentProperties
- Added Interface ConfigurationAssignmentsForSubscriptionsListOptionalParams
- Added Interface MaintenanceClientOptionalParams
- Added Interface MaintenanceConfigurationOperationGroupCreateOrUpdateOptionalParams
- Added Interface MaintenanceConfigurationOperationGroupDeleteOptionalParams
- Added Interface MaintenanceConfigurationOperationGroupGetOptionalParams
- Added Interface MaintenanceConfigurationOperationGroupListOptionalParams
- Added Interface MaintenanceConfigurationOperationGroupMaintenanceConfigurationsListOptionalParams
- Added Interface MaintenanceConfigurationOperationGroupUpdateOptionalParams
- Added Interface MaintenanceConfigurationProperties
- Added Interface MaintenanceWindow
- Added Interface OperationDisplay
- Added Interface PagedAsyncIterableIterator
- Added Interface PageSettings
- Added Interface ProxyResource
- Added Interface ScheduledEventOperationGroupAcknowledgeOptionalParams
- Added Interface TrackedResource
- Added Interface UpdateProperties
- Added Interface UpdatesOperationGroupListOptionalParams
- Added Interface UpdatesOperationGroupListParentOptionalParams
- Added Class MaintenanceClient
- Added Type Alias ActionType
- Added Type Alias ContinuablePage
- Added Type Alias Origin
- Interface ApplyUpdate has a new optional parameter properties
- Interface ConfigurationAssignment has a new optional parameter properties
- Interface MaintenanceConfiguration has a new optional parameter properties
- Interface Operation has a new optional parameter actionType
- Interface Update has a new optional parameter properties
- Added Enum KnownActionType
- Added Enum KnownOrigin
- Added Enum KnownVersions

### Bugs Fixed

### Other Changes
### Breaking Changes

- Removed operation group ApplyUpdateForResourceGroup
- Removed operation group ConfigurationAssignmentsWithinSubscription
- Removed operation group MaintenanceConfigurationsForResourceGroup
- Removed operation group PublicMaintenanceConfigurations
- Removed operation group ScheduledEvent
- Removed operation group Updates
- Removed operation ApplyUpdates.createOrUpdate
- Removed operation ApplyUpdates.createOrUpdateOrCancel
- Removed operation ApplyUpdates.createOrUpdateParent
- Removed operation ApplyUpdates.get
- Removed operation ApplyUpdates.list
- Removed operation ConfigurationAssignments.createOrUpdate
- Removed operation ConfigurationAssignments.delete
- Removed operation ConfigurationAssignments.get
- Removed operation ConfigurationAssignments.list
- Removed operation MaintenanceConfigurations.createOrUpdate
- Removed operation MaintenanceConfigurations.delete
- Removed operation MaintenanceConfigurations.update
- Deleted Class MaintenanceManagementClient
- Interface ApplyUpdate no longer has parameter lastUpdateTime
- Interface ApplyUpdate no longer has parameter resourceId
- Interface ApplyUpdate no longer has parameter status
- Interface ConfigurationAssignment no longer has parameter filter
- Interface ConfigurationAssignment no longer has parameter maintenanceConfigurationId
- Interface ConfigurationAssignment no longer has parameter resourceId
- Interface MaintenanceConfiguration no longer has parameter duration
- Interface MaintenanceConfiguration no longer has parameter expirationDateTime
- Interface MaintenanceConfiguration no longer has parameter extensionProperties
- Interface MaintenanceConfiguration no longer has parameter installPatches
- Interface MaintenanceConfiguration no longer has parameter maintenanceScope
- Interface MaintenanceConfiguration no longer has parameter namespace
- Interface MaintenanceConfiguration no longer has parameter recurEvery
- Interface MaintenanceConfiguration no longer has parameter startDateTime
- Interface MaintenanceConfiguration no longer has parameter timeZone
- Interface MaintenanceConfiguration no longer has parameter visibility
- Interface Operation no longer has parameter properties
- Interface Update no longer has parameter resourceId
- Type of parameter display of interface Operation is changed from OperationInfo to OperationDisplay
- Type of parameter origin of interface Operation is changed from string to Origin
- Type of parameter tags of interface TagSettingsProperties is changed from {
[propertyName: string]: string[];
} to Record<string, string[]>
- Removed function getContinuationToken


## 1.0.0-beta.2 (2024-05-10)

### Features Added
Expand Down
2 changes: 1 addition & 1 deletion sdk/maintenance/arm-maintenance/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.
36 changes: 17 additions & 19 deletions sdk/maintenance/arm-maintenance/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

Azure Maintenance Management Client

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

## Getting started

Expand All @@ -30,7 +32,7 @@ Install the Azure MaintenanceManagement client library for JavaScript with `npm`
npm install @azure/arm-maintenance
```

### Create and authenticate a `MaintenanceManagementClient`
### Create and authenticate a `MaintenanceClient`

To create a client object to access the Azure MaintenanceManagement API, you will need the `endpoint` of your Azure MaintenanceManagement resource and a `credential`. The Azure MaintenanceManagement client can use Azure Active Directory credentials to authenticate.
You can find the endpoint for your Azure MaintenanceManagement resource in the [Azure Portal][azure_portal].
Expand All @@ -44,43 +46,41 @@ npm install @azure/identity
```

You will also need to **register a new AAD application and grant access to Azure MaintenanceManagement** 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).

Using Node.js and Node-like environments, you can use the `DefaultAzureCredential` class to authenticate the client.

```ts snippet:ReadmeSampleCreateClient_Node
import { MaintenanceManagementClient } from "@azure/arm-maintenance";
import { MaintenanceClient } from "@azure/arm-maintenance";
import { DefaultAzureCredential } from "@azure/identity";

const subscriptionId = "00000000-0000-0000-0000-000000000000";
const client = new MaintenanceManagementClient(new DefaultAzureCredential(), subscriptionId);
const client = new MaintenanceClient(new DefaultAzureCredential(), subscriptionId);
```

For browser environments, use the `InteractiveBrowserCredential` from the `@azure/identity` package to authenticate.

```ts snippet:ReadmeSampleCreateClient_Browser
import { InteractiveBrowserCredential } from "@azure/identity";
import { MaintenanceManagementClient } from "@azure/arm-maintenance";
import { MaintenanceClient } from "@azure/arm-maintenance";

const subscriptionId = "00000000-0000-0000-0000-000000000000";
const credential = new InteractiveBrowserCredential({
tenantId: "<YOUR_TENANT_ID>",
clientId: "<YOUR_CLIENT_ID>",
});
const client = new MaintenanceManagementClient(credential, subscriptionId);
clientId: "<YOUR_CLIENT_ID>"
});
const client = new MaintenanceClient(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

### MaintenanceManagementClient
### MaintenanceClient

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

## Troubleshooting

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

## Contributing

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

This file was deleted.

6 changes: 0 additions & 6 deletions sdk/maintenance/arm-maintenance/assets.json

This file was deleted.

14 changes: 14 additions & 0 deletions sdk/maintenance/arm-maintenance/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",
},
},
]);
Loading