diff --git a/common/config/rush/pnpm-lock.yaml b/common/config/rush/pnpm-lock.yaml index 8e099cee31d4..c40fa23f229c 100644 --- a/common/config/rush/pnpm-lock.yaml +++ b/common/config/rush/pnpm-lock.yaml @@ -3925,7 +3925,7 @@ packages: dependencies: semver: 7.3.8 shelljs: 0.8.5 - typescript: 5.1.0-dev.20230227 + typescript: 5.1.0-dev.20230301 dev: false /ecdsa-sig-formatter/1.0.11: @@ -8644,8 +8644,8 @@ packages: hasBin: true dev: false - /typescript/5.1.0-dev.20230227: - resolution: {integrity: sha512-nPxrgb/3C40X3eXsCPUpiVEgQltswKoAh3Zwm7tDIVE4ldDr3flXq63odqyWUuOZFc/+NCFdm80RpTB0nz2M8w==} + /typescript/5.1.0-dev.20230301: + resolution: {integrity: sha512-aJ0PIgQ00zlf9npD2tri7MWDAooMoh3iIn4v0hAMSRCSKqJjTzt7fVopvdtbvWPKripipxeXnX5mhkBZcGrEKQ==} engines: {node: '>=4.2.0'} hasBin: true dev: false @@ -13499,15 +13499,15 @@ packages: dev: false file:projects/arm-orbital.tgz: - resolution: {integrity: sha512-jtAxUepcGECrA5FsDvJxDWqN2M2CAcWLzADq8Tq2D18Qil1+UcGsHAi+auL1cxIIveqhlKVsIbuwGVFs+OhH3Q==, tarball: file:projects/arm-orbital.tgz} + resolution: {integrity: sha512-PhmeI2kkcPla0JWQ7eezXYevqIoL0QBXkZ3KmwSN4v/LvpYhObq28mQ3JQpptKR0Ty4sbVbbYEfYlrCvP9Tj3w==, tarball: file:projects/arm-orbital.tgz} name: '@rush-temp/arm-orbital' version: 0.0.0 dependencies: '@azure/identity': 2.1.0 '@microsoft/api-extractor': 7.34.4_@types+node@14.18.36 - '@rollup/plugin-commonjs': 24.0.1_rollup@2.79.1 - '@rollup/plugin-json': 6.0.0_rollup@2.79.1 - '@rollup/plugin-multi-entry': 6.0.0_rollup@2.79.1 + '@rollup/plugin-commonjs': 21.1.0_rollup@2.79.1 + '@rollup/plugin-json': 4.1.0_rollup@2.79.1 + '@rollup/plugin-multi-entry': 4.1.0_rollup@2.79.1 '@rollup/plugin-node-resolve': 13.3.0_rollup@2.79.1 '@types/chai': 4.3.4 '@types/node': 14.18.36 @@ -19076,7 +19076,7 @@ packages: dev: false file:projects/storage-file-datalake.tgz: - resolution: {integrity: sha512-xuXx7xw2PY3EfFu3Y2ZhtncwocIC2pYEbZudC76SeEw2+SFX58NBKRvspIr6XKH0CYFLtIeflkeCwmjc1WsCdw==, tarball: file:projects/storage-file-datalake.tgz} + resolution: {integrity: sha512-H+1+hOCQ8fol8EJZj522Y1j1k5pE72nNkgDzgnP+gUOIh0KlNsHDjHCh2+keKPNZcq6fU1joESBcwUbHoZ7QKw==, tarball: file:projects/storage-file-datalake.tgz} name: '@rush-temp/storage-file-datalake' version: 0.0.0 dependencies: diff --git a/sdk/orbital/arm-orbital/CHANGELOG.md b/sdk/orbital/arm-orbital/CHANGELOG.md index 296009ca02ab..8d6da0166a78 100644 --- a/sdk/orbital/arm-orbital/CHANGELOG.md +++ b/sdk/orbital/arm-orbital/CHANGELOG.md @@ -1,15 +1,55 @@ # Release History + +## 2.0.0 (2023-03-02) + +**Features** -## 1.2.1 (Unreleased) - -### Features Added - -### Breaking Changes - -### Bugs Fixed + - Added Interface ContactProfileThirdPartyConfiguration + - Added Interface ErrorAdditionalInfo + - Added Interface ErrorDetail + - Added Interface ErrorResponse + - Added Type Alias ContactsStatus + - Interface ContactProfile has a new optional parameter thirdPartyConfigurations + - Interface ContactProfilesCreateOrUpdateOptionalParams has a new optional parameter thirdPartyConfigurations + - Interface ContactProfilesProperties has a new optional parameter thirdPartyConfigurations + - Interface OperationResult has a new optional parameter nextLink + - Interface OperationResult has a new optional parameter value + - Added Enum KnownContactsStatus + - Added Enum KnownStatus -### Other Changes +**Breaking Changes** + - Removed operation AvailableGroundStations.get + - Operation ContactProfiles.beginCreateOrUpdate has a new signature + - Operation ContactProfiles.beginCreateOrUpdateAndWait has a new signature + - Operation Spacecrafts.beginCreateOrUpdate has a new signature + - Operation Spacecrafts.beginCreateOrUpdateAndWait has a new signature + - Interface Contact no longer has parameter etag + - Interface ContactProfile no longer has parameter etag + - Interface ContactProfilesCreateOrUpdateOptionalParams no longer has parameter links + - Interface ContactProfilesCreateOrUpdateOptionalParams no longer has parameter networkConfiguration + - Interface Spacecraft no longer has parameter etag + - Interface SpacecraftsCreateOrUpdateOptionalParams no longer has parameter links + - Interface SpacecraftsCreateOrUpdateOptionalParams no longer has parameter titleLine + - Interface SpacecraftsCreateOrUpdateOptionalParams no longer has parameter tleLine1 + - Interface SpacecraftsCreateOrUpdateOptionalParams no longer has parameter tleLine2 + - Parameter expirationDate of interface AuthorizedGroundstation is now required + - Parameter groundStation of interface AuthorizedGroundstation is now required + - Parameter contactProfile of interface Contact is now required + - Parameter groundStationName of interface Contact is now required + - Parameter reservationEndTime of interface Contact is now required + - Parameter reservationStartTime of interface Contact is now required + - Parameter links of interface ContactProfile is now required + - Parameter networkConfiguration of interface ContactProfile is now required + - Parameter id of interface ResourceReference is now required + - Parameter links of interface Spacecraft is now required + - Parameter titleLine of interface Spacecraft is now required + - Parameter tleLine1 of interface Spacecraft is now required + - Parameter tleLine2 of interface Spacecraft is now required + - Type of parameter status of interface Contact is changed from Status to ContactsStatus + - Removed Enum KnownApiVersionParameter + + ## 1.2.0 (2023-01-30) **Features** diff --git a/sdk/orbital/arm-orbital/README.md b/sdk/orbital/arm-orbital/README.md index cf6f07d9ca7e..e57f063d8f61 100644 --- a/sdk/orbital/arm-orbital/README.md +++ b/sdk/orbital/arm-orbital/README.md @@ -2,7 +2,7 @@ This package contains an isomorphic SDK (runs both in Node.js and in browsers) for AzureOrbital client. -Azure Orbital service +Azure Orbital service. [Source code](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/orbital/arm-orbital) | [Package (NPM)](https://www.npmjs.com/package/@azure/arm-orbital) | diff --git a/sdk/orbital/arm-orbital/_meta.json b/sdk/orbital/arm-orbital/_meta.json index f8508919140d..4cfe05091fbc 100644 --- a/sdk/orbital/arm-orbital/_meta.json +++ b/sdk/orbital/arm-orbital/_meta.json @@ -1,8 +1,8 @@ { - "commit": "08894fa8d66cb44dc62a73f7a09530f905985fa3", - "readme": "specification\\orbital\\resource-manager\\readme.md", - "autorest_command": "autorest --version=3.9.3 --typescript --modelerfour.lenient-model-deduplication --azure-arm --head-as-boolean=true --license-header=MICROSOFT_MIT_NO_VERSION --generate-test --typescript-sdks-folder=F:\\azure-sdk-for-js ..\\azure-rest-api-specs\\specification\\orbital\\resource-manager\\readme.md --use=@autorest/typescript@6.0.0-rc.7 --generate-sample=true", + "commit": "fa6baee349c5599b261f20905d970914e5e6ca42", + "readme": "specification/orbital/resource-manager/readme.md", + "autorest_command": "autorest --version=3.9.3 --typescript --modelerfour.lenient-model-deduplication --azure-arm --head-as-boolean=true --license-header=MICROSOFT_MIT_NO_VERSION --generate-test --typescript-sdks-folder=/mnt/vss/_work/1/s/azure-sdk-for-js ../azure-rest-api-specs/specification/orbital/resource-manager/readme.md --use=@autorest/typescript@6.0.0-rc.5", "repository_url": "https://github.com/Azure/azure-rest-api-specs.git", - "release_tool": "@azure-tools/js-sdk-release-tools@2.6.0", - "use": "@autorest/typescript@6.0.0-rc.7" + "release_tool": "@azure-tools/js-sdk-release-tools@2.6.2", + "use": "@autorest/typescript@6.0.0-rc.5" } \ No newline at end of file diff --git a/sdk/orbital/arm-orbital/package.json b/sdk/orbital/arm-orbital/package.json index 719555f7d056..046a88bd8299 100644 --- a/sdk/orbital/arm-orbital/package.json +++ b/sdk/orbital/arm-orbital/package.json @@ -3,7 +3,7 @@ "sdk-type": "mgmt", "author": "Microsoft Corporation", "description": "A generated SDK for AzureOrbital.", - "version": "1.2.1", + "version": "2.0.0", "engines": { "node": ">=14.0.0" }, @@ -29,9 +29,9 @@ "types": "./types/arm-orbital.d.ts", "devDependencies": { "@microsoft/api-extractor": "^7.31.1", - "@rollup/plugin-commonjs": "^24.0.0", - "@rollup/plugin-json": "^6.0.0", - "@rollup/plugin-multi-entry": "^6.0.0", + "@rollup/plugin-commonjs": "^21.0.1", + "@rollup/plugin-json": "^4.1.0", + "@rollup/plugin-multi-entry": "^4.1.0", "@rollup/plugin-node-resolve": "^13.1.3", "mkdirp": "^1.0.4", "rollup": "^2.66.1", @@ -39,7 +39,6 @@ "typescript": "~4.8.0", "uglify-js": "^3.4.9", "rimraf": "^3.0.0", - "dotenv": "^8.2.0", "@azure/identity": "^2.0.1", "@azure-tools/test-recorder": "^2.0.0", "@azure-tools/test-credential": "^1.0.0", @@ -50,6 +49,7 @@ "@types/node": "^14.0.0", "@azure/dev-tool": "^1.0.0" }, + "homepage": "https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/orbital/arm-orbital", "repository": { "type": "git", "url": "https://github.com/Azure/azure-sdk-for-js.git" @@ -110,14 +110,5 @@ } ] }, - "autoPublish": true, - "homepage": "https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/orbital/arm-orbital", - "//sampleConfiguration": { - "productName": "", - "productSlugs": [ - "azure" - ], - "disableDocsMs": true, - "apiRefLink": "https://docs.microsoft.com/javascript/api/@azure/arm-orbital?view=azure-node-preview" - } -} + "autoPublish": true +} \ No newline at end of file diff --git a/sdk/orbital/arm-orbital/review/arm-orbital.api.md b/sdk/orbital/arm-orbital/review/arm-orbital.api.md index 40a16889d749..8f4e815a89b0 100644 --- a/sdk/orbital/arm-orbital/review/arm-orbital.api.md +++ b/sdk/orbital/arm-orbital/review/arm-orbital.api.md @@ -13,13 +13,10 @@ import { PollOperationState } from '@azure/core-lro'; // @public export type ActionType = string; -// @public -export type ApiVersionParameter = string; - // @public export interface AuthorizedGroundstation { - expirationDate?: Date; - groundStation?: string; + expirationDate: Date; + groundStation: string; } // @public @@ -90,17 +87,9 @@ export interface AvailableGroundStationPropertiesAutoGenerated { // @public export interface AvailableGroundStations { - get(groundStationName: string, options?: AvailableGroundStationsGetOptionalParams): Promise; listByCapability(capability: CapabilityParameter, options?: AvailableGroundStationsListByCapabilityOptionalParams): PagedAsyncIterableIterator; } -// @public -export interface AvailableGroundStationsGetOptionalParams extends coreClient.OperationOptions { -} - -// @public -export type AvailableGroundStationsGetResponse = AvailableGroundStation; - // @public export interface AvailableGroundStationsListByCapabilityNextOptionalParams extends coreClient.OperationOptions { } @@ -151,37 +140,23 @@ export type Capability = string; // @public export type CapabilityParameter = string; -// @public -export interface CloudError { - error?: CloudErrorBody; -} - -// @public -export interface CloudErrorBody { - code?: string; - details?: CloudErrorBody[]; - message?: string; - target?: string; -} - // @public export interface Contact extends ProxyResource { readonly antennaConfiguration?: ContactsPropertiesAntennaConfiguration; - contactProfile?: ContactsPropertiesContactProfile; + contactProfile: ContactsPropertiesContactProfile; readonly endAzimuthDegrees?: number; readonly endElevationDegrees?: number; readonly errorMessage?: string; - readonly etag?: string; - groundStationName?: string; + groundStationName: string; readonly maximumElevationDegrees?: number; provisioningState?: ContactsPropertiesProvisioningState; - reservationEndTime?: Date; - reservationStartTime?: Date; + reservationEndTime: Date; + reservationStartTime: Date; readonly rxEndTime?: Date; readonly rxStartTime?: Date; readonly startAzimuthDegrees?: number; readonly startElevationDegrees?: number; - readonly status?: Status; + readonly status?: ContactsStatus; readonly txEndTime?: Date; readonly txStartTime?: Date; } @@ -220,13 +195,13 @@ export interface ContactParametersContactProfile extends ResourceReference { // @public export interface ContactProfile extends TrackedResource { autoTrackingConfiguration?: AutoTrackingConfiguration; - readonly etag?: string; eventHubUri?: string; - links?: ContactProfileLink[]; + links: ContactProfileLink[]; minimumElevationDegrees?: number; minimumViableContactDuration?: string; - networkConfiguration?: ContactProfilesPropertiesNetworkConfiguration; + networkConfiguration: ContactProfilesPropertiesNetworkConfiguration; provisioningState?: ContactProfilesPropertiesProvisioningState; + thirdPartyConfigurations?: ContactProfileThirdPartyConfiguration[]; } // @public @@ -263,8 +238,8 @@ export interface ContactProfileProperties extends ContactProfilesProperties { // @public export interface ContactProfiles { - beginCreateOrUpdate(resourceGroupName: string, contactProfileName: string, location: string, options?: ContactProfilesCreateOrUpdateOptionalParams): Promise, ContactProfilesCreateOrUpdateResponse>>; - beginCreateOrUpdateAndWait(resourceGroupName: string, contactProfileName: string, location: string, options?: ContactProfilesCreateOrUpdateOptionalParams): Promise; + beginCreateOrUpdate(resourceGroupName: string, contactProfileName: string, location: string, networkConfiguration: ContactProfilesPropertiesNetworkConfiguration, links: ContactProfileLink[], options?: ContactProfilesCreateOrUpdateOptionalParams): Promise, ContactProfilesCreateOrUpdateResponse>>; + beginCreateOrUpdateAndWait(resourceGroupName: string, contactProfileName: string, location: string, networkConfiguration: ContactProfilesPropertiesNetworkConfiguration, links: ContactProfileLink[], options?: ContactProfilesCreateOrUpdateOptionalParams): Promise; beginDelete(resourceGroupName: string, contactProfileName: string, options?: ContactProfilesDeleteOptionalParams): Promise, void>>; beginDeleteAndWait(resourceGroupName: string, contactProfileName: string, options?: ContactProfilesDeleteOptionalParams): Promise; beginUpdateTags(resourceGroupName: string, contactProfileName: string, parameters: TagsObject, options?: ContactProfilesUpdateTagsOptionalParams): Promise, ContactProfilesUpdateTagsResponse>>; @@ -283,15 +258,14 @@ export interface ContactProfilesCreateOrUpdateHeaders { export interface ContactProfilesCreateOrUpdateOptionalParams extends coreClient.OperationOptions { autoTrackingConfiguration?: AutoTrackingConfiguration; eventHubUri?: string; - links?: ContactProfileLink[]; minimumElevationDegrees?: number; minimumViableContactDuration?: string; - networkConfiguration?: ContactProfilesPropertiesNetworkConfiguration; provisioningState?: ContactProfilesPropertiesProvisioningState; resumeFrom?: string; tags?: { [propertyName: string]: string; }; + thirdPartyConfigurations?: ContactProfileThirdPartyConfiguration[]; updateIntervalInMs?: number; } @@ -355,6 +329,7 @@ export interface ContactProfilesProperties { minimumViableContactDuration?: string; networkConfiguration: ContactProfilesPropertiesNetworkConfiguration; provisioningState?: ContactProfilesPropertiesProvisioningState; + thirdPartyConfigurations?: ContactProfileThirdPartyConfiguration[]; } // @public @@ -379,6 +354,12 @@ export interface ContactProfilesUpdateTagsOptionalParams extends coreClient.Oper // @public export type ContactProfilesUpdateTagsResponse = ContactProfile; +// @public +export interface ContactProfileThirdPartyConfiguration { + missionConfiguration: string; + providerName: string; +} + // @public export interface Contacts { beginCreate(resourceGroupName: string, spacecraftName: string, contactName: string, parameters: Contact, options?: ContactsCreateOptionalParams): Promise, ContactsCreateResponse>>; @@ -449,6 +430,9 @@ export interface ContactsPropertiesContactProfile extends ResourceReference { // @public export type ContactsPropertiesProvisioningState = string; +// @public +export type ContactsStatus = string; + // @public export type CreatedByType = string; @@ -464,18 +448,31 @@ export interface EndPoint { } // @public -export function getContinuationToken(page: unknown): string | undefined; +export interface ErrorAdditionalInfo { + readonly info?: Record; + readonly type?: string; +} // @public -export enum KnownActionType { - Internal = "Internal" +export interface ErrorDetail { + readonly additionalInfo?: ErrorAdditionalInfo[]; + readonly code?: string; + readonly details?: ErrorDetail[]; + readonly message?: string; + readonly target?: string; } // @public -export enum KnownApiVersionParameter { - TwoThousandTwenty0901Preview = "2020-09-01-preview", - TwoThousandTwentyOne0404Preview = "2021-04-04-preview", - TwoThousandTwentyTwo0301 = "2022-03-01" +export interface ErrorResponse { + error?: ErrorDetail; +} + +// @public +export function getContinuationToken(page: unknown): string | undefined; + +// @public +export enum KnownActionType { + Internal = "Internal" } // @public @@ -492,22 +489,31 @@ export enum KnownCapabilityParameter { // @public export enum KnownContactProfilesPropertiesProvisioningState { - Canceled = "Canceled", - Creating = "Creating", - Deleting = "Deleting", - Failed = "Failed", - Succeeded = "Succeeded", - Updating = "Updating" + Canceled = "canceled", + Creating = "creating", + Deleting = "deleting", + Failed = "failed", + Succeeded = "succeeded", + Updating = "updating" } // @public export enum KnownContactsPropertiesProvisioningState { - Canceled = "Canceled", - Creating = "Creating", - Deleting = "Deleting", - Failed = "Failed", - Succeeded = "Succeeded", - Updating = "Updating" + Canceled = "canceled", + Creating = "creating", + Deleting = "deleting", + Failed = "failed", + Succeeded = "succeeded", + Updating = "updating" +} + +// @public +export enum KnownContactsStatus { + Cancelled = "cancelled", + Failed = "failed", + ProviderCancelled = "providerCancelled", + Scheduled = "scheduled", + Succeeded = "succeeded" } // @public @@ -520,8 +526,8 @@ export enum KnownCreatedByType { // @public export enum KnownDirection { - Downlink = "downlink", - Uplink = "uplink" + Downlink = "Downlink", + Uplink = "Uplink" } // @public @@ -547,12 +553,12 @@ export enum KnownProtocol { // @public export enum KnownProvisioningState { - Canceled = "Canceled", - Creating = "Creating", - Deleting = "Deleting", - Failed = "Failed", - Succeeded = "Succeeded", - Updating = "Updating" + Canceled = "canceled", + Creating = "creating", + Deleting = "deleting", + Failed = "failed", + Succeeded = "succeeded", + Updating = "updating" } // @public @@ -563,12 +569,20 @@ export enum KnownReleaseMode { // @public export enum KnownSpacecraftsPropertiesProvisioningState { + Canceled = "canceled", + Creating = "creating", + Deleting = "deleting", + Failed = "failed", + Succeeded = "succeeded", + Updating = "updating" +} + +// @public +export enum KnownStatus { Canceled = "Canceled", - Creating = "Creating", - Deleting = "Deleting", Failed = "Failed", - Succeeded = "Succeeded", - Updating = "Updating" + Running = "Running", + Succeeded = "Succeeded" } // @public @@ -600,10 +614,12 @@ export interface OperationResult { error?: OperationResultErrorProperties; readonly id?: string; readonly name?: string; + readonly nextLink?: string; readonly percentComplete?: number; properties?: Record; readonly startTime?: Date; - status?: Status; + readonly status?: Status; + readonly value?: Record[]; } // @public @@ -684,18 +700,17 @@ export interface ResourceIdListResultValueItem { // @public export interface ResourceReference { - id?: string; + id: string; } // @public export interface Spacecraft extends TrackedResource { - readonly etag?: string; - links?: SpacecraftLink[]; + links: SpacecraftLink[]; noradId?: string; provisioningState?: SpacecraftsPropertiesProvisioningState; - titleLine?: string; - tleLine1?: string; - tleLine2?: string; + titleLine: string; + tleLine1: string; + tleLine2: string; } // @public @@ -716,8 +731,8 @@ export interface SpacecraftListResult { // @public export interface Spacecrafts { - beginCreateOrUpdate(resourceGroupName: string, spacecraftName: string, location: string, options?: SpacecraftsCreateOrUpdateOptionalParams): Promise, SpacecraftsCreateOrUpdateResponse>>; - beginCreateOrUpdateAndWait(resourceGroupName: string, spacecraftName: string, location: string, options?: SpacecraftsCreateOrUpdateOptionalParams): Promise; + beginCreateOrUpdate(resourceGroupName: string, spacecraftName: string, location: string, titleLine: string, tleLine1: string, tleLine2: string, links: SpacecraftLink[], options?: SpacecraftsCreateOrUpdateOptionalParams): Promise, SpacecraftsCreateOrUpdateResponse>>; + beginCreateOrUpdateAndWait(resourceGroupName: string, spacecraftName: string, location: string, titleLine: string, tleLine1: string, tleLine2: string, links: SpacecraftLink[], options?: SpacecraftsCreateOrUpdateOptionalParams): Promise; beginDelete(resourceGroupName: string, spacecraftName: string, options?: SpacecraftsDeleteOptionalParams): Promise, void>>; beginDeleteAndWait(resourceGroupName: string, spacecraftName: string, options?: SpacecraftsDeleteOptionalParams): Promise; beginListAvailableContactsAndWait(resourceGroupName: string, spacecraftName: string, contactProfile: ContactParametersContactProfile, groundStationName: string, startTime: Date, endTime: Date, options?: SpacecraftsListAvailableContactsOptionalParams): PagedAsyncIterableIterator; @@ -735,16 +750,12 @@ export interface SpacecraftsCreateOrUpdateHeaders { // @public export interface SpacecraftsCreateOrUpdateOptionalParams extends coreClient.OperationOptions { - links?: SpacecraftLink[]; noradId?: string; provisioningState?: SpacecraftsPropertiesProvisioningState; resumeFrom?: string; tags?: { [propertyName: string]: string; }; - titleLine?: string; - tleLine1?: string; - tleLine2?: string; updateIntervalInMs?: number; } @@ -843,7 +854,7 @@ export interface SpacecraftsUpdateTagsOptionalParams extends coreClient.Operatio export type SpacecraftsUpdateTagsResponse = Spacecraft; // @public -export type Status = "scheduled" | "cancelled" | "succeeded" | "failed" | "providerCancelled" | "Succeeded" | "Canceled" | "Failed" | "Running"; +export type Status = string; // @public export interface SystemData { diff --git a/sdk/orbital/arm-orbital/src/azureOrbital.ts b/sdk/orbital/arm-orbital/src/azureOrbital.ts index efe271d94114..791372d53102 100644 --- a/sdk/orbital/arm-orbital/src/azureOrbital.ts +++ b/sdk/orbital/arm-orbital/src/azureOrbital.ts @@ -64,7 +64,7 @@ export class AzureOrbital extends coreClient.ServiceClient { credential: credentials }; - const packageDetails = `azsdk-js-arm-orbital/1.2.1`; + const packageDetails = `azsdk-js-arm-orbital/2.0.0`; const userAgentPrefix = options.userAgentOptions && options.userAgentOptions.userAgentPrefix ? `${options.userAgentOptions.userAgentPrefix} ${packageDetails}` @@ -117,7 +117,7 @@ export class AzureOrbital extends coreClient.ServiceClient { // Assigning values to Constant parameters this.$host = options.$host || "https://management.azure.com"; - this.apiVersion = options.apiVersion || "2022-03-01"; + this.apiVersion = options.apiVersion || "2022-11-01"; this.operations = new OperationsImpl(this); this.spacecrafts = new SpacecraftsImpl(this); this.contacts = new ContactsImpl(this); diff --git a/sdk/orbital/arm-orbital/src/models/index.ts b/sdk/orbital/arm-orbital/src/models/index.ts index 4c78877e4727..725e9b5a7091 100644 --- a/sdk/orbital/arm-orbital/src/models/index.ts +++ b/sdk/orbital/arm-orbital/src/models/index.ts @@ -72,22 +72,53 @@ export interface OperationDisplay { readonly description?: string; } -/** An error response from the service. */ -export interface CloudError { - /** An error response from the service. */ - error?: CloudErrorBody; +/** Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.). */ +export interface ErrorResponse { + /** The error object. */ + error?: ErrorDetail; } -/** An error response from the service. */ -export interface CloudErrorBody { - /** An identifier for the error. Codes are invariant and are intended to be consumed programmatically. */ - code?: string; - /** A message describing the error, intended to be suitable for display in a user interface. */ - message?: string; - /** The target of the particular error. For example, the name of the property in error. */ - target?: string; - /** A list of additional details about the error. */ - details?: CloudErrorBody[]; +/** The error detail. */ +export interface ErrorDetail { + /** + * The error code. + * NOTE: This property will not be serialized. It can only be populated by the server. + */ + readonly code?: string; + /** + * The error message. + * NOTE: This property will not be serialized. It can only be populated by the server. + */ + readonly message?: string; + /** + * The error target. + * NOTE: This property will not be serialized. It can only be populated by the server. + */ + readonly target?: string; + /** + * The error details. + * NOTE: This property will not be serialized. It can only be populated by the server. + */ + readonly details?: ErrorDetail[]; + /** + * The error additional info. + * NOTE: This property will not be serialized. It can only be populated by the server. + */ + readonly additionalInfo?: ErrorAdditionalInfo[]; +} + +/** The resource management error additional info. */ +export interface ErrorAdditionalInfo { + /** + * The additional info type. + * NOTE: This property will not be serialized. It can only be populated by the server. + */ + readonly type?: string; + /** + * The additional info. + * NOTE: This property will not be serialized. It can only be populated by the server. + */ + readonly info?: Record; } /** Response for the ListSpacecrafts API service call. */ @@ -101,17 +132,17 @@ export interface SpacecraftListResult { readonly nextLink?: string; } -/** Authorized Ground Stations for the link */ +/** List of authorized spacecraft links per ground station and the expiration date of the authorization. */ export interface SpacecraftLink { - /** Link name */ + /** Link name. */ name: string; - /** Center Frequency in MHz */ + /** Center Frequency in MHz. */ centerFrequencyMHz: number; - /** Bandwidth in MHz */ + /** Bandwidth in MHz. */ bandwidthMHz: number; - /** Direction (uplink or downlink) */ + /** Direction (Uplink or Downlink). */ direction: Direction; - /** polarization. eg (RHCP, LHCP) */ + /** Polarization. e.g. (RHCP, LHCP). */ polarization: Polarization; /** * Authorized Ground Stations @@ -120,12 +151,12 @@ export interface SpacecraftLink { readonly authorizations?: AuthorizedGroundstation[]; } -/** Authorized groundstation */ +/** Authorized groundstation. */ export interface AuthorizedGroundstation { - /** Groundstation name */ - groundStation?: string; - /** Date of authorization expiration */ - expirationDate?: Date; + /** Groundstation name. */ + groundStation: string; + /** Date of authorization expiration. */ + expirationDate: Date; } /** Common fields that are returned in the response for all Azure Resource Manager resources */ @@ -193,10 +224,10 @@ export interface ContactsPropertiesAntennaConfiguration { sourceIps?: string[]; } -/** Resource Reference */ +/** Resource Reference. */ export interface ResourceReference { /** Resource ID. */ - id?: string; + id: string; } /** Parameters that define the contact resource. */ @@ -205,15 +236,15 @@ export interface ContactParameters { contactProfile: ContactParametersContactProfile; /** Name of Azure Ground Station. */ groundStationName: string; - /** Start time of a contact. */ + /** Start time of a contact (ISO 8601 UTC standard). */ startTime: Date; - /** End time of a contact. */ + /** End time of a contact (ISO 8601 UTC standard). */ endTime: Date; } /** Response for the ListAvailableContacts API service call. */ export interface AvailableContactsListResult { - /** A list of available contacts */ + /** A list of available contacts. */ value?: AvailableContacts[]; /** * The URL to get the next set of results. @@ -237,22 +268,22 @@ export interface AvailableContacts { */ readonly maximumElevationDegrees?: number; /** - * Time at which antenna transmit will be enabled. + * Time at which antenna transmit will be enabled (ISO 8601 UTC standard). * NOTE: This property will not be serialized. It can only be populated by the server. */ readonly txStartTime?: Date; /** - * Time at which antenna transmit will be disabled. + * Time at which antenna transmit will be disabled (ISO 8601 UTC standard). * NOTE: This property will not be serialized. It can only be populated by the server. */ readonly txEndTime?: Date; /** - * Earliest time to receive a signal. + * Earliest time to receive a signal (ISO 8601 UTC standard). * NOTE: This property will not be serialized. It can only be populated by the server. */ readonly rxStartTime?: Date; /** - * Time to lost receiving a signal. + * Time to lost receiving a signal (ISO 8601 UTC standard). * NOTE: This property will not be serialized. It can only be populated by the server. */ readonly rxEndTime?: Date; @@ -278,7 +309,7 @@ export interface AvailableContacts { readonly endElevationDegrees?: number; } -/** Contact Instance Properties */ +/** Contact Instance Properties. */ export interface ContactInstanceProperties { /** * Maximum elevation of the antenna during the contact in decimal degrees. @@ -286,22 +317,22 @@ export interface ContactInstanceProperties { */ readonly maximumElevationDegrees?: number; /** - * Time at which antenna transmit will be enabled. + * Time at which antenna transmit will be enabled (ISO 8601 UTC standard). * NOTE: This property will not be serialized. It can only be populated by the server. */ readonly txStartTime?: Date; /** - * Time at which antenna transmit will be disabled. + * Time at which antenna transmit will be disabled (ISO 8601 UTC standard). * NOTE: This property will not be serialized. It can only be populated by the server. */ readonly txEndTime?: Date; /** - * Earliest time to receive a signal. + * Earliest time to receive a signal (ISO 8601 UTC standard). * NOTE: This property will not be serialized. It can only be populated by the server. */ readonly rxStartTime?: Date; /** - * Time to lost receiving a signal. + * Time to lost receiving a signal (ISO 8601 UTC standard). * NOTE: This property will not be serialized. It can only be populated by the server. */ readonly rxEndTime?: Date; @@ -329,67 +360,77 @@ export interface ContactInstanceProperties { /** List of Contact Profile Resource Properties. */ export interface ContactProfilesProperties { - /** The current state of the resource's creation, deletion, or modification */ + /** The current state of the resource's creation, deletion, or modification. */ provisioningState?: ContactProfilesPropertiesProvisioningState; - /** Minimum viable contact duration in ISO 8601 format. */ + /** Minimum viable contact duration in ISO 8601 format. Used for listing the available contacts with a spacecraft at a given ground station. */ minimumViableContactDuration?: string; - /** Minimum viable elevation for the contact in decimal degrees. */ + /** Minimum viable elevation for the contact in decimal degrees. Used for listing the available contacts with a spacecraft at a given ground station. */ minimumElevationDegrees?: number; - /** Auto track configuration. */ + /** Auto-tracking configuration. */ autoTrackingConfiguration?: AutoTrackingConfiguration; - /** The URI of the Event Hub used for telemetry */ + /** ARM resource identifier of the Event Hub used for telemetry. Requires granting Orbital Resource Provider the rights to send telemetry into the hub. */ eventHubUri?: string; /** Network configuration of customer virtual network. */ networkConfiguration: ContactProfilesPropertiesNetworkConfiguration; - /** Links of the Contact Profile */ + /** Third-party mission configuration of the Contact Profile. Describes RF links, modem processing, and IP endpoints. */ + thirdPartyConfigurations?: ContactProfileThirdPartyConfiguration[]; + /** Links of the Contact Profile. Describes RF links, modem processing, and IP endpoints. */ links: ContactProfileLink[]; } /** Network configuration of customer virtual network. */ export interface ContactProfilesPropertiesNetworkConfiguration { - /** Customer subnet ARM resource identifier. */ + /** ARM resource identifier of the subnet delegated to the Microsoft.Orbital/orbitalGateways. Needs to be at least a class C subnet, and should not have any IP created in it. */ subnetId: string; } -/** Contact Profile Link */ +/** Contact Profile third-party partner configuration. */ +export interface ContactProfileThirdPartyConfiguration { + /** Name of the third-party provider. */ + providerName: string; + /** Name of string referencing the configuration describing contact set-up for a particular mission. Expected values are those which have been created in collaboration with the partner network. */ + missionConfiguration: string; +} + +/** Contact Profile Link. */ export interface ContactProfileLink { - /** Link name */ + /** Link name. */ name: string; - /** polarization. eg (RHCP, LHCP) */ + /** Polarization. e.g. (RHCP, LHCP). */ polarization: Polarization; - /** Direction (uplink or downlink) */ + /** Direction (Uplink or Downlink). */ direction: Direction; - /** Gain To Noise Temperature in db/K. */ + /** Gain to noise temperature in db/K. It is the required G/T by the customer. Not used yet. */ gainOverTemperature?: number; - /** Effective Isotropic Radiated Power (EIRP) in dBW. */ + /** Effective Isotropic Radiated Power (EIRP) in dBW. It is the required EIRP by the customer. Not used yet. */ eirpdBW?: number; - /** Contact Profile Link Channel */ + /** Contact Profile Link Channel. */ channels: ContactProfileLinkChannel[]; } -/** Contact Profile Link Channel */ +/** Contact Profile Link Channel. */ export interface ContactProfileLinkChannel { - /** Channel name */ + /** Channel name. */ name: string; - /** Center Frequency in MHz */ + /** Center Frequency in MHz. */ centerFrequencyMHz: number; - /** Bandwidth in MHz */ + /** Bandwidth in MHz. */ bandwidthMHz: number; - /** Customer End point to store/retrieve data during a contact. */ + /** Customer end point to store and retrieve data during a contact with the spacecraft. */ endPoint: EndPoint; - /** Configuration for modulation */ + /** Copy of the modem configuration file such as Kratos QRadio. Only valid for uplink directions. If provided, the modem connects to the customer endpoint and accepts commands from the customer instead of a VITA.49 stream. */ modulationConfiguration?: string; - /** Configuration for demodulation */ + /** Copy of the modem configuration file such as Kratos QRadio or Kratos QuantumRx. Only valid for downlink directions. If provided, the modem connects to the customer endpoint and sends demodulated data instead of a VITA.49 stream. */ demodulationConfiguration?: string; - /** Configuration for encoding */ + /** Currently unused. */ encodingConfiguration?: string; - /** Configuration for decoding */ + /** Currently unused. */ decodingConfiguration?: string; } -/** Customer End point to store/retrieve data during a contact. */ +/** Customer end point to store and retrieve data during a contact with the spacecraft. */ export interface EndPoint { - /** IP Address. */ + /** IP Address (IPv4). */ ipAddress: string; /** Name of an end point. */ endPointName: string; @@ -421,10 +462,10 @@ export interface AvailableGroundStationListResult { readonly nextLink?: string; } -/** GroundStations available to schedule Contacts */ +/** Ground Stations available to schedule Contacts. */ export interface AvailableGroundStation { /** - * Id of groundStation + * ID of groundStation. * NOTE: This property will not be serialized. It can only be populated by the server. */ readonly id?: string; @@ -433,7 +474,7 @@ export interface AvailableGroundStation { * NOTE: This property will not be serialized. It can only be populated by the server. */ readonly name?: string; - /** Azure region */ + /** Azure region. */ location?: string; /** * Resource type. @@ -448,9 +489,9 @@ export interface AvailableGroundStation { longitudeDegrees?: number; /** Latitude of the ground station in decimal degrees. */ latitudeDegrees?: number; - /** Altitude of the ground station */ + /** Altitude of the ground station. */ altitudeMeters?: number; - /** Release Status of a ground station */ + /** Release Status of a ground station. */ releaseMode?: ReleaseMode; } @@ -464,9 +505,9 @@ export interface AvailableGroundStationPropertiesAutoGenerated { longitudeDegrees?: number; /** Latitude of the ground station in decimal degrees. */ latitudeDegrees?: number; - /** Altitude of the ground station */ + /** Altitude of the ground station. */ altitudeMeters?: number; - /** Release Status of a ground station */ + /** Release Status of a ground station. */ releaseMode?: ReleaseMode; } @@ -482,15 +523,18 @@ export interface OperationResult { * NOTE: This property will not be serialized. It can only be populated by the server. */ readonly name?: string; - /** Status of a contact. */ - status?: Status; /** - * The operation start time + * The status of operation. + * NOTE: This property will not be serialized. It can only be populated by the server. + */ + readonly status?: Status; + /** + * The operation start time (ISO 8601 UTC standard). * NOTE: This property will not be serialized. It can only be populated by the server. */ readonly startTime?: Date; /** - * The operation end time + * The operation end time (ISO 8601 UTC standard). * NOTE: This property will not be serialized. It can only be populated by the server. */ readonly endTime?: Date; @@ -499,13 +543,23 @@ export interface OperationResult { * NOTE: This property will not be serialized. It can only be populated by the server. */ readonly percentComplete?: number; - /** Operation result properties */ + /** + * A list of results when the operation returns multiple results. + * NOTE: This property will not be serialized. It can only be populated by the server. + */ + readonly value?: Record[]; + /** + * The URL to get the next set of results. + * NOTE: This property will not be serialized. It can only be populated by the server. + */ + readonly nextLink?: string; + /** Operation result properties. */ properties?: Record; - /** Operation result error properties */ + /** Operation result error properties. */ error?: OperationResultErrorProperties; } -/** Operation result error properties */ +/** Operation result error properties. */ export interface OperationResultErrorProperties { /** * The code of the error. @@ -531,7 +585,7 @@ export interface ResourceIdListResult { } export interface ResourceIdListResultValueItem { - /** The Azure Resource ID */ + /** The Azure Resource ID. */ id?: string; } @@ -562,89 +616,76 @@ export interface AvailableContactsProperties /** Properties of the contact profile resource. */ export interface ContactProfileProperties extends ContactProfilesProperties {} -/** The properties bag for this resource */ +/** The properties bag for this resource. */ export interface AvailableGroundStationProperties extends AvailableGroundStationPropertiesAutoGenerated {} /** Customer creates a spacecraft resource to schedule a contact. */ export interface Spacecraft extends TrackedResource { - /** - * A unique read-only string that changes whenever the resource is updated. - * NOTE: This property will not be serialized. It can only be populated by the server. - */ - readonly etag?: string; - /** The current state of the resource's creation, deletion, or modification */ + /** The current state of the resource's creation, deletion, or modification. */ provisioningState?: SpacecraftsPropertiesProvisioningState; /** NORAD ID of the spacecraft. */ noradId?: string; - /** Title line of Two Line Element (TLE). */ - titleLine?: string; - /** Line 1 of Two Line Element (TLE). */ - tleLine1?: string; - /** Line 2 of Two Line Element (TLE). */ - tleLine2?: string; - /** Links of the Spacecraft */ - links?: SpacecraftLink[]; + /** Title line of the two-line element set (TLE). */ + titleLine: string; + /** Line 1 of the two-line element set (TLE). */ + tleLine1: string; + /** Line 2 of the two-line element set (TLE). */ + tleLine2: string; + /** Immutable list of Spacecraft links. */ + links: SpacecraftLink[]; } /** Customer creates a Contact Profile Resource, which will contain all of the configurations required for scheduling a contact. */ export interface ContactProfile extends TrackedResource { - /** - * A unique read-only string that changes whenever the resource is updated. - * NOTE: This property will not be serialized. It can only be populated by the server. - */ - readonly etag?: string; - /** The current state of the resource's creation, deletion, or modification */ + /** The current state of the resource's creation, deletion, or modification. */ provisioningState?: ContactProfilesPropertiesProvisioningState; - /** Minimum viable contact duration in ISO 8601 format. */ + /** Minimum viable contact duration in ISO 8601 format. Used for listing the available contacts with a spacecraft at a given ground station. */ minimumViableContactDuration?: string; - /** Minimum viable elevation for the contact in decimal degrees. */ + /** Minimum viable elevation for the contact in decimal degrees. Used for listing the available contacts with a spacecraft at a given ground station. */ minimumElevationDegrees?: number; - /** Auto track configuration. */ + /** Auto-tracking configuration. */ autoTrackingConfiguration?: AutoTrackingConfiguration; - /** The URI of the Event Hub used for telemetry */ + /** ARM resource identifier of the Event Hub used for telemetry. Requires granting Orbital Resource Provider the rights to send telemetry into the hub. */ eventHubUri?: string; /** Network configuration of customer virtual network. */ - networkConfiguration?: ContactProfilesPropertiesNetworkConfiguration; - /** Links of the Contact Profile */ - links?: ContactProfileLink[]; + networkConfiguration: ContactProfilesPropertiesNetworkConfiguration; + /** Third-party mission configuration of the Contact Profile. Describes RF links, modem processing, and IP endpoints. */ + thirdPartyConfigurations?: ContactProfileThirdPartyConfiguration[]; + /** Links of the Contact Profile. Describes RF links, modem processing, and IP endpoints. */ + links: ContactProfileLink[]; } /** Customer creates a contact resource for a spacecraft resource. */ export interface Contact extends ProxyResource { - /** - * A unique read-only string that changes whenever the resource is updated. - * NOTE: This property will not be serialized. It can only be populated by the server. - */ - readonly etag?: string; - /** The current state of the resource's creation, deletion, or modification */ + /** The current state of the resource's creation, deletion, or modification. */ provisioningState?: ContactsPropertiesProvisioningState; /** * Status of a contact. * NOTE: This property will not be serialized. It can only be populated by the server. */ - readonly status?: Status; - /** Reservation start time of a contact. */ - reservationStartTime?: Date; - /** Reservation end time of a contact. */ - reservationEndTime?: Date; + readonly status?: ContactsStatus; + /** Reservation start time of a contact (ISO 8601 UTC standard). */ + reservationStartTime: Date; + /** Reservation end time of a contact (ISO 8601 UTC standard). */ + reservationEndTime: Date; /** - * Receive start time of a contact. + * Receive start time of a contact (ISO 8601 UTC standard). * NOTE: This property will not be serialized. It can only be populated by the server. */ readonly rxStartTime?: Date; /** - * Receive end time of a contact. + * Receive end time of a contact (ISO 8601 UTC standard). * NOTE: This property will not be serialized. It can only be populated by the server. */ readonly rxEndTime?: Date; /** - * Transmit start time of a contact. + * Transmit start time of a contact (ISO 8601 UTC standard). * NOTE: This property will not be serialized. It can only be populated by the server. */ readonly txStartTime?: Date; /** - * Transmit end time of a contact. + * Transmit end time of a contact (ISO 8601 UTC standard). * NOTE: This property will not be serialized. It can only be populated by the server. */ readonly txEndTime?: Date; @@ -669,7 +710,7 @@ export interface Contact extends ProxyResource { */ readonly endAzimuthDegrees?: number; /** Azure Ground Station name. */ - groundStationName?: string; + groundStationName: string; /** * Spacecraft elevation above the horizon at contact start. * NOTE: This property will not be serialized. It can only be populated by the server. @@ -686,7 +727,7 @@ export interface Contact extends ProxyResource { */ readonly antennaConfiguration?: ContactsPropertiesAntennaConfiguration; /** The reference to the contact profile resource. */ - contactProfile?: ContactsPropertiesContactProfile; + contactProfile: ContactsPropertiesContactProfile; } /** Defines headers for Spacecrafts_createOrUpdate operation. */ @@ -794,17 +835,17 @@ export type ActionType = string; /** Known values of {@link ProvisioningState} that the service accepts. */ export enum KnownProvisioningState { /** Creating */ - Creating = "Creating", + Creating = "creating", /** Succeeded */ - Succeeded = "Succeeded", + Succeeded = "succeeded", /** Failed */ - Failed = "Failed", + Failed = "failed", /** Canceled */ - Canceled = "Canceled", + Canceled = "canceled", /** Updating */ - Updating = "Updating", + Updating = "updating", /** Deleting */ - Deleting = "Deleting" + Deleting = "deleting" } /** @@ -812,29 +853,29 @@ export enum KnownProvisioningState { * {@link KnownProvisioningState} can be used interchangeably with ProvisioningState, * this enum contains the known values that the service supports. * ### Known values supported by the service - * **Creating** \ - * **Succeeded** \ - * **Failed** \ - * **Canceled** \ - * **Updating** \ - * **Deleting** + * **creating** \ + * **succeeded** \ + * **failed** \ + * **canceled** \ + * **updating** \ + * **deleting** */ export type ProvisioningState = string; /** Known values of {@link SpacecraftsPropertiesProvisioningState} that the service accepts. */ export enum KnownSpacecraftsPropertiesProvisioningState { /** Creating */ - Creating = "Creating", + Creating = "creating", /** Succeeded */ - Succeeded = "Succeeded", + Succeeded = "succeeded", /** Failed */ - Failed = "Failed", + Failed = "failed", /** Canceled */ - Canceled = "Canceled", + Canceled = "canceled", /** Updating */ - Updating = "Updating", + Updating = "updating", /** Deleting */ - Deleting = "Deleting" + Deleting = "deleting" } /** @@ -842,21 +883,21 @@ export enum KnownSpacecraftsPropertiesProvisioningState { * {@link KnownSpacecraftsPropertiesProvisioningState} can be used interchangeably with SpacecraftsPropertiesProvisioningState, * this enum contains the known values that the service supports. * ### Known values supported by the service - * **Creating** \ - * **Succeeded** \ - * **Failed** \ - * **Canceled** \ - * **Updating** \ - * **Deleting** + * **creating** \ + * **succeeded** \ + * **failed** \ + * **canceled** \ + * **updating** \ + * **deleting** */ export type SpacecraftsPropertiesProvisioningState = string; /** Known values of {@link Direction} that the service accepts. */ export enum KnownDirection { /** Uplink */ - Uplink = "uplink", + Uplink = "Uplink", /** Downlink */ - Downlink = "downlink" + Downlink = "Downlink" } /** @@ -864,8 +905,8 @@ export enum KnownDirection { * {@link KnownDirection} can be used interchangeably with Direction, * this enum contains the known values that the service supports. * ### Known values supported by the service - * **uplink** \ - * **downlink** + * **Uplink** \ + * **Downlink** */ export type Direction = string; @@ -920,17 +961,17 @@ export type CreatedByType = string; /** Known values of {@link ContactsPropertiesProvisioningState} that the service accepts. */ export enum KnownContactsPropertiesProvisioningState { /** Creating */ - Creating = "Creating", + Creating = "creating", /** Succeeded */ - Succeeded = "Succeeded", + Succeeded = "succeeded", /** Failed */ - Failed = "Failed", + Failed = "failed", /** Canceled */ - Canceled = "Canceled", + Canceled = "canceled", /** Updating */ - Updating = "Updating", + Updating = "updating", /** Deleting */ - Deleting = "Deleting" + Deleting = "deleting" } /** @@ -938,29 +979,56 @@ export enum KnownContactsPropertiesProvisioningState { * {@link KnownContactsPropertiesProvisioningState} can be used interchangeably with ContactsPropertiesProvisioningState, * this enum contains the known values that the service supports. * ### Known values supported by the service - * **Creating** \ - * **Succeeded** \ - * **Failed** \ - * **Canceled** \ - * **Updating** \ - * **Deleting** + * **creating** \ + * **succeeded** \ + * **failed** \ + * **canceled** \ + * **updating** \ + * **deleting** */ export type ContactsPropertiesProvisioningState = string; +/** Known values of {@link ContactsStatus} that the service accepts. */ +export enum KnownContactsStatus { + /** Scheduled */ + Scheduled = "scheduled", + /** Cancelled */ + Cancelled = "cancelled", + /** Succeeded */ + Succeeded = "succeeded", + /** Failed */ + Failed = "failed", + /** ProviderCancelled */ + ProviderCancelled = "providerCancelled" +} + +/** + * Defines values for ContactsStatus. \ + * {@link KnownContactsStatus} can be used interchangeably with ContactsStatus, + * this enum contains the known values that the service supports. + * ### Known values supported by the service + * **scheduled** \ + * **cancelled** \ + * **succeeded** \ + * **failed** \ + * **providerCancelled** + */ +export type ContactsStatus = string; + /** Known values of {@link ContactProfilesPropertiesProvisioningState} that the service accepts. */ export enum KnownContactProfilesPropertiesProvisioningState { /** Creating */ - Creating = "Creating", + Creating = "creating", /** Succeeded */ - Succeeded = "Succeeded", + Succeeded = "succeeded", /** Failed */ - Failed = "Failed", + Failed = "failed", /** Canceled */ - Canceled = "Canceled", + Canceled = "canceled", /** Updating */ - Updating = "Updating", + Updating = "updating", /** Deleting */ - Deleting = "Deleting" + Deleting = "deleting" } /** @@ -968,12 +1036,12 @@ export enum KnownContactProfilesPropertiesProvisioningState { * {@link KnownContactProfilesPropertiesProvisioningState} can be used interchangeably with ContactProfilesPropertiesProvisioningState, * this enum contains the known values that the service supports. * ### Known values supported by the service - * **Creating** \ - * **Succeeded** \ - * **Failed** \ - * **Canceled** \ - * **Updating** \ - * **Deleting** + * **creating** \ + * **succeeded** \ + * **failed** \ + * **canceled** \ + * **updating** \ + * **deleting** */ export type ContactProfilesPropertiesProvisioningState = string; @@ -1031,6 +1099,30 @@ export enum KnownReleaseMode { */ export type ReleaseMode = string; +/** Known values of {@link Status} that the service accepts. */ +export enum KnownStatus { + /** Succeeded */ + Succeeded = "Succeeded", + /** Canceled */ + Canceled = "Canceled", + /** Failed */ + Failed = "Failed", + /** Running */ + Running = "Running" +} + +/** + * Defines values for Status. \ + * {@link KnownStatus} can be used interchangeably with Status, + * this enum contains the known values that the service supports. + * ### Known values supported by the service + * **Succeeded** \ + * **Canceled** \ + * **Failed** \ + * **Running** + */ +export type Status = string; + /** Known values of {@link Capability} that the service accepts. */ export enum KnownCapability { /** EarthObservation */ @@ -1048,38 +1140,6 @@ export enum KnownCapability { * **Communication** */ export type Capability = string; - -/** Known values of {@link ApiVersionParameter} that the service accepts. */ -export enum KnownApiVersionParameter { - /** TwoThousandTwenty0901Preview */ - TwoThousandTwenty0901Preview = "2020-09-01-preview", - /** TwoThousandTwentyOne0404Preview */ - TwoThousandTwentyOne0404Preview = "2021-04-04-preview", - /** TwoThousandTwentyTwo0301 */ - TwoThousandTwentyTwo0301 = "2022-03-01" -} - -/** - * Defines values for ApiVersionParameter. \ - * {@link KnownApiVersionParameter} can be used interchangeably with ApiVersionParameter, - * this enum contains the known values that the service supports. - * ### Known values supported by the service - * **2020-09-01-preview** \ - * **2021-04-04-preview** \ - * **2022-03-01** - */ -export type ApiVersionParameter = string; -/** Defines values for Status. */ -export type Status = - | "scheduled" - | "cancelled" - | "succeeded" - | "failed" - | "providerCancelled" - | "Succeeded" - | "Canceled" - | "Failed" - | "Running"; /** Defines values for AutoTrackingConfiguration. */ export type AutoTrackingConfiguration = "disabled" | "xBand" | "sBand"; @@ -1122,18 +1182,10 @@ export interface SpacecraftsCreateOrUpdateOptionalParams extends coreClient.OperationOptions { /** Resource tags. */ tags?: { [propertyName: string]: string }; - /** The current state of the resource's creation, deletion, or modification */ + /** The current state of the resource's creation, deletion, or modification. */ provisioningState?: SpacecraftsPropertiesProvisioningState; /** NORAD ID of the spacecraft. */ noradId?: string; - /** Title line of Two Line Element (TLE). */ - titleLine?: string; - /** Line 1 of Two Line Element (TLE). */ - tleLine1?: string; - /** Line 2 of Two Line Element (TLE). */ - tleLine2?: string; - /** Links of the Spacecraft */ - links?: SpacecraftLink[]; /** Delay to wait until next poll, in milliseconds. */ updateIntervalInMs?: number; /** A serialized poller which can be used to resume an existing paused Long-Running-Operation. */ @@ -1254,20 +1306,18 @@ export interface ContactProfilesCreateOrUpdateOptionalParams extends coreClient.OperationOptions { /** Resource tags. */ tags?: { [propertyName: string]: string }; - /** The current state of the resource's creation, deletion, or modification */ + /** The current state of the resource's creation, deletion, or modification. */ provisioningState?: ContactProfilesPropertiesProvisioningState; - /** Minimum viable contact duration in ISO 8601 format. */ + /** Minimum viable contact duration in ISO 8601 format. Used for listing the available contacts with a spacecraft at a given ground station. */ minimumViableContactDuration?: string; - /** Minimum viable elevation for the contact in decimal degrees. */ + /** Minimum viable elevation for the contact in decimal degrees. Used for listing the available contacts with a spacecraft at a given ground station. */ minimumElevationDegrees?: number; - /** Auto track configuration. */ + /** Auto-tracking configuration. */ autoTrackingConfiguration?: AutoTrackingConfiguration; - /** The URI of the Event Hub used for telemetry */ + /** ARM resource identifier of the Event Hub used for telemetry. Requires granting Orbital Resource Provider the rights to send telemetry into the hub. */ eventHubUri?: string; - /** Network configuration of customer virtual network. */ - networkConfiguration?: ContactProfilesPropertiesNetworkConfiguration; - /** Links of the Contact Profile */ - links?: ContactProfileLink[]; + /** Third-party mission configuration of the Contact Profile. Describes RF links, modem processing, and IP endpoints. */ + thirdPartyConfigurations?: ContactProfileThirdPartyConfiguration[]; /** Delay to wait until next poll, in milliseconds. */ updateIntervalInMs?: number; /** A serialized poller which can be used to resume an existing paused Long-Running-Operation. */ @@ -1339,13 +1389,6 @@ export interface AvailableGroundStationsListByCapabilityOptionalParams /** Contains response data for the listByCapability operation. */ export type AvailableGroundStationsListByCapabilityResponse = AvailableGroundStationListResult; -/** Optional parameters. */ -export interface AvailableGroundStationsGetOptionalParams - extends coreClient.OperationOptions {} - -/** Contains response data for the get operation. */ -export type AvailableGroundStationsGetResponse = AvailableGroundStation; - /** Optional parameters. */ export interface AvailableGroundStationsListByCapabilityNextOptionalParams extends coreClient.OperationOptions {} diff --git a/sdk/orbital/arm-orbital/src/models/mappers.ts b/sdk/orbital/arm-orbital/src/models/mappers.ts index a80a7f82b8f2..c4b9da4cc0d2 100644 --- a/sdk/orbital/arm-orbital/src/models/mappers.ts +++ b/sdk/orbital/arm-orbital/src/models/mappers.ts @@ -118,56 +118,97 @@ export const OperationDisplay: coreClient.CompositeMapper = { } }; -export const CloudError: coreClient.CompositeMapper = { +export const ErrorResponse: coreClient.CompositeMapper = { type: { name: "Composite", - className: "CloudError", + className: "ErrorResponse", modelProperties: { error: { serializedName: "error", type: { name: "Composite", - className: "CloudErrorBody" + className: "ErrorDetail" } } } } }; -export const CloudErrorBody: coreClient.CompositeMapper = { +export const ErrorDetail: coreClient.CompositeMapper = { type: { name: "Composite", - className: "CloudErrorBody", + className: "ErrorDetail", modelProperties: { code: { serializedName: "code", + readOnly: true, type: { name: "String" } }, message: { serializedName: "message", + readOnly: true, type: { name: "String" } }, target: { serializedName: "target", + readOnly: true, type: { name: "String" } }, details: { serializedName: "details", + readOnly: true, type: { name: "Sequence", element: { type: { name: "Composite", - className: "CloudErrorBody" + className: "ErrorDetail" } } } + }, + additionalInfo: { + serializedName: "additionalInfo", + readOnly: true, + type: { + name: "Sequence", + element: { + type: { + name: "Composite", + className: "ErrorAdditionalInfo" + } + } + } + } + } + } +}; + +export const ErrorAdditionalInfo: coreClient.CompositeMapper = { + type: { + name: "Composite", + className: "ErrorAdditionalInfo", + modelProperties: { + type: { + serializedName: "type", + readOnly: true, + type: { + name: "String" + } + }, + info: { + serializedName: "info", + readOnly: true, + type: { + name: "Dictionary", + value: { type: { name: "any" } } + } } } } @@ -265,12 +306,14 @@ export const AuthorizedGroundstation: coreClient.CompositeMapper = { modelProperties: { groundStation: { serializedName: "groundStation", + required: true, type: { name: "String" } }, expirationDate: { serializedName: "expirationDate", + required: true, type: { name: "Date" } @@ -438,6 +481,7 @@ export const ResourceReference: coreClient.CompositeMapper = { modelProperties: { id: { serializedName: "id", + required: true, type: { name: "String" } @@ -712,6 +756,18 @@ export const ContactProfilesProperties: coreClient.CompositeMapper = { className: "ContactProfilesPropertiesNetworkConfiguration" } }, + thirdPartyConfigurations: { + serializedName: "thirdPartyConfigurations", + type: { + name: "Sequence", + element: { + type: { + name: "Composite", + className: "ContactProfileThirdPartyConfiguration" + } + } + } + }, links: { serializedName: "links", required: true, @@ -745,6 +801,29 @@ export const ContactProfilesPropertiesNetworkConfiguration: coreClient.Composite } }; +export const ContactProfileThirdPartyConfiguration: coreClient.CompositeMapper = { + type: { + name: "Composite", + className: "ContactProfileThirdPartyConfiguration", + modelProperties: { + providerName: { + serializedName: "providerName", + required: true, + type: { + name: "String" + } + }, + missionConfiguration: { + serializedName: "missionConfiguration", + required: true, + type: { + name: "String" + } + } + } + } +}; + export const ContactProfileLink: coreClient.CompositeMapper = { type: { name: "Composite", @@ -1092,19 +1171,9 @@ export const OperationResult: coreClient.CompositeMapper = { }, status: { serializedName: "status", + readOnly: true, type: { - name: "Enum", - allowedValues: [ - "scheduled", - "cancelled", - "succeeded", - "failed", - "providerCancelled", - "Succeeded", - "Canceled", - "Failed", - "Running" - ] + name: "String" } }, startTime: { @@ -1132,6 +1201,26 @@ export const OperationResult: coreClient.CompositeMapper = { name: "Number" } }, + value: { + serializedName: "value", + readOnly: true, + type: { + name: "Sequence", + element: { + type: { + name: "Dictionary", + value: { type: { name: "any" } } + } + } + } + }, + nextLink: { + serializedName: "nextLink", + readOnly: true, + type: { + name: "String" + } + }, properties: { serializedName: "properties", type: { @@ -1316,13 +1405,6 @@ export const Spacecraft: coreClient.CompositeMapper = { className: "Spacecraft", modelProperties: { ...TrackedResource.type.modelProperties, - etag: { - serializedName: "etag", - readOnly: true, - type: { - name: "String" - } - }, provisioningState: { serializedName: "properties.provisioningState", type: { @@ -1337,24 +1419,28 @@ export const Spacecraft: coreClient.CompositeMapper = { }, titleLine: { serializedName: "properties.titleLine", + required: true, type: { name: "String" } }, tleLine1: { serializedName: "properties.tleLine1", + required: true, type: { name: "String" } }, tleLine2: { serializedName: "properties.tleLine2", + required: true, type: { name: "String" } }, links: { serializedName: "properties.links", + required: true, type: { name: "Sequence", element: { @@ -1375,13 +1461,6 @@ export const ContactProfile: coreClient.CompositeMapper = { className: "ContactProfile", modelProperties: { ...TrackedResource.type.modelProperties, - etag: { - serializedName: "etag", - readOnly: true, - type: { - name: "String" - } - }, provisioningState: { serializedName: "properties.provisioningState", type: { @@ -1420,8 +1499,21 @@ export const ContactProfile: coreClient.CompositeMapper = { className: "ContactProfilesPropertiesNetworkConfiguration" } }, + thirdPartyConfigurations: { + serializedName: "properties.thirdPartyConfigurations", + type: { + name: "Sequence", + element: { + type: { + name: "Composite", + className: "ContactProfileThirdPartyConfiguration" + } + } + } + }, links: { serializedName: "properties.links", + required: true, type: { name: "Sequence", element: { @@ -1442,13 +1534,6 @@ export const Contact: coreClient.CompositeMapper = { className: "Contact", modelProperties: { ...ProxyResource.type.modelProperties, - etag: { - serializedName: "etag", - readOnly: true, - type: { - name: "String" - } - }, provisioningState: { serializedName: "properties.provisioningState", type: { @@ -1459,28 +1544,19 @@ export const Contact: coreClient.CompositeMapper = { serializedName: "properties.status", readOnly: true, type: { - name: "Enum", - allowedValues: [ - "scheduled", - "cancelled", - "succeeded", - "failed", - "providerCancelled", - "Succeeded", - "Canceled", - "Failed", - "Running" - ] + name: "String" } }, reservationStartTime: { serializedName: "properties.reservationStartTime", + required: true, type: { name: "DateTime" } }, reservationEndTime: { serializedName: "properties.reservationEndTime", + required: true, type: { name: "DateTime" } @@ -1543,6 +1619,7 @@ export const Contact: coreClient.CompositeMapper = { }, groundStationName: { serializedName: "properties.groundStationName", + required: true, type: { name: "String" } diff --git a/sdk/orbital/arm-orbital/src/models/parameters.ts b/sdk/orbital/arm-orbital/src/models/parameters.ts index 3a205e5a5026..06802a29f302 100644 --- a/sdk/orbital/arm-orbital/src/models/parameters.ts +++ b/sdk/orbital/arm-orbital/src/models/parameters.ts @@ -46,7 +46,7 @@ export const $host: OperationURLParameter = { export const apiVersion: OperationQueryParameter = { parameterPath: "apiVersion", mapper: { - defaultValue: "2022-03-01", + defaultValue: "2022-11-01", isConstant: true, serializedName: "api-version", type: { @@ -138,22 +138,22 @@ export const noradId: OperationParameter = { }; export const titleLine: OperationParameter = { - parameterPath: ["options", "titleLine"], + parameterPath: "titleLine", mapper: SpacecraftMapper }; export const tleLine1: OperationParameter = { - parameterPath: ["options", "tleLine1"], + parameterPath: "tleLine1", mapper: SpacecraftMapper }; export const tleLine2: OperationParameter = { - parameterPath: ["options", "tleLine2"], + parameterPath: "tleLine2", mapper: SpacecraftMapper }; export const links: OperationParameter = { - parameterPath: ["options", "links"], + parameterPath: "links", mapper: SpacecraftMapper }; @@ -257,19 +257,23 @@ export const eventHubUri: OperationParameter = { }; export const networkConfiguration: OperationParameter = { - parameterPath: ["options", "networkConfiguration"], + parameterPath: "networkConfiguration", + mapper: ContactProfileMapper +}; + +export const thirdPartyConfigurations: OperationParameter = { + parameterPath: ["options", "thirdPartyConfigurations"], mapper: ContactProfileMapper }; export const links1: OperationParameter = { - parameterPath: ["options", "links"], + parameterPath: "links", mapper: ContactProfileMapper }; export const capability: OperationQueryParameter = { parameterPath: "capability", mapper: { - defaultValue: "EarthObservation", serializedName: "capability", required: true, type: { @@ -278,17 +282,6 @@ export const capability: OperationQueryParameter = { } }; -export const groundStationName1: OperationURLParameter = { - parameterPath: "groundStationName", - mapper: { - serializedName: "groundStationName", - required: true, - type: { - name: "String" - } - } -}; - export const location2: OperationURLParameter = { parameterPath: "location", mapper: { diff --git a/sdk/orbital/arm-orbital/src/operations/availableGroundStations.ts b/sdk/orbital/arm-orbital/src/operations/availableGroundStations.ts index c1e34a0aaf88..d39cc188e382 100644 --- a/sdk/orbital/arm-orbital/src/operations/availableGroundStations.ts +++ b/sdk/orbital/arm-orbital/src/operations/availableGroundStations.ts @@ -19,8 +19,6 @@ import { CapabilityParameter, AvailableGroundStationsListByCapabilityOptionalParams, AvailableGroundStationsListByCapabilityResponse, - AvailableGroundStationsGetOptionalParams, - AvailableGroundStationsGetResponse, AvailableGroundStationsListByCapabilityNextResponse } from "../models"; @@ -38,8 +36,8 @@ export class AvailableGroundStationsImpl implements AvailableGroundStations { } /** - * Returns list of available ground stations - * @param capability Ground Station Capability + * Returns list of available ground stations. + * @param capability Ground Station Capability. * @param options The options parameters. */ public listByCapability( @@ -99,8 +97,8 @@ export class AvailableGroundStationsImpl implements AvailableGroundStations { } /** - * Returns list of available ground stations - * @param capability Ground Station Capability + * Returns list of available ground stations. + * @param capability Ground Station Capability. * @param options The options parameters. */ private _listByCapability( @@ -113,21 +111,6 @@ export class AvailableGroundStationsImpl implements AvailableGroundStations { ); } - /** - * Gets the specified available ground station - * @param groundStationName Ground Station name - * @param options The options parameters. - */ - get( - groundStationName: string, - options?: AvailableGroundStationsGetOptionalParams - ): Promise { - return this.client.sendOperationRequest( - { groundStationName, options }, - getOperationSpec - ); - } - /** * ListByCapabilityNext * @param nextLink The nextLink from the previous successful call to the ListByCapability method. @@ -155,7 +138,7 @@ const listByCapabilityOperationSpec: coreClient.OperationSpec = { bodyMapper: Mappers.AvailableGroundStationListResult }, default: { - bodyMapper: Mappers.CloudError + bodyMapper: Mappers.ErrorResponse } }, queryParameters: [Parameters.apiVersion, Parameters.capability], @@ -163,27 +146,6 @@ const listByCapabilityOperationSpec: coreClient.OperationSpec = { headerParameters: [Parameters.accept], serializer }; -const getOperationSpec: coreClient.OperationSpec = { - path: - "/subscriptions/{subscriptionId}/providers/Microsoft.Orbital/availableGroundStations/{groundStationName}", - httpMethod: "GET", - responses: { - 200: { - bodyMapper: Mappers.AvailableGroundStation - }, - default: { - bodyMapper: Mappers.CloudError - } - }, - queryParameters: [Parameters.apiVersion], - urlParameters: [ - Parameters.$host, - Parameters.subscriptionId, - Parameters.groundStationName1 - ], - headerParameters: [Parameters.accept], - serializer -}; const listByCapabilityNextOperationSpec: coreClient.OperationSpec = { path: "{nextLink}", httpMethod: "GET", @@ -192,7 +154,7 @@ const listByCapabilityNextOperationSpec: coreClient.OperationSpec = { bodyMapper: Mappers.AvailableGroundStationListResult }, default: { - bodyMapper: Mappers.CloudError + bodyMapper: Mappers.ErrorResponse } }, urlParameters: [ diff --git a/sdk/orbital/arm-orbital/src/operations/contactProfiles.ts b/sdk/orbital/arm-orbital/src/operations/contactProfiles.ts index c2b779d7e6d1..552f3ace0497 100644 --- a/sdk/orbital/arm-orbital/src/operations/contactProfiles.ts +++ b/sdk/orbital/arm-orbital/src/operations/contactProfiles.ts @@ -25,6 +25,8 @@ import { ContactProfilesListResponse, ContactProfilesGetOptionalParams, ContactProfilesGetResponse, + ContactProfilesPropertiesNetworkConfiguration, + ContactProfileLink, ContactProfilesCreateOrUpdateOptionalParams, ContactProfilesCreateOrUpdateResponse, ContactProfilesDeleteOptionalParams, @@ -49,7 +51,7 @@ export class ContactProfilesImpl implements ContactProfiles { } /** - * Returns list of contact profiles by Subscription + * Returns list of contact profiles by Subscription. * @param options The options parameters. */ public listBySubscription( @@ -103,7 +105,7 @@ export class ContactProfilesImpl implements ContactProfiles { } /** - * Returns list of contact profiles by Resource Group + * Returns list of contact profiles by Resource Group. * @param resourceGroupName The name of the resource group. The name is case insensitive. * @param options The options parameters. */ @@ -165,9 +167,9 @@ export class ContactProfilesImpl implements ContactProfiles { } /** - * Gets the specified contact Profile in a specified resource group + * Gets the specified contact Profile in a specified resource group. * @param resourceGroupName The name of the resource group. The name is case insensitive. - * @param contactProfileName Contact Profile Name + * @param contactProfileName Contact Profile name. * @param options The options parameters. */ get( @@ -182,16 +184,20 @@ export class ContactProfilesImpl implements ContactProfiles { } /** - * Creates or updates a contact profile + * Creates or updates a contact profile. * @param resourceGroupName The name of the resource group. The name is case insensitive. - * @param contactProfileName Contact Profile Name + * @param contactProfileName Contact Profile name. * @param location The geo-location where the resource lives + * @param networkConfiguration Network configuration of customer virtual network. + * @param links Links of the Contact Profile. Describes RF links, modem processing, and IP endpoints. * @param options The options parameters. */ async beginCreateOrUpdate( resourceGroupName: string, contactProfileName: string, location: string, + networkConfiguration: ContactProfilesPropertiesNetworkConfiguration, + links: ContactProfileLink[], options?: ContactProfilesCreateOrUpdateOptionalParams ): Promise< PollerLike< @@ -240,7 +246,14 @@ export class ContactProfilesImpl implements ContactProfiles { const lro = new LroImpl( sendOperation, - { resourceGroupName, contactProfileName, location, options }, + { + resourceGroupName, + contactProfileName, + location, + networkConfiguration, + links, + options + }, createOrUpdateOperationSpec ); const poller = new LroEngine(lro, { @@ -253,22 +266,28 @@ export class ContactProfilesImpl implements ContactProfiles { } /** - * Creates or updates a contact profile + * Creates or updates a contact profile. * @param resourceGroupName The name of the resource group. The name is case insensitive. - * @param contactProfileName Contact Profile Name + * @param contactProfileName Contact Profile name. * @param location The geo-location where the resource lives + * @param networkConfiguration Network configuration of customer virtual network. + * @param links Links of the Contact Profile. Describes RF links, modem processing, and IP endpoints. * @param options The options parameters. */ async beginCreateOrUpdateAndWait( resourceGroupName: string, contactProfileName: string, location: string, + networkConfiguration: ContactProfilesPropertiesNetworkConfiguration, + links: ContactProfileLink[], options?: ContactProfilesCreateOrUpdateOptionalParams ): Promise { const poller = await this.beginCreateOrUpdate( resourceGroupName, contactProfileName, location, + networkConfiguration, + links, options ); return poller.pollUntilDone(); @@ -277,7 +296,7 @@ export class ContactProfilesImpl implements ContactProfiles { /** * Deletes a specified contact profile resource. * @param resourceGroupName The name of the resource group. The name is case insensitive. - * @param contactProfileName Contact Profile Name + * @param contactProfileName Contact Profile name. * @param options The options parameters. */ async beginDelete( @@ -341,7 +360,7 @@ export class ContactProfilesImpl implements ContactProfiles { /** * Deletes a specified contact profile resource. * @param resourceGroupName The name of the resource group. The name is case insensitive. - * @param contactProfileName Contact Profile Name + * @param contactProfileName Contact Profile name. * @param options The options parameters. */ async beginDeleteAndWait( @@ -360,7 +379,7 @@ export class ContactProfilesImpl implements ContactProfiles { /** * Updates the specified contact profile tags. * @param resourceGroupName The name of the resource group. The name is case insensitive. - * @param contactProfileName Contact Profile Name + * @param contactProfileName Contact Profile name. * @param parameters Parameters supplied to update contact profile tags. * @param options The options parameters. */ @@ -431,7 +450,7 @@ export class ContactProfilesImpl implements ContactProfiles { /** * Updates the specified contact profile tags. * @param resourceGroupName The name of the resource group. The name is case insensitive. - * @param contactProfileName Contact Profile Name + * @param contactProfileName Contact Profile name. * @param parameters Parameters supplied to update contact profile tags. * @param options The options parameters. */ @@ -451,7 +470,7 @@ export class ContactProfilesImpl implements ContactProfiles { } /** - * Returns list of contact profiles by Subscription + * Returns list of contact profiles by Subscription. * @param options The options parameters. */ private _listBySubscription( @@ -464,7 +483,7 @@ export class ContactProfilesImpl implements ContactProfiles { } /** - * Returns list of contact profiles by Resource Group + * Returns list of contact profiles by Resource Group. * @param resourceGroupName The name of the resource group. The name is case insensitive. * @param options The options parameters. */ @@ -522,7 +541,7 @@ const getOperationSpec: coreClient.OperationSpec = { bodyMapper: Mappers.ContactProfile }, default: { - bodyMapper: Mappers.CloudError + bodyMapper: Mappers.ErrorResponse } }, queryParameters: [Parameters.apiVersion], @@ -553,7 +572,7 @@ const createOrUpdateOperationSpec: coreClient.OperationSpec = { bodyMapper: Mappers.ContactProfile }, default: { - bodyMapper: Mappers.CloudError + bodyMapper: Mappers.ErrorResponse } }, requestBody: { @@ -565,8 +584,9 @@ const createOrUpdateOperationSpec: coreClient.OperationSpec = { minimumElevationDegrees: ["options", "minimumElevationDegrees"], autoTrackingConfiguration: ["options", "autoTrackingConfiguration"], eventHubUri: ["options", "eventHubUri"], - networkConfiguration: ["options", "networkConfiguration"], - links: ["options", "links"] + networkConfiguration: ["networkConfiguration"], + thirdPartyConfigurations: ["options", "thirdPartyConfigurations"], + links: ["links"] }, mapper: { ...Mappers.ContactProfile, required: true } }, @@ -591,7 +611,7 @@ const deleteOperationSpec: coreClient.OperationSpec = { 202: {}, 204: {}, default: { - bodyMapper: Mappers.CloudError + bodyMapper: Mappers.ErrorResponse } }, queryParameters: [Parameters.apiVersion], @@ -622,7 +642,7 @@ const updateTagsOperationSpec: coreClient.OperationSpec = { bodyMapper: Mappers.ContactProfile }, default: { - bodyMapper: Mappers.CloudError + bodyMapper: Mappers.ErrorResponse } }, requestBody: Parameters.parameters1, @@ -646,7 +666,7 @@ const listBySubscriptionOperationSpec: coreClient.OperationSpec = { bodyMapper: Mappers.ContactProfileListResult }, default: { - bodyMapper: Mappers.CloudError + bodyMapper: Mappers.ErrorResponse } }, queryParameters: [Parameters.apiVersion, Parameters.skiptoken], @@ -663,7 +683,7 @@ const listOperationSpec: coreClient.OperationSpec = { bodyMapper: Mappers.ContactProfileListResult }, default: { - bodyMapper: Mappers.CloudError + bodyMapper: Mappers.ErrorResponse } }, queryParameters: [Parameters.apiVersion, Parameters.skiptoken], @@ -683,7 +703,7 @@ const listBySubscriptionNextOperationSpec: coreClient.OperationSpec = { bodyMapper: Mappers.ContactProfileListResult }, default: { - bodyMapper: Mappers.CloudError + bodyMapper: Mappers.ErrorResponse } }, urlParameters: [ @@ -702,7 +722,7 @@ const listNextOperationSpec: coreClient.OperationSpec = { bodyMapper: Mappers.ContactProfileListResult }, default: { - bodyMapper: Mappers.CloudError + bodyMapper: Mappers.ErrorResponse } }, urlParameters: [ diff --git a/sdk/orbital/arm-orbital/src/operations/contacts.ts b/sdk/orbital/arm-orbital/src/operations/contacts.ts index f833aafda3f1..719463e4180d 100644 --- a/sdk/orbital/arm-orbital/src/operations/contacts.ts +++ b/sdk/orbital/arm-orbital/src/operations/contacts.ts @@ -42,9 +42,9 @@ export class ContactsImpl implements Contacts { } /** - * Returns list of contacts by spacecraftName + * Returns list of contacts by spacecraftName. * @param resourceGroupName The name of the resource group. The name is case insensitive. - * @param spacecraftName Spacecraft ID + * @param spacecraftName Spacecraft ID. * @param options The options parameters. */ public list( @@ -118,9 +118,9 @@ export class ContactsImpl implements Contacts { } /** - * Returns list of contacts by spacecraftName + * Returns list of contacts by spacecraftName. * @param resourceGroupName The name of the resource group. The name is case insensitive. - * @param spacecraftName Spacecraft ID + * @param spacecraftName Spacecraft ID. * @param options The options parameters. */ private _list( @@ -135,10 +135,10 @@ export class ContactsImpl implements Contacts { } /** - * Gets the specified contact in a specified resource group + * Gets the specified contact in a specified resource group. * @param resourceGroupName The name of the resource group. The name is case insensitive. - * @param spacecraftName Spacecraft ID - * @param contactName Contact Name + * @param spacecraftName Spacecraft ID. + * @param contactName Contact name. * @param options The options parameters. */ get( @@ -156,8 +156,8 @@ export class ContactsImpl implements Contacts { /** * Creates a contact. * @param resourceGroupName The name of the resource group. The name is case insensitive. - * @param spacecraftName Spacecraft ID - * @param contactName Contact Name + * @param spacecraftName Spacecraft ID. + * @param contactName Contact name. * @param parameters The parameters to provide for the created contact. * @param options The options parameters. */ @@ -229,8 +229,8 @@ export class ContactsImpl implements Contacts { /** * Creates a contact. * @param resourceGroupName The name of the resource group. The name is case insensitive. - * @param spacecraftName Spacecraft ID - * @param contactName Contact Name + * @param spacecraftName Spacecraft ID. + * @param contactName Contact name. * @param parameters The parameters to provide for the created contact. * @param options The options parameters. */ @@ -252,10 +252,10 @@ export class ContactsImpl implements Contacts { } /** - * Deletes a specified contact + * Deletes a specified contact. * @param resourceGroupName The name of the resource group. The name is case insensitive. - * @param spacecraftName Spacecraft ID - * @param contactName Contact Name + * @param spacecraftName Spacecraft ID. + * @param contactName Contact name. * @param options The options parameters. */ async beginDelete( @@ -318,10 +318,10 @@ export class ContactsImpl implements Contacts { } /** - * Deletes a specified contact + * Deletes a specified contact. * @param resourceGroupName The name of the resource group. The name is case insensitive. - * @param spacecraftName Spacecraft ID - * @param contactName Contact Name + * @param spacecraftName Spacecraft ID. + * @param contactName Contact name. * @param options The options parameters. */ async beginDeleteAndWait( @@ -342,7 +342,7 @@ export class ContactsImpl implements Contacts { /** * ListNext * @param resourceGroupName The name of the resource group. The name is case insensitive. - * @param spacecraftName Spacecraft ID + * @param spacecraftName Spacecraft ID. * @param nextLink The nextLink from the previous successful call to the List method. * @param options The options parameters. */ @@ -370,7 +370,7 @@ const listOperationSpec: coreClient.OperationSpec = { bodyMapper: Mappers.ContactListResult }, default: { - bodyMapper: Mappers.CloudError + bodyMapper: Mappers.ErrorResponse } }, queryParameters: [Parameters.apiVersion, Parameters.skiptoken], @@ -392,7 +392,7 @@ const getOperationSpec: coreClient.OperationSpec = { bodyMapper: Mappers.Contact }, default: { - bodyMapper: Mappers.CloudError + bodyMapper: Mappers.ErrorResponse } }, queryParameters: [Parameters.apiVersion], @@ -424,7 +424,7 @@ const createOperationSpec: coreClient.OperationSpec = { bodyMapper: Mappers.Contact }, default: { - bodyMapper: Mappers.CloudError + bodyMapper: Mappers.ErrorResponse } }, requestBody: Parameters.parameters3, @@ -450,7 +450,7 @@ const deleteOperationSpec: coreClient.OperationSpec = { 202: {}, 204: {}, default: { - bodyMapper: Mappers.CloudError + bodyMapper: Mappers.ErrorResponse } }, queryParameters: [Parameters.apiVersion], @@ -472,7 +472,7 @@ const listNextOperationSpec: coreClient.OperationSpec = { bodyMapper: Mappers.ContactListResult }, default: { - bodyMapper: Mappers.CloudError + bodyMapper: Mappers.ErrorResponse } }, urlParameters: [ diff --git a/sdk/orbital/arm-orbital/src/operations/operations.ts b/sdk/orbital/arm-orbital/src/operations/operations.ts index f6b261a81bd5..c3865da36263 100644 --- a/sdk/orbital/arm-orbital/src/operations/operations.ts +++ b/sdk/orbital/arm-orbital/src/operations/operations.ts @@ -93,7 +93,7 @@ const listOperationSpec: coreClient.OperationSpec = { bodyMapper: Mappers.OperationListResult }, default: { - bodyMapper: Mappers.CloudError + bodyMapper: Mappers.ErrorResponse } }, queryParameters: [Parameters.apiVersion], diff --git a/sdk/orbital/arm-orbital/src/operations/operationsResults.ts b/sdk/orbital/arm-orbital/src/operations/operationsResults.ts index afcfebf0131f..33ba561a9304 100644 --- a/sdk/orbital/arm-orbital/src/operations/operationsResults.ts +++ b/sdk/orbital/arm-orbital/src/operations/operationsResults.ts @@ -92,7 +92,8 @@ export class OperationsResultsImpl implements OperationsResults { ); const poller = new LroEngine(lro, { resumeFrom: options?.resumeFrom, - intervalInMs: options?.updateIntervalInMs + intervalInMs: options?.updateIntervalInMs, + lroResourceLocationConfig: "location" }); await poller.poll(); return poller; @@ -134,7 +135,7 @@ const getOperationSpec: coreClient.OperationSpec = { bodyMapper: Mappers.OperationResult }, default: { - bodyMapper: Mappers.CloudError + bodyMapper: Mappers.ErrorResponse } }, queryParameters: [Parameters.apiVersion], diff --git a/sdk/orbital/arm-orbital/src/operations/spacecrafts.ts b/sdk/orbital/arm-orbital/src/operations/spacecrafts.ts index 13dcf8a3cb38..fee3b8754214 100644 --- a/sdk/orbital/arm-orbital/src/operations/spacecrafts.ts +++ b/sdk/orbital/arm-orbital/src/operations/spacecrafts.ts @@ -30,6 +30,7 @@ import { SpacecraftsListAvailableContactsResponse, SpacecraftsGetOptionalParams, SpacecraftsGetResponse, + SpacecraftLink, SpacecraftsCreateOrUpdateOptionalParams, SpacecraftsCreateOrUpdateResponse, SpacecraftsDeleteOptionalParams, @@ -55,7 +56,7 @@ export class SpacecraftsImpl implements Spacecrafts { } /** - * Return list of spacecrafts + * Returns list of spacecrafts by subscription. * @param options The options parameters. */ public listBySubscription( @@ -109,7 +110,7 @@ export class SpacecraftsImpl implements Spacecrafts { } /** - * Return list of spacecrafts + * Returns list of spacecrafts by resource group. * @param resourceGroupName The name of the resource group. The name is case insensitive. * @param options The options parameters. */ @@ -171,13 +172,14 @@ export class SpacecraftsImpl implements Spacecrafts { } /** - * Return list of available contacts + * Returns list of available contacts. A contact is available if the spacecraft is visible from the + * ground station for more than the minimum viable contact duration provided in the contact profile. * @param resourceGroupName The name of the resource group. The name is case insensitive. - * @param spacecraftName Spacecraft ID + * @param spacecraftName Spacecraft ID. * @param contactProfile The reference to the contact profile resource. * @param groundStationName Name of Azure Ground Station. - * @param startTime Start time of a contact. - * @param endTime End time of a contact. + * @param startTime Start time of a contact (ISO 8601 UTC standard). + * @param endTime End time of a contact (ISO 8601 UTC standard). * @param options The options parameters. */ public beginListAvailableContactsAndWait( @@ -292,7 +294,7 @@ export class SpacecraftsImpl implements Spacecrafts { } /** - * Return list of spacecrafts + * Returns list of spacecrafts by subscription. * @param options The options parameters. */ private _listBySubscription( @@ -305,7 +307,7 @@ export class SpacecraftsImpl implements Spacecrafts { } /** - * Return list of spacecrafts + * Returns list of spacecrafts by resource group. * @param resourceGroupName The name of the resource group. The name is case insensitive. * @param options The options parameters. */ @@ -320,9 +322,9 @@ export class SpacecraftsImpl implements Spacecrafts { } /** - * Gets the specified spacecraft in a specified resource group + * Gets the specified spacecraft in a specified resource group. * @param resourceGroupName The name of the resource group. The name is case insensitive. - * @param spacecraftName Spacecraft ID + * @param spacecraftName Spacecraft ID. * @param options The options parameters. */ get( @@ -337,16 +339,24 @@ export class SpacecraftsImpl implements Spacecrafts { } /** - * Creates or updates a spacecraft resource + * Creates or updates a spacecraft resource. * @param resourceGroupName The name of the resource group. The name is case insensitive. - * @param spacecraftName Spacecraft ID + * @param spacecraftName Spacecraft ID. * @param location The geo-location where the resource lives + * @param titleLine Title line of the two-line element set (TLE). + * @param tleLine1 Line 1 of the two-line element set (TLE). + * @param tleLine2 Line 2 of the two-line element set (TLE). + * @param links Immutable list of Spacecraft links. * @param options The options parameters. */ async beginCreateOrUpdate( resourceGroupName: string, spacecraftName: string, location: string, + titleLine: string, + tleLine1: string, + tleLine2: string, + links: SpacecraftLink[], options?: SpacecraftsCreateOrUpdateOptionalParams ): Promise< PollerLike< @@ -395,7 +405,16 @@ export class SpacecraftsImpl implements Spacecrafts { const lro = new LroImpl( sendOperation, - { resourceGroupName, spacecraftName, location, options }, + { + resourceGroupName, + spacecraftName, + location, + titleLine, + tleLine1, + tleLine2, + links, + options + }, createOrUpdateOperationSpec ); const poller = new LroEngine(lro, { @@ -408,22 +427,34 @@ export class SpacecraftsImpl implements Spacecrafts { } /** - * Creates or updates a spacecraft resource + * Creates or updates a spacecraft resource. * @param resourceGroupName The name of the resource group. The name is case insensitive. - * @param spacecraftName Spacecraft ID + * @param spacecraftName Spacecraft ID. * @param location The geo-location where the resource lives + * @param titleLine Title line of the two-line element set (TLE). + * @param tleLine1 Line 1 of the two-line element set (TLE). + * @param tleLine2 Line 2 of the two-line element set (TLE). + * @param links Immutable list of Spacecraft links. * @param options The options parameters. */ async beginCreateOrUpdateAndWait( resourceGroupName: string, spacecraftName: string, location: string, + titleLine: string, + tleLine1: string, + tleLine2: string, + links: SpacecraftLink[], options?: SpacecraftsCreateOrUpdateOptionalParams ): Promise { const poller = await this.beginCreateOrUpdate( resourceGroupName, spacecraftName, location, + titleLine, + tleLine1, + tleLine2, + links, options ); return poller.pollUntilDone(); @@ -432,7 +463,7 @@ export class SpacecraftsImpl implements Spacecrafts { /** * Deletes a specified spacecraft resource. * @param resourceGroupName The name of the resource group. The name is case insensitive. - * @param spacecraftName Spacecraft ID + * @param spacecraftName Spacecraft ID. * @param options The options parameters. */ async beginDelete( @@ -496,7 +527,7 @@ export class SpacecraftsImpl implements Spacecrafts { /** * Deletes a specified spacecraft resource. * @param resourceGroupName The name of the resource group. The name is case insensitive. - * @param spacecraftName Spacecraft ID + * @param spacecraftName Spacecraft ID. * @param options The options parameters. */ async beginDeleteAndWait( @@ -515,7 +546,7 @@ export class SpacecraftsImpl implements Spacecrafts { /** * Updates the specified spacecraft tags. * @param resourceGroupName The name of the resource group. The name is case insensitive. - * @param spacecraftName Spacecraft ID + * @param spacecraftName Spacecraft ID. * @param parameters Parameters supplied to update spacecraft tags. * @param options The options parameters. */ @@ -586,7 +617,7 @@ export class SpacecraftsImpl implements Spacecrafts { /** * Updates the specified spacecraft tags. * @param resourceGroupName The name of the resource group. The name is case insensitive. - * @param spacecraftName Spacecraft ID + * @param spacecraftName Spacecraft ID. * @param parameters Parameters supplied to update spacecraft tags. * @param options The options parameters. */ @@ -606,13 +637,14 @@ export class SpacecraftsImpl implements Spacecrafts { } /** - * Return list of available contacts + * Returns list of available contacts. A contact is available if the spacecraft is visible from the + * ground station for more than the minimum viable contact duration provided in the contact profile. * @param resourceGroupName The name of the resource group. The name is case insensitive. - * @param spacecraftName Spacecraft ID + * @param spacecraftName Spacecraft ID. * @param contactProfile The reference to the contact profile resource. * @param groundStationName Name of Azure Ground Station. - * @param startTime Start time of a contact. - * @param endTime End time of a contact. + * @param startTime Start time of a contact (ISO 8601 UTC standard). + * @param endTime End time of a contact (ISO 8601 UTC standard). * @param options The options parameters. */ private async _listAvailableContacts( @@ -725,11 +757,11 @@ export class SpacecraftsImpl implements Spacecrafts { /** * ListAvailableContactsNext * @param resourceGroupName The name of the resource group. The name is case insensitive. - * @param spacecraftName Spacecraft ID + * @param spacecraftName Spacecraft ID. * @param contactProfile The reference to the contact profile resource. * @param groundStationName Name of Azure Ground Station. - * @param startTime Start time of a contact. - * @param endTime End time of a contact. + * @param startTime Start time of a contact (ISO 8601 UTC standard). + * @param endTime End time of a contact (ISO 8601 UTC standard). * @param nextLink The nextLink from the previous successful call to the ListAvailableContacts method. * @param options The options parameters. */ @@ -770,7 +802,7 @@ const listBySubscriptionOperationSpec: coreClient.OperationSpec = { bodyMapper: Mappers.SpacecraftListResult }, default: { - bodyMapper: Mappers.CloudError + bodyMapper: Mappers.ErrorResponse } }, queryParameters: [Parameters.apiVersion, Parameters.skiptoken], @@ -787,7 +819,7 @@ const listOperationSpec: coreClient.OperationSpec = { bodyMapper: Mappers.SpacecraftListResult }, default: { - bodyMapper: Mappers.CloudError + bodyMapper: Mappers.ErrorResponse } }, queryParameters: [Parameters.apiVersion, Parameters.skiptoken], @@ -808,7 +840,7 @@ const getOperationSpec: coreClient.OperationSpec = { bodyMapper: Mappers.Spacecraft }, default: { - bodyMapper: Mappers.CloudError + bodyMapper: Mappers.ErrorResponse } }, queryParameters: [Parameters.apiVersion], @@ -839,7 +871,7 @@ const createOrUpdateOperationSpec: coreClient.OperationSpec = { bodyMapper: Mappers.Spacecraft }, default: { - bodyMapper: Mappers.CloudError + bodyMapper: Mappers.ErrorResponse } }, requestBody: { @@ -848,10 +880,10 @@ const createOrUpdateOperationSpec: coreClient.OperationSpec = { location: ["location"], provisioningState: ["options", "provisioningState"], noradId: ["options", "noradId"], - titleLine: ["options", "titleLine"], - tleLine1: ["options", "tleLine1"], - tleLine2: ["options", "tleLine2"], - links: ["options", "links"] + titleLine: ["titleLine"], + tleLine1: ["tleLine1"], + tleLine2: ["tleLine2"], + links: ["links"] }, mapper: { ...Mappers.Spacecraft, required: true } }, @@ -876,7 +908,7 @@ const deleteOperationSpec: coreClient.OperationSpec = { 202: {}, 204: {}, default: { - bodyMapper: Mappers.CloudError + bodyMapper: Mappers.ErrorResponse } }, queryParameters: [Parameters.apiVersion], @@ -907,7 +939,7 @@ const updateTagsOperationSpec: coreClient.OperationSpec = { bodyMapper: Mappers.Spacecraft }, default: { - bodyMapper: Mappers.CloudError + bodyMapper: Mappers.ErrorResponse } }, requestBody: Parameters.parameters1, @@ -940,7 +972,7 @@ const listAvailableContactsOperationSpec: coreClient.OperationSpec = { bodyMapper: Mappers.AvailableContactsListResult }, default: { - bodyMapper: Mappers.CloudError + bodyMapper: Mappers.ErrorResponse } }, requestBody: { @@ -971,7 +1003,7 @@ const listBySubscriptionNextOperationSpec: coreClient.OperationSpec = { bodyMapper: Mappers.SpacecraftListResult }, default: { - bodyMapper: Mappers.CloudError + bodyMapper: Mappers.ErrorResponse } }, urlParameters: [ @@ -990,7 +1022,7 @@ const listNextOperationSpec: coreClient.OperationSpec = { bodyMapper: Mappers.SpacecraftListResult }, default: { - bodyMapper: Mappers.CloudError + bodyMapper: Mappers.ErrorResponse } }, urlParameters: [ @@ -1013,7 +1045,7 @@ const listAvailableContactsNextOperationSpec: coreClient.OperationSpec = { headersMapper: Mappers.SpacecraftsListAvailableContactsNextHeaders }, default: { - bodyMapper: Mappers.CloudError + bodyMapper: Mappers.ErrorResponse } }, urlParameters: [ diff --git a/sdk/orbital/arm-orbital/src/operationsInterfaces/availableGroundStations.ts b/sdk/orbital/arm-orbital/src/operationsInterfaces/availableGroundStations.ts index 148eea09edeb..ab2787d7c533 100644 --- a/sdk/orbital/arm-orbital/src/operationsInterfaces/availableGroundStations.ts +++ b/sdk/orbital/arm-orbital/src/operationsInterfaces/availableGroundStations.ts @@ -10,30 +10,19 @@ import { PagedAsyncIterableIterator } from "@azure/core-paging"; import { AvailableGroundStation, CapabilityParameter, - AvailableGroundStationsListByCapabilityOptionalParams, - AvailableGroundStationsGetOptionalParams, - AvailableGroundStationsGetResponse + AvailableGroundStationsListByCapabilityOptionalParams } from "../models"; /// /** Interface representing a AvailableGroundStations. */ export interface AvailableGroundStations { /** - * Returns list of available ground stations - * @param capability Ground Station Capability + * Returns list of available ground stations. + * @param capability Ground Station Capability. * @param options The options parameters. */ listByCapability( capability: CapabilityParameter, options?: AvailableGroundStationsListByCapabilityOptionalParams ): PagedAsyncIterableIterator; - /** - * Gets the specified available ground station - * @param groundStationName Ground Station name - * @param options The options parameters. - */ - get( - groundStationName: string, - options?: AvailableGroundStationsGetOptionalParams - ): Promise; } diff --git a/sdk/orbital/arm-orbital/src/operationsInterfaces/contactProfiles.ts b/sdk/orbital/arm-orbital/src/operationsInterfaces/contactProfiles.ts index 9bc45c6dd3e7..4f25d765b074 100644 --- a/sdk/orbital/arm-orbital/src/operationsInterfaces/contactProfiles.ts +++ b/sdk/orbital/arm-orbital/src/operationsInterfaces/contactProfiles.ts @@ -14,6 +14,8 @@ import { ContactProfilesListOptionalParams, ContactProfilesGetOptionalParams, ContactProfilesGetResponse, + ContactProfilesPropertiesNetworkConfiguration, + ContactProfileLink, ContactProfilesCreateOrUpdateOptionalParams, ContactProfilesCreateOrUpdateResponse, ContactProfilesDeleteOptionalParams, @@ -26,14 +28,14 @@ import { /** Interface representing a ContactProfiles. */ export interface ContactProfiles { /** - * Returns list of contact profiles by Subscription + * Returns list of contact profiles by Subscription. * @param options The options parameters. */ listBySubscription( options?: ContactProfilesListBySubscriptionOptionalParams ): PagedAsyncIterableIterator; /** - * Returns list of contact profiles by Resource Group + * Returns list of contact profiles by Resource Group. * @param resourceGroupName The name of the resource group. The name is case insensitive. * @param options The options parameters. */ @@ -42,9 +44,9 @@ export interface ContactProfiles { options?: ContactProfilesListOptionalParams ): PagedAsyncIterableIterator; /** - * Gets the specified contact Profile in a specified resource group + * Gets the specified contact Profile in a specified resource group. * @param resourceGroupName The name of the resource group. The name is case insensitive. - * @param contactProfileName Contact Profile Name + * @param contactProfileName Contact Profile name. * @param options The options parameters. */ get( @@ -53,16 +55,20 @@ export interface ContactProfiles { options?: ContactProfilesGetOptionalParams ): Promise; /** - * Creates or updates a contact profile + * Creates or updates a contact profile. * @param resourceGroupName The name of the resource group. The name is case insensitive. - * @param contactProfileName Contact Profile Name + * @param contactProfileName Contact Profile name. * @param location The geo-location where the resource lives + * @param networkConfiguration Network configuration of customer virtual network. + * @param links Links of the Contact Profile. Describes RF links, modem processing, and IP endpoints. * @param options The options parameters. */ beginCreateOrUpdate( resourceGroupName: string, contactProfileName: string, location: string, + networkConfiguration: ContactProfilesPropertiesNetworkConfiguration, + links: ContactProfileLink[], options?: ContactProfilesCreateOrUpdateOptionalParams ): Promise< PollerLike< @@ -71,22 +77,26 @@ export interface ContactProfiles { > >; /** - * Creates or updates a contact profile + * Creates or updates a contact profile. * @param resourceGroupName The name of the resource group. The name is case insensitive. - * @param contactProfileName Contact Profile Name + * @param contactProfileName Contact Profile name. * @param location The geo-location where the resource lives + * @param networkConfiguration Network configuration of customer virtual network. + * @param links Links of the Contact Profile. Describes RF links, modem processing, and IP endpoints. * @param options The options parameters. */ beginCreateOrUpdateAndWait( resourceGroupName: string, contactProfileName: string, location: string, + networkConfiguration: ContactProfilesPropertiesNetworkConfiguration, + links: ContactProfileLink[], options?: ContactProfilesCreateOrUpdateOptionalParams ): Promise; /** * Deletes a specified contact profile resource. * @param resourceGroupName The name of the resource group. The name is case insensitive. - * @param contactProfileName Contact Profile Name + * @param contactProfileName Contact Profile name. * @param options The options parameters. */ beginDelete( @@ -97,7 +107,7 @@ export interface ContactProfiles { /** * Deletes a specified contact profile resource. * @param resourceGroupName The name of the resource group. The name is case insensitive. - * @param contactProfileName Contact Profile Name + * @param contactProfileName Contact Profile name. * @param options The options parameters. */ beginDeleteAndWait( @@ -108,7 +118,7 @@ export interface ContactProfiles { /** * Updates the specified contact profile tags. * @param resourceGroupName The name of the resource group. The name is case insensitive. - * @param contactProfileName Contact Profile Name + * @param contactProfileName Contact Profile name. * @param parameters Parameters supplied to update contact profile tags. * @param options The options parameters. */ @@ -126,7 +136,7 @@ export interface ContactProfiles { /** * Updates the specified contact profile tags. * @param resourceGroupName The name of the resource group. The name is case insensitive. - * @param contactProfileName Contact Profile Name + * @param contactProfileName Contact Profile name. * @param parameters Parameters supplied to update contact profile tags. * @param options The options parameters. */ diff --git a/sdk/orbital/arm-orbital/src/operationsInterfaces/contacts.ts b/sdk/orbital/arm-orbital/src/operationsInterfaces/contacts.ts index af54194ec7d1..27ff526717a7 100644 --- a/sdk/orbital/arm-orbital/src/operationsInterfaces/contacts.ts +++ b/sdk/orbital/arm-orbital/src/operationsInterfaces/contacts.ts @@ -22,9 +22,9 @@ import { /** Interface representing a Contacts. */ export interface Contacts { /** - * Returns list of contacts by spacecraftName + * Returns list of contacts by spacecraftName. * @param resourceGroupName The name of the resource group. The name is case insensitive. - * @param spacecraftName Spacecraft ID + * @param spacecraftName Spacecraft ID. * @param options The options parameters. */ list( @@ -33,10 +33,10 @@ export interface Contacts { options?: ContactsListOptionalParams ): PagedAsyncIterableIterator; /** - * Gets the specified contact in a specified resource group + * Gets the specified contact in a specified resource group. * @param resourceGroupName The name of the resource group. The name is case insensitive. - * @param spacecraftName Spacecraft ID - * @param contactName Contact Name + * @param spacecraftName Spacecraft ID. + * @param contactName Contact name. * @param options The options parameters. */ get( @@ -48,8 +48,8 @@ export interface Contacts { /** * Creates a contact. * @param resourceGroupName The name of the resource group. The name is case insensitive. - * @param spacecraftName Spacecraft ID - * @param contactName Contact Name + * @param spacecraftName Spacecraft ID. + * @param contactName Contact name. * @param parameters The parameters to provide for the created contact. * @param options The options parameters. */ @@ -68,8 +68,8 @@ export interface Contacts { /** * Creates a contact. * @param resourceGroupName The name of the resource group. The name is case insensitive. - * @param spacecraftName Spacecraft ID - * @param contactName Contact Name + * @param spacecraftName Spacecraft ID. + * @param contactName Contact name. * @param parameters The parameters to provide for the created contact. * @param options The options parameters. */ @@ -81,10 +81,10 @@ export interface Contacts { options?: ContactsCreateOptionalParams ): Promise; /** - * Deletes a specified contact + * Deletes a specified contact. * @param resourceGroupName The name of the resource group. The name is case insensitive. - * @param spacecraftName Spacecraft ID - * @param contactName Contact Name + * @param spacecraftName Spacecraft ID. + * @param contactName Contact name. * @param options The options parameters. */ beginDelete( @@ -94,10 +94,10 @@ export interface Contacts { options?: ContactsDeleteOptionalParams ): Promise, void>>; /** - * Deletes a specified contact + * Deletes a specified contact. * @param resourceGroupName The name of the resource group. The name is case insensitive. - * @param spacecraftName Spacecraft ID - * @param contactName Contact Name + * @param spacecraftName Spacecraft ID. + * @param contactName Contact name. * @param options The options parameters. */ beginDeleteAndWait( diff --git a/sdk/orbital/arm-orbital/src/operationsInterfaces/spacecrafts.ts b/sdk/orbital/arm-orbital/src/operationsInterfaces/spacecrafts.ts index c58118f01a19..5b3e9349cedf 100644 --- a/sdk/orbital/arm-orbital/src/operationsInterfaces/spacecrafts.ts +++ b/sdk/orbital/arm-orbital/src/operationsInterfaces/spacecrafts.ts @@ -17,6 +17,7 @@ import { SpacecraftsListAvailableContactsOptionalParams, SpacecraftsGetOptionalParams, SpacecraftsGetResponse, + SpacecraftLink, SpacecraftsCreateOrUpdateOptionalParams, SpacecraftsCreateOrUpdateResponse, SpacecraftsDeleteOptionalParams, @@ -29,14 +30,14 @@ import { /** Interface representing a Spacecrafts. */ export interface Spacecrafts { /** - * Return list of spacecrafts + * Returns list of spacecrafts by subscription. * @param options The options parameters. */ listBySubscription( options?: SpacecraftsListBySubscriptionOptionalParams ): PagedAsyncIterableIterator; /** - * Return list of spacecrafts + * Returns list of spacecrafts by resource group. * @param resourceGroupName The name of the resource group. The name is case insensitive. * @param options The options parameters. */ @@ -45,13 +46,14 @@ export interface Spacecrafts { options?: SpacecraftsListOptionalParams ): PagedAsyncIterableIterator; /** - * Return list of available contacts + * Returns list of available contacts. A contact is available if the spacecraft is visible from the + * ground station for more than the minimum viable contact duration provided in the contact profile. * @param resourceGroupName The name of the resource group. The name is case insensitive. - * @param spacecraftName Spacecraft ID + * @param spacecraftName Spacecraft ID. * @param contactProfile The reference to the contact profile resource. * @param groundStationName Name of Azure Ground Station. - * @param startTime Start time of a contact. - * @param endTime End time of a contact. + * @param startTime Start time of a contact (ISO 8601 UTC standard). + * @param endTime End time of a contact (ISO 8601 UTC standard). * @param options The options parameters. */ beginListAvailableContactsAndWait( @@ -64,9 +66,9 @@ export interface Spacecrafts { options?: SpacecraftsListAvailableContactsOptionalParams ): PagedAsyncIterableIterator; /** - * Gets the specified spacecraft in a specified resource group + * Gets the specified spacecraft in a specified resource group. * @param resourceGroupName The name of the resource group. The name is case insensitive. - * @param spacecraftName Spacecraft ID + * @param spacecraftName Spacecraft ID. * @param options The options parameters. */ get( @@ -75,16 +77,24 @@ export interface Spacecrafts { options?: SpacecraftsGetOptionalParams ): Promise; /** - * Creates or updates a spacecraft resource + * Creates or updates a spacecraft resource. * @param resourceGroupName The name of the resource group. The name is case insensitive. - * @param spacecraftName Spacecraft ID + * @param spacecraftName Spacecraft ID. * @param location The geo-location where the resource lives + * @param titleLine Title line of the two-line element set (TLE). + * @param tleLine1 Line 1 of the two-line element set (TLE). + * @param tleLine2 Line 2 of the two-line element set (TLE). + * @param links Immutable list of Spacecraft links. * @param options The options parameters. */ beginCreateOrUpdate( resourceGroupName: string, spacecraftName: string, location: string, + titleLine: string, + tleLine1: string, + tleLine2: string, + links: SpacecraftLink[], options?: SpacecraftsCreateOrUpdateOptionalParams ): Promise< PollerLike< @@ -93,22 +103,30 @@ export interface Spacecrafts { > >; /** - * Creates or updates a spacecraft resource + * Creates or updates a spacecraft resource. * @param resourceGroupName The name of the resource group. The name is case insensitive. - * @param spacecraftName Spacecraft ID + * @param spacecraftName Spacecraft ID. * @param location The geo-location where the resource lives + * @param titleLine Title line of the two-line element set (TLE). + * @param tleLine1 Line 1 of the two-line element set (TLE). + * @param tleLine2 Line 2 of the two-line element set (TLE). + * @param links Immutable list of Spacecraft links. * @param options The options parameters. */ beginCreateOrUpdateAndWait( resourceGroupName: string, spacecraftName: string, location: string, + titleLine: string, + tleLine1: string, + tleLine2: string, + links: SpacecraftLink[], options?: SpacecraftsCreateOrUpdateOptionalParams ): Promise; /** * Deletes a specified spacecraft resource. * @param resourceGroupName The name of the resource group. The name is case insensitive. - * @param spacecraftName Spacecraft ID + * @param spacecraftName Spacecraft ID. * @param options The options parameters. */ beginDelete( @@ -119,7 +137,7 @@ export interface Spacecrafts { /** * Deletes a specified spacecraft resource. * @param resourceGroupName The name of the resource group. The name is case insensitive. - * @param spacecraftName Spacecraft ID + * @param spacecraftName Spacecraft ID. * @param options The options parameters. */ beginDeleteAndWait( @@ -130,7 +148,7 @@ export interface Spacecrafts { /** * Updates the specified spacecraft tags. * @param resourceGroupName The name of the resource group. The name is case insensitive. - * @param spacecraftName Spacecraft ID + * @param spacecraftName Spacecraft ID. * @param parameters Parameters supplied to update spacecraft tags. * @param options The options parameters. */ @@ -148,7 +166,7 @@ export interface Spacecrafts { /** * Updates the specified spacecraft tags. * @param resourceGroupName The name of the resource group. The name is case insensitive. - * @param spacecraftName Spacecraft ID + * @param spacecraftName Spacecraft ID. * @param parameters Parameters supplied to update spacecraft tags. * @param options The options parameters. */ diff --git a/sdk/orbital/arm-orbital/tsconfig.json b/sdk/orbital/arm-orbital/tsconfig.json index 5962d95cb1e4..3e6ae96443f3 100644 --- a/sdk/orbital/arm-orbital/tsconfig.json +++ b/sdk/orbital/arm-orbital/tsconfig.json @@ -15,17 +15,11 @@ ], "declaration": true, "outDir": "./dist-esm", - "importHelpers": true, - "paths": { - "@azure/arm-orbital": [ - "./src/index" - ] - } + "importHelpers": true }, "include": [ "./src/**/*.ts", - "./test/**/*.ts", - "samples-dev/**/*.ts" + "./test/**/*.ts" ], "exclude": [ "node_modules"