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

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

# PRLabel: %Mgmt
Expand Down
27 changes: 21 additions & 6 deletions pnpm-lock.yaml

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

40 changes: 28 additions & 12 deletions sdk/serialconsole/arm-serialconsole/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,21 +1,37 @@
# Release History

## 2.1.2 (Unreleased)
## 3.0.0-beta.1 (2026-05-19)
Compared with version 2.1.0

### Features Added
- Added operation group SerialConsoleOperationGroupOperations
- Added Interface DisableSerialConsoleResultProperties
- Added Interface EnableSerialConsoleResultProperties
Comment thread
JialinHuang803 marked this conversation as resolved.
Outdated
- Added Interface SerialConsoleOperationGroupDisableConsoleOptionalParams
- Added Interface SerialConsoleOperationGroupEnableConsoleOptionalParams
- Added Interface SerialConsoleStatusProperties
- Added Interface SerialPortProperties
- Added Interface SystemData
- Interface ProxyResource has a new optional parameter systemData
- Interface Resource has a new optional parameter systemData
- Interface SerialConsoleStatus has a new optional parameter properties
- Interface SerialPort has a new optional parameter connectionState
- Interface SerialPort has a new optional parameter systemData
- Added Type Alias AzureSupportedClouds
- Added Type Alias CreatedByType
- Added Type Alias SerialPortConnectionState
- Added Enum AzureClouds
- Added Enum KnownCreatedByType
- Added Enum KnownVersions

### Breaking Changes
- Removed operation SerialPorts.delete
- Removed Interface DisableConsoleOptionalParams
- Removed Interface EnableConsoleOptionalParams
- Removed Interface SerialPortsDeleteOptionalParams
- Interface SerialConsoleStatus no longer has parameter disabled

### Bugs Fixed

### Other Changes

## 2.1.1 (2025-08-22)

### Other Changes

- Other fixes


## 2.1.0 (2022-12-09)

### Features Added
Expand All @@ -37,4 +53,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/serialconsole/arm-serialconsole/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: 10 additions & 13 deletions sdk/serialconsole/arm-serialconsole/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

The Azure Serial Console allows you to access the serial console of a Virtual Machine or VM scale set instance

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

## Getting started

Expand Down Expand Up @@ -35,7 +37,7 @@ npm install @azure/arm-serialconsole
To create a client object to access the Azure MicrosoftSerialConsole API, you will need the `endpoint` of your Azure MicrosoftSerialConsole resource and a `credential`. The Azure MicrosoftSerialConsole client can use Azure Active Directory credentials to authenticate.
You can find the endpoint for your Azure MicrosoftSerialConsole 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 MicrosoftSerialConsole** 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 @@ -64,16 +65,16 @@ For browser environments, use the `InteractiveBrowserCredential` from the `@azur
import { InteractiveBrowserCredential } from "@azure/identity";
import { MicrosoftSerialConsoleClient } from "@azure/arm-serialconsole";

const subscriptionId = "00000000-0000-0000-0000-000000000000";
const credential = new InteractiveBrowserCredential({
tenantId: "<YOUR_TENANT_ID>",
clientId: "<YOUR_CLIENT_ID>",
});
const subscriptionId = "00000000-0000-0000-0000-000000000000";
const client = new MicrosoftSerialConsoleClient(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
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/serialconsole/arm-serialconsole/samples) directory for detailed examples on how to use this library.

## Contributing

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

This file was deleted.

4 changes: 1 addition & 3 deletions sdk/serialconsole/arm-serialconsole/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/serialconsole/arm-serialconsole/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/serialconsole/arm-serialconsole",
"Tag": "js/serialconsole/arm-serialconsole_b87bf18d31"
"Tag": "js/serialconsole/arm-serialconsole_f7aec331ac"
}
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-serialconsole": [
"../dist/esm"
]
"@azure/arm-serialconsole": ["../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-serialconsole": ["../src/index.ts"],
"@azure/arm-serialconsole/*": ["../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-serialconsole": ["../src/index.ts"],
"@azure/arm-serialconsole/*": ["../src/*"],
"$internal/*": ["../src/*"]
}
}
}
6 changes: 3 additions & 3 deletions sdk/serialconsole/arm-serialconsole/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
43 changes: 43 additions & 0 deletions sdk/serialconsole/arm-serialconsole/metadata.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
{
"apiVersions": {
"Microsoft.SerialConsole": "2024-07-01"
},
"emitterVersion": "0.53.2",
"crossLanguageDefinitions": {
"CrossLanguagePackageId": "Microsoft.SerialConsole",
"CrossLanguageDefinitionId": {
"@azure/arm-serialconsole!SerialConsoleStatus:interface": "Microsoft.SerialConsole.SerialConsoleStatus",
"@azure/arm-serialconsole!SerialConsoleStatusProperties:interface": "Microsoft.SerialConsole.SerialConsoleStatusProperties",
"@azure/arm-serialconsole!GetSerialConsoleSubscriptionNotFound:interface": "Microsoft.SerialConsole.GetSerialConsoleSubscriptionNotFound",
"@azure/arm-serialconsole!CloudError:interface": "Microsoft.SerialConsole.CloudError",
"@azure/arm-serialconsole!CloudErrorBody:interface": "Microsoft.SerialConsole.CloudErrorBody",
"@azure/arm-serialconsole!SerialConsoleOperations:interface": "Microsoft.SerialConsole.SerialConsoleOperations",
"@azure/arm-serialconsole!SerialConsoleOperationsValueItem:interface": "Microsoft.SerialConsole.SerialConsoleOperationsValueItem",
"@azure/arm-serialconsole!SerialConsoleOperationsValueItemDisplay:interface": "Microsoft.SerialConsole.SerialConsoleOperationsValueItemDisplay",
"@azure/arm-serialconsole!SerialPort:interface": "Microsoft.SerialConsole.SerialPort",
"@azure/arm-serialconsole!SerialPortProperties:interface": "Microsoft.SerialConsole.SerialPortProperties",
"@azure/arm-serialconsole!ProxyResource:interface": "Azure.ResourceManager.CommonTypes.ProxyResource",
"@azure/arm-serialconsole!Resource:interface": "Azure.ResourceManager.CommonTypes.Resource",
"@azure/arm-serialconsole!SystemData:interface": "Azure.ResourceManager.CommonTypes.SystemData",
"@azure/arm-serialconsole!SerialPortListResult:interface": "Microsoft.SerialConsole.SerialPortListResult",
"@azure/arm-serialconsole!SerialPortConnectResult:interface": "Microsoft.SerialConsole.SerialPortConnectResult",
"@azure/arm-serialconsole!DisableSerialConsoleResult:interface": "Microsoft.SerialConsole.DisableSerialConsoleResult",
"@azure/arm-serialconsole!DisableSerialConsoleResultProperties:interface": "Microsoft.SerialConsole.DisableSerialConsoleResultProperties",
"@azure/arm-serialconsole!EnableSerialConsoleResult:interface": "Microsoft.SerialConsole.EnableSerialConsoleResult",
"@azure/arm-serialconsole!EnableSerialConsoleResultProperties:interface": "Microsoft.SerialConsole.EnableSerialConsoleResultProperties",
"@azure/arm-serialconsole!KnownSerialPortState:enum": "Microsoft.SerialConsole.SerialPortState",
"@azure/arm-serialconsole!KnownSerialPortConnectionState:enum": "Microsoft.SerialConsole.SerialPortConnectionState",
"@azure/arm-serialconsole!KnowncreatedByType:enum": "Azure.ResourceManager.CommonTypes.createdByType",
"@azure/arm-serialconsole!KnownVersions:enum": "Microsoft.SerialConsole.Versions",
"@azure/arm-serialconsole!MicrosoftSerialConsoleClient#ListOperations:member(1)": "Microsoft.SerialConsole.Operations.list",
"@azure/arm-serialconsole!MicrosoftSerialConsoleClient#getConsoleStatus:member(1)": "Microsoft.SerialConsole.getConsoleStatus",
"@azure/arm-serialconsole!SerialConsoleOperationGroupOperations#enableConsole:member": "Microsoft.SerialConsole.SerialConsoleOperationGroup.enableConsole",
"@azure/arm-serialconsole!SerialConsoleOperationGroupOperations#disableConsole:member": "Microsoft.SerialConsole.SerialConsoleOperationGroup.disableConsole",
"@azure/arm-serialconsole!SerialPortsOperations#connect:member": "Microsoft.SerialConsole.SerialPorts.connect",
"@azure/arm-serialconsole!SerialPortsOperations#listBySubscriptions:member": "Microsoft.SerialConsole.SerialPorts.listBySubscriptions",
"@azure/arm-serialconsole!SerialPortsOperations#list:member": "Microsoft.SerialConsole.SerialPorts.list",
"@azure/arm-serialconsole!SerialPortsOperations#create:member": "Microsoft.SerialConsole.SerialPorts.create",
"@azure/arm-serialconsole!SerialPortsOperations#get:member": "Microsoft.SerialConsole.SerialPorts.get"
}
}
}
Loading
Loading