Skip to content

[AutoPR @azure/arm-orbital] [TSP Migration][orbital] TypeSpec migrated from swagger #15376

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
68 changes: 60 additions & 8 deletions sdk/orbital/arm-orbital/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,67 @@
# Release History

## 2.0.1 (Unreleased)

## 3.0.0 (2025-05-06)
### Features Added

### Breaking Changes

### Bugs Fixed
- Added operation OperationsResults.get
- Added Interface AzureResourceManagerArmResponseAvailableContactsListResult
- Added Interface OperationsListNextOptionalParams
- Added Type Alias OperationsListNextResponse
- Interface ContactProfilesCreateOrUpdateHeaders has a new optional parameter retryAfter
- Interface ContactProfilesDeleteHeaders has a new optional parameter retryAfter
- Interface ContactProfilesUpdateTagsHeaders has a new optional parameter retryAfter
- Interface ContactsCreateHeaders has a new optional parameter retryAfter
- Interface ContactsDeleteHeaders has a new optional parameter retryAfter
- Interface SpacecraftsCreateOrUpdateHeaders has a new optional parameter retryAfter
- Interface SpacecraftsDeleteHeaders has a new optional parameter retryAfter
- Interface SpacecraftsListAvailableContactsHeaders has a new optional parameter retryAfter
- Interface SpacecraftsListAvailableContactsNextHeaders has a new optional parameter retryAfter
- Interface SpacecraftsUpdateTagsHeaders has a new optional parameter retryAfter
- Add parameters of OperationsResultsGetHeaders to TypeAlias OperationsResultsGetResponse

### Other Changes
### Breaking Changes

- Removed operation OperationsResults.beginGet
- Removed operation OperationsResults.beginGetAndWait
- 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
- Operation Spacecrafts.beginListAvailableContactsAndWait has a new signature
- Interface ContactProfilesCreateOrUpdateOptionalParams no longer has parameter autoTrackingConfiguration
- Interface ContactProfilesCreateOrUpdateOptionalParams no longer has parameter eventHubUri
- Interface ContactProfilesCreateOrUpdateOptionalParams no longer has parameter minimumElevationDegrees
- Interface ContactProfilesCreateOrUpdateOptionalParams no longer has parameter minimumViableContactDuration
- Interface ContactProfilesCreateOrUpdateOptionalParams no longer has parameter provisioningState
- Interface ContactProfilesCreateOrUpdateOptionalParams no longer has parameter tags
- Interface ContactProfilesCreateOrUpdateOptionalParams no longer has parameter thirdPartyConfigurations
- Interface OperationsResultsGetOptionalParams no longer has parameter resumeFrom
- Interface OperationsResultsGetOptionalParams no longer has parameter updateIntervalInMs
- Interface SpacecraftsCreateOrUpdateOptionalParams no longer has parameter noradId
- Interface SpacecraftsCreateOrUpdateOptionalParams no longer has parameter provisioningState
- Interface SpacecraftsCreateOrUpdateOptionalParams no longer has parameter tags
- Parameter value of interface AvailableContactsListResult is now required
- Parameter value of interface AvailableGroundStationListResult is now required
- Parameter value of interface ContactListResult is now required
- Parameter value of interface ContactProfileListResult is now required
- Parameter value of interface SpacecraftListResult is now required
- Type of parameter spacecraft of interface AvailableContacts is changed from AvailableContactsSpacecraft to ResourceReference
- Type of parameter contactProfile of interface Contact is changed from ContactsPropertiesContactProfile to ResourceReference
- Type of parameter provisioningState of interface Contact is changed from ContactsPropertiesProvisioningState to ProvisioningState
- Type of parameter contactProfile of interface ContactParameters is changed from ContactParametersContactProfile to ResourceReference
- Type of parameter provisioningState of interface ContactProfile is changed from ContactProfilesPropertiesProvisioningState to ProvisioningState
- Type of parameter properties of interface OperationResult is changed from Record<string, unknown> to {
[propertyName: string]: any;
}
- Type of parameter value of interface OperationResult is changed from Record<string, unknown>[] to {
[propertyName: string]: any;
}[]
- Removed Enum KnownCapability
- Removed Enum KnownContactProfilesPropertiesProvisioningState
- Removed Enum KnownContactsPropertiesProvisioningState


## 2.0.0 (2023-03-08)

### Features Added
Expand Down Expand Up @@ -90,4 +142,4 @@

## 1.0.0 (2022-06-02)

The package of @azure/arm-orbital is using our next generation design principles. To learn more, please refer to our documentation [Quick Start](https://aka.ms/azsdk/js/mgmt/quickstart ).
The package of @azure/arm-orbital is using our next generation design principles. To learn more, please refer to our documentation [Quick Start](https://aka.ms/azsdk/js/mgmt/quickstart).
2 changes: 1 addition & 1 deletion sdk/orbital/arm-orbital/LICENSE
Original file line number Diff line number Diff line change
Expand Up @@ -18,4 +18,4 @@ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
SOFTWARE.
9 changes: 2 additions & 7 deletions sdk/orbital/arm-orbital/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,6 @@ npm install @azure/identity
```

You will also need to **register a new AAD application and grant access to AzureOrbital** by assigning the suitable role to your service principal (note: roles such as `"Owner"` will not grant the necessary permissions).
Set the values of the client ID, tenant ID, and client secret of the AAD application as environment variables: `AZURE_CLIENT_ID`, `AZURE_TENANT_ID`, `AZURE_CLIENT_SECRET`.

For more information about how to create an Azure AD Application check out [this guide](https://learn.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal).

Expand All @@ -64,17 +63,14 @@ For browser environments, use the `InteractiveBrowserCredential` from the `@azur
import { InteractiveBrowserCredential } from "@azure/identity";
import { AzureOrbital } from "@azure/arm-orbital";

const subscriptionId = "00000000-0000-0000-0000-000000000000";
const credential = new InteractiveBrowserCredential({
tenantId: "<YOUR_TENANT_ID>",
clientId: "<YOUR_CLIENT_ID>",
});
clientId: "<YOUR_CLIENT_ID>"
});
const client = new AzureOrbital(credential, subscriptionId);
```


### JavaScript Bundle

To use this client library in the browser, first you need to use a bundler. For details on how to do this, please refer to our [bundling documentation](https://aka.ms/AzureSDKBundling).

## Key concepts
Expand Down Expand Up @@ -110,7 +106,6 @@ If you'd like to contribute to this library, please read the [contributing guide
- [Microsoft Azure SDK for JavaScript](https://github.com/Azure/azure-sdk-for-js)



[azure_cli]: https://learn.microsoft.com/cli/azure
[azure_sub]: https://azure.microsoft.com/free/
[azure_sub]: https://azure.microsoft.com/free/
Expand Down
8 changes: 4 additions & 4 deletions sdk/orbital/arm-orbital/_meta.json
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
{
"commit": "4f4044394791773e6e7e82a9bd90d3935caaca1b",
"commit": "14ddb11bf9f301e56ffae91fddb70d797b8918ca",
"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=D:\\Git\\azure-sdk-for-js ..\\azure-rest-api-specs\\specification\\orbital\\resource-manager\\readme.md --use=@autorest/[email protected].0-rc.9 --generate-sample=true",
"autorest_command": "autorest --version=3.9.7 --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.12",
"repository_url": "https://github.com/Azure/azure-rest-api-specs.git",
"release_tool": "@azure-tools/js-sdk-release-tools@2.6.2",
"use": "@autorest/[email protected].0-rc.9"
"release_tool": "@azure-tools/js-sdk-release-tools@2.7.26",
"use": "@autorest/typescript@^6.0.12"
}
2 changes: 1 addition & 1 deletion sdk/orbital/arm-orbital/api-extractor.json
Original file line number Diff line number Diff line change
Expand Up @@ -28,4 +28,4 @@
}
}
}
}
}
36 changes: 14 additions & 22 deletions sdk/orbital/arm-orbital/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,17 +3,17 @@
"sdk-type": "mgmt",
"author": "Microsoft Corporation",
"description": "A generated SDK for AzureOrbital.",
"version": "2.0.1",
"version": "3.0.0",
"engines": {
"node": ">=18.0.0"
},
"dependencies": {
"@azure/abort-controller": "^2.1.2",
"@azure/core-auth": "^1.9.0",
"@azure/core-client": "^1.9.2",
"@azure/core-lro": "^2.5.0",
"@azure/core-client": "^1.9.4",
"@azure/core-lro": "^2.5.4",
"@azure/core-paging": "^1.6.2",
"@azure/core-rest-pipeline": "^1.19.0",
"@azure/core-rest-pipeline": "^1.20.0",
"tslib": "^2.8.1"
},
"keywords": [
Expand All @@ -28,18 +28,19 @@
"main": "./dist/commonjs/index.js",
"module": "./dist/esm/index.js",
"types": "./dist/commonjs/index.d.ts",
"type": "module",
"devDependencies": {
"@azure-tools/test-credential": "^2.0.0",
"@azure-tools/test-recorder": "^4.1.0",
"@azure-tools/test-utils-vitest": "^1.0.0",
"@azure/dev-tool": "^1.0.0",
"@azure/identity": "^4.6.0",
"@azure/logger": "^1.1.4",
"@azure/identity": "^4.9.1",
"@azure/logger": "^1.2.0",
"@types/node": "^18.0.0",
"@vitest/browser": "^3.0.9",
"@vitest/coverage-istanbul": "^3.0.9",
"dotenv": "^16.0.0",
"playwright": "^1.50.1",
"playwright": "^1.52.0",
"typescript": "~5.8.2",
"vitest": "^3.0.9"
},
Expand All @@ -60,16 +61,16 @@
"build:node": "echo skipped",
"build:samples": "echo skipped.",
"build:test": "echo skipped",
"check-format": "echo skipped",
"check-format": "dev-tool run vendored prettier --list-different --config ../../../.prettierrc.json --ignore-path ../../../.prettierignore \"src/**/*.{ts,cts,mts}\" \"test/**/*.{ts,cts,mts}\" \"*.{js,cjs,mjs,json}\" ",
"clean": "dev-tool run vendored rimraf --glob dist dist-browser dist-esm test-dist temp types *.tgz *.log",
"execute:samples": "echo skipped",
"extract-api": "dev-tool run extract-api",
"format": "echo skipped",
"format": "dev-tool run vendored prettier --write --config ../../../.prettierrc.json --ignore-path ../../../.prettierignore \"src/**/*.{ts,cts,mts}\" \"test/**/*.{ts,cts,mts}\" \"*.{js,cjs,mjs,json}\" ",
"integration-test": "npm run integration-test:node && npm run integration-test:browser",
"integration-test:browser": "echo skipped",
"integration-test:node": "dev-tool run test:vitest --esm",
"lint": "echo skipped",
"minify": "echo skipped",
"minify": "dev-tool run vendored uglifyjs -c -m --comments --source-map \"content='./dist/index.js.map'\" -o ./dist/index.min.js ./dist/index.js",
"pack": "npm pack 2>&1",
"prepack": "npm run build",
"test": "npm run integration-test",
Expand All @@ -90,16 +91,9 @@
]
},
"autoPublish": true,
"browser": "./dist/browser/index.js",
"react-native": "./dist/react-native/index.js",
"homepage": "https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/orbital/arm-orbital",
"//sampleConfiguration": {
"productName": "",
"productSlugs": [
"azure"
],
"disableDocsMs": true,
"apiRefLink": "https://learn.microsoft.com/javascript/api/@azure/arm-orbital?view=azure-node-preview"
},
"type": "module",
"tshy": {
"project": "./tsconfig.src.json",
"exports": {
Expand All @@ -116,8 +110,6 @@
],
"selfLink": false
},
"browser": "./dist/browser/index.js",
"react-native": "./dist/react-native/index.js",
"exports": {
"./package.json": "./package.json",
".": {
Expand All @@ -139,4 +131,4 @@
}
}
}
}
}
Loading