Skip to content
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

[AutoPR @azure-rest/developer-devcenter] Adding IsZoneResilientProvisioningAllowed property in the response for location capabilities api #12315

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
687 changes: 344 additions & 343 deletions common/config/rush/pnpm-lock.yaml

Large diffs are not rendered by default.

89 changes: 4 additions & 85 deletions sdk/devcenter/developer-devcenter-rest/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,87 +1,6 @@
# Release History

## 1.0.1 (Unreleased)

## 1.0.0 (2024-10-08)

### Features Added

### Breaking Changes

### Bugs Fixed

### Other Changes

## 1.0.0 (2024-07-08)

This release targets Azure Dev Center 2023-04-01 General Available API, which is the same version as the previous 1.0.0-beta.3 release.

### Features Added

- Added output types:
- DevBoxActionDelayResultStatusOutput
- DevBoxActionTypeOutput
- DevBoxProvisioningStateOutput
- EnvironmentProvisioningStateOutput
- EnvironmentTypeEnableStatusOutput
- HibernateSupportOutput
- LocalAdminStatusOutput
- OperationStateOutput
- OsTypeOutput
- ParameterTypeOutput
- PoolHealthStatusOutput
- PowerStateOutput
- ScheduledFrequencyOutput
- ScheduledTypeOutput
- SkuNameOutput
- StopOnDisconnectEnableStatusOutput

### Breaking Changes

- Rename interfaces to match operation names in Dev Center API documentation
- ListSchedules was renamed to ListSchedulesByPool
- GetSchedule was renamed to GetScheduleByPool
- ListDevBoxes was renamed to ListDevBoxesByUser
- GetDevBox was renamed to GetDevBoxByUser
- ListDevBoxActions was renamed to ListActions
- GetDevBoxAction was renamed to GetAction
- DelayAllActions was renamed to DelayActions
- ListAllEnvironments was renamed to ListEnvironments
- ListEnvironments was renamed to ListEnvironmentsByUser
- GetEnvironment was renamed to GetEnvironmentByUser
- CreateOrUpdateEnvironment was renamed to CreateOrReplaceEnvironment
- ListCatalogs was renamed to ListCatalogsByProject
- ListEnvironmentDefinitions was renamed to listEnvironmentDefinitionsByProject

## 1.0.0-beta.3 (2023-11-20)
This release updates the Azure DevCenter library to use the 2023-04-01 GA API.

### Breaking Changes

- Environments client now works with "environment definitions" instead of "catalog items"
- Creating a new environment requires passing `environmentDefinitionName` instead of `catalogItemName`
- Creating a new environment requires passing an additional parameter `catalogName`

## 1.0.0-beta.2 (2023-02-07)

This release updates the Azure DevCenter library to use the 2022-11-11-preview API.

### Breaking Changes

- `createClient` now accepts an endpoint URI on construction rather than tenant ID + dev center name.

### Features Added

- Added upcoming actions APIs to dev boxes.
- `/projects/{projectName}/users/{userId}/devboxes/{devBoxName}/upcomingActions`
- `/projects/{projectName}/users/{userId}/devboxes/{devBoxName}/upcomingActions/{upcomingActionId}`
- `/projects/{projectName}/users/{userId}/devboxes/{devBoxName}/upcomingActions/{upcomingActionId}:skip`
- `/projects/{projectName}/users/{userId}/devboxes/{devBoxName}/upcomingActions/{upcomingActionId}:delay`

### Bugs Fixed
- Invalid response types removed from `DeleteDevBox`, `StartDevBox`, and `StopDevBox` APIs.
- Invalid `DeleteEnvironmentAction` API removed from `EnvironmentsClient`.
- Unimplemented artifacts APIs removed from `EnvironmentsClient`.

## 1.0.0-beta.1 (2022-11-11)

### Features Added
Initial release of the Azure DevCenter package
- Added Interface AzureDeveloperDevCenterClientOptions

2 changes: 1 addition & 1 deletion sdk/devcenter/developer-devcenter-rest/LICENSE
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
The MIT License (MIT)

Copyright (c) 2022 Microsoft
Copyright (c) 2024 Microsoft

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
28 changes: 3 additions & 25 deletions sdk/devcenter/developer-devcenter-rest/README.md
Original file line number Diff line number Diff line change
@@ -1,22 +1,13 @@
# Azure DevCenter REST client library for JavaScript


The Azure DevCenter library provides access to manage resources for Microsoft Dev Box and Azure Deployment Environments. This package enables managing developer machines and environments in Azure.

Use the package for Azure DevCenter to:
> Create, access, manage, and delete Dev Box resources
> Create, deploy, manage, and delete Environment resources

DevCenter service

**Please rely heavily on our [REST client docs](https://github.com/Azure/azure-sdk-for-js/blob/main/documentation/rest-clients.md) to use this library**

Key links:

- [Source code](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/devcenter/developer-devcenter-rest)
- [Package (NPM)](https://www.npmjs.com/package/@azure-rest/developer-devcenter)
- [API reference documentation](https://docs.microsoft.com/javascript/api/@azure-rest/developer-devcenter)
- [Samples](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/devcenter/developer-devcenter-rest/samples)

## Getting started

Expand All @@ -27,9 +18,7 @@ Key links:
### Prerequisites

- You must have an [Azure subscription](https://azure.microsoft.com/free/) to use this package.
- You must have [configured](https://learn.microsoft.com/azure/dev-box/quickstart-configure-dev-box-service) a DevCenter, Project, Network Connection, Dev Box Definition, and Pool before you can create Dev Boxes
- You must have [configured](https://learn.microsoft.com/azure/deployment-environments/) a DevCenter, Project, Catalog, and Environment Type before you can create Environments


### Install the `@azure-rest/developer-devcenter` package

Install the Azure DevCenter REST client REST client library for JavaScript with `npm`:
Expand All @@ -50,19 +39,8 @@ After setup, you can choose which type of [credential](https://github.com/Azure/
As an example, [DefaultAzureCredential](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/identity/identity#defaultazurecredential)
can be used to authenticate the client.

Set the value of dev center endpoint as environment variable:
DEVCENTER_ENDPOINT

## Key Concepts

### REST Client

This client is one of our REST clients. We highly recommend you read how to use a REST client [here](https://github.com/Azure/azure-sdk-for-js/blob/main/documentation/rest-clients.md).

### DevCenter Concepts
Dev Boxes refer to managed developer machines running in Azure. Dev Boxes are provisioned in Pools, which define the network and image used for a Dev Box.

Environments refer to templated developer environments, which combine a template (Catalog Item) and parameters, as well as an Environment Type which defines permissions and where the resources are deployed.
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

## Troubleshooting

Expand Down
25 changes: 19 additions & 6 deletions sdk/devcenter/developer-devcenter-rest/api-extractor.json
Original file line number Diff line number Diff line change
@@ -1,18 +1,31 @@
{
"$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
"mainEntryPointFilePath": "./dist/esm/index.d.ts",
"docModel": { "enabled": true },
"apiReport": { "enabled": true, "reportFolder": "./review" },
"docModel": {
"enabled": true
},
"apiReport": {
"enabled": true,
"reportFolder": "./review"
},
"dtsRollup": {
"enabled": true,
"untrimmedFilePath": "",
"publicTrimmedFilePath": "./types/developer-devcenter.d.ts"
},
"messages": {
"tsdocMessageReporting": { "default": { "logLevel": "none" } },
"tsdocMessageReporting": {
"default": {
"logLevel": "none"
}
},
"extractorMessageReporting": {
"ae-missing-release-tag": { "logLevel": "none" },
"ae-unresolved-link": { "logLevel": "none" }
"ae-missing-release-tag": {
"logLevel": "none"
},
"ae-unresolved-link": {
"logLevel": "none"
}
}
}
}
}
6 changes: 0 additions & 6 deletions sdk/devcenter/developer-devcenter-rest/assets.json

This file was deleted.

6 changes: 3 additions & 3 deletions sdk/devcenter/developer-devcenter-rest/eslint.config.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,10 @@ export default [
"@azure/azure-sdk/ts-apiextractor-json-types": "warn",
"@azure/azure-sdk/ts-package-json-types": "warn",
"@azure/azure-sdk/ts-package-json-engine-is-present": "warn",
"tsdoc/syntax": "warn",
"@azure/azure-sdk/ts-package-json-module": "off",
"@azure/azure-sdk/ts-package-json-files-required": "off",
"@azure/azure-sdk/ts-package-json-main-is-cjs": "off",
},
},
"tsdoc/syntax": "warn"
}
}
];
133 changes: 0 additions & 133 deletions sdk/devcenter/developer-devcenter-rest/karma.conf.js

This file was deleted.

Loading