Skip to content

Commit

Permalink
CodeGen from PR 16781 in Azure/azure-rest-api-specs
Browse files Browse the repository at this point in the history
[Hub Generated] Public private branch 'dev-orbital-Microsoft.Orbital-2021-04-04-preview' (Azure#16781)

* New Swagger Spec File

* New Swagger Example Spec File

* New Readme Config File

* New Azure AZ Readme Config File

* New Azure CLI Readme Config File

* New Go Language Readme Config File

* New Python Language Readme Config File

* New Typescript Language Readme Config File

* New C# Language Readme Config File

* Orbital sdk 2021 04 04 preview (#5253)

* New Readme Config File

* New Go Language Readme Config File

* New Typescript Language Readme Config File

* New Python Language Readme Config File

* New C# Language Readme Config File

* New Ruby Language Readme Config File

* New Swagger Spec File

* New Swagger Example Spec File

* Added orbital.json file

* Passed linting using AutoRest for 2020-09-01 Azure Orbital Private Privew

* Updated Operation object under Azure Orbital 2020-09-01 preview.

* Updated Operation object under Azure Orbital 2020-09-01 preview.

* Updated Satellites object for Azure Orbital 2020-09-01 preview

* Updated examples for Azure Orbital Private Preview 2020-09-01

* Updated examples for Azure Orbital Private Preview 2020-09-01

* Updated examples for Azure Orbital Private Preview 2020-09-01

* Addressed feedback from ARMChangesRequested

* Updated the GetAvailableContacts api to add long running operation

* Updated the api version

* Updated the objects based on discussion with PM.

* list available ground station made a POST request (#2521)

* list available ground station made a POST request

* Swagger LintDiff fix

Co-authored-by: Devanshu Singh <devasingh@microsoft.com>

* swagger specs for version-20210404-preview

* removed cross version references. Copied over unchanged examples from the previous API version 2021-09-01-preview

* removed availableGroundStations API

* New Readme Config File

New Go Language Readme Config File

New Typescript Language Readme Config File

New Python Language Readme Config File

New C# Language Readme Config File

New Ruby Language Readme Config File

New Swagger Spec File

New Swagger Example Spec File

Added orbital.json file

Passed linting using AutoRest for 2020-09-01 Azure Orbital Private Privew

Updated Operation object under Azure Orbital 2020-09-01 preview.

Updated Operation object under Azure Orbital 2020-09-01 preview.

Updated Satellites object for Azure Orbital 2020-09-01 preview

Updated examples for Azure Orbital Private Preview 2020-09-01

Updated examples for Azure Orbital Private Preview 2020-09-01

Updated examples for Azure Orbital Private Preview 2020-09-01

Addressed feedback from ARMChangesRequested

Updated the GetAvailableContacts api to add long running operation

Updated the api version

Updated the objects based on discussion with PM.

list available ground station made a POST request (#2521)

* list available ground station made a POST request

* Swagger LintDiff fix

Co-authored-by: Devanshu Singh <devasingh@microsoft.com>

* validation check changes. Avocado, SpellCheck and prettier

* validation checks changes

* Modify readme.md for sdk generation

* added system data

* sdk pre namer validation changes

* lintdiff warning changes

* add comms scenario swagger (#3794)

* add comms scenario swagger

* remove unused example

* fix some validation errors

* fix style issues

* update spec based on feedback

* add updated example files

* fix CI errors

* change endpoints/connections list APIs to posts from gets

* connections lists from endpoints return resource IDs rather than full
objects.

* update examples files for endpoints connections list APIs

* fix operationIds and add descriptions

* fix more op ids and add descriptions for real

* fix typos, add constraints, and remove kbps/gbps from bandwidth (#4023)

* Updates to Resource Types (Modifications and Renames) (#4294)

* update orbital.json

* update examples

* prettier fix

* unfix old api version

* fix ci issues

* make more fields immutable

* update provisioning states

* swagger specs for Available groundstation APIs, version 2021-preview (#4920)

* swagger specs for Available groundstation APIs, version 2021-preview

* npm prettier check

* added type object

* removed capability and global comms info from responses

* prettier fix

* changed AP id response

* changes to schema to follow ARM format, resource id update

* Spelling check fix

* Ground Station spell check

* added groundstation to custom words

* Revert "added groundstation to custom words"

This reverts commit 0d7e18217de98836dcb8ba991685e15436004836.

* Revert "Ground Station spell check"

This reverts commit ef85b3b26f9ddf81dc1f50a9b677f9d8f115c4cf.

* Revert "Spelling check fix"

This reverts commit 6bd95c6e013889b6d488703846bbe87bbbb9c494.

* word addition

* type in response

* type definition in swagger

* readonly add

Co-authored-by: Akanksha Bhattacharyya <akankshab@microsoft.com>

* removed comms APIs

* readme updated

* fixed Swagger Avocado errors

* swagger lintDiff fix 1

* swagger lintDiff fix 2

* swagger lintDiff fix 3

Co-authored-by: Sunny Patel <sunny27710@gmail.com>
Co-authored-by: Sunny Patel <sunpatel@microsoft.com>
Co-authored-by: Arthur Ning <57385816+akning-ms@users.noreply.github.com>
Co-authored-by: Devanshu Singh <devasingh@microsoft.com>
Co-authored-by: Zhenglai Zhang <darinzh@microsoft.com>
Co-authored-by: Jim Harris <72156062+MicrosoftJim@users.noreply.github.com>
Co-authored-by: Akanksha Bhattacharyya <akanksha.nb@gmail.com>
Co-authored-by: Akanksha Bhattacharyya <akankshab@microsoft.com>

* operation IDs updated (#5461)

Co-authored-by: Devanshu Singh <devasingh@microsoft.com>

* Dev orbital microsoft.orbital 2021 04 04 preview (#5491)

* operation IDs updated

* updated OperationListResult definition

* review points implemented

Co-authored-by: Devanshu Singh <devasingh@microsoft.com>

* Azure Orbital - Review points implemented (#5507)

* operation IDs updated

* updated OperationListResult definition

* review points implemented

* referencing CloudError, ApiVersionParameter, ResourceGroupNameParameter, SubscriptionIdParameter from common-types

* reverting cloudError refs

* prettify json

* reorder some parameters

Co-authored-by: Devanshu Singh <devasingh@microsoft.com>
Co-authored-by: ArcturusZhang <dapzhang@microsoft.com>

* Removed Empty allOf (#5510)

* operation IDs updated

* updated OperationListResult definition

* review points implemented

* referencing CloudError, ApiVersionParameter, ResourceGroupNameParameter, SubscriptionIdParameter from common-types

* reverting cloudError refs

* prettify json

* removed empty allOf

* validation checks

Co-authored-by: Devanshu Singh <devasingh@microsoft.com>

* readme.go.md fixed (#5512)

* operation IDs updated

* updated OperationListResult definition

* review points implemented

* referencing CloudError, ApiVersionParameter, ResourceGroupNameParameter, SubscriptionIdParameter from common-types

* reverting cloudError refs

* prettify json

* removed empty allOf

* validation checks

* readme.go.md fixed

Co-authored-by: Devanshu Singh <devasingh@microsoft.com>

* Remove last empty allOf (#5513)

* operation IDs updated

* updated OperationListResult definition

* review points implemented

* referencing CloudError, ApiVersionParameter, ResourceGroupNameParameter, SubscriptionIdParameter from common-types

* reverting cloudError refs

* prettify json

* removed empty allOf

* validation checks

* readme.go.md fixed

* remove one last empty allOf

Co-authored-by: Devanshu Singh <devasingh@microsoft.com>

Co-authored-by: Sunny Patel <sunny27710@gmail.com>
Co-authored-by: Sunny Patel <sunpatel@microsoft.com>
Co-authored-by: Arthur Ning <57385816+akning-ms@users.noreply.github.com>
Co-authored-by: Devanshu Singh <devasingh@microsoft.com>
Co-authored-by: Zhenglai Zhang <darinzh@microsoft.com>
Co-authored-by: Jim Harris <72156062+MicrosoftJim@users.noreply.github.com>
Co-authored-by: Akanksha Bhattacharyya <akanksha.nb@gmail.com>
Co-authored-by: Akanksha Bhattacharyya <akankshab@microsoft.com>
Co-authored-by: ArcturusZhang <dapzhang@microsoft.com>
  • Loading branch information
10 people committed Nov 18, 2021
1 parent b4e21db commit 4706b49
Show file tree
Hide file tree
Showing 21 changed files with 4,472 additions and 0 deletions.
21 changes: 21 additions & 0 deletions sdk/orbital/arm-orbital/LICENSE.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
The MIT License (MIT)

Copyright (c) 2021 Microsoft

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
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.
106 changes: 106 additions & 0 deletions sdk/orbital/arm-orbital/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,106 @@
## Azure AzureOrbital SDK for JavaScript

This package contains an isomorphic SDK (runs both in node.js and in browsers) for AzureOrbital.

### Currently supported environments

- [LTS versions of Node.js](https://nodejs.org/about/releases/)
- Latest versions of Safari, Chrome, Edge and Firefox.

### Prerequisites

You must have an [Azure subscription](https://azure.microsoft.com/free/).

### How to install

To use this SDK in your project, you will need to install two packages.
- `@azure/arm-orbital` that contains the client.
- `@azure/identity` that provides different mechanisms for the client to authenticate your requests using Azure Active Directory.

Install both packages using the below command:
```bash
npm install --save @azure/arm-orbital @azure/identity
```
> **Note**: You may have used either `@azure/ms-rest-nodeauth` or `@azure/ms-rest-browserauth` in the past. These packages are in maintenance mode receiving critical bug fixes, but no new features.
If you are on a [Node.js that has LTS status](https://nodejs.org/about/releases/), or are writing a client side browser application, we strongly encourage you to upgrade to `@azure/identity` which uses the latest versions of Azure Active Directory and MSAL APIs and provides more authentication options.

### How to use

- If you are writing a client side browser application,
- Follow the instructions in the section on Authenticating client side browser applications in [Azure Identity examples](https://aka.ms/azsdk/js/identity/examples) to register your application in the Microsoft identity platform and set the right permissions.
- Copy the client ID and tenant ID from the Overview section of your app registration in Azure portal and use it in the browser sample below.
- If you are writing a server side application,
- [Select a credential from `@azure/identity` based on the authentication method of your choice](https://aka.ms/azsdk/js/identity/examples)
- Complete the set up steps required by the credential if any.
- Use the credential you picked in the place of `DefaultAzureCredential` in the Node.js sample below.

In the below samples, we pass the credential and the Azure subscription id to instantiate the client.
Once the client is created, explore the operations on it either in your favorite editor or in our [API reference documentation](https://docs.microsoft.com/javascript/api) to get started.
#### nodejs - Authentication, client creation, and list operations as an example written in JavaScript.

##### Sample code

```javascript
const { DefaultAzureCredential } = require("@azure/identity");
const { AzureOrbital } = require("@azure/arm-orbital");
const subscriptionId = process.env["AZURE_SUBSCRIPTION_ID"];

// Use `DefaultAzureCredential` or any other credential of your choice based on https://aka.ms/azsdk/js/identity/examples
// Please note that you can also use credentials from the `@azure/ms-rest-nodeauth` package instead.
const creds = new DefaultAzureCredential();
const client = new AzureOrbital(creds, subscriptionId);
client.operations.list().then((result) => {
console.log("The result is:");
console.log(result);
}).catch((err) => {
console.log("An error occurred:");
console.error(err);
});
```

#### browser - Authentication, client creation, and list operations as an example written in JavaScript.

In browser applications, we recommend using the `InteractiveBrowserCredential` that interactively authenticates using the default system browser.
- See [Single-page application: App registration guide](https://docs.microsoft.com/azure/active-directory/develop/scenario-spa-app-registration) to configure your app registration for the browser.
- Note down the client Id from the previous step and use it in the browser sample below.

##### Sample code

- index.html

```html
<!DOCTYPE html>
<html lang="en">
<head>
<title>@azure/arm-orbital sample</title>
<script src="node_modules/@azure/ms-rest-azure-js/dist/msRestAzure.js"></script>
<script src="node_modules/@azure/identity/dist/index.js"></script>
<script src="node_modules/@azure/arm-orbital/dist/arm-orbital.js"></script>
<script type="text/javascript">
const subscriptionId = "<Subscription_Id>";
// Create credentials using the `@azure/identity` package.
// Please note that you can also use credentials from the `@azure/ms-rest-browserauth` package instead.
const credential = new InteractiveBrowserCredential(
{
clientId: "<client id for your Azure AD app>",
tenant: "<optional tenant for your organization>"
});
const client = new Azure.ArmOrbital.AzureOrbital(creds, subscriptionId);
client.operations.list().then((result) => {
console.log("The result is:");
console.log(result);
}).catch((err) => {
console.log("An error occurred:");
console.error(err);
});
</script>
</head>
<body></body>
</html>
```

## Related projects

- [Microsoft Azure SDK for Javascript](https://github.com/Azure/azure-sdk-for-js)

![Impressions](https://azure-sdk-impressions.azurewebsites.net/api/impressions/azure-sdk-for-js/sdk/orbital/arm-orbital/README.png)
59 changes: 59 additions & 0 deletions sdk/orbital/arm-orbital/package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
{
"name": "@azure/arm-orbital",
"author": "Microsoft Corporation",
"description": "AzureOrbital Library with typescript type definitions for node.js and browser.",
"version": "1.0.0",
"dependencies": {
"@azure/ms-rest-azure-js": "^2.1.0",
"@azure/ms-rest-js": "^2.2.0",
"@azure/core-auth": "^1.1.4",
"tslib": "^1.10.0"
},
"keywords": [
"node",
"azure",
"typescript",
"browser",
"isomorphic"
],
"license": "MIT",
"main": "./dist/arm-orbital.js",
"module": "./esm/azureOrbital.js",
"types": "./esm/azureOrbital.d.ts",
"devDependencies": {
"typescript": "^3.6.0",
"rollup": "^1.18.0",
"rollup-plugin-node-resolve": "^5.2.0",
"rollup-plugin-sourcemaps": "^0.4.2",
"uglify-js": "^3.6.0"
},
"homepage": "https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/orbital/arm-orbital",
"repository": {
"type": "git",
"url": "https://github.com/Azure/azure-sdk-for-js.git"
},
"bugs": {
"url": "https://github.com/Azure/azure-sdk-for-js/issues"
},
"files": [
"dist/**/*.js",
"dist/**/*.js.map",
"dist/**/*.d.ts",
"dist/**/*.d.ts.map",
"esm/**/*.js",
"esm/**/*.js.map",
"esm/**/*.d.ts",
"esm/**/*.d.ts.map",
"src/**/*.ts",
"README.md",
"rollup.config.js",
"tsconfig.json"
],
"scripts": {
"build": "tsc && rollup -c rollup.config.js && npm run minify",
"minify": "uglifyjs -c -m --comments --source-map \"content='./dist/arm-orbital.js.map'\" -o ./dist/arm-orbital.min.js ./dist/arm-orbital.js",
"prepack": "npm install && npm run build"
},
"sideEffects": false,
"autoPublish": true
}
37 changes: 37 additions & 0 deletions sdk/orbital/arm-orbital/rollup.config.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
import rollup from "rollup";
import nodeResolve from "rollup-plugin-node-resolve";
import sourcemaps from "rollup-plugin-sourcemaps";

/**
* @type {rollup.RollupFileOptions}
*/
const config = {
input: "./esm/azureOrbital.js",
external: [
"@azure/ms-rest-js",
"@azure/ms-rest-azure-js"
],
output: {
file: "./dist/arm-orbital.js",
format: "umd",
name: "Azure.ArmOrbital",
sourcemap: true,
globals: {
"@azure/ms-rest-js": "msRest",
"@azure/ms-rest-azure-js": "msRestAzure"
},
banner: `/*
* Copyright (c) Microsoft Corporation.
* Licensed under the MIT License.
*
* Code generated by Microsoft (R) AutoRest Code Generator.
* Changes may cause incorrect behavior and will be lost if the code is regenerated.
*/`
},
plugins: [
nodeResolve({ mainFields: ['module', 'main'] }),
sourcemaps()
]
};

export default config;
55 changes: 55 additions & 0 deletions sdk/orbital/arm-orbital/src/azureOrbital.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
/*
* Copyright (c) Microsoft Corporation.
* Licensed under the MIT License.
*
* Code generated by Microsoft (R) AutoRest Code Generator.
* Changes may cause incorrect behavior and will be lost if the code is
* regenerated.
*/

import * as msRest from "@azure/ms-rest-js";
import { TokenCredential } from "@azure/core-auth";
import * as Models from "./models";
import * as Mappers from "./models/mappers";
import * as operations from "./operations";
import { AzureOrbitalContext } from "./azureOrbitalContext";


class AzureOrbital extends AzureOrbitalContext {
// Operation groups
operations: operations.Operations;
spacecrafts: operations.Spacecrafts;
contacts: operations.Contacts;
contactProfiles: operations.ContactProfiles;
availableGroundStations: operations.AvailableGroundStations;

/**
* Initializes a new instance of the AzureOrbital class.
* @param credentials Credentials needed for the client to connect to Azure. Credentials
* implementing the TokenCredential interface from the @azure/identity package are recommended. For
* more information about these credentials, see
* {@link https://www.npmjs.com/package/@azure/identity}. Credentials implementing the
* ServiceClientCredentials interface from the older packages @azure/ms-rest-nodeauth and
* @azure/ms-rest-browserauth are also supported.
* @param subscriptionId The ID of the target subscription.
* @param [options] The parameter options
*/
constructor(credentials: msRest.ServiceClientCredentials | TokenCredential, subscriptionId: string, options?: Models.AzureOrbitalOptions) {
super(credentials, subscriptionId, options);
this.operations = new operations.Operations(this);
this.spacecrafts = new operations.Spacecrafts(this);
this.contacts = new operations.Contacts(this);
this.contactProfiles = new operations.ContactProfiles(this);
this.availableGroundStations = new operations.AvailableGroundStations(this);
}
}

// Operation Specifications

export {
AzureOrbital,
AzureOrbitalContext,
Models as AzureOrbitalModels,
Mappers as AzureOrbitalMappers
};
export * from "./operations";
67 changes: 67 additions & 0 deletions sdk/orbital/arm-orbital/src/azureOrbitalContext.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,67 @@
/*
* Copyright (c) Microsoft Corporation.
* Licensed under the MIT License.
*
* Code generated by Microsoft (R) AutoRest Code Generator.
* Changes may cause incorrect behavior and will be lost if the code is
* regenerated.
*/

import * as Models from "./models";
import * as msRest from "@azure/ms-rest-js";
import * as msRestAzure from "@azure/ms-rest-azure-js";
import { TokenCredential } from "@azure/core-auth";

const packageName = "@azure/arm-orbital";
const packageVersion = "1.0.0";

export class AzureOrbitalContext extends msRestAzure.AzureServiceClient {
credentials: msRest.ServiceClientCredentials | TokenCredential;
apiVersion?: string;
subscriptionId: string;

/**
* Initializes a new instance of the AzureOrbital class.
* @param credentials Credentials needed for the client to connect to Azure. Credentials
* implementing the TokenCredential interface from the @azure/identity package are recommended. For
* more information about these credentials, see
* {@link https://www.npmjs.com/package/@azure/identity}. Credentials implementing the
* ServiceClientCredentials interface from the older packages @azure/ms-rest-nodeauth and
* @azure/ms-rest-browserauth are also supported.
* @param subscriptionId The ID of the target subscription.
* @param [options] The parameter options
*/
constructor(credentials: msRest.ServiceClientCredentials | TokenCredential, subscriptionId: string, options?: Models.AzureOrbitalOptions) {
if (credentials == undefined) {
throw new Error('\'credentials\' cannot be null.');
}
if (subscriptionId == undefined) {
throw new Error('\'subscriptionId\' cannot be null.');
}

if (!options) {
options = {};
}
if (!options.userAgent) {
const defaultUserAgent = msRestAzure.getDefaultUserAgentValue();
options.userAgent = `${packageName}/${packageVersion} ${defaultUserAgent}`;
}

super(credentials, options);

this.apiVersion = '2021-04-04-preview';
this.acceptLanguage = 'en-US';
this.longRunningOperationRetryTimeout = 30;
this.baseUri = options.baseUri || this.baseUri || "https://management.azure.com";
this.requestContentType = "application/json; charset=utf-8";
this.credentials = credentials;
this.subscriptionId = subscriptionId;

if (options.acceptLanguage !== null && options.acceptLanguage !== undefined) {
this.acceptLanguage = options.acceptLanguage;
}
if (options.longRunningOperationRetryTimeout !== null && options.longRunningOperationRetryTimeout !== undefined) {
this.longRunningOperationRetryTimeout = options.longRunningOperationRetryTimeout;
}
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
/*
* Copyright (c) Microsoft Corporation.
* Licensed under the MIT License.
*
* Code generated by Microsoft (R) AutoRest Code Generator.
* Changes may cause incorrect behavior and will be lost if the code is regenerated.
*/

export {
AvailableGroundStation,
AvailableGroundStationListResult,
CloudError
} from "../models/mappers";
27 changes: 27 additions & 0 deletions sdk/orbital/arm-orbital/src/models/contactProfilesMappers.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
/*
* Copyright (c) Microsoft Corporation.
* Licensed under the MIT License.
*
* Code generated by Microsoft (R) AutoRest Code Generator.
* Changes may cause incorrect behavior and will be lost if the code is regenerated.
*/

export {
AzureEntityResource,
BaseResource,
CloudError,
Contact,
ContactProfile,
ContactProfileLink,
ContactProfileLinkChannel,
ContactProfileListResult,
EndPoint,
ProxyResource,
Resource,
ResourceReference,
Spacecraft,
SpacecraftLink,
SystemData,
TagsObject,
TrackedResource
} from "../models/mappers";
Loading

0 comments on commit 4706b49

Please sign in to comment.