diff --git a/sdk/orbital/arm-orbital/CHANGELOG.md b/sdk/orbital/arm-orbital/CHANGELOG.md index efab2ba31f71..ddcd45eac98f 100644 --- a/sdk/orbital/arm-orbital/CHANGELOG.md +++ b/sdk/orbital/arm-orbital/CHANGELOG.md @@ -1,15 +1,11 @@ # Release History + +## 1.0.0-beta.2 (2021-12-27) + +The package of @azure/arm-orbital is using our next generation design principles since version 1.0.0-beta.2, which contains breaking changes. -## 1.0.0-beta.2 (Unreleased) +To understand the detail of the change, please refer to [Changelog](https://aka.ms/js-track2-changelog). -### Features Added +To migrate the existing applications to the latest version, please refer to [Migration Guide](https://aka.ms/js-track2-migration-guide). -### Breaking Changes - -### Bugs Fixed - -### Other Changes - -## 1.0.0-beta.1 (2021-11-22) - - - Initial Release +To learn more, please refer to our documentation [Quick Start](https://aka.ms/js-track2-quickstart). diff --git a/sdk/orbital/arm-orbital/_meta.json b/sdk/orbital/arm-orbital/_meta.json index e6c3f1ddd89a..21527487968d 100644 --- a/sdk/orbital/arm-orbital/_meta.json +++ b/sdk/orbital/arm-orbital/_meta.json @@ -1,7 +1,7 @@ { - "commit": "e827b527ff33475b4b561d445f06bf4b184e3efe", + "commit": "c77c6c634dc3644d65d3e35df5d73a9c34d3c956", "readme": "specification/orbital/resource-manager/readme.md", - "autorest_command": "autorest --version=3.1.3 --typescript --modelerfour.lenient-model-deduplication --head-as-boolean=true --license-header=MICROSOFT_MIT_NO_VERSION --generate-test --typescript-sdks-folder=D:\\mydev\\azure-sdk-for-js ../azure-rest-api-specs/specification/orbital/resource-manager/readme.md --use=@autorest/typescript@6.0.0-alpha.15.20211116.1", + "autorest_command": "autorest --version=3.1.3 --typescript --modelerfour.lenient-model-deduplication --head-as-boolean=true --license-header=MICROSOFT_MIT_NO_VERSION --generate-test --typescript-sdks-folder=D:\\mydev\\azure-sdk-for-js ../azure-rest-api-specs/specification/orbital/resource-manager/readme.md --use=@autorest/typescript@6.0.0-alpha.16.20211217.1", "repository_url": "https://github.com/Azure/azure-rest-api-specs.git", - "use": "@autorest/typescript@6.0.0-alpha.15.20211116.1" + "use": "@autorest/typescript@6.0.0-alpha.16.20211217.1" } \ No newline at end of file diff --git a/sdk/orbital/arm-orbital/package.json b/sdk/orbital/arm-orbital/package.json index aeeff6ffdbd7..5824cdfacc73 100644 --- a/sdk/orbital/arm-orbital/package.json +++ b/sdk/orbital/arm-orbital/package.json @@ -4,9 +4,7 @@ "author": "Microsoft Corporation", "description": "A generated SDK for AzureOrbital.", "version": "1.0.0-beta.2", - "engines": { - "node": ">=12.0.0" - }, + "engines": { "node": ">=12.0.0" }, "dependencies": { "@azure/core-lro": "^2.2.0", "@azure/abort-controller": "^1.0.0", @@ -16,13 +14,7 @@ "@azure/core-rest-pipeline": "^1.1.0", "tslib": "^2.2.0" }, - "keywords": [ - "node", - "azure", - "typescript", - "browser", - "isomorphic" - ], + "keywords": ["node", "azure", "typescript", "browser", "isomorphic"], "license": "MIT", "main": "./dist/index.js", "module": "./dist-esm/src/index.js", @@ -49,9 +41,7 @@ "type": "git", "url": "https://github.com/Azure/azure-sdk-for-js.git" }, - "bugs": { - "url": "https://github.com/Azure/azure-sdk-for-js/issues" - }, + "bugs": { "url": "https://github.com/Azure/azure-sdk-for-js/issues" }, "files": [ "dist/**/*.js", "dist/**/*.js.map", diff --git a/sdk/orbital/arm-orbital/review/arm-orbital.api.md b/sdk/orbital/arm-orbital/review/arm-orbital.api.md index cfe46bc64b8d..653bbd902fe0 100644 --- a/sdk/orbital/arm-orbital/review/arm-orbital.api.md +++ b/sdk/orbital/arm-orbital/review/arm-orbital.api.md @@ -87,9 +87,13 @@ export interface AvailableGroundStationsListByCapabilityOptionalParams extends c export type AvailableGroundStationsListByCapabilityResponse = AvailableGroundStationListResult; // @public (undocumented) -export class AzureOrbital extends AzureOrbitalContext { +export class AzureOrbital extends coreClient.ServiceClient { + // (undocumented) + $host: string; constructor(credentials: coreAuth.TokenCredential, subscriptionId: string, options?: AzureOrbitalOptionalParams); // (undocumented) + apiVersion: string; + // (undocumented) availableGroundStations: AvailableGroundStations; // (undocumented) contactProfiles: ContactProfiles; @@ -99,15 +103,6 @@ export class AzureOrbital extends AzureOrbitalContext { operations: Operations; // (undocumented) spacecrafts: Spacecrafts; -} - -// @public (undocumented) -export class AzureOrbitalContext extends coreClient.ServiceClient { - // (undocumented) - $host: string; - constructor(credentials: coreAuth.TokenCredential, subscriptionId: string, options?: AzureOrbitalOptionalParams); - // (undocumented) - apiVersion: string; // (undocumented) subscriptionId: string; } @@ -175,6 +170,7 @@ export type ContactProfile = TrackedResource & { minimumViableContactDuration?: string; minimumElevationDegrees?: number; autoTrackingConfiguration?: AutoTrackingConfiguration; + eventHubUri?: string; links?: ContactProfileLink[]; }; @@ -219,6 +215,7 @@ export interface ContactProfiles { // @public export interface ContactProfilesCreateOrUpdateOptionalParams extends coreClient.OperationOptions { autoTrackingConfiguration?: AutoTrackingConfiguration; + eventHubUri?: string; links?: ContactProfileLink[]; minimumElevationDegrees?: number; minimumViableContactDuration?: string; diff --git a/sdk/orbital/arm-orbital/src/azureOrbital.ts b/sdk/orbital/arm-orbital/src/azureOrbital.ts index dcc71c01d0c9..f23108ff9021 100644 --- a/sdk/orbital/arm-orbital/src/azureOrbital.ts +++ b/sdk/orbital/arm-orbital/src/azureOrbital.ts @@ -6,6 +6,7 @@ * Changes may cause incorrect behavior and will be lost if the code is regenerated. */ +import * as coreClient from "@azure/core-client"; import * as coreAuth from "@azure/core-auth"; import { OperationsImpl, @@ -21,10 +22,13 @@ import { ContactProfiles, AvailableGroundStations } from "./operationsInterfaces"; -import { AzureOrbitalContext } from "./azureOrbitalContext"; import { AzureOrbitalOptionalParams } from "./models"; -export class AzureOrbital extends AzureOrbitalContext { +export class AzureOrbital extends coreClient.ServiceClient { + $host: string; + apiVersion: string; + subscriptionId: string; + /** * Initializes a new instance of the AzureOrbital class. * @param credentials Subscription credentials which uniquely identify client subscription. @@ -36,7 +40,46 @@ export class AzureOrbital extends AzureOrbitalContext { subscriptionId: string, options?: AzureOrbitalOptionalParams ) { - super(credentials, subscriptionId, options); + if (credentials === undefined) { + throw new Error("'credentials' cannot be null"); + } + if (subscriptionId === undefined) { + throw new Error("'subscriptionId' cannot be null"); + } + + // Initializing default values for options + if (!options) { + options = {}; + } + const defaults: AzureOrbitalOptionalParams = { + requestContentType: "application/json; charset=utf-8", + credential: credentials + }; + + const packageDetails = `azsdk-js-arm-orbital/1.0.0-beta.2`; + const userAgentPrefix = + options.userAgentOptions && options.userAgentOptions.userAgentPrefix + ? `${options.userAgentOptions.userAgentPrefix} ${packageDetails}` + : `${packageDetails}`; + + if (!options.credentialScopes) { + options.credentialScopes = ["https://management.azure.com/.default"]; + } + const optionsWithDefaults = { + ...defaults, + ...options, + userAgentOptions: { + userAgentPrefix + }, + baseUri: options.endpoint || "https://management.azure.com" + }; + super(optionsWithDefaults); + // Parameter assignments + this.subscriptionId = subscriptionId; + + // Assigning values to Constant parameters + this.$host = options.$host || "https://management.azure.com"; + this.apiVersion = options.apiVersion || "2021-04-04-preview"; this.operations = new OperationsImpl(this); this.spacecrafts = new SpacecraftsImpl(this); this.contacts = new ContactsImpl(this); diff --git a/sdk/orbital/arm-orbital/src/azureOrbitalContext.ts b/sdk/orbital/arm-orbital/src/azureOrbitalContext.ts deleted file mode 100644 index d049a4ec40c5..000000000000 --- a/sdk/orbital/arm-orbital/src/azureOrbitalContext.ts +++ /dev/null @@ -1,70 +0,0 @@ -/* - * Copyright (c) Microsoft Corporation. - * Licensed under the MIT License. - * - * Code generated by Microsoft (R) AutoRest Code Generator. - * Changes may cause incorrect behavior and will be lost if the code is regenerated. - */ - -import * as coreClient from "@azure/core-client"; -import * as coreAuth from "@azure/core-auth"; -import { AzureOrbitalOptionalParams } from "./models"; - -export class AzureOrbitalContext extends coreClient.ServiceClient { - $host: string; - apiVersion: string; - subscriptionId: string; - - /** - * Initializes a new instance of the AzureOrbitalContext class. - * @param credentials Subscription credentials which uniquely identify client subscription. - * @param subscriptionId The ID of the target subscription. - * @param options The parameter options - */ - constructor( - credentials: coreAuth.TokenCredential, - subscriptionId: string, - options?: AzureOrbitalOptionalParams - ) { - if (credentials === undefined) { - throw new Error("'credentials' cannot be null"); - } - if (subscriptionId === undefined) { - throw new Error("'subscriptionId' cannot be null"); - } - - // Initializing default values for options - if (!options) { - options = {}; - } - const defaults: AzureOrbitalOptionalParams = { - requestContentType: "application/json; charset=utf-8", - credential: credentials - }; - - const packageDetails = `azsdk-js-arm-orbital/1.0.0-beta.1`; - const userAgentPrefix = - options.userAgentOptions && options.userAgentOptions.userAgentPrefix - ? `${options.userAgentOptions.userAgentPrefix} ${packageDetails}` - : `${packageDetails}`; - - if (!options.credentialScopes) { - options.credentialScopes = ["https://management.azure.com/.default"]; - } - const optionsWithDefaults = { - ...defaults, - ...options, - userAgentOptions: { - userAgentPrefix - }, - baseUri: options.endpoint || "https://management.azure.com" - }; - super(optionsWithDefaults); - // Parameter assignments - this.subscriptionId = subscriptionId; - - // Assigning values to Constant parameters - this.$host = options.$host || "https://management.azure.com"; - this.apiVersion = options.apiVersion || "2021-04-04-preview"; - } -} diff --git a/sdk/orbital/arm-orbital/src/index.ts b/sdk/orbital/arm-orbital/src/index.ts index bfb40c359e8f..c09831bede21 100644 --- a/sdk/orbital/arm-orbital/src/index.ts +++ b/sdk/orbital/arm-orbital/src/index.ts @@ -9,5 +9,4 @@ /// export * from "./models"; export { AzureOrbital } from "./azureOrbital"; -export { AzureOrbitalContext } from "./azureOrbitalContext"; export * from "./operationsInterfaces"; diff --git a/sdk/orbital/arm-orbital/src/models/index.ts b/sdk/orbital/arm-orbital/src/models/index.ts index 5b0a284b4008..d4525a2a2bfc 100644 --- a/sdk/orbital/arm-orbital/src/models/index.ts +++ b/sdk/orbital/arm-orbital/src/models/index.ts @@ -421,6 +421,8 @@ export type ContactProfile = TrackedResource & { minimumElevationDegrees?: number; /** Auto track configuration. */ autoTrackingConfiguration?: AutoTrackingConfiguration; + /** The URI of the Event Hub used for telemetry */ + eventHubUri?: string; /** Links of the Contact Profile */ links?: ContactProfileLink[]; }; @@ -779,6 +781,8 @@ export interface ContactProfilesCreateOrUpdateOptionalParams minimumElevationDegrees?: number; /** Auto track configuration. */ autoTrackingConfiguration?: AutoTrackingConfiguration; + /** The URI of the Event Hub used for telemetry */ + eventHubUri?: string; /** Links of the Contact Profile */ links?: ContactProfileLink[]; /** Delay to wait until next poll, in milliseconds. */ diff --git a/sdk/orbital/arm-orbital/src/models/mappers.ts b/sdk/orbital/arm-orbital/src/models/mappers.ts index 07c1cdf1fb6d..0c257c38bc0c 100644 --- a/sdk/orbital/arm-orbital/src/models/mappers.ts +++ b/sdk/orbital/arm-orbital/src/models/mappers.ts @@ -968,6 +968,12 @@ export const ContactProfile: coreClient.CompositeMapper = { allowedValues: ["disabled", "xBand", "sBand"] } }, + eventHubUri: { + serializedName: "properties.eventHubUri", + type: { + name: "String" + } + }, links: { serializedName: "properties.links", type: { diff --git a/sdk/orbital/arm-orbital/src/models/parameters.ts b/sdk/orbital/arm-orbital/src/models/parameters.ts index b0ce28d22075..12d0a82cada7 100644 --- a/sdk/orbital/arm-orbital/src/models/parameters.ts +++ b/sdk/orbital/arm-orbital/src/models/parameters.ts @@ -219,6 +219,11 @@ export const autoTrackingConfiguration: OperationParameter = { mapper: ContactProfileMapper }; +export const eventHubUri: OperationParameter = { + parameterPath: ["options", "eventHubUri"], + mapper: ContactProfileMapper +}; + export const links1: OperationParameter = { parameterPath: ["options", "links"], mapper: ContactProfileMapper diff --git a/sdk/orbital/arm-orbital/src/operations/availableGroundStations.ts b/sdk/orbital/arm-orbital/src/operations/availableGroundStations.ts index bd49ef5188ff..5df25eab882a 100644 --- a/sdk/orbital/arm-orbital/src/operations/availableGroundStations.ts +++ b/sdk/orbital/arm-orbital/src/operations/availableGroundStations.ts @@ -11,7 +11,7 @@ import { AvailableGroundStations } from "../operationsInterfaces"; import * as coreClient from "@azure/core-client"; import * as Mappers from "../models/mappers"; import * as Parameters from "../models/parameters"; -import { AzureOrbitalContext } from "../azureOrbitalContext"; +import { AzureOrbital } from "../azureOrbital"; import { AvailableGroundStation, Enum6, @@ -26,13 +26,13 @@ import { /// /** Class containing AvailableGroundStations operations. */ export class AvailableGroundStationsImpl implements AvailableGroundStations { - private readonly client: AzureOrbitalContext; + private readonly client: AzureOrbital; /** * Initialize a new instance of the class AvailableGroundStations class. * @param client Reference to the service client */ - constructor(client: AzureOrbitalContext) { + constructor(client: AzureOrbital) { this.client = client; } diff --git a/sdk/orbital/arm-orbital/src/operations/contactProfiles.ts b/sdk/orbital/arm-orbital/src/operations/contactProfiles.ts index 2c10f9fca1cd..dba0196a58cb 100644 --- a/sdk/orbital/arm-orbital/src/operations/contactProfiles.ts +++ b/sdk/orbital/arm-orbital/src/operations/contactProfiles.ts @@ -11,7 +11,7 @@ import { ContactProfiles } from "../operationsInterfaces"; import * as coreClient from "@azure/core-client"; import * as Mappers from "../models/mappers"; import * as Parameters from "../models/parameters"; -import { AzureOrbitalContext } from "../azureOrbitalContext"; +import { AzureOrbital } from "../azureOrbital"; import { PollerLike, PollOperationState, LroEngine } from "@azure/core-lro"; import { LroImpl } from "../lroImpl"; import { @@ -33,13 +33,13 @@ import { /// /** Class containing ContactProfiles operations. */ export class ContactProfilesImpl implements ContactProfiles { - private readonly client: AzureOrbitalContext; + private readonly client: AzureOrbital; /** * Initialize a new instance of the class ContactProfiles class. * @param client Reference to the service client */ - constructor(client: AzureOrbitalContext) { + constructor(client: AzureOrbital) { this.client = client; } @@ -408,6 +408,7 @@ const createOrUpdateOperationSpec: coreClient.OperationSpec = { minimumViableContactDuration: ["options", "minimumViableContactDuration"], minimumElevationDegrees: ["options", "minimumElevationDegrees"], autoTrackingConfiguration: ["options", "autoTrackingConfiguration"], + eventHubUri: ["options", "eventHubUri"], links: ["options", "links"] }, mapper: { ...Mappers.ContactProfile, required: true } diff --git a/sdk/orbital/arm-orbital/src/operations/contacts.ts b/sdk/orbital/arm-orbital/src/operations/contacts.ts index c11b51ddc294..279101a90e04 100644 --- a/sdk/orbital/arm-orbital/src/operations/contacts.ts +++ b/sdk/orbital/arm-orbital/src/operations/contacts.ts @@ -11,7 +11,7 @@ import { Contacts } from "../operationsInterfaces"; import * as coreClient from "@azure/core-client"; import * as Mappers from "../models/mappers"; import * as Parameters from "../models/parameters"; -import { AzureOrbitalContext } from "../azureOrbitalContext"; +import { AzureOrbital } from "../azureOrbital"; import { PollerLike, PollOperationState, LroEngine } from "@azure/core-lro"; import { LroImpl } from "../lroImpl"; import { @@ -28,13 +28,13 @@ import { /// /** Class containing Contacts operations. */ export class ContactsImpl implements Contacts { - private readonly client: AzureOrbitalContext; + private readonly client: AzureOrbital; /** * Initialize a new instance of the class Contacts class. * @param client Reference to the service client */ - constructor(client: AzureOrbitalContext) { + constructor(client: AzureOrbital) { this.client = client; } diff --git a/sdk/orbital/arm-orbital/src/operations/operations.ts b/sdk/orbital/arm-orbital/src/operations/operations.ts index 411ec0dc3304..22b00e7d4f1c 100644 --- a/sdk/orbital/arm-orbital/src/operations/operations.ts +++ b/sdk/orbital/arm-orbital/src/operations/operations.ts @@ -11,7 +11,7 @@ import { Operations } from "../operationsInterfaces"; import * as coreClient from "@azure/core-client"; import * as Mappers from "../models/mappers"; import * as Parameters from "../models/parameters"; -import { AzureOrbitalContext } from "../azureOrbitalContext"; +import { AzureOrbital } from "../azureOrbital"; import { Operation, OperationsListOptionalParams, @@ -21,13 +21,13 @@ import { /// /** Class containing Operations operations. */ export class OperationsImpl implements Operations { - private readonly client: AzureOrbitalContext; + private readonly client: AzureOrbital; /** * Initialize a new instance of the class Operations class. * @param client Reference to the service client */ - constructor(client: AzureOrbitalContext) { + constructor(client: AzureOrbital) { this.client = client; } diff --git a/sdk/orbital/arm-orbital/src/operations/spacecrafts.ts b/sdk/orbital/arm-orbital/src/operations/spacecrafts.ts index ef2ab19a3d8f..d98473826dcc 100644 --- a/sdk/orbital/arm-orbital/src/operations/spacecrafts.ts +++ b/sdk/orbital/arm-orbital/src/operations/spacecrafts.ts @@ -11,7 +11,7 @@ import { Spacecrafts } from "../operationsInterfaces"; import * as coreClient from "@azure/core-client"; import * as Mappers from "../models/mappers"; import * as Parameters from "../models/parameters"; -import { AzureOrbitalContext } from "../azureOrbitalContext"; +import { AzureOrbital } from "../azureOrbital"; import { PollerLike, PollOperationState, LroEngine } from "@azure/core-lro"; import { LroImpl } from "../lroImpl"; import { @@ -36,13 +36,13 @@ import { /// /** Class containing Spacecrafts operations. */ export class SpacecraftsImpl implements Spacecrafts { - private readonly client: AzureOrbitalContext; + private readonly client: AzureOrbital; /** * Initialize a new instance of the class Spacecrafts class. * @param client Reference to the service client */ - constructor(client: AzureOrbitalContext) { + constructor(client: AzureOrbital) { this.client = client; }