From d43e70739d4f6afd061c683992453e02a18f38ad Mon Sep 17 00:00:00 2001 From: Devanshu Singh <8132290+thisisdevanshu@users.noreply.github.com> Date: Wed, 6 Oct 2021 11:57:00 -0400 Subject: [PATCH 01/26] New Swagger Spec File --- .../preview/2021-04-04-preview/orbital.json | 132 ++++++++++++++++++ 1 file changed, 132 insertions(+) create mode 100644 specification/orbital/resource-manager/Microsoft.Orbital/preview/2021-04-04-preview/orbital.json diff --git a/specification/orbital/resource-manager/Microsoft.Orbital/preview/2021-04-04-preview/orbital.json b/specification/orbital/resource-manager/Microsoft.Orbital/preview/2021-04-04-preview/orbital.json new file mode 100644 index 000000000000..c4311c6cec7d --- /dev/null +++ b/specification/orbital/resource-manager/Microsoft.Orbital/preview/2021-04-04-preview/orbital.json @@ -0,0 +1,132 @@ +{ + "swagger": "2.0", + "info": { + "version": "2021-04-04-preview", + "title": "orbital", + "description": "Description of the new service", + "x-ms-code-generation-settings": { + "name": "orbitalClient" + } + }, + "host": "management.azure.com", + "schemes": ["https"], + "consumes": ["application/json"], + "produces": ["application/json"], + "security": [ + { + "azure_auth": ["user_impersonation"] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Orbital/operations": { + "get": { + "tags": ["Tag1"], + "operationId": "OperationGroup_Get", + "x-ms-examples": { + "BatchAccountDelete": { "$ref": "./examples/OperationGroupGet.json" } + }, + "description": "This is a sample get operation, please see guidelines in azure-rest-api-specs repository for more info", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "Describe the result of a successful operation.", + "schema": { + "$ref": "#/definitions/Result" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + } + }, + "definitions": { + "Result": { + "description": "Sample result definition", + "properties": { + "sampleProperty": { + "type": "string", + "description": "Sample property of type string" + } + } + }, + "ErrorResponse": { + "description": "Error response.", + "properties": { + "error": { + "$ref": "#/definitions/ErrorDefinition", + "description": "The error details." + } + } + }, + "ErrorDefinition": { + "description": "Error definition.", + "properties": { + "code": { + "description": "Service specific error code which serves as the substatus for the HTTP error code.", + "type": "string", + "readOnly": true + }, + "message": { + "description": "Description of the error.", + "type": "string", + "readOnly": true + }, + "details": { + "description": "Internal error details.", + "type": "array", + "items": { + "$ref": "#/definitions/ErrorDefinition" + }, + "readOnly": true + } + } + } + }, + "parameters": { + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "required": true, + "type": "string", + "description": "The Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000)" + }, + "ResourceGroupNameParameter": { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group.", + "x-ms-parameter-location": "method" + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "The API version to be used with the HTTP request." + } + } +} From c2dc086e5c2dc5f67b7d01787eebdda8791eb808 Mon Sep 17 00:00:00 2001 From: Devanshu Singh <8132290+thisisdevanshu@users.noreply.github.com> Date: Wed, 6 Oct 2021 11:57:01 -0400 Subject: [PATCH 02/26] New Swagger Example Spec File --- .../examples/OperationGroupGet.json | 15 +++++++++++++++ 1 file changed, 15 insertions(+) create mode 100644 specification/orbital/resource-manager/Microsoft.Orbital/preview/2021-04-04-preview/examples/OperationGroupGet.json diff --git a/specification/orbital/resource-manager/Microsoft.Orbital/preview/2021-04-04-preview/examples/OperationGroupGet.json b/specification/orbital/resource-manager/Microsoft.Orbital/preview/2021-04-04-preview/examples/OperationGroupGet.json new file mode 100644 index 000000000000..74dbf6de33e1 --- /dev/null +++ b/specification/orbital/resource-manager/Microsoft.Orbital/preview/2021-04-04-preview/examples/OperationGroupGet.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "accountName": "sampleacct", + "resourceGroupName": "orbitalClient", + "api-version": "2021-04-04-preview", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "sampleProperty": "sampleProperty" + } + } + } +} From 22d7f03325dd931ef8463ae9c04cf202b10f018f Mon Sep 17 00:00:00 2001 From: Devanshu Singh <8132290+thisisdevanshu@users.noreply.github.com> Date: Wed, 6 Oct 2021 11:57:02 -0400 Subject: [PATCH 03/26] New Readme Config File --- .../orbital/resource-manager/readme.md | 77 +++++++++++++++++++ 1 file changed, 77 insertions(+) create mode 100644 specification/orbital/resource-manager/readme.md diff --git a/specification/orbital/resource-manager/readme.md b/specification/orbital/resource-manager/readme.md new file mode 100644 index 000000000000..19db38fee1ef --- /dev/null +++ b/specification/orbital/resource-manager/readme.md @@ -0,0 +1,77 @@ +# orbital + +> see https://aka.ms/autorest + +This is the AutoRest configuration file for orbital. + +## Getting Started + +To build the SDKs for My API, simply install AutoRest via `npm` (`npm install -g autorest`) and then run: + +> `autorest readme.md` + +To see additional help and options, run: + +> `autorest --help` + +For other options on installation see [Installing AutoRest](https://aka.ms/autorest/install) on the AutoRest github page. + +--- + +## Configuration + +### Basic Information + +These are the global settings for the orbital. + +```yaml +openapi-type: arm +tag: package-2021-04-04-preview +``` + +### Tag: package-2021-04-04-preview + +These settings apply only when `--tag=package-2021-04-04-preview` is specified on the command line. + +```yaml $(tag) == 'package-2021-04-04-preview' +input-file: + - Microsoft.Orbital/preview/2021-04-04-preview/orbital.json +``` + +--- + +# Code Generation + +## Swagger to SDK + +This section describes what SDK should be generated by the automatic system. +This is not used by Autorest itself. + +```yaml $(swagger-to-sdk) +swagger-to-sdk: + - repo: azure-sdk-for-python-track2 + - repo: azure-sdk-for-java + - repo: azure-sdk-for-go-track2 + - repo: azure-sdk-for-js + - repo: azure-resource-manager-schemas + - repo: azure-cli-extensions +``` +## Az + +See configuration in [readme.az.md](./readme.az.md) + +## Go + +See configuration in [readme.go.md](./readme.go.md) + +## Python + +See configuration in [readme.python.md](./readme.python.md) + +## TypeScript + +See configuration in [readme.typescript.md](./readme.typescript.md) + +## CSharp + +See configuration in [readme.csharp.md](./readme.csharp.md) From 4df809595391757a6b91970c918ba61c28a34651 Mon Sep 17 00:00:00 2001 From: Devanshu Singh <8132290+thisisdevanshu@users.noreply.github.com> Date: Wed, 6 Oct 2021 11:57:03 -0400 Subject: [PATCH 04/26] New Azure AZ Readme Config File --- .../orbital/resource-manager/readme.az.md | 28 +++++++++++++++++++ 1 file changed, 28 insertions(+) create mode 100644 specification/orbital/resource-manager/readme.az.md diff --git a/specification/orbital/resource-manager/readme.az.md b/specification/orbital/resource-manager/readme.az.md new file mode 100644 index 000000000000..3126290b3676 --- /dev/null +++ b/specification/orbital/resource-manager/readme.az.md @@ -0,0 +1,28 @@ +## AZ + +These settings apply only when `--az` is specified on the command line. + +For new Resource Provider. It is highly recommended to onboard Azure CLI extensions. There's no differences in terms of customer usage. + +``` yaml $(az) && $(target-mode) != 'core' +az: + extensions: orbital + namespace: azure.mgmt.orbital + package-name: azure-mgmt-orbital +az-output-folder: $(azure-cli-extension-folder)/src/orbital +python-sdk-output-folder: "$(az-output-folder)/azext_orbital/vendored_sdks/orbital" +# add additional configuration here specific for Azure CLI +# refer to the faq.md for more details +``` + + + +This is for command modules that already in azure cli main repo. +``` yaml $(az) && $(target-mode) == 'core' +az: + extensions: orbital + namespace: azure.mgmt.orbital + package-name: azure-mgmt-orbital +az-output-folder: $(azure-cli-folder)/src/azure-cli/azure/cli/command_modules/orbital +python-sdk-output-folder: "$(az-output-folder)/vendored_sdks/orbital" +``` \ No newline at end of file From bf2cbd0dc75362c616415567f3ea50959256fbc8 Mon Sep 17 00:00:00 2001 From: Devanshu Singh <8132290+thisisdevanshu@users.noreply.github.com> Date: Wed, 6 Oct 2021 11:57:03 -0400 Subject: [PATCH 05/26] New Azure CLI Readme Config File --- specification/orbital/resource-manager/readme.cli.md | 1 + 1 file changed, 1 insertion(+) create mode 100644 specification/orbital/resource-manager/readme.cli.md diff --git a/specification/orbital/resource-manager/readme.cli.md b/specification/orbital/resource-manager/readme.cli.md new file mode 100644 index 000000000000..c6cf6ad37ea4 --- /dev/null +++ b/specification/orbital/resource-manager/readme.cli.md @@ -0,0 +1 @@ +## CLI Common Settings for all the command line tools \ No newline at end of file From 6c0ae2ed8ac53fc39297b138692260dc80a86639 Mon Sep 17 00:00:00 2001 From: Devanshu Singh <8132290+thisisdevanshu@users.noreply.github.com> Date: Wed, 6 Oct 2021 11:57:04 -0400 Subject: [PATCH 06/26] New Go Language Readme Config File --- specification/orbital/resource-manager/readme.go.md | 11 +++++++++++ 1 file changed, 11 insertions(+) create mode 100644 specification/orbital/resource-manager/readme.go.md diff --git a/specification/orbital/resource-manager/readme.go.md b/specification/orbital/resource-manager/readme.go.md new file mode 100644 index 000000000000..61b1f03cb3ec --- /dev/null +++ b/specification/orbital/resource-manager/readme.go.md @@ -0,0 +1,11 @@ +## Go + +These settings apply only when `--go` is specified on the command line. + +```yaml $(go) && $(track2) +azure-arm: true +license-header: MICROSOFT_MIT_NO_VERSION +module-name: sdk/orbital/armorbital +module: github.com/Azure/azure-sdk-for-go/$(module-name) +output-folder: $(go-sdk-folder)/$(module-name) +``` From 0044c466d5a556bfaea7a5739d7949f2c9936697 Mon Sep 17 00:00:00 2001 From: Devanshu Singh <8132290+thisisdevanshu@users.noreply.github.com> Date: Wed, 6 Oct 2021 11:57:05 -0400 Subject: [PATCH 07/26] New Python Language Readme Config File --- .../orbital/resource-manager/readme.python.md | 23 +++++++++++++++++++ 1 file changed, 23 insertions(+) create mode 100644 specification/orbital/resource-manager/readme.python.md diff --git a/specification/orbital/resource-manager/readme.python.md b/specification/orbital/resource-manager/readme.python.md new file mode 100644 index 000000000000..ee93d0c55312 --- /dev/null +++ b/specification/orbital/resource-manager/readme.python.md @@ -0,0 +1,23 @@ +## Python + +These settings apply only when `--python` is specified on the command line. +Please also specify `--python-sdks-folder=`. + +``` yaml $(track2) +azure-arm: true +license-header: MICROSOFT_MIT_NO_VERSION +package-name: azure-mgmt-orbital +no-namespace-folders: true +package-version: 1.0.0b1 +clear-output-folder: true +``` + +``` yaml $(python-mode) == 'update' && $(track2) +no-namespace-folders: true +output-folder: $(python-sdks-folder)/orbital/azure-mgmt-orbital/azure/mgmt/orbital +``` + +``` yaml $(python-mode) == 'create' && $(track2) +basic-setup-py: true +output-folder: $(python-sdks-folder)/orbital/azure-mgmt-orbital +``` From cc63c2162cac4e0d796ce52061910e7bca9f4ad8 Mon Sep 17 00:00:00 2001 From: Devanshu Singh <8132290+thisisdevanshu@users.noreply.github.com> Date: Wed, 6 Oct 2021 11:57:05 -0400 Subject: [PATCH 08/26] New Typescript Language Readme Config File --- .../orbital/resource-manager/readme.typescript.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) create mode 100644 specification/orbital/resource-manager/readme.typescript.md diff --git a/specification/orbital/resource-manager/readme.typescript.md b/specification/orbital/resource-manager/readme.typescript.md new file mode 100644 index 000000000000..0d531d938a32 --- /dev/null +++ b/specification/orbital/resource-manager/readme.typescript.md @@ -0,0 +1,14 @@ +## TypeScript + +These settings apply only when `--typescript` is specified on the command line. +Please also specify `--typescript-sdks-folder=`. + +``` yaml $(typescript) +typescript: + azure-arm: true + package-name: "@azure/arm-orbital" + output-folder: "$(typescript-sdks-folder)/sdk/orbital/arm-orbital" + payload-flattening-threshold: 1 + clear-output-folder: true + generate-metadata: true +``` From ca5c506887ad0bb07d6e5d5b6000cd023f220f3e Mon Sep 17 00:00:00 2001 From: Devanshu Singh <8132290+thisisdevanshu@users.noreply.github.com> Date: Wed, 6 Oct 2021 11:57:06 -0400 Subject: [PATCH 09/26] New C# Language Readme Config File --- .../orbital/resource-manager/readme.csharp.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) create mode 100644 specification/orbital/resource-manager/readme.csharp.md diff --git a/specification/orbital/resource-manager/readme.csharp.md b/specification/orbital/resource-manager/readme.csharp.md new file mode 100644 index 000000000000..7d800fe8ef4e --- /dev/null +++ b/specification/orbital/resource-manager/readme.csharp.md @@ -0,0 +1,15 @@ +## C# + +These settings apply only when `--csharp` is specified on the command line. +Please also specify `--csharp-sdks-folder=`. + +```yaml $(csharp) +csharp: + azure-arm: true + license-header: MICROSOFT_MIT_NO_VERSION + payload-flattening-threshold: 1 + clear-output-folder: true + client-side-validation: false + namespace: Microsoft.Orbital + output-folder: $(csharp-sdks-folder)/orbital/management/Microsoft.Orbital/GeneratedProtocol +``` From 3fc016900bfd315f81716371ae048e715cff5ff0 Mon Sep 17 00:00:00 2001 From: Devanshu Singh <8132290+thisisdevanshu@users.noreply.github.com> Date: Wed, 3 Nov 2021 22:17:34 -0400 Subject: [PATCH 10/26] 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 * 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 * 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 * 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 Co-authored-by: Sunny Patel Co-authored-by: Arthur Ning <57385816+akning-ms@users.noreply.github.com> Co-authored-by: Devanshu Singh Co-authored-by: Zhenglai Zhang Co-authored-by: Jim Harris <72156062+MicrosoftJim@users.noreply.github.com> Co-authored-by: Akanksha Bhattacharyya Co-authored-by: Akanksha Bhattacharyya --- custom-words.txt | 7 + .../examples/AvailableContactsList.json | 59 + .../examples/AvailableGroundStationGet.json | 24 + ...ailableGroundStationsByCapabilityList.json | 42 + .../examples/ContactCreate.json | 73 + .../examples/ContactDelete.json | 14 + .../examples/ContactGet.json | 37 + .../examples/ContactProfileCreate.json | 182 ++ .../examples/ContactProfileDelete.json | 13 + .../examples/ContactProfileGet.json | 69 + .../examples/ContactProfileUpdateTag.json | 79 + .../ContactProfilesByResourceGroupList.json | 73 + .../ContactProfilesBySubscriptionList.json | 73 + .../ContactsBySpacecraftNameList.json | 65 + .../examples/OperationGroupGet.json | 15 - .../examples/OperationsList.json | 22 + .../examples/SpacecraftCreate.json | 93 + .../examples/SpacecraftDelete.json | 13 + .../examples/SpacecraftGet.json | 40 + .../examples/SpacecraftUpdateTags.json | 50 + .../SpacecraftsByResourceGroupList.json | 44 + .../SpacecraftsBySubscriptionList.json | 43 + .../preview/2021-04-04-preview/orbital.json | 2051 ++++++++++++++++- .../orbital/resource-manager/readme.csharp.md | 2 +- .../orbital/resource-manager/readme.go.md | 2 +- .../orbital/resource-manager/readme.md | 2 +- .../orbital/resource-manager/readme.python.md | 2 +- .../resource-manager/readme.typescript.md | 2 +- 28 files changed, 3109 insertions(+), 82 deletions(-) create mode 100644 specification/orbital/resource-manager/Microsoft.Orbital/preview/2021-04-04-preview/examples/AvailableContactsList.json create mode 100644 specification/orbital/resource-manager/Microsoft.Orbital/preview/2021-04-04-preview/examples/AvailableGroundStationGet.json create mode 100644 specification/orbital/resource-manager/Microsoft.Orbital/preview/2021-04-04-preview/examples/AvailableGroundStationsByCapabilityList.json create mode 100644 specification/orbital/resource-manager/Microsoft.Orbital/preview/2021-04-04-preview/examples/ContactCreate.json create mode 100644 specification/orbital/resource-manager/Microsoft.Orbital/preview/2021-04-04-preview/examples/ContactDelete.json create mode 100644 specification/orbital/resource-manager/Microsoft.Orbital/preview/2021-04-04-preview/examples/ContactGet.json create mode 100644 specification/orbital/resource-manager/Microsoft.Orbital/preview/2021-04-04-preview/examples/ContactProfileCreate.json create mode 100644 specification/orbital/resource-manager/Microsoft.Orbital/preview/2021-04-04-preview/examples/ContactProfileDelete.json create mode 100644 specification/orbital/resource-manager/Microsoft.Orbital/preview/2021-04-04-preview/examples/ContactProfileGet.json create mode 100644 specification/orbital/resource-manager/Microsoft.Orbital/preview/2021-04-04-preview/examples/ContactProfileUpdateTag.json create mode 100644 specification/orbital/resource-manager/Microsoft.Orbital/preview/2021-04-04-preview/examples/ContactProfilesByResourceGroupList.json create mode 100644 specification/orbital/resource-manager/Microsoft.Orbital/preview/2021-04-04-preview/examples/ContactProfilesBySubscriptionList.json create mode 100644 specification/orbital/resource-manager/Microsoft.Orbital/preview/2021-04-04-preview/examples/ContactsBySpacecraftNameList.json delete mode 100644 specification/orbital/resource-manager/Microsoft.Orbital/preview/2021-04-04-preview/examples/OperationGroupGet.json create mode 100644 specification/orbital/resource-manager/Microsoft.Orbital/preview/2021-04-04-preview/examples/OperationsList.json create mode 100644 specification/orbital/resource-manager/Microsoft.Orbital/preview/2021-04-04-preview/examples/SpacecraftCreate.json create mode 100644 specification/orbital/resource-manager/Microsoft.Orbital/preview/2021-04-04-preview/examples/SpacecraftDelete.json create mode 100644 specification/orbital/resource-manager/Microsoft.Orbital/preview/2021-04-04-preview/examples/SpacecraftGet.json create mode 100644 specification/orbital/resource-manager/Microsoft.Orbital/preview/2021-04-04-preview/examples/SpacecraftUpdateTags.json create mode 100644 specification/orbital/resource-manager/Microsoft.Orbital/preview/2021-04-04-preview/examples/SpacecraftsByResourceGroupList.json create mode 100644 specification/orbital/resource-manager/Microsoft.Orbital/preview/2021-04-04-preview/examples/SpacecraftsBySubscriptionList.json diff --git a/custom-words.txt b/custom-words.txt index 65ed31f317a2..4fa60af3b575 100644 --- a/custom-words.txt +++ b/custom-words.txt @@ -631,6 +631,8 @@ Edgenode edgenodes EDIFACT EDMX +EIRP +eirpd Einsteinweg Ekaterinburg ekus @@ -821,6 +823,7 @@ GRANTACE granularities graphrbac Greenplum +groundstation Groupby groupedby GRPC @@ -1055,6 +1058,8 @@ leavingpool LEDs legalhold Lfot +LHCP +Lhcp libtrust lifecycle lifecycles @@ -1690,6 +1695,8 @@ REVOKEACE RGBARGBA RGBRGB rgname +RHCP +Rhcp rhel RIRs rmem diff --git a/specification/orbital/resource-manager/Microsoft.Orbital/preview/2021-04-04-preview/examples/AvailableContactsList.json b/specification/orbital/resource-manager/Microsoft.Orbital/preview/2021-04-04-preview/examples/AvailableContactsList.json new file mode 100644 index 000000000000..2a6f279cc11b --- /dev/null +++ b/specification/orbital/resource-manager/Microsoft.Orbital/preview/2021-04-04-preview/examples/AvailableContactsList.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "api-version": "2021-04-04-preview", + "subscriptionId": "subid", + "resourceGroupName": "rgName", + "spacecraftName": "AQUA", + "parameters": { + "contactProfile": { + "id": "/subscriptions/subId/resourceGroups/rg/Microsoft.Orbital/contactProfiles/AQUA_DIRECTPLAYBACK_WITH_UPLINK" + }, + "groundStationName": "westus_gs1", + "startTime": "2020-07-16T05:40:21.00Z", + "endTime": "2020-07-17T23:49:40.00Z" + } + }, + "responses": { + "200": { + "body": { + "value": [ + { + "spacecraft": { + "id": "/subscriptions/subId/resourceGroups/rg/Microsoft.Orbital/spacecrafts/AQUA" + }, + "groundStationName": "westus_gs1", + "properties": { + "maximumElevationDegrees": 70.94, + "rxStartTime": "2020-07-16T20:40:21.00Z", + "rxEndTime": "2020-07-16T20:49:40.00Z", + "txStartTime": "2020-07-16T20:40:21.00Z", + "txEndTime": "2020-07-16T20:49:40.00Z", + "startAzimuthDegrees": 148.237, + "endAzimuthDegrees": 353.837, + "startElevationDegrees": 10.0, + "endElevationDegrees": 10.0 + } + }, + { + "spacecraft": { + "id": "/subscriptions/subId/resourceGroups/rg/Microsoft.Orbital/spacecrafts/AQUA" + }, + "groundStationName": "westus_gs1", + "properties": { + "maximumElevationDegrees": 87.153, + "rxStartTime": "2020-07-17T10:13:55.00Z", + "rxEndTime": "2020-07-17T10:23:30.00Z", + "txStartTime": "2020-07-17T10:13:55.00Z", + "txEndTime": "2020-07-17T10:23:30.00Z", + "startAzimuthDegrees": 14.392, + "endAzimuthDegrees": 194.36, + "startElevationDegrees": 10.0, + "endElevationDegrees": 10.0 + } + } + ], + "nextLink": "string" + } + } + } +} diff --git a/specification/orbital/resource-manager/Microsoft.Orbital/preview/2021-04-04-preview/examples/AvailableGroundStationGet.json b/specification/orbital/resource-manager/Microsoft.Orbital/preview/2021-04-04-preview/examples/AvailableGroundStationGet.json new file mode 100644 index 000000000000..782e5291c0d2 --- /dev/null +++ b/specification/orbital/resource-manager/Microsoft.Orbital/preview/2021-04-04-preview/examples/AvailableGroundStationGet.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "api-version": "2021-04-04-preview", + "subscriptionId": "subid", + "groundStationName": "westus_gs1" + }, + "responses": { + "200": { + "body": { + "name": "westus_gs1", + "location": "westus", + "id": "/subscriptions/subid/providers/Microsoft.Orbital/availableGroundStations/westus_gs1", + "type": "Microsoft.Orbital/availableGroundStations", + "properties": { + "city": "redmond", + "providerName": "Microsoft", + "longitudeDegrees": 47.674, + "latitudeDegrees": -122.122, + "altitudeMeters": 1500.83 + } + } + } + } +} diff --git a/specification/orbital/resource-manager/Microsoft.Orbital/preview/2021-04-04-preview/examples/AvailableGroundStationsByCapabilityList.json b/specification/orbital/resource-manager/Microsoft.Orbital/preview/2021-04-04-preview/examples/AvailableGroundStationsByCapabilityList.json new file mode 100644 index 000000000000..af85bcb2551a --- /dev/null +++ b/specification/orbital/resource-manager/Microsoft.Orbital/preview/2021-04-04-preview/examples/AvailableGroundStationsByCapabilityList.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "api-version": "2021-04-04-preview", + "subscriptionId": "subId", + "capability": "EarthObservation" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "westus_gs1", + "location": "westus", + "id": "/subscriptions/subId/providers/Microsoft.Orbital/availableGroundStations/westus_gs1", + "type": "Microsoft.Orbital/availableGroundStations", + "properties": { + "city": "redmond", + "providerName": "Microsoft", + "longitudeDegrees": 47.674, + "latitudeDegrees": -122.122, + "altitudeMeters": 1500.83 + } + }, + { + "name": "westus_gs2", + "location": "westus", + "id": "/subscriptions/subId/providers/Microsoft.Orbital/availableGroundStations/westus_gs2", + "type": "Microsoft.Orbital/availableGroundStations", + "properties": { + "city": "redmond", + "providerName": "Microsoft", + "longitudeDegrees": 47.674, + "latitudeDegrees": -122.122, + "altitudeMeters": 1500.83 + } + } + ], + "nextLink": "string" + } + } + } +} diff --git a/specification/orbital/resource-manager/Microsoft.Orbital/preview/2021-04-04-preview/examples/ContactCreate.json b/specification/orbital/resource-manager/Microsoft.Orbital/preview/2021-04-04-preview/examples/ContactCreate.json new file mode 100644 index 000000000000..ef80f8f8a95c --- /dev/null +++ b/specification/orbital/resource-manager/Microsoft.Orbital/preview/2021-04-04-preview/examples/ContactCreate.json @@ -0,0 +1,73 @@ +{ + "parameters": { + "api-version": "2021-04-04-preview", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "contactName": "contact1", + "spacecraftName": "AQUA", + "parameters": { + "properties": { + "reservationStartTime": "2020-07-16T20:35:00.00Z", + "reservationEndTime": "2020-07-16T20:55:00.00Z", + "groundStationName": "westus_gs1", + "contactProfile": { + "id": "/subscriptions/subId/resourceGroups/rg/Microsoft.Orbital/contactProfiles/AQUA_DIRECTPLAYBACK_WITH_UPLINK" + } + } + } + }, + "responses": { + "200": { + "body": { + "name": "contact1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Orbital/spacecrafts/AQUA/contacts/contact1", + "properties": { + "status": "scheduled", + "reservationStartTime": "2020-07-16T20:35:00.00Z", + "reservationEndTime": "2020-07-16T20:55:00.00Z", + "rxStartTime": "2020-07-16T20:40:21.00Z", + "rxEndTime": "2020-07-16T20:49:40.00Z", + "txStartTime": "2020-07-16T20:40:21.00Z", + "txEndTime": "2020-07-16T20:49:40.00Z", + "errorMessage": "", + "maximumElevationDegrees": 70.94, + "startAzimuthDegrees": 148.237, + "endAzimuthDegrees": 353.837, + "startElevationDegrees": 10.0, + "endElevationDegrees": 10.0, + "groundStationName": "westus_gs1", + "contactProfile": { + "id": "/subscriptions/subId/resourceGroups/rg/Microsoft.Orbital/contactProfiles/AQUA_DIRECTPLAYBACK_WITH_UPLINK" + } + }, + "type": "Microsoft.Orbital/contacts" + } + }, + "201": { + "body": { + "name": "contact1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Orbital/spacecrafts/AQUA/contacts/contact1", + "properties": { + "status": "scheduled", + "reservationStartTime": "2020-07-16T20:35:00.00Z", + "reservationEndTime": "2020-07-16T20:55:00.00Z", + "rxStartTime": "2020-07-16T20:40:21.00Z", + "rxEndTime": "2020-07-16T20:49:40.00Z", + "txStartTime": "2020-07-16T20:40:21.00Z", + "txEndTime": "2020-07-16T20:49:40.00Z", + "errorMessage": "", + "maximumElevationDegrees": 70.94, + "startAzimuthDegrees": 148.237, + "endAzimuthDegrees": 353.837, + "startElevationDegrees": 10.0, + "endElevationDegrees": 10.0, + "groundStationName": "westus_gs1", + "contactProfile": { + "id": "/subscriptions/subId/resourceGroups/rg/Microsoft.Orbital/contactProfiles/AQUA_DIRECTPLAYBACK_WITH_UPLINK" + } + }, + "type": "Microsoft.Orbital/contacts" + } + } + } +} diff --git a/specification/orbital/resource-manager/Microsoft.Orbital/preview/2021-04-04-preview/examples/ContactDelete.json b/specification/orbital/resource-manager/Microsoft.Orbital/preview/2021-04-04-preview/examples/ContactDelete.json new file mode 100644 index 000000000000..ae80d2569db8 --- /dev/null +++ b/specification/orbital/resource-manager/Microsoft.Orbital/preview/2021-04-04-preview/examples/ContactDelete.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "api-version": "2021-04-04-preview", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "spacecraftName": "AQUA", + "contactName": "contact1" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/orbital/resource-manager/Microsoft.Orbital/preview/2021-04-04-preview/examples/ContactGet.json b/specification/orbital/resource-manager/Microsoft.Orbital/preview/2021-04-04-preview/examples/ContactGet.json new file mode 100644 index 000000000000..9b10f94c0486 --- /dev/null +++ b/specification/orbital/resource-manager/Microsoft.Orbital/preview/2021-04-04-preview/examples/ContactGet.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "api-version": "2021-04-04-preview", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "spacecraftName": "AQUA", + "contactName": "contact1" + }, + "responses": { + "200": { + "body": { + "name": "contact1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Orbital/spacecrafts/AQUA/contacts/contact1", + "properties": { + "status": "scheduled", + "reservationStartTime": "2020-07-16T20:35:00.00Z", + "reservationEndTime": "2020-07-16T20:55:00.00Z", + "rxStartTime": "2020-07-16T20:40:21.00Z", + "rxEndTime": "2020-07-16T20:49:40.00Z", + "txStartTime": "2020-07-16T20:40:21.00Z", + "txEndTime": "2020-07-16T20:49:40.00Z", + "errorMessage": "", + "maximumElevationDegrees": 70.94, + "startAzimuthDegrees": 148.237, + "endAzimuthDegrees": 353.837, + "startElevationDegrees": 10.0, + "endElevationDegrees": 10.0, + "groundStationName": "westus_gs1", + "contactProfile": { + "id": "/subscriptions/subId/resourceGroups/rg/Microsoft.Orbital/contactProfiles/AQUA_DIRECTPLAYBACK_WITH_UPLINK" + } + }, + "type": "Microsoft.Orbital/contacts" + } + } + } +} diff --git a/specification/orbital/resource-manager/Microsoft.Orbital/preview/2021-04-04-preview/examples/ContactProfileCreate.json b/specification/orbital/resource-manager/Microsoft.Orbital/preview/2021-04-04-preview/examples/ContactProfileCreate.json new file mode 100644 index 000000000000..4070e8fddd14 --- /dev/null +++ b/specification/orbital/resource-manager/Microsoft.Orbital/preview/2021-04-04-preview/examples/ContactProfileCreate.json @@ -0,0 +1,182 @@ +{ + "parameters": { + "api-version": "2021-04-04-preview", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "contactProfileName": "AQUA_DIRECTPLAYBACK_WITH_UPLINK", + "parameters": { + "location": "westus", + "properties": { + "minimumViableContactDuration": "PT1M", + "minimumElevationDegrees": 10, + "autoTrackingConfiguration": "xBand", + "links": [ + { + "polarization": "RHCP", + "direction": "uplink", + "gainOverTemperature": 0, + "eirpdBW": 45, + "channels": [ + { + "centerFrequencyMHz": 2106.4063, + "bandwidthMHz": 0.036, + "endPoint": { + "ipAddress": "10.0.1.0", + "endPointName": "AQUA_command", + "port": "4000", + "protocol": "TCP" + }, + "modulationConfiguration": "AQUA_UPLINK_BPSK", + "demodulationConfiguration": "na", + "encodingConfiguration": "AQUA_CMD_CCSDS", + "decodingConfiguration": "na" + } + ] + }, + { + "polarization": "RHCP", + "direction": "downlink", + "gainOverTemperature": 25, + "eirpdBW": 0, + "channels": [ + { + "centerFrequencyMHz": 8160, + "bandwidthMHz": 150, + "endPoint": { + "ipAddress": "10.0.2.0", + "endPointName": "AQUA_directplayback", + "port": "4000", + "protocol": "TCP" + }, + "modulationConfiguration": "na", + "demodulationConfiguration": "AQUA_DOWNLINK_QPSK", + "encodingConfiguration": "na", + "decodingConfiguration": "AQUA_DIRECTPLAYBACK_CCSDS" + } + ] + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "name": "AQUA_DIRECTPLAYBACK_WITH_UPLINK", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Orbital/contactProfiles/AQUA_DIRECTPLAYBACK_WITH_UPLINK", + "location": "westus", + "properties": { + "minimumViableContactDuration": "PT1M", + "minimumElevationDegrees": 10, + "autoTrackingConfiguration": "xBand", + "links": [ + { + "polarization": "RHCP", + "direction": "uplink", + "gainOverTemperature": 0, + "eirpdBW": 45, + "channels": [ + { + "centerFrequencyMHz": 2106.4063, + "bandwidthMHz": 0.036, + "endPoint": { + "ipAddress": "10.0.1.0", + "endPointName": "AQUA_command", + "port": "4000", + "protocol": "TCP" + }, + "modulationConfiguration": "AQUA_UPLINK_BPSK", + "demodulationConfiguration": "na", + "encodingConfiguration": "AQUA_CMD_CCSDS", + "decodingConfiguration": "na" + } + ] + }, + { + "polarization": "RHCP", + "direction": "downlink", + "gainOverTemperature": 25, + "eirpdBW": 0, + "channels": [ + { + "centerFrequencyMHz": 8160, + "bandwidthMHz": 150, + "endPoint": { + "ipAddress": "10.0.2.0", + "endPointName": "AQUA_directplayback", + "port": "4000", + "protocol": "TCP" + }, + "modulationConfiguration": "na", + "demodulationConfiguration": "AQUA_DOWNLINK_QPSK", + "encodingConfiguration": "na", + "decodingConfiguration": "AQUA_DIRECTPLAYBACK_CCSDS" + } + ] + } + ] + }, + "type": "Microsoft.Orbital/contactProfiles" + } + }, + "201": { + "body": { + "name": "contactProfile1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Orbital/contactProfiles/contactProfile1", + "location": "westus", + "properties": { + "minimumViableContactDuration": "PT1M", + "minimumElevationDegrees": 10, + "autoTrackingConfiguration": "xBand", + "links": [ + { + "polarization": "RHCP", + "direction": "uplink", + "gainOverTemperature": 0, + "eirpdBW": 45, + "channels": [ + { + "centerFrequencyMHz": 2106.4063, + "bandwidthMHz": 0.036, + "endPoint": { + "ipAddress": "10.0.1.0", + "endPointName": "AQUA_command", + "port": "4000", + "protocol": "TCP" + }, + "modulationConfiguration": "AQUA_UPLINK_BPSK", + "demodulationConfiguration": "na", + "encodingConfiguration": "AQUA_CMD_CCSDS", + "decodingConfiguration": "na" + } + ] + }, + { + "polarization": "RHCP", + "direction": "downlink", + "gainOverTemperature": 25, + "eirpdBW": 0, + "channels": [ + { + "centerFrequencyMHz": 8160, + "bandwidthMHz": 150, + "endPoint": { + "ipAddress": "10.0.2.0", + "endPointName": "AQUA_directplayback", + "port": "4000", + "protocol": "TCP" + }, + "modulationConfiguration": "na", + "demodulationConfiguration": "AQUA_DOWNLINK_QPSK", + "encodingConfiguration": "na", + "decodingConfiguration": "AQUA_DIRECTPLAYBACK_CCSDS" + } + ] + } + ] + }, + "type": "Microsoft.Orbital/contactProfiles" + } + } + } +} diff --git a/specification/orbital/resource-manager/Microsoft.Orbital/preview/2021-04-04-preview/examples/ContactProfileDelete.json b/specification/orbital/resource-manager/Microsoft.Orbital/preview/2021-04-04-preview/examples/ContactProfileDelete.json new file mode 100644 index 000000000000..19c7bc19f3da --- /dev/null +++ b/specification/orbital/resource-manager/Microsoft.Orbital/preview/2021-04-04-preview/examples/ContactProfileDelete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2021-04-04-preview", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "contactProfileName": "AQUA_DIRECTPLAYBACK_WITH_UPLINK" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/orbital/resource-manager/Microsoft.Orbital/preview/2021-04-04-preview/examples/ContactProfileGet.json b/specification/orbital/resource-manager/Microsoft.Orbital/preview/2021-04-04-preview/examples/ContactProfileGet.json new file mode 100644 index 000000000000..a2c64f92db8c --- /dev/null +++ b/specification/orbital/resource-manager/Microsoft.Orbital/preview/2021-04-04-preview/examples/ContactProfileGet.json @@ -0,0 +1,69 @@ +{ + "parameters": { + "api-version": "2021-04-04-preview", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "contactProfileName": "AQUA_DIRECTPLAYBACK_WITH_UPLINK" + }, + "responses": { + "200": { + "body": { + "name": "AQUA_DIRECTPLAYBACK_WITH_UPLINK", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Orbital/contactProfiles/AQUA_DIRECTPLAYBACK_WITH_UPLINK", + "location": "westus", + "properties": { + "minimumViableContactDuration": "PT1M", + "minimumElevationDegrees": 10, + "autoTrackingConfiguration": "xBand", + "links": [ + { + "polarization": "RHCP", + "direction": "uplink", + "gainOverTemperature": 0, + "eirpdBW": 45, + "channels": [ + { + "centerFrequencyMHz": 2106.4063, + "bandwidthMHz": 0.036, + "endPoint": { + "ipAddress": "10.0.1.0", + "endPointName": "AQUA_command", + "port": "4000", + "protocol": "TCP" + }, + "modulationConfiguration": "AQUA_UPLINK_BPSK", + "demodulationConfiguration": "na", + "encodingConfiguration": "AQUA_CMD_CCSDS", + "decodingConfiguration": "na" + } + ] + }, + { + "polarization": "RHCP", + "direction": "downlink", + "gainOverTemperature": 25, + "eirpdBW": 0, + "channels": [ + { + "centerFrequencyMHz": 8160, + "bandwidthMHz": 150, + "endPoint": { + "ipAddress": "10.0.2.0", + "endPointName": "AQUA_directplayback", + "port": "4000", + "protocol": "TCP" + }, + "modulationConfiguration": "na", + "demodulationConfiguration": "AQUA_DOWNLINK_QPSK", + "encodingConfiguration": "na", + "decodingConfiguration": "AQUA_DIRECTPLAYBACK_CCSDS" + } + ] + } + ] + }, + "type": "Microsoft.Orbital/contactProfiles" + } + } + } +} diff --git a/specification/orbital/resource-manager/Microsoft.Orbital/preview/2021-04-04-preview/examples/ContactProfileUpdateTag.json b/specification/orbital/resource-manager/Microsoft.Orbital/preview/2021-04-04-preview/examples/ContactProfileUpdateTag.json new file mode 100644 index 000000000000..6719ea248a4c --- /dev/null +++ b/specification/orbital/resource-manager/Microsoft.Orbital/preview/2021-04-04-preview/examples/ContactProfileUpdateTag.json @@ -0,0 +1,79 @@ +{ + "parameters": { + "api-version": "2021-04-04-preview", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "contactProfileName": "AQUA_DIRECTPLAYBACK_WITH_UPLINK", + "parameters": { + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + }, + "responses": { + "200": { + "body": { + "name": "AQUA_DIRECTPLAYBACK_WITH_UPLINK", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Orbital/contactProfiles/AQUA_DIRECTPLAYBACK_WITH_UPLINK", + "location": "westus", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "minimumViableContactDuration": "PT1M", + "minimumElevationDegrees": 10, + "autoTrackingConfiguration": "xBand", + "links": [ + { + "polarization": "RHCP", + "direction": "uplink", + "gainOverTemperature": 0, + "eirpdBW": 45, + "channels": [ + { + "centerFrequencyMHz": 2106.4063, + "bandwidthMHz": 0.036, + "endPoint": { + "ipAddress": "10.0.1.0", + "endPointName": "AQUA_command", + "port": "4000", + "protocol": "TCP" + }, + "modulationConfiguration": "AQUA_UPLINK_BPSK", + "demodulationConfiguration": "na", + "encodingConfiguration": "AQUA_CMD_CCSDS", + "decodingConfiguration": "na" + } + ] + }, + { + "polarization": "RHCP", + "direction": "downlink", + "gainOverTemperature": 25, + "eirpdBW": 0, + "channels": [ + { + "centerFrequencyMHz": 8160, + "bandwidthMHz": 150, + "endPoint": { + "ipAddress": "10.0.2.0", + "endPointName": "AQUA_directplayback", + "port": "4000", + "protocol": "TCP" + }, + "modulationConfiguration": "na", + "demodulationConfiguration": "AQUA_DOWNLINK_QPSK", + "encodingConfiguration": "na", + "decodingConfiguration": "AQUA_DIRECTPLAYBACK_CCSDS" + } + ] + } + ] + }, + "type": "Microsoft.Orbital/contactProfiles" + } + } + } +} diff --git a/specification/orbital/resource-manager/Microsoft.Orbital/preview/2021-04-04-preview/examples/ContactProfilesByResourceGroupList.json b/specification/orbital/resource-manager/Microsoft.Orbital/preview/2021-04-04-preview/examples/ContactProfilesByResourceGroupList.json new file mode 100644 index 000000000000..97a974eb3e41 --- /dev/null +++ b/specification/orbital/resource-manager/Microsoft.Orbital/preview/2021-04-04-preview/examples/ContactProfilesByResourceGroupList.json @@ -0,0 +1,73 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "api-version": "2021-04-04-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "AQUA_DIRECTPLAYBACK_WITH_UPLINK", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Orbital/contactProfiles/AQUA_DIRECTPLAYBACK_WITH_UPLINK", + "location": "westus", + "properties": { + "minimumViableContactDuration": "PT1M", + "minimumElevationDegrees": 10, + "autoTrackingConfiguration": "xBand", + "links": [ + { + "polarization": "RHCP", + "direction": "uplink", + "gainOverTemperature": 0, + "eirpdBW": 45, + "channels": [ + { + "centerFrequencyMHz": 2106.4063, + "bandwidthMHz": 0.036, + "endPoint": { + "ipAddress": "10.0.1.0", + "endPointName": "AQUA_command", + "port": "4000", + "protocol": "TCP" + }, + "modulationConfiguration": "AQUA_UPLINK_BPSK", + "demodulationConfiguration": "na", + "encodingConfiguration": "AQUA_CMD_CCSDS", + "decodingConfiguration": "na" + } + ] + }, + { + "polarization": "RHCP", + "direction": "downlink", + "gainOverTemperature": 25, + "eirpdBW": 0, + "channels": [ + { + "centerFrequencyMHz": 8160, + "bandwidthMHz": 150, + "endPoint": { + "ipAddress": "10.0.2.0", + "endPointName": "AQUA_directplayback", + "port": "4000", + "protocol": "TCP" + }, + "modulationConfiguration": "na", + "demodulationConfiguration": "AQUA_DOWNLINK_QPSK", + "encodingConfiguration": "na", + "decodingConfiguration": "AQUA_DIRECTPLAYBACK_CCSDS" + } + ] + } + ] + }, + "type": "Microsoft.Orbital/contactProfiles" + } + ], + "nextLink": "string" + } + } + } +} diff --git a/specification/orbital/resource-manager/Microsoft.Orbital/preview/2021-04-04-preview/examples/ContactProfilesBySubscriptionList.json b/specification/orbital/resource-manager/Microsoft.Orbital/preview/2021-04-04-preview/examples/ContactProfilesBySubscriptionList.json new file mode 100644 index 000000000000..97a974eb3e41 --- /dev/null +++ b/specification/orbital/resource-manager/Microsoft.Orbital/preview/2021-04-04-preview/examples/ContactProfilesBySubscriptionList.json @@ -0,0 +1,73 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "api-version": "2021-04-04-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "AQUA_DIRECTPLAYBACK_WITH_UPLINK", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Orbital/contactProfiles/AQUA_DIRECTPLAYBACK_WITH_UPLINK", + "location": "westus", + "properties": { + "minimumViableContactDuration": "PT1M", + "minimumElevationDegrees": 10, + "autoTrackingConfiguration": "xBand", + "links": [ + { + "polarization": "RHCP", + "direction": "uplink", + "gainOverTemperature": 0, + "eirpdBW": 45, + "channels": [ + { + "centerFrequencyMHz": 2106.4063, + "bandwidthMHz": 0.036, + "endPoint": { + "ipAddress": "10.0.1.0", + "endPointName": "AQUA_command", + "port": "4000", + "protocol": "TCP" + }, + "modulationConfiguration": "AQUA_UPLINK_BPSK", + "demodulationConfiguration": "na", + "encodingConfiguration": "AQUA_CMD_CCSDS", + "decodingConfiguration": "na" + } + ] + }, + { + "polarization": "RHCP", + "direction": "downlink", + "gainOverTemperature": 25, + "eirpdBW": 0, + "channels": [ + { + "centerFrequencyMHz": 8160, + "bandwidthMHz": 150, + "endPoint": { + "ipAddress": "10.0.2.0", + "endPointName": "AQUA_directplayback", + "port": "4000", + "protocol": "TCP" + }, + "modulationConfiguration": "na", + "demodulationConfiguration": "AQUA_DOWNLINK_QPSK", + "encodingConfiguration": "na", + "decodingConfiguration": "AQUA_DIRECTPLAYBACK_CCSDS" + } + ] + } + ] + }, + "type": "Microsoft.Orbital/contactProfiles" + } + ], + "nextLink": "string" + } + } + } +} diff --git a/specification/orbital/resource-manager/Microsoft.Orbital/preview/2021-04-04-preview/examples/ContactsBySpacecraftNameList.json b/specification/orbital/resource-manager/Microsoft.Orbital/preview/2021-04-04-preview/examples/ContactsBySpacecraftNameList.json new file mode 100644 index 000000000000..00f19a553ac8 --- /dev/null +++ b/specification/orbital/resource-manager/Microsoft.Orbital/preview/2021-04-04-preview/examples/ContactsBySpacecraftNameList.json @@ -0,0 +1,65 @@ +{ + "parameters": { + "api-version": "2021-04-04-preview", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "spacecraftName": "AQUA" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "contact1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Orbital/spacecrafts/AQUA/contacts/contact1", + "properties": { + "status": "scheduled", + "reservationStartTime": "2020-07-16T20:35:00.00Z", + "reservationEndTime": "2020-07-16T20:55:00.00Z", + "rxStartTime": "2020-07-16T20:40:21.00Z", + "rxEndTime": "2020-07-16T20:49:40.00Z", + "txStartTime": "2020-07-16T20:40:21.00Z", + "txEndTime": "2020-07-16T20:49:40.00Z", + "errorMessage": "", + "maximumElevationDegrees": 70.94, + "startAzimuthDegrees": 148.237, + "endAzimuthDegrees": 353.837, + "startElevationDegrees": 10.0, + "endElevationDegrees": 10.0, + "groundStationName": "westus_gs1", + "contactProfile": { + "id": "/subscriptions/subId/resourceGroups/rg/Microsoft.Orbital/contactProfiles/AQUA_DIRECTPLAYBACK_WITH_UPLINK" + } + }, + "type": "Microsoft.Orbital/contacts" + }, + { + "name": "contact2", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Orbital/spacecrafts/AQUA/contacts/contact2", + "properties": { + "status": "scheduled", + "reservationStartTime": "2020-07-23T20:35:00.00Z", + "reservationEndTime": "2020-07-23T20:55:00.00Z", + "rxStartTime": "2020-07-23T20:40:21.00Z", + "rxEndTime": "2020-07-23T20:49:40.00Z", + "txStartTime": "2020-07-23T20:40:21.00Z", + "txEndTime": "2020-07-23T20:49:40.00Z", + "errorMessage": "", + "maximumElevationDegrees": 70.94, + "startAzimuthDegrees": 148.237, + "endAzimuthDegrees": 353.837, + "startElevationDegrees": 10.0, + "endElevationDegrees": 10.0, + "groundStationName": "westus_gs1", + "contactProfile": { + "id": "/subscriptions/subId/resourceGroups/rg/Microsoft.Orbital/contactProfiles/AQUA_DIRECTPLAYBACK_WITH_UPLINK" + } + }, + "type": "Microsoft.Orbital/contacts" + } + ], + "nextLink": "string" + } + } + } +} diff --git a/specification/orbital/resource-manager/Microsoft.Orbital/preview/2021-04-04-preview/examples/OperationGroupGet.json b/specification/orbital/resource-manager/Microsoft.Orbital/preview/2021-04-04-preview/examples/OperationGroupGet.json deleted file mode 100644 index 74dbf6de33e1..000000000000 --- a/specification/orbital/resource-manager/Microsoft.Orbital/preview/2021-04-04-preview/examples/OperationGroupGet.json +++ /dev/null @@ -1,15 +0,0 @@ -{ - "parameters": { - "accountName": "sampleacct", - "resourceGroupName": "orbitalClient", - "api-version": "2021-04-04-preview", - "subscriptionId": "subid" - }, - "responses": { - "200": { - "body": { - "sampleProperty": "sampleProperty" - } - } - } -} diff --git a/specification/orbital/resource-manager/Microsoft.Orbital/preview/2021-04-04-preview/examples/OperationsList.json b/specification/orbital/resource-manager/Microsoft.Orbital/preview/2021-04-04-preview/examples/OperationsList.json new file mode 100644 index 000000000000..c911b02a08b5 --- /dev/null +++ b/specification/orbital/resource-manager/Microsoft.Orbital/preview/2021-04-04-preview/examples/OperationsList.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2021-04-04-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.Orbital/spacecrafts/write", + "display": { + "provider": "Microsoft Orbital", + "resource": "Spacecraft", + "operation": "Create/Update a spacecraft", + "description": "Creates or Update a spacecraft" + } + } + ] + } + } + } +} diff --git a/specification/orbital/resource-manager/Microsoft.Orbital/preview/2021-04-04-preview/examples/SpacecraftCreate.json b/specification/orbital/resource-manager/Microsoft.Orbital/preview/2021-04-04-preview/examples/SpacecraftCreate.json new file mode 100644 index 000000000000..cab52f2d1bcb --- /dev/null +++ b/specification/orbital/resource-manager/Microsoft.Orbital/preview/2021-04-04-preview/examples/SpacecraftCreate.json @@ -0,0 +1,93 @@ +{ + "parameters": { + "api-version": "2021-04-04-preview", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "spacecraftName": "AQUA", + "parameters": { + "location": "westus", + "properties": { + "noradId": "27424", + "titleLine": "(AQUA)", + "tleLine1": "1 27424U 02022A 20195.59202355 .00000039 00000-0 18634-4 0 9991", + "tleLine2": "2 27424 98.2098 135.8486 0000176 28.4050 144.5909 14.57108832967671", + "links": [ + { + "centerFrequencyMHz": 2106.4063, + "bandwidthMHz": 0.036, + "direction": "uplink", + "polarization": "RHCP" + }, + { + "centerFrequencyMHz": 8125, + "bandwidthMHz": 150, + "direction": "downlink", + "polarization": "RHCP" + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "name": "AQUA", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Orbital/spacecrafts/AQUA", + "location": "westus", + "properties": { + "noradId": "27424", + "authorizationStatus": "Allowed", + "authorizationStatusExtended": "string", + "titleLine": "AQUA", + "tleLine1": "1 27424U 02022A 20195.59202355 .00000039 00000-0 18634-4 0 9991", + "tleLine2": "2 27424 98.2098 135.8486 0000176 28.4050 144.5909 14.57108832967671", + "links": [ + { + "centerFrequencyMHz": 2106.4063, + "bandwidthMHz": 0.036, + "direction": "uplink", + "polarization": "RHCP" + }, + { + "centerFrequencyMHz": 8125, + "bandwidthMHz": 150, + "direction": "downlink", + "polarization": "RHCP" + } + ] + }, + "type": "Microsoft.Orbital/spacecrafts" + } + }, + "201": { + "body": { + "name": "AQUA", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Orbital/spacecrafts/AQUA", + "location": "westus", + "properties": { + "noradId": "27424", + "authorizationStatus": "Allowed", + "authorizationStatusExtended": "string", + "titleLine": "AQUA", + "tleLine1": "1 27424U 02022A 20195.59202355 .00000039 00000-0 18634-4 0 9991", + "tleLine2": "2 27424 98.2098 135.8486 0000176 28.4050 144.5909 14.57108832967671", + "links": [ + { + "centerFrequencyMHz": 2106.4063, + "bandwidthMHz": 0.036, + "direction": "uplink", + "polarization": "RHCP" + }, + { + "centerFrequencyMHz": 8125, + "bandwidthMHz": 150, + "direction": "downlink", + "polarization": "RHCP" + } + ] + }, + "type": "Microsoft.Orbital/spacecrafts" + } + } + } +} diff --git a/specification/orbital/resource-manager/Microsoft.Orbital/preview/2021-04-04-preview/examples/SpacecraftDelete.json b/specification/orbital/resource-manager/Microsoft.Orbital/preview/2021-04-04-preview/examples/SpacecraftDelete.json new file mode 100644 index 000000000000..d14d3761813f --- /dev/null +++ b/specification/orbital/resource-manager/Microsoft.Orbital/preview/2021-04-04-preview/examples/SpacecraftDelete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2021-04-04-preview", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "spacecraftName": "AQUA" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/orbital/resource-manager/Microsoft.Orbital/preview/2021-04-04-preview/examples/SpacecraftGet.json b/specification/orbital/resource-manager/Microsoft.Orbital/preview/2021-04-04-preview/examples/SpacecraftGet.json new file mode 100644 index 000000000000..adb245426dcb --- /dev/null +++ b/specification/orbital/resource-manager/Microsoft.Orbital/preview/2021-04-04-preview/examples/SpacecraftGet.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "api-version": "2021-04-04-preview", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "spacecraftName": "AQUA" + }, + "responses": { + "200": { + "body": { + "name": "AQUA", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Orbital/spacecrafts/AQUA", + "location": "westus", + "properties": { + "noradId": "27424", + "authorizationStatus": "Allowed", + "authorizationStatusExtended": "string", + "titleLine": "AQUA", + "tleLine1": "1 27424U 02022A 20195.59202355 .00000039 00000-0 18634-4 0 9991", + "tleLine2": "2 27424 98.2098 135.8486 0000176 28.4050 144.5909 14.57108832967671", + "links": [ + { + "centerFrequencyMHz": 2106.4063, + "bandwidthMHz": 0.036, + "direction": "uplink", + "polarization": "RHCP" + }, + { + "centerFrequencyMHz": 8125, + "bandwidthMHz": 150, + "direction": "downlink", + "polarization": "RHCP" + } + ] + }, + "type": "Microsoft.Orbital/spacecrafts" + } + } + } +} diff --git a/specification/orbital/resource-manager/Microsoft.Orbital/preview/2021-04-04-preview/examples/SpacecraftUpdateTags.json b/specification/orbital/resource-manager/Microsoft.Orbital/preview/2021-04-04-preview/examples/SpacecraftUpdateTags.json new file mode 100644 index 000000000000..73567f047303 --- /dev/null +++ b/specification/orbital/resource-manager/Microsoft.Orbital/preview/2021-04-04-preview/examples/SpacecraftUpdateTags.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "api-version": "2021-04-04-preview", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "spacecraftName": "AQUA", + "parameters": { + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + }, + "responses": { + "200": { + "body": { + "name": "AQUA", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Orbital/spacecrafts/AQUA", + "location": "westus", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "noradId": "27424", + "authorizationStatus": "Allowed", + "authorizationStatusExtended": "string", + "titleLine": "AQUA", + "tleLine1": "1 27424U 02022A 20195.59202355 .00000039 00000-0 18634-4 0 9991", + "tleLine2": "2 27424 98.2098 135.8486 0000176 28.4050 144.5909 14.57108832967671", + "links": [ + { + "centerFrequencyMHz": 2106.4063, + "bandwidthMHz": 0.036, + "direction": "uplink", + "polarization": "RHCP" + }, + { + "centerFrequencyMHz": 8125, + "bandwidthMHz": 150, + "direction": "downlink", + "polarization": "RHCP" + } + ] + }, + "type": "Microsoft.Orbital/spacecrafts" + } + } + } +} diff --git a/specification/orbital/resource-manager/Microsoft.Orbital/preview/2021-04-04-preview/examples/SpacecraftsByResourceGroupList.json b/specification/orbital/resource-manager/Microsoft.Orbital/preview/2021-04-04-preview/examples/SpacecraftsByResourceGroupList.json new file mode 100644 index 000000000000..ba1c875ca853 --- /dev/null +++ b/specification/orbital/resource-manager/Microsoft.Orbital/preview/2021-04-04-preview/examples/SpacecraftsByResourceGroupList.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "api-version": "2021-04-04-preview", + "subscriptionId": "subid", + "resourceGroupName": "rg1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "AQUA", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Orbital/spacecrafts/AQUA", + "location": "westus", + "properties": { + "noradId": "27424", + "authorizationStatus": "Allowed", + "authorizationStatusExtended": "string", + "titleLine": "AQUA", + "tleLine1": "1 27424U 02022A 20195.59202355 .00000039 00000-0 18634-4 0 9991", + "tleLine2": "2 27424 98.2098 135.8486 0000176 28.4050 144.5909 14.57108832967671", + "links": [ + { + "centerFrequencyMHz": 2106.4063, + "bandwidthMHz": 0.036, + "direction": "uplink", + "polarization": "RHCP" + }, + { + "centerFrequencyMHz": 8125, + "bandwidthMHz": 150, + "direction": "downlink", + "polarization": "RHCP" + } + ] + }, + "type": "Microsoft.Orbital/spacecrafts" + } + ], + "nextLink": "string" + } + } + } +} diff --git a/specification/orbital/resource-manager/Microsoft.Orbital/preview/2021-04-04-preview/examples/SpacecraftsBySubscriptionList.json b/specification/orbital/resource-manager/Microsoft.Orbital/preview/2021-04-04-preview/examples/SpacecraftsBySubscriptionList.json new file mode 100644 index 000000000000..7f12b8f89dbc --- /dev/null +++ b/specification/orbital/resource-manager/Microsoft.Orbital/preview/2021-04-04-preview/examples/SpacecraftsBySubscriptionList.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "api-version": "2021-04-04-preview", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "AQUA", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Orbital/spacecrafts/AQUA", + "location": "westus", + "properties": { + "noradId": "27424", + "authorizationStatus": "Allowed", + "authorizationStatusExtended": "string", + "titleLine": "AQUA", + "tleLine1": "1 27424U 02022A 20195.59202355 .00000039 00000-0 18634-4 0 9991", + "tleLine2": "2 27424 98.2098 135.8486 0000176 28.4050 144.5909 14.57108832967671", + "links": [ + { + "centerFrequencyMHz": 2106.4063, + "bandwidthMHz": 0.036, + "direction": "uplink", + "polarization": "RHCP" + }, + { + "centerFrequencyMHz": 8125, + "bandwidthMHz": 150, + "direction": "downlink", + "polarization": "RHCP" + } + ] + }, + "type": "Microsoft.Orbital/spacecrafts" + } + ], + "nextLink": "string" + } + } + } +} diff --git a/specification/orbital/resource-manager/Microsoft.Orbital/preview/2021-04-04-preview/orbital.json b/specification/orbital/resource-manager/Microsoft.Orbital/preview/2021-04-04-preview/orbital.json index c4311c6cec7d..db53e0e588a9 100644 --- a/specification/orbital/resource-manager/Microsoft.Orbital/preview/2021-04-04-preview/orbital.json +++ b/specification/orbital/resource-manager/Microsoft.Orbital/preview/2021-04-04-preview/orbital.json @@ -2,20 +2,21 @@ "swagger": "2.0", "info": { "version": "2021-04-04-preview", - "title": "orbital", - "description": "Description of the new service", - "x-ms-code-generation-settings": { - "name": "orbitalClient" + "title": "Azure Orbital", + "description": "Azure Orbital service", + "license": { + "name": "Microsoft" } }, "host": "management.azure.com", - "schemes": ["https"], - "consumes": ["application/json"], - "produces": ["application/json"], - "security": [ - { - "azure_auth": ["user_impersonation"] - } + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" ], "securityDefinitions": { "azure_auth": { @@ -29,91 +30,1956 @@ } }, "paths": { - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Orbital/operations": { + "/providers/Microsoft.Orbital/operations": { + "get": { + "tags": [ + "Operations" + ], + "description": "Lists all of the available Orbital Rest API operations.", + "operationId": "Orbital_ListOperations", + "x-ms-examples": { + "OperationsList": { + "$ref": "./examples/OperationsList.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/OperationListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed. If the resource group does not exist, 404 (NotFound) will be returned.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Orbital/spacecrafts": { + "get": { + "tags": [ + "Spacecraft" + ], + "description": "Return list of spacecrafts", + "operationId": "Orbital_ListSpacecraftsBySubscription", + "x-ms-examples": { + "List of Spacecraft by Subscription": { + "$ref": "./examples/SpacecraftsBySubscriptionList.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of spacecraft resources.", + "schema": { + "$ref": "#/definitions/SpacecraftListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed. If the resource group does not exist, 404 (NotFound) will be returned.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Orbital/spacecrafts": { + "get": { + "tags": [ + "Spacecraft" + ], + "description": "Return list of spacecrafts", + "operationId": "Orbital_ListSpacecraftsByResourceGroup", + "x-ms-examples": { + "List of Spacecraft by Resource Group": { + "$ref": "./examples/SpacecraftsByResourceGroupList.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of spacecraft resources.", + "schema": { + "$ref": "#/definitions/SpacecraftListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed. If the resource group does not exist, 404 (NotFound) will be returned.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Orbital/spacecrafts/{spacecraftName}": { + "get": { + "tags": [ + "Spacecraft" + ], + "operationId": "Orbital_GetSpacecraft", + "description": "Gets the specified spacecraft in a specified resource group", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/spacecraftNameParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting Spacecraft resource.", + "schema": { + "$ref": "#/definitions/Spacecraft" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get Spacecraft": { + "$ref": "./examples/SpacecraftGet.json" + } + } + }, + "put": { + "tags": [ + "Spacecraft" + ], + "description": "Creates or updates a spacecraft resource", + "operationId": "Orbital_CreateOrUpdateSpacecraft", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/spacecraftNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "x-ms-client-flatten": true, + "schema": { + "$ref": "#/definitions/Spacecraft" + }, + "description": "The parameters to provide for the created spacecraft." + } + ], + "responses": { + "200": { + "description": "Update successful. The operation returns the resulting spacecraft resource.", + "schema": { + "$ref": "#/definitions/Spacecraft" + } + }, + "201": { + "description": "Create successful. The operation returns the resulting spacecraft resource.", + "schema": { + "$ref": "#/definitions/Spacecraft" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Create a spacecraft": { + "$ref": "./examples/SpacecraftCreate.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "delete": { + "tags": [ + "Spacecraft" + ], + "operationId": "Orbital_DeleteSpacecraft", + "description": "Deletes a specified spacecraft resource.", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/spacecraftNameParameter" + } + ], + "responses": { + "200": { + "description": "Delete successful." + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "204": { + "description": "Request successful. Resource does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Delete Spacecraft": { + "$ref": "./examples/SpacecraftDelete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "patch": { + "tags": [ + "Spacecraft" + ], + "operationId": "Orbital_UpdateTagsSpacecraft", + "x-ms-examples": { + "Update Spacecraft tags": { + "$ref": "./examples/SpacecraftUpdateTags.json" + } + }, + "description": "Updates the specified spacecraft tags.", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/TagsObject" + }, + "description": "Parameters supplied to update spacecraft tags." + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/spacecraftNameParameter" + } + ], + "responses": { + "200": { + "description": "Update successful. The operation returns the resulting Spacecraft resource.", + "schema": { + "$ref": "#/definitions/Spacecraft" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Orbital/spacecrafts/{spacecraftName}/contacts": { + "get": { + "tags": [ + "Spacecraft" + ], + "description": "Returns list of contacts by spacecraftName", + "operationId": "Orbital_ListContactsBySpacecraftName", + "x-ms-examples": { + "List of Contacts": { + "$ref": "./examples/ContactsBySpacecraftNameList.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/spacecraftNameParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of contacts by spacecraftName.", + "schema": { + "$ref": "#/definitions/ContactListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed. If the resource group does not exist, 404 (NotFound) will be returned.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Orbital/spacecrafts/{spacecraftName}/contacts/{contactName}": { "get": { - "tags": ["Tag1"], - "operationId": "OperationGroup_Get", + "tags": [ + "Contact" + ], + "operationId": "Orbital_GetContact", + "description": "Gets the specified contact in a specified resource group", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/spacecraftNameParameter" + }, + { + "$ref": "#/parameters/contactNameParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting Contact resource.", + "schema": { + "$ref": "#/definitions/Contact" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, "x-ms-examples": { - "BatchAccountDelete": { "$ref": "./examples/OperationGroupGet.json" } + "Get Contact": { + "$ref": "./examples/ContactGet.json" + } + } + }, + "put": { + "tags": [ + "Contact" + ], + "description": "Creates a contact.", + "operationId": "Orbital_CreateContact", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/spacecraftNameParameter" + }, + { + "$ref": "#/parameters/contactNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Contact" + }, + "description": "The parameters to provide for the created contact." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Contact" + } + }, + "201": { + "description": "Create successful. The operation returns the resulting contact resource.", + "schema": { + "$ref": "#/definitions/Contact" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Create a contact": { + "$ref": "./examples/ContactCreate.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "delete": { + "tags": [ + "Contact" + ], + "operationId": "Orbital_DeleteContact", + "description": "Deletes a specified contact", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/spacecraftNameParameter" + }, + { + "$ref": "#/parameters/contactNameParameter" + } + ], + "responses": { + "200": { + "description": "Delete successful." + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "204": { + "description": "Request successful. Resource does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Delete Contact": { + "$ref": "./examples/ContactDelete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Orbital/spacecrafts/{spacecraftName}/listAvailableContacts": { + "post": { + "tags": [ + "Contact" + ], + "description": "Return list of available contacts", + "operationId": "Orbital_ListAvailableContacts", + "x-ms-examples": { + "List of Contact": { + "$ref": "./examples/AvailableContactsList.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/spacecraftNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "x-ms-client-flatten": true, + "schema": { + "$ref": "#/definitions/ContactParameters" + }, + "description": "The parameters to provide for the contacts." + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of available contacts resources.", + "schema": { + "$ref": "#/definitions/AvailableContactsListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed. If the resource group does not exist, 404 (NotFound) will be returned.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Orbital/contactProfiles/{contactProfileName}": { + "get": { + "tags": [ + "Contact Profile" + ], + "operationId": "Orbital_GetContactProfile", + "description": "Gets the specified contact Profile in a specified resource group", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/contactProfileNameParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting ContactProfile resource.", + "schema": { + "$ref": "#/definitions/ContactProfile" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get a contact profile": { + "$ref": "./examples/ContactProfileGet.json" + } + } + }, + "put": { + "tags": [ + "Contact Profile" + ], + "description": "Creates or updates a contact profile", + "operationId": "Orbital_CreateOrUpdateContactProfile", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/contactProfileNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "x-ms-client-flatten": true, + "schema": { + "$ref": "#/definitions/ContactProfile" + }, + "description": "The parameters to provide for the created Contact Profile." + } + ], + "responses": { + "200": { + "description": "Update successful. The operation returns the resulting ContactProfile resource.", + "schema": { + "$ref": "#/definitions/ContactProfile" + } + }, + "201": { + "description": "Create successful. The operation returns the resulting ContactProfile resource.", + "schema": { + "$ref": "#/definitions/ContactProfile" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Create a contact profile": { + "$ref": "./examples/ContactProfileCreate.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "delete": { + "tags": [ + "Contact Profile" + ], + "operationId": "Orbital_DeleteContactProfile", + "description": "Deletes a specified contact profile resource.", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/contactProfileNameParameter" + } + ], + "responses": { + "200": { + "description": "Delete successful." + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "204": { + "description": "Request successful. Resource does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Delete Contact Profile": { + "$ref": "./examples/ContactProfileDelete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "patch": { + "tags": [ + "Contact Profile" + ], + "operationId": "Orbital_UpdateTagsContactProfile", + "x-ms-examples": { + "Update Contact Profile tags": { + "$ref": "./examples/ContactProfileUpdateTag.json" + } + }, + "description": "Updates the specified contact profile tags.", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/TagsObject" + }, + "description": "Parameters supplied to update contact profile tags." + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/contactProfileNameParameter" + } + ], + "responses": { + "200": { + "description": "Update successful. The operation returns the resulting Contact Profile resource.", + "schema": { + "$ref": "#/definitions/ContactProfile" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Orbital/contactProfiles": { + "get": { + "tags": [ + "Contact Profile" + ], + "description": "Returns list of contact profiles", + "operationId": "Orbital_ListContactProfilesBySubscription", + "x-ms-examples": { + "List of Contact Profiles by Subscription": { + "$ref": "./examples/ContactProfilesBySubscriptionList.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of contact profile resources.", + "schema": { + "$ref": "#/definitions/ContactProfileListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed. If the resource group does not exist, 404 (NotFound) will be returned.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Orbital/contactProfiles": { + "get": { + "tags": [ + "Contact Profile" + ], + "description": "Returns list of contact profiles", + "operationId": "Orbital_ListContactProfilesByResourceGroup", + "x-ms-examples": { + "List of Contact Profiles by Resource Group": { + "$ref": "./examples/ContactProfilesByResourceGroupList.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of contact profile resources.", + "schema": { + "$ref": "#/definitions/ContactProfileListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed. If the resource group does not exist, 404 (NotFound) will be returned.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Orbital/availableGroundStations": { + "get": { + "tags": [ + "Ground Station" + ], + "description": "Returns list of available ground stations", + "operationId": "AvailableGroundStations_ListByCapability", + "x-ms-examples": { + "List of Ground Stations by Capability": { + "$ref": "./examples/AvailableGroundStationsByCapabilityList.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/capabilityParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of Ground Station resources.", + "schema": { + "$ref": "#/definitions/AvailableGroundStationListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed. If the resource group does not exist, 404 (NotFound) will be returned.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Orbital/availableGroundStations/{groundStationName}": { + "get": { + "tags": [ + "Ground Station" + ], + "operationId": "AvailableGroundStations_Get", + "description": "Gets the specified available ground station", + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/groundStationNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting ground station resource.", + "schema": { + "$ref": "#/definitions/AvailableGroundStation" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get GroundStation": { + "$ref": "./examples/AvailableGroundStationGet.json" + } + } + } + } + }, + "definitions": { + "TagsObject": { + "type": "object", + "properties": { + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Resource tags." + } + }, + "description": "Tags object for patch operations." + }, + "SpacecraftsProperties": { + "type": "object", + "required": [ + "noradId" + ], + "properties": { + "noradId": { + "type": "string", + "description": "NORAD ID of the spacecraft." + }, + "authorizationStatus": { + "type": "string", + "readOnly": true, + "enum": [ + "Allowed", + "Pending", + "Denied" + ], + "x-ms-enum": { + "name": "AuthorizationStatus", + "modelAsString": false + }, + "description": "Authorization status of spacecraft." + }, + "authorizationStatusExtended": { + "type": "string", + "readOnly": true, + "description": "Details of the authorization status." + }, + "titleLine": { + "type": "string", + "description": "Title line of Two Line Element (TLE)." + }, + "tleLine1": { + "type": "string", + "description": "Line 1 of Two Line Element (TLE)." + }, + "tleLine2": { + "type": "string", + "description": "Line 2 of Two Line Element (TLE)." + }, + "links": { + "type": "array", + "items": { + "$ref": "#/definitions/SpacecraftLink" + }, + "description": "Links of the Spacecraft" + } + }, + "description": "List of Spacecraft Resource Properties." + }, + "SpacecraftListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Spacecraft" + }, + "description": "A list of spacecraft resources in a resource group." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of results.", + "readOnly": true + } + }, + "description": "Response for the ListSpacecrafts API service call." + }, + "SpacecraftLink": { + "type": "object", + "required": [ + "centerFrequencyMHz", + "bandwidthMHz", + "direction", + "polarization" + ], + "properties": { + "centerFrequencyMHz": { + "type": "number", + "description": "Center Frequency in MHz" + }, + "bandwidthMHz": { + "type": "number", + "description": "Bandwidth in MHz" + }, + "direction": { + "type": "string", + "description": "Direction (uplink or downlink)", + "enum": [ + "uplink", + "downlink" + ], + "x-ms-enum": { + "name": "direction", + "modelAsString": true + } + }, + "polarization": { + "type": "string", + "description": "polarization. eg (RHCP, LHCP)", + "enum": [ + "RHCP", + "LHCP", + "dualRhcpLhcp", + "linearVertical", + "linearHorizontal" + ], + "x-ms-enum": { + "name": "polarization", + "modelAsString": true + } + } + }, + "description": "Spacecraft Link" + }, + "Spacecraft": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "allOf": [ + { + "$ref": "#/definitions/SpacecraftsProperties" + } + ], + "description": "Spacecraft Properties" + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "description": "Customer creates a spacecraft resource to schedule a contact." + }, + "ResourceReference": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Resource ID." + } + }, + "x-ms-azure-resource": true, + "description": "Resource Reference" + }, + "Resource": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Resource ID.", + "readOnly": true + }, + "name": { + "type": "string", + "description": "Resource name.", + "readOnly": true + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Resource type." + }, + "location": { + "type": "string", + "description": "Resource location." + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Resource tags." + }, + "systemData": { + "allOf": [ + { + "$ref": "#/definitions/SystemData" + } + ], + "description": "Metadata pertaining to creation and last modification of the resource.", + "readOnly": true + } + }, + "description": "Common resource representation.", + "x-ms-azure-resource": true + }, + "ProxyResource": { + "type": "object", + "x-ms-azure-resource": true, + "description": "An azure resource object", + "properties": { + "id": { + "type": "string", + "readOnly": true, + "description": "Azure resource Id" + }, + "type": { + "type": "string", + "readOnly": true, + "description": "Azure resource type" + }, + "name": { + "type": "string", + "readOnly": true, + "description": "Azure resource name" + }, + "systemData": { + "allOf": [ + { + "$ref": "#/definitions/SystemData" + } + ], + "description": "Metadata pertaining to creation and last modification of the resource.", + "readOnly": true + } + } + }, + "OperationListResult": { + "type": "object", + "description": "Result of the request to list Orbital operations. It contains a list of operations and a URL link to get the next set of results.", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Operation" + }, + "description": "List of Orbital operations supported by the Orbital resource provider." + } + } + }, + "Operation": { + "description": "Orbital REST API operation definition.", + "type": "object", + "properties": { + "name": { + "description": "Operation name: {provider}/{resource}/{operation}", + "type": "string" + }, + "isDataAction": { + "type": "boolean", + "default": false, + "description": "Indicates whether the operation applies to data-plane." + }, + "display": { + "type": "object", + "description": "Display metadata associated with the operation.", + "properties": { + "provider": { + "description": "Service provider: Microsoft Orbital.", + "type": "string" + }, + "resource": { + "description": "Resource on which the operation is performed etc.", + "type": "string" + }, + "operation": { + "description": "Type of operation: get, read, delete, etc.", + "type": "string" + }, + "description": { + "description": "Description of the operation.", + "type": "string" + } + } + }, + "origin": { + "type": "string", + "description": "The origin of operations." + } + } + }, + "EndPoint": { + "type": "object", + "required": [ + "ipAddress", + "endPointName", + "port", + "protocol" + ], + "properties": { + "ipAddress": { + "type": "string", + "description": "IP Address." + }, + "endPointName": { + "type": "string", + "description": "Name of an end point." + }, + "port": { + "type": "string", + "description": "TCP port to listen on to receive data." + }, + "protocol": { + "type": "string", + "description": "Protocol either UDP or TCP.", + "enum": [ + "TCP", + "UDP" + ], + "x-ms-enum": { + "name": "protocol", + "modelAsString": true + } + } + }, + "description": "Customer End point to store/retrieve data during a contact." + }, + "ContactsProperties": { + "type": "object", + "required": [ + "reservationStartTime", + "reservationEndTime", + "groundStationName", + "contactProfile" + ], + "properties": { + "status": { + "type": "string", + "readOnly": true, + "enum": [ + "scheduled", + "cancelled", + "succeeded", + "failed", + "providerCancelled" + ], + "x-ms-enum": { + "name": "Status", + "modelAsString": false + }, + "description": "Status of a contact." + }, + "reservationStartTime": { + "type": "string", + "format": "date-time", + "description": "Reservation start time of a contact." + }, + "reservationEndTime": { + "type": "string", + "format": "date-time", + "description": "Reservation end time of a contact." }, - "description": "This is a sample get operation, please see guidelines in azure-rest-api-specs repository for more info", - "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" + "rxStartTime": { + "type": "string", + "format": "date-time", + "readOnly": true, + "description": "Receive start time of a contact." + }, + "rxEndTime": { + "type": "string", + "format": "date-time", + "readOnly": true, + "description": "Receive end time of a contact." + }, + "txStartTime": { + "type": "string", + "format": "date-time", + "readOnly": true, + "description": "Transmit start time of a contact." + }, + "txEndTime": { + "type": "string", + "format": "date-time", + "readOnly": true, + "description": "Transmit end time of a contact." + }, + "errorMessage": { + "type": "string", + "readOnly": true, + "description": "Any error message while scheduling a contact." + }, + "maximumElevationDegrees": { + "type": "number", + "readOnly": true, + "description": "Maximum elevation of the antenna during the contact in decimal degrees." + }, + "startAzimuthDegrees": { + "type": "number", + "readOnly": true, + "description": "Azimuth of the antenna at the start of the contact in decimal degrees." + }, + "endAzimuthDegrees": { + "type": "number", + "readOnly": true, + "description": "Azimuth of the antenna at the end of the contact in decimal degrees." + }, + "groundStationName": { + "type": "string", + "description": "Azure Ground Station name." + }, + "startElevationDegrees": { + "type": "number", + "readOnly": true, + "description": "Spacecraft elevation above the horizon at contact start." + }, + "endElevationDegrees": { + "type": "number", + "readOnly": true, + "description": "Spacecraft elevation above the horizon at contact end." + }, + "contactProfile": { + "allOf": [ + { + "$ref": "#/definitions/ResourceReference" + } + ], + "description": "The reference to the contact profile resource." + } + }, + "description": "Properties of the Contact Resource." + }, + "ContactProfilesProperties": { + "type": "object", + "required": [ + "links" + ], + "properties": { + "minimumViableContactDuration": { + "type": "string", + "description": "Minimum viable contact duration in ISO 8601 format." + }, + "minimumElevationDegrees": { + "type": "number", + "description": "Minimum viable elevation for the contact in decimal degrees." + }, + "autoTrackingConfiguration": { + "type": "string", + "enum": [ + "disabled", + "xBand", + "sBand" + ], + "x-ms-enum": { + "name": "AutoTrackingConfiguration", + "modelAsString": false }, - { - "$ref": "#/parameters/ResourceGroupNameParameter" + "description": "Auto track configuration." + }, + "links": { + "type": "array", + "items": { + "$ref": "#/definitions/ContactProfileLink" + }, + "description": "Links of the Contact Profile" + } + }, + "description": "List of Contact Profile Resource Properties." + }, + "ContactProfileListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ContactProfile" + }, + "description": "A list of contact profile resources in a resource group." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of results.", + "readOnly": true + } + }, + "description": "Response for the ListContactProfiles API service call." + }, + "ContactProfileLinkChannel": { + "type": "object", + "required": [ + "centerFrequencyMHz", + "bandwidthMHz", + "endPoint" + ], + "properties": { + "centerFrequencyMHz": { + "type": "number", + "description": "Center Frequency in MHz" + }, + "bandwidthMHz": { + "type": "number", + "description": "Bandwidth in MHz" + }, + "endPoint": { + "$ref": "#/definitions/EndPoint" + }, + "modulationConfiguration": { + "type": "string", + "description": "Configuration for modulation" + }, + "demodulationConfiguration": { + "type": "string", + "description": "Configuration for demodulation" + }, + "encodingConfiguration": { + "type": "string", + "description": "Configuration for encoding" + }, + "decodingConfiguration": { + "type": "string", + "description": "Configuration for decoding" + } + }, + "description": "Contact Profile Link Channel" + }, + "ContactProfileLink": { + "type": "object", + "required": [ + "polarization", + "direction", + "channels" + ], + "properties": { + "polarization": { + "type": "string", + "description": "polarization. eg (RHCP, LHCP)", + "enum": [ + "RHCP", + "LHCP", + "dualRhcpLhcp", + "linearVertical", + "linearHorizontal" + ], + "x-ms-enum": { + "name": "polarization", + "modelAsString": true } - ], - "responses": { - "200": { - "description": "Describe the result of a successful operation.", - "schema": { - "$ref": "#/definitions/Result" - } + }, + "direction": { + "type": "string", + "description": "Direction (uplink or downlink)", + "enum": [ + "uplink", + "downlink" + ], + "x-ms-enum": { + "name": "direction", + "modelAsString": true + } + }, + "gainOverTemperature": { + "type": "number", + "description": "Gain To Noise Temperature in db/K." + }, + "eirpdBW": { + "type": "number", + "description": "Effective Isotropic Radiated Power (EIRP) in dBW." + }, + "channels": { + "type": "array", + "items": { + "$ref": "#/definitions/ContactProfileLinkChannel" }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" + "description": "Contact Profile Link Channel" + } + }, + "description": "Contact Profile link" + }, + "ContactProfile": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "allOf": [ + { + "$ref": "#/definitions/ContactProfilesProperties" } - } + ], + "description": "Properties of the spacecraft resource." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." } - } - } - }, - "definitions": { - "Result": { - "description": "Sample result definition", + }, + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "description": "Customer creates a Contact Profile Resource, which will contain all of the configurations required for scheduling a contact." + }, + "ContactParameters": { + "type": "object", + "description": "Parameters that define the contact resource.", + "required": [ + "contactProfile", + "groundStationName", + "startTime", + "endTime" + ], "properties": { - "sampleProperty": { + "contactProfile": { + "allOf": [ + { + "$ref": "#/definitions/ResourceReference" + } + ], + "description": "The reference to the contact profile resource." + }, + "groundStationName": { "type": "string", - "description": "Sample property of type string" + "description": "Name of Azure Ground Station." + }, + "startTime": { + "type": "string", + "format": "date-time", + "description": "Start time of a contact." + }, + "endTime": { + "type": "string", + "format": "date-time", + "description": "End time of a contact." } } }, - "ErrorResponse": { - "description": "Error response.", + "ContactListResult": { + "type": "object", "properties": { - "error": { - "$ref": "#/definitions/ErrorDefinition", - "description": "The error details." + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Contact" + }, + "description": "A list of contact resources in a resource group." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of results.", + "readOnly": true } - } + }, + "description": "Response for the ListContacts API service call." + }, + "ContactInstanceProperties": { + "type": "object", + "properties": { + "maximumElevationDegrees": { + "type": "number", + "readOnly": true, + "description": "Maximum elevation of the antenna during the contact in decimal degrees." + }, + "txStartTime": { + "type": "string", + "format": "date-time", + "readOnly": true, + "description": "Time at which antenna transmit will be enabled." + }, + "txEndTime": { + "type": "string", + "format": "date-time", + "readOnly": true, + "description": "Time at which antenna transmit will be disabled." + }, + "rxStartTime": { + "type": "string", + "format": "date-time", + "readOnly": true, + "description": "Earliest time to receive a signal." + }, + "rxEndTime": { + "type": "string", + "format": "date-time", + "readOnly": true, + "description": "Time to lost receiving a signal." + }, + "startAzimuthDegrees": { + "type": "number", + "readOnly": true, + "description": "Azimuth of the antenna at the start of the contact in decimal degrees." + }, + "endAzimuthDegrees": { + "type": "number", + "readOnly": true, + "description": "Azimuth of the antenna at the end of the contact in decimal degrees." + }, + "startElevationDegrees": { + "type": "number", + "readOnly": true, + "description": "Spacecraft elevation above the horizon at contact start." + }, + "endElevationDegrees": { + "type": "number", + "readOnly": true, + "description": "Spacecraft elevation above the horizon at contact end." + } + }, + "description": "Contact Instance Properties" + }, + "Contact": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ContactsProperties" + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "#/definitions/ProxyResource" + } + ], + "description": "Customer creates a contact resource for a spacecraft resource." }, - "ErrorDefinition": { - "description": "Error definition.", + "CloudErrorBody": { + "x-ms-external": true, + "type": "object", "properties": { "code": { - "description": "Service specific error code which serves as the substatus for the HTTP error code.", "type": "string", - "readOnly": true + "description": "An identifier for the error. Codes are invariant and are intended to be consumed programmatically." }, "message": { - "description": "Description of the error.", "type": "string", - "readOnly": true + "description": "A message describing the error, intended to be suitable for display in a user interface." + }, + "target": { + "type": "string", + "description": "The target of the particular error. For example, the name of the property in error." }, "details": { - "description": "Internal error details.", "type": "array", "items": { - "$ref": "#/definitions/ErrorDefinition" + "$ref": "#/definitions/CloudErrorBody" + }, + "description": "A list of additional details about the error." + } + }, + "description": "An error response from the service." + }, + "CloudError": { + "x-ms-external": true, + "type": "object", + "properties": { + "error": { + "$ref": "#/definitions/CloudErrorBody" + } + }, + "description": "An error response from the service." + }, + "AvailableContactsListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/AvailableContacts" + }, + "description": "A list of available contacts" + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of results.", + "readOnly": true + } + }, + "description": "Response for the ListAvailableContacts API service call." + }, + "AvailableContacts": { + "type": "object", + "properties": { + "spacecraft": { + "allOf": [ + { + "$ref": "#/definitions/ResourceReference" + } + ], + "description": "The reference to the spacecraft resource." + }, + "groundStationName": { + "type": "string", + "readOnly": true, + "description": "Name of Azure Ground Station." + }, + "properties": { + "x-ms-client-flatten": true, + "allOf": [ + { + "$ref": "#/definitions/ContactInstanceProperties" + } + ], + "description": "Properties of Contact resource." + } + }, + "description": "Customer retrieves list of Available Contacts for a spacecraft resource. Later, one of the available contact can be selected to create a contact." + }, + "AvailableGroundStationListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/AvailableGroundStation" }, + "description": "A list of ground station resources." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of results.", "readOnly": true } + }, + "description": "Response for the AvailableGroundStations API service call." + }, + "AvailableGroundStation": { + "type": "object", + "x-ms-client-flatten": true, + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "Id of groundStation" + }, + "name": { + "readOnly": true, + "type": "string", + "description": "Name of the ground station." + }, + "location": { + "type": "string", + "description": "Azure region" + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Resource type." + }, + "properties": { + "x-ms-client-flatten": true, + "allOf": [ + { + "$ref": "#/definitions/AvailableGroundStationProperties" + } + ], + "description": "The properties bag for this resource" + } + }, + "description": "GroundStations available to schedule Contacts" + }, + "AvailableGroundStationProperties": { + "type": "object", + "properties": { + "city": { + "type": "string", + "description": "City of ground station." + }, + "providerName": { + "type": "string", + "description": "Ground station provider name." + }, + "longitudeDegrees": { + "type": "number", + "description": "Longitude of the ground station in decimal degrees." + }, + "latitudeDegrees": { + "type": "number", + "description": "Latitude of the ground station in decimal degrees." + }, + "altitudeMeters": { + "type": "number", + "description": "Altitude of the ground station" + } + }, + "description": "Properties object for Available groundstation." + }, + "Capability": { + "type": "string", + "description": "Capability of the Ground Station.", + "enum": [ + "EarthObservation", + "Communication" + ] + }, + "SystemData": { + "description": "Metadata pertaining to creation and last modification of the resource.", + "type": "object", + "readOnly": true, + "properties": { + "createdBy": { + "type": "string", + "description": "The identity that created the resource." + }, + "createdByType": { + "type": "string", + "description": "The type of identity that created the resource.", + "enum": [ + "User", + "Application", + "ManagedIdentity", + "Key" + ], + "x-ms-enum": { + "name": "createdByType", + "modelAsString": true + } + }, + "createdAt": { + "type": "string", + "format": "date-time", + "description": "The timestamp of resource creation (UTC)." + }, + "lastModifiedBy": { + "type": "string", + "description": "The identity that last modified the resource." + }, + "lastModifiedByType": { + "type": "string", + "description": "The type of identity that last modified the resource.", + "enum": [ + "User", + "Application", + "ManagedIdentity", + "Key" + ], + "x-ms-enum": { + "name": "createdByType", + "modelAsString": true + } + } } + }, + "ResourceIdListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The Azure Resource ID" + } + } + }, + "description": "A list of Azure Resource IDs." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of results.", + "readOnly": true + } + }, + "description": "Response for an API service call that lists the resource IDs of resources associated with another resource." + }, + "Etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." } }, "parameters": { - "SubscriptionIdParameter": { - "name": "subscriptionId", + "apiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "2020-09-01-preview", + "2021-04-04-preview" + ], + "default": "2021-04-04-preview", + "description": "Version of the API to be used with the client request." + }, + "contactNameParameter": { + "name": "contactName", + "in": "path", + "description": "Contact Name", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "contactProfileNameParameter": { + "name": "contactProfileName", + "in": "path", + "description": "Contact Profile Name", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "groundStationNameParameter": { + "name": "groundStationName", "in": "path", "required": true, "type": "string", - "description": "The Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000)" + "description": "Ground Station name", + "x-ms-parameter-location": "method" }, - "ResourceGroupNameParameter": { + "resourceGroupName": { "name": "resourceGroupName", "in": "path", "required": true, @@ -121,12 +1987,73 @@ "description": "The name of the resource group.", "x-ms-parameter-location": "method" }, - "ApiVersionParameter": { - "name": "api-version", + "spacecraftNameParameter": { + "name": "spacecraftName", + "in": "path", + "description": "Spacecraft ID", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "subscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "description": "Azure Subscription ID.", + "required": true, + "type": "string" + }, + "capabilityParameter": { + "name": "capability", "in": "query", "required": true, "type": "string", - "description": "The API version to be used with the HTTP request." + "enum": [ + "EarthObservation", + "Communication" + ], + "default": "EarthObservation", + "description": "Ground Station Capability", + "x-ms-parameter-location": "method" + }, + "orbitalGatewayNameParameter": { + "name": "orbitalGatewayName", + "in": "path", + "description": "Orbital gateway name", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "edgeSiteNameParameter": { + "name": "edgeSiteName", + "in": "path", + "description": "Edge site name", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "l2ConnectionNameParameter": { + "name": "l2ConnectionName", + "in": "path", + "description": "L2 Connection name", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "l3ConnectionNameParameter": { + "name": "l3ConnectionName", + "in": "path", + "description": "L3 connection name", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "globalCommunicationsSiteNameParameter": { + "name": "globalCommunicationsSiteName", + "in": "path", + "description": "Global communications Site name", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" } } } diff --git a/specification/orbital/resource-manager/readme.csharp.md b/specification/orbital/resource-manager/readme.csharp.md index 7d800fe8ef4e..4d2d5ea6cbe7 100644 --- a/specification/orbital/resource-manager/readme.csharp.md +++ b/specification/orbital/resource-manager/readme.csharp.md @@ -12,4 +12,4 @@ csharp: client-side-validation: false namespace: Microsoft.Orbital output-folder: $(csharp-sdks-folder)/orbital/management/Microsoft.Orbital/GeneratedProtocol -``` +``` \ No newline at end of file diff --git a/specification/orbital/resource-manager/readme.go.md b/specification/orbital/resource-manager/readme.go.md index 61b1f03cb3ec..7a6eb638c1ac 100644 --- a/specification/orbital/resource-manager/readme.go.md +++ b/specification/orbital/resource-manager/readme.go.md @@ -8,4 +8,4 @@ license-header: MICROSOFT_MIT_NO_VERSION module-name: sdk/orbital/armorbital module: github.com/Azure/azure-sdk-for-go/$(module-name) output-folder: $(go-sdk-folder)/$(module-name) -``` +``` \ No newline at end of file diff --git a/specification/orbital/resource-manager/readme.md b/specification/orbital/resource-manager/readme.md index 19db38fee1ef..6e42dd89d6b8 100644 --- a/specification/orbital/resource-manager/readme.md +++ b/specification/orbital/resource-manager/readme.md @@ -74,4 +74,4 @@ See configuration in [readme.typescript.md](./readme.typescript.md) ## CSharp -See configuration in [readme.csharp.md](./readme.csharp.md) +See configuration in [readme.csharp.md](./readme.csharp.md) \ No newline at end of file diff --git a/specification/orbital/resource-manager/readme.python.md b/specification/orbital/resource-manager/readme.python.md index ee93d0c55312..a9f5c099a5a4 100644 --- a/specification/orbital/resource-manager/readme.python.md +++ b/specification/orbital/resource-manager/readme.python.md @@ -20,4 +20,4 @@ output-folder: $(python-sdks-folder)/orbital/azure-mgmt-orbital/azure/mgmt/orbit ``` yaml $(python-mode) == 'create' && $(track2) basic-setup-py: true output-folder: $(python-sdks-folder)/orbital/azure-mgmt-orbital -``` +``` \ No newline at end of file diff --git a/specification/orbital/resource-manager/readme.typescript.md b/specification/orbital/resource-manager/readme.typescript.md index 0d531d938a32..1fd450daf586 100644 --- a/specification/orbital/resource-manager/readme.typescript.md +++ b/specification/orbital/resource-manager/readme.typescript.md @@ -11,4 +11,4 @@ typescript: payload-flattening-threshold: 1 clear-output-folder: true generate-metadata: true -``` +``` \ No newline at end of file From 4331ff34d7819ce1b1653e3ce00ba1286ef187ad Mon Sep 17 00:00:00 2001 From: Devanshu Singh <8132290+thisisdevanshu@users.noreply.github.com> Date: Thu, 11 Nov 2021 01:16:45 -0500 Subject: [PATCH 11/26] operation IDs updated (#5461) Co-authored-by: Devanshu Singh --- .../preview/2021-04-04-preview/orbital.json | 38 +++++++++---------- 1 file changed, 19 insertions(+), 19 deletions(-) diff --git a/specification/orbital/resource-manager/Microsoft.Orbital/preview/2021-04-04-preview/orbital.json b/specification/orbital/resource-manager/Microsoft.Orbital/preview/2021-04-04-preview/orbital.json index db53e0e588a9..7f5b1c2ae319 100644 --- a/specification/orbital/resource-manager/Microsoft.Orbital/preview/2021-04-04-preview/orbital.json +++ b/specification/orbital/resource-manager/Microsoft.Orbital/preview/2021-04-04-preview/orbital.json @@ -36,7 +36,7 @@ "Operations" ], "description": "Lists all of the available Orbital Rest API operations.", - "operationId": "Orbital_ListOperations", + "operationId": "Operations_List", "x-ms-examples": { "OperationsList": { "$ref": "./examples/OperationsList.json" @@ -72,7 +72,7 @@ "Spacecraft" ], "description": "Return list of spacecrafts", - "operationId": "Orbital_ListSpacecraftsBySubscription", + "operationId": "Spacecrafts_ListBySubscription", "x-ms-examples": { "List of Spacecraft by Subscription": { "$ref": "./examples/SpacecraftsBySubscriptionList.json" @@ -111,7 +111,7 @@ "Spacecraft" ], "description": "Return list of spacecrafts", - "operationId": "Orbital_ListSpacecraftsByResourceGroup", + "operationId": "Spacecrafts_List", "x-ms-examples": { "List of Spacecraft by Resource Group": { "$ref": "./examples/SpacecraftsByResourceGroupList.json" @@ -152,7 +152,7 @@ "tags": [ "Spacecraft" ], - "operationId": "Orbital_GetSpacecraft", + "operationId": "Spacecrafts_Get", "description": "Gets the specified spacecraft in a specified resource group", "parameters": [ { @@ -193,7 +193,7 @@ "Spacecraft" ], "description": "Creates or updates a spacecraft resource", - "operationId": "Orbital_CreateOrUpdateSpacecraft", + "operationId": "Spacecrafts_CreateOrUpdate", "parameters": [ { "$ref": "#/parameters/resourceGroupName" @@ -252,7 +252,7 @@ "tags": [ "Spacecraft" ], - "operationId": "Orbital_DeleteSpacecraft", + "operationId": "Spacecrafts_Delete", "description": "Deletes a specified spacecraft resource.", "parameters": [ { @@ -299,7 +299,7 @@ "tags": [ "Spacecraft" ], - "operationId": "Orbital_UpdateTagsSpacecraft", + "operationId": "Spacecrafts_UpdateTags", "x-ms-examples": { "Update Spacecraft tags": { "$ref": "./examples/SpacecraftUpdateTags.json" @@ -348,10 +348,10 @@ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Orbital/spacecrafts/{spacecraftName}/contacts": { "get": { "tags": [ - "Spacecraft" + "Contact" ], "description": "Returns list of contacts by spacecraftName", - "operationId": "Orbital_ListContactsBySpacecraftName", + "operationId": "Contacts_List", "x-ms-examples": { "List of Contacts": { "$ref": "./examples/ContactsBySpacecraftNameList.json" @@ -395,7 +395,7 @@ "tags": [ "Contact" ], - "operationId": "Orbital_GetContact", + "operationId": "Contacts_Get", "description": "Gets the specified contact in a specified resource group", "parameters": [ { @@ -439,7 +439,7 @@ "Contact" ], "description": "Creates a contact.", - "operationId": "Orbital_CreateContact", + "operationId": "Contacts_Create", "parameters": [ { "$ref": "#/parameters/resourceGroupName" @@ -500,7 +500,7 @@ "tags": [ "Contact" ], - "operationId": "Orbital_DeleteContact", + "operationId": "Contacts_Delete", "description": "Deletes a specified contact", "parameters": [ { @@ -553,7 +553,7 @@ "Contact" ], "description": "Return list of available contacts", - "operationId": "Orbital_ListAvailableContacts", + "operationId": "Spacecrafts_ListAvailableContacts", "x-ms-examples": { "List of Contact": { "$ref": "./examples/AvailableContactsList.json" @@ -608,7 +608,7 @@ "tags": [ "Contact Profile" ], - "operationId": "Orbital_GetContactProfile", + "operationId": "ContactProfiles_Get", "description": "Gets the specified contact Profile in a specified resource group", "parameters": [ { @@ -649,7 +649,7 @@ "Contact Profile" ], "description": "Creates or updates a contact profile", - "operationId": "Orbital_CreateOrUpdateContactProfile", + "operationId": "ContactProfiles_CreateOrUpdate", "parameters": [ { "$ref": "#/parameters/resourceGroupName" @@ -708,7 +708,7 @@ "tags": [ "Contact Profile" ], - "operationId": "Orbital_DeleteContactProfile", + "operationId": "ContactProfiles_Delete", "description": "Deletes a specified contact profile resource.", "parameters": [ { @@ -755,7 +755,7 @@ "tags": [ "Contact Profile" ], - "operationId": "Orbital_UpdateTagsContactProfile", + "operationId": "ContactProfiles_UpdateTags", "x-ms-examples": { "Update Contact Profile tags": { "$ref": "./examples/ContactProfileUpdateTag.json" @@ -807,7 +807,7 @@ "Contact Profile" ], "description": "Returns list of contact profiles", - "operationId": "Orbital_ListContactProfilesBySubscription", + "operationId": "ContactProfiles_ListBySubscription", "x-ms-examples": { "List of Contact Profiles by Subscription": { "$ref": "./examples/ContactProfilesBySubscriptionList.json" @@ -846,7 +846,7 @@ "Contact Profile" ], "description": "Returns list of contact profiles", - "operationId": "Orbital_ListContactProfilesByResourceGroup", + "operationId": "ContactProfiles_List", "x-ms-examples": { "List of Contact Profiles by Resource Group": { "$ref": "./examples/ContactProfilesByResourceGroupList.json" From 04419dae57ca055fb6e9b778dfc426847ee0103f Mon Sep 17 00:00:00 2001 From: Devanshu Singh <8132290+thisisdevanshu@users.noreply.github.com> Date: Tue, 16 Nov 2021 01:41:47 -0500 Subject: [PATCH 12/26] Dev orbital microsoft.orbital 2021 04 04 preview (#5491) * operation IDs updated * updated OperationListResult definition * review points implemented Co-authored-by: Devanshu Singh --- .../preview/2021-04-04-preview/orbital.json | 56 +------------------ 1 file changed, 1 insertion(+), 55 deletions(-) diff --git a/specification/orbital/resource-manager/Microsoft.Orbital/preview/2021-04-04-preview/orbital.json b/specification/orbital/resource-manager/Microsoft.Orbital/preview/2021-04-04-preview/orbital.json index 7f5b1c2ae319..6ceae7230a4e 100644 --- a/specification/orbital/resource-manager/Microsoft.Orbital/preview/2021-04-04-preview/orbital.json +++ b/specification/orbital/resource-manager/Microsoft.Orbital/preview/2021-04-04-preview/orbital.json @@ -51,7 +51,7 @@ "200": { "description": "OK. The request has succeeded.", "schema": { - "$ref": "#/definitions/OperationListResult" + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/OperationListResult" } }, "default": { @@ -1203,60 +1203,6 @@ } } }, - "OperationListResult": { - "type": "object", - "description": "Result of the request to list Orbital operations. It contains a list of operations and a URL link to get the next set of results.", - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/Operation" - }, - "description": "List of Orbital operations supported by the Orbital resource provider." - } - } - }, - "Operation": { - "description": "Orbital REST API operation definition.", - "type": "object", - "properties": { - "name": { - "description": "Operation name: {provider}/{resource}/{operation}", - "type": "string" - }, - "isDataAction": { - "type": "boolean", - "default": false, - "description": "Indicates whether the operation applies to data-plane." - }, - "display": { - "type": "object", - "description": "Display metadata associated with the operation.", - "properties": { - "provider": { - "description": "Service provider: Microsoft Orbital.", - "type": "string" - }, - "resource": { - "description": "Resource on which the operation is performed etc.", - "type": "string" - }, - "operation": { - "description": "Type of operation: get, read, delete, etc.", - "type": "string" - }, - "description": { - "description": "Description of the operation.", - "type": "string" - } - } - }, - "origin": { - "type": "string", - "description": "The origin of operations." - } - } - }, "EndPoint": { "type": "object", "required": [ From e65b9e2ec735a9b9b7a4b53e31a43856f56a5f45 Mon Sep 17 00:00:00 2001 From: Devanshu Singh <8132290+thisisdevanshu@users.noreply.github.com> Date: Tue, 16 Nov 2021 19:21:05 -0500 Subject: [PATCH 13/26] 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 Co-authored-by: ArcturusZhang --- .../preview/2021-04-04-preview/orbital.json | 167 ++++++++---------- 1 file changed, 70 insertions(+), 97 deletions(-) diff --git a/specification/orbital/resource-manager/Microsoft.Orbital/preview/2021-04-04-preview/orbital.json b/specification/orbital/resource-manager/Microsoft.Orbital/preview/2021-04-04-preview/orbital.json index 6ceae7230a4e..c35baf0c2499 100644 --- a/specification/orbital/resource-manager/Microsoft.Orbital/preview/2021-04-04-preview/orbital.json +++ b/specification/orbital/resource-manager/Microsoft.Orbital/preview/2021-04-04-preview/orbital.json @@ -44,7 +44,7 @@ }, "parameters": [ { - "$ref": "#/parameters/apiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" } ], "responses": { @@ -80,10 +80,10 @@ }, "parameters": [ { - "$ref": "#/parameters/subscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "#/parameters/apiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" } ], "responses": { @@ -119,13 +119,13 @@ }, "parameters": [ { - "$ref": "#/parameters/resourceGroupName" + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "#/parameters/subscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" }, { - "$ref": "#/parameters/apiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" } ], "responses": { @@ -156,13 +156,13 @@ "description": "Gets the specified spacecraft in a specified resource group", "parameters": [ { - "$ref": "#/parameters/resourceGroupName" + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "#/parameters/subscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" }, { - "$ref": "#/parameters/apiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/spacecraftNameParameter" @@ -196,13 +196,13 @@ "operationId": "Spacecrafts_CreateOrUpdate", "parameters": [ { - "$ref": "#/parameters/resourceGroupName" + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "#/parameters/subscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" }, { - "$ref": "#/parameters/apiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/spacecraftNameParameter" @@ -256,13 +256,13 @@ "description": "Deletes a specified spacecraft resource.", "parameters": [ { - "$ref": "#/parameters/resourceGroupName" + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "#/parameters/subscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" }, { - "$ref": "#/parameters/apiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/spacecraftNameParameter" @@ -308,7 +308,13 @@ "description": "Updates the specified spacecraft tags.", "parameters": [ { - "$ref": "#/parameters/resourceGroupName" + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/spacecraftNameParameter" }, { "name": "parameters", @@ -320,13 +326,7 @@ "description": "Parameters supplied to update spacecraft tags." }, { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - }, - { - "$ref": "#/parameters/spacecraftNameParameter" + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" } ], "responses": { @@ -359,13 +359,13 @@ }, "parameters": [ { - "$ref": "#/parameters/resourceGroupName" + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "#/parameters/subscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" }, { - "$ref": "#/parameters/apiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/spacecraftNameParameter" @@ -399,19 +399,19 @@ "description": "Gets the specified contact in a specified resource group", "parameters": [ { - "$ref": "#/parameters/resourceGroupName" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "#/parameters/apiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/spacecraftNameParameter" }, { "$ref": "#/parameters/contactNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" } ], "responses": { @@ -442,13 +442,10 @@ "operationId": "Contacts_Create", "parameters": [ { - "$ref": "#/parameters/resourceGroupName" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "#/parameters/apiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/spacecraftNameParameter" @@ -464,6 +461,9 @@ "$ref": "#/definitions/Contact" }, "description": "The parameters to provide for the created contact." + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" } ], "responses": { @@ -504,19 +504,19 @@ "description": "Deletes a specified contact", "parameters": [ { - "$ref": "#/parameters/resourceGroupName" + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/spacecraftNameParameter" }, { "$ref": "#/parameters/contactNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" } ], "responses": { @@ -565,13 +565,10 @@ }, "parameters": [ { - "$ref": "#/parameters/resourceGroupName" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "#/parameters/apiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/spacecraftNameParameter" @@ -585,6 +582,9 @@ "$ref": "#/definitions/ContactParameters" }, "description": "The parameters to provide for the contacts." + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" } ], "responses": { @@ -612,16 +612,16 @@ "description": "Gets the specified contact Profile in a specified resource group", "parameters": [ { - "$ref": "#/parameters/resourceGroupName" + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "#/parameters/subscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" }, { - "$ref": "#/parameters/apiVersionParameter" + "$ref": "#/parameters/contactProfileNameParameter" }, { - "$ref": "#/parameters/contactProfileNameParameter" + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" } ], "responses": { @@ -652,13 +652,13 @@ "operationId": "ContactProfiles_CreateOrUpdate", "parameters": [ { - "$ref": "#/parameters/resourceGroupName" + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "#/parameters/subscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" }, { - "$ref": "#/parameters/apiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/contactProfileNameParameter" @@ -712,13 +712,13 @@ "description": "Deletes a specified contact profile resource.", "parameters": [ { - "$ref": "#/parameters/resourceGroupName" + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "#/parameters/subscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" }, { - "$ref": "#/parameters/apiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/contactProfileNameParameter" @@ -764,7 +764,10 @@ "description": "Updates the specified contact profile tags.", "parameters": [ { - "$ref": "#/parameters/resourceGroupName" + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "parameters", @@ -776,10 +779,7 @@ "description": "Parameters supplied to update contact profile tags." }, { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/contactProfileNameParameter" @@ -815,10 +815,10 @@ }, "parameters": [ { - "$ref": "#/parameters/subscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "#/parameters/apiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" } ], "responses": { @@ -854,13 +854,13 @@ }, "parameters": [ { - "$ref": "#/parameters/resourceGroupName" + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "#/parameters/subscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" }, { - "$ref": "#/parameters/apiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" } ], "responses": { @@ -896,10 +896,10 @@ }, "parameters": [ { - "$ref": "#/parameters/subscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "#/parameters/apiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/capabilityParameter" @@ -933,13 +933,13 @@ "description": "Gets the specified available ground station", "parameters": [ { - "$ref": "#/parameters/subscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "#/parameters/groundStationNameParameter" }, { - "$ref": "#/parameters/apiVersionParameter" + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" } ], "responses": { @@ -1889,18 +1889,6 @@ } }, "parameters": { - "apiVersionParameter": { - "name": "api-version", - "in": "query", - "required": true, - "type": "string", - "enum": [ - "2020-09-01-preview", - "2021-04-04-preview" - ], - "default": "2021-04-04-preview", - "description": "Version of the API to be used with the client request." - }, "contactNameParameter": { "name": "contactName", "in": "path", @@ -1925,14 +1913,6 @@ "description": "Ground Station name", "x-ms-parameter-location": "method" }, - "resourceGroupName": { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group.", - "x-ms-parameter-location": "method" - }, "spacecraftNameParameter": { "name": "spacecraftName", "in": "path", @@ -1941,13 +1921,6 @@ "type": "string", "x-ms-parameter-location": "method" }, - "subscriptionIdParameter": { - "name": "subscriptionId", - "in": "path", - "description": "Azure Subscription ID.", - "required": true, - "type": "string" - }, "capabilityParameter": { "name": "capability", "in": "query", From d5f2d3660fe7946babd14a2272eddd5a3a7be0e8 Mon Sep 17 00:00:00 2001 From: Devanshu Singh <8132290+thisisdevanshu@users.noreply.github.com> Date: Tue, 16 Nov 2021 21:47:24 -0500 Subject: [PATCH 14/26] 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 --- .../preview/2021-04-04-preview/orbital.json | 231 ++++-------------- 1 file changed, 43 insertions(+), 188 deletions(-) diff --git a/specification/orbital/resource-manager/Microsoft.Orbital/preview/2021-04-04-preview/orbital.json b/specification/orbital/resource-manager/Microsoft.Orbital/preview/2021-04-04-preview/orbital.json index c35baf0c2499..2221222524d4 100644 --- a/specification/orbital/resource-manager/Microsoft.Orbital/preview/2021-04-04-preview/orbital.json +++ b/specification/orbital/resource-manager/Microsoft.Orbital/preview/2021-04-04-preview/orbital.json @@ -80,7 +80,7 @@ }, "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" @@ -119,10 +119,10 @@ }, "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" @@ -156,10 +156,10 @@ "description": "Gets the specified spacecraft in a specified resource group", "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" @@ -196,10 +196,10 @@ "operationId": "Spacecrafts_CreateOrUpdate", "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" @@ -256,10 +256,10 @@ "description": "Deletes a specified spacecraft resource.", "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" @@ -308,10 +308,10 @@ "description": "Updates the specified spacecraft tags.", "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/spacecraftNameParameter" @@ -359,10 +359,10 @@ }, "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" @@ -399,10 +399,10 @@ "description": "Gets the specified contact in a specified resource group", "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/spacecraftNameParameter" @@ -442,10 +442,10 @@ "operationId": "Contacts_Create", "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/spacecraftNameParameter" @@ -504,10 +504,10 @@ "description": "Deletes a specified contact", "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/spacecraftNameParameter" @@ -565,10 +565,10 @@ }, "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/spacecraftNameParameter" @@ -612,10 +612,10 @@ "description": "Gets the specified contact Profile in a specified resource group", "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/contactProfileNameParameter" @@ -652,10 +652,10 @@ "operationId": "ContactProfiles_CreateOrUpdate", "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" @@ -712,10 +712,10 @@ "description": "Deletes a specified contact profile resource.", "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" @@ -764,10 +764,10 @@ "description": "Updates the specified contact profile tags.", "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "parameters", @@ -815,7 +815,7 @@ }, "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" @@ -854,10 +854,10 @@ }, "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" @@ -896,7 +896,7 @@ }, "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" @@ -933,7 +933,7 @@ "description": "Gets the specified available ground station", "parameters": [ { - "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "#/parameters/groundStationNameParameter" @@ -1099,11 +1099,7 @@ "properties": { "properties": { "x-ms-client-flatten": true, - "allOf": [ - { - "$ref": "#/definitions/SpacecraftsProperties" - } - ], + "$ref": "#/definitions/SpacecraftsProperties", "description": "Spacecraft Properties" }, "etag": { @@ -1114,7 +1110,7 @@ }, "allOf": [ { - "$ref": "#/definitions/Resource" + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/TrackedResource" } ], "description": "Customer creates a spacecraft resource to schedule a contact." @@ -1130,79 +1126,6 @@ "x-ms-azure-resource": true, "description": "Resource Reference" }, - "Resource": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Resource ID.", - "readOnly": true - }, - "name": { - "type": "string", - "description": "Resource name.", - "readOnly": true - }, - "type": { - "readOnly": true, - "type": "string", - "description": "Resource type." - }, - "location": { - "type": "string", - "description": "Resource location." - }, - "tags": { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "description": "Resource tags." - }, - "systemData": { - "allOf": [ - { - "$ref": "#/definitions/SystemData" - } - ], - "description": "Metadata pertaining to creation and last modification of the resource.", - "readOnly": true - } - }, - "description": "Common resource representation.", - "x-ms-azure-resource": true - }, - "ProxyResource": { - "type": "object", - "x-ms-azure-resource": true, - "description": "An azure resource object", - "properties": { - "id": { - "type": "string", - "readOnly": true, - "description": "Azure resource Id" - }, - "type": { - "type": "string", - "readOnly": true, - "description": "Azure resource type" - }, - "name": { - "type": "string", - "readOnly": true, - "description": "Azure resource name" - }, - "systemData": { - "allOf": [ - { - "$ref": "#/definitions/SystemData" - } - ], - "description": "Metadata pertaining to creation and last modification of the resource.", - "readOnly": true - } - } - }, "EndPoint": { "type": "object", "required": [ @@ -1333,11 +1256,7 @@ "description": "Spacecraft elevation above the horizon at contact end." }, "contactProfile": { - "allOf": [ - { - "$ref": "#/definitions/ResourceReference" - } - ], + "$ref": "#/definitions/ResourceReference", "description": "The reference to the contact profile resource." } }, @@ -1494,11 +1413,7 @@ "properties": { "properties": { "x-ms-client-flatten": true, - "allOf": [ - { - "$ref": "#/definitions/ContactProfilesProperties" - } - ], + "$ref": "#/definitions/ContactProfilesProperties", "description": "Properties of the spacecraft resource." }, "etag": { @@ -1509,7 +1424,7 @@ }, "allOf": [ { - "$ref": "#/definitions/Resource" + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/TrackedResource" } ], "description": "Customer creates a Contact Profile Resource, which will contain all of the configurations required for scheduling a contact." @@ -1636,7 +1551,7 @@ }, "allOf": [ { - "$ref": "#/definitions/ProxyResource" + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" } ], "description": "Customer creates a contact resource for a spacecraft resource." @@ -1699,11 +1614,7 @@ "type": "object", "properties": { "spacecraft": { - "allOf": [ - { - "$ref": "#/definitions/ResourceReference" - } - ], + "$ref": "#/definitions/ResourceReference", "description": "The reference to the spacecraft resource." }, "groundStationName": { @@ -1713,11 +1624,7 @@ }, "properties": { "x-ms-client-flatten": true, - "allOf": [ - { - "$ref": "#/definitions/ContactInstanceProperties" - } - ], + "$ref": "#/definitions/ContactInstanceProperties", "description": "Properties of Contact resource." } }, @@ -1766,11 +1673,7 @@ }, "properties": { "x-ms-client-flatten": true, - "allOf": [ - { - "$ref": "#/definitions/AvailableGroundStationProperties" - } - ], + "$ref": "#/definitions/AvailableGroundStationProperties", "description": "The properties bag for this resource" } }, @@ -1810,54 +1713,6 @@ "Communication" ] }, - "SystemData": { - "description": "Metadata pertaining to creation and last modification of the resource.", - "type": "object", - "readOnly": true, - "properties": { - "createdBy": { - "type": "string", - "description": "The identity that created the resource." - }, - "createdByType": { - "type": "string", - "description": "The type of identity that created the resource.", - "enum": [ - "User", - "Application", - "ManagedIdentity", - "Key" - ], - "x-ms-enum": { - "name": "createdByType", - "modelAsString": true - } - }, - "createdAt": { - "type": "string", - "format": "date-time", - "description": "The timestamp of resource creation (UTC)." - }, - "lastModifiedBy": { - "type": "string", - "description": "The identity that last modified the resource." - }, - "lastModifiedByType": { - "type": "string", - "description": "The type of identity that last modified the resource.", - "enum": [ - "User", - "Application", - "ManagedIdentity", - "Key" - ], - "x-ms-enum": { - "name": "createdByType", - "modelAsString": true - } - } - } - }, "ResourceIdListResult": { "type": "object", "properties": { From 9d61a475d5e45a49dc0115b3ee06cb901bfe79bd Mon Sep 17 00:00:00 2001 From: Devanshu Singh <8132290+thisisdevanshu@users.noreply.github.com> Date: Tue, 16 Nov 2021 22:16:36 -0500 Subject: [PATCH 15/26] 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 --- specification/orbital/resource-manager/readme.go.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/specification/orbital/resource-manager/readme.go.md b/specification/orbital/resource-manager/readme.go.md index 7a6eb638c1ac..0d2ae571be72 100644 --- a/specification/orbital/resource-manager/readme.go.md +++ b/specification/orbital/resource-manager/readme.go.md @@ -5,7 +5,7 @@ These settings apply only when `--go` is specified on the command line. ```yaml $(go) && $(track2) azure-arm: true license-header: MICROSOFT_MIT_NO_VERSION -module-name: sdk/orbital/armorbital +module-name: sdk/resourcemanager/orbital/armorbital module: github.com/Azure/azure-sdk-for-go/$(module-name) output-folder: $(go-sdk-folder)/$(module-name) ``` \ No newline at end of file From de23823fbe62b8612035d5f5ab25af7f534bfb86 Mon Sep 17 00:00:00 2001 From: Devanshu Singh <8132290+thisisdevanshu@users.noreply.github.com> Date: Tue, 16 Nov 2021 22:36:13 -0500 Subject: [PATCH 16/26] 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 --- .../preview/2021-04-04-preview/orbital.json | 6 +----- 1 file changed, 1 insertion(+), 5 deletions(-) diff --git a/specification/orbital/resource-manager/Microsoft.Orbital/preview/2021-04-04-preview/orbital.json b/specification/orbital/resource-manager/Microsoft.Orbital/preview/2021-04-04-preview/orbital.json index 2221222524d4..c8d0a4592c47 100644 --- a/specification/orbital/resource-manager/Microsoft.Orbital/preview/2021-04-04-preview/orbital.json +++ b/specification/orbital/resource-manager/Microsoft.Orbital/preview/2021-04-04-preview/orbital.json @@ -1440,11 +1440,7 @@ ], "properties": { "contactProfile": { - "allOf": [ - { - "$ref": "#/definitions/ResourceReference" - } - ], + "$ref": "#/definitions/ResourceReference", "description": "The reference to the contact profile resource." }, "groundStationName": { From 4c335e3370bc4b49f07725c7c2f09b066e485296 Mon Sep 17 00:00:00 2001 From: Devanshu Singh Date: Fri, 18 Mar 2022 00:56:59 -0400 Subject: [PATCH 17/26] stable API version 2022-03-01 --- .../examples/AvailableContactsList.json | 64 + .../examples/AvailableGroundStationGet.json | 25 + ...ailableGroundStationsByCapabilityList.json | 44 + .../2022-03-01/examples/ContactCreate.json | 81 + .../2022-03-01/examples/ContactDelete.json | 18 + .../2022-03-01/examples/ContactGet.json | 46 + .../examples/ContactProfileCreate.json | 214 ++ .../examples/ContactProfileDelete.json | 17 + .../examples/ContactProfileGet.json | 78 + .../examples/ContactProfileUpdateTag.json | 93 + .../ContactProfilesByResourceGroupList.json | 83 + .../ContactProfilesBySubscriptionList.json | 83 + .../ContactsBySpacecraftNameList.json | 68 + .../examples/OperationResultsGet.json | 30 + .../2022-03-01/examples/OperationsList.json | 22 + .../2022-03-01/examples/SpacecraftCreate.json | 117 + .../2022-03-01/examples/SpacecraftDelete.json | 17 + .../2022-03-01/examples/SpacecraftGet.json | 53 + .../examples/SpacecraftUpdateTags.json | 68 + .../SpacecraftsByResourceGroupList.json | 53 + .../SpacecraftsBySubscriptionList.json | 57 + .../stable/2022-03-01/orbital.json | 2295 +++++++++++++++++ .../orbital/resource-manager/readme.md | 9 + 23 files changed, 3635 insertions(+) create mode 100644 specification/orbital/resource-manager/Microsoft.Orbital/stable/2022-03-01/examples/AvailableContactsList.json create mode 100644 specification/orbital/resource-manager/Microsoft.Orbital/stable/2022-03-01/examples/AvailableGroundStationGet.json create mode 100644 specification/orbital/resource-manager/Microsoft.Orbital/stable/2022-03-01/examples/AvailableGroundStationsByCapabilityList.json create mode 100644 specification/orbital/resource-manager/Microsoft.Orbital/stable/2022-03-01/examples/ContactCreate.json create mode 100644 specification/orbital/resource-manager/Microsoft.Orbital/stable/2022-03-01/examples/ContactDelete.json create mode 100644 specification/orbital/resource-manager/Microsoft.Orbital/stable/2022-03-01/examples/ContactGet.json create mode 100644 specification/orbital/resource-manager/Microsoft.Orbital/stable/2022-03-01/examples/ContactProfileCreate.json create mode 100644 specification/orbital/resource-manager/Microsoft.Orbital/stable/2022-03-01/examples/ContactProfileDelete.json create mode 100644 specification/orbital/resource-manager/Microsoft.Orbital/stable/2022-03-01/examples/ContactProfileGet.json create mode 100644 specification/orbital/resource-manager/Microsoft.Orbital/stable/2022-03-01/examples/ContactProfileUpdateTag.json create mode 100644 specification/orbital/resource-manager/Microsoft.Orbital/stable/2022-03-01/examples/ContactProfilesByResourceGroupList.json create mode 100644 specification/orbital/resource-manager/Microsoft.Orbital/stable/2022-03-01/examples/ContactProfilesBySubscriptionList.json create mode 100644 specification/orbital/resource-manager/Microsoft.Orbital/stable/2022-03-01/examples/ContactsBySpacecraftNameList.json create mode 100644 specification/orbital/resource-manager/Microsoft.Orbital/stable/2022-03-01/examples/OperationResultsGet.json create mode 100644 specification/orbital/resource-manager/Microsoft.Orbital/stable/2022-03-01/examples/OperationsList.json create mode 100644 specification/orbital/resource-manager/Microsoft.Orbital/stable/2022-03-01/examples/SpacecraftCreate.json create mode 100644 specification/orbital/resource-manager/Microsoft.Orbital/stable/2022-03-01/examples/SpacecraftDelete.json create mode 100644 specification/orbital/resource-manager/Microsoft.Orbital/stable/2022-03-01/examples/SpacecraftGet.json create mode 100644 specification/orbital/resource-manager/Microsoft.Orbital/stable/2022-03-01/examples/SpacecraftUpdateTags.json create mode 100644 specification/orbital/resource-manager/Microsoft.Orbital/stable/2022-03-01/examples/SpacecraftsByResourceGroupList.json create mode 100644 specification/orbital/resource-manager/Microsoft.Orbital/stable/2022-03-01/examples/SpacecraftsBySubscriptionList.json create mode 100644 specification/orbital/resource-manager/Microsoft.Orbital/stable/2022-03-01/orbital.json diff --git a/specification/orbital/resource-manager/Microsoft.Orbital/stable/2022-03-01/examples/AvailableContactsList.json b/specification/orbital/resource-manager/Microsoft.Orbital/stable/2022-03-01/examples/AvailableContactsList.json new file mode 100644 index 000000000000..ce2e72075a63 --- /dev/null +++ b/specification/orbital/resource-manager/Microsoft.Orbital/stable/2022-03-01/examples/AvailableContactsList.json @@ -0,0 +1,64 @@ +{ + "parameters": { + "api-version": "2022-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rgName", + "spacecraftName": "AQUA", + "parameters": { + "contactProfile": { + "id": "/subscriptions/subId/resourceGroups/rg/Microsoft.Orbital/contactProfiles/AQUA_DIRECTPLAYBACK_WITH_UPLINK" + }, + "groundStationName": "westus_gs1", + "startTime": "2020-07-16T05:40:21.00Z", + "endTime": "2020-07-17T23:49:40.00Z" + } + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/Microsoft.Orbital/operationResults/4e2ffff7-b331-4fcb-ab11-b5fa49368188?api-version=2022-03-01" + } + }, + "200": { + "body": { + "value": [ + { + "spacecraft": { + "id": "/subscriptions/subId/resourceGroups/rg/Microsoft.Orbital/spacecrafts/AQUA" + }, + "groundStationName": "westus_gs1", + "properties": { + "maximumElevationDegrees": 70.94, + "rxStartTime": "2020-07-16T20:40:21.00Z", + "rxEndTime": "2020-07-16T20:49:40.00Z", + "txStartTime": "2020-07-16T20:40:21.00Z", + "txEndTime": "2020-07-16T20:49:40.00Z", + "startAzimuthDegrees": 148.237, + "endAzimuthDegrees": 353.837, + "startElevationDegrees": 10.0, + "endElevationDegrees": 10.0 + } + }, + { + "spacecraft": { + "id": "/subscriptions/subId/resourceGroups/rg/Microsoft.Orbital/spacecrafts/AQUA" + }, + "groundStationName": "westus_gs1", + "properties": { + "maximumElevationDegrees": 87.153, + "rxStartTime": "2020-07-17T10:13:55.00Z", + "rxEndTime": "2020-07-17T10:23:30.00Z", + "txStartTime": "2020-07-17T10:13:55.00Z", + "txEndTime": "2020-07-17T10:23:30.00Z", + "startAzimuthDegrees": 14.392, + "endAzimuthDegrees": 194.36, + "startElevationDegrees": 10.0, + "endElevationDegrees": 10.0 + } + } + ], + "nextLink": "string" + } + } + } +} diff --git a/specification/orbital/resource-manager/Microsoft.Orbital/stable/2022-03-01/examples/AvailableGroundStationGet.json b/specification/orbital/resource-manager/Microsoft.Orbital/stable/2022-03-01/examples/AvailableGroundStationGet.json new file mode 100644 index 000000000000..885d7465b75a --- /dev/null +++ b/specification/orbital/resource-manager/Microsoft.Orbital/stable/2022-03-01/examples/AvailableGroundStationGet.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2022-03-01", + "subscriptionId": "subid", + "groundStationName": "westus_gs1" + }, + "responses": { + "200": { + "body": { + "name": "westus_gs1", + "location": "westus", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Orbital/availableGroundStations/westus_gs1", + "type": "Microsoft.Orbital/availableGroundStations", + "properties": { + "city": "redmond", + "providerName": "Microsoft", + "longitudeDegrees": 47.674, + "latitudeDegrees": -122.122, + "altitudeMeters": 1500.83, + "releaseMode": "" + } + } + } + } +} diff --git a/specification/orbital/resource-manager/Microsoft.Orbital/stable/2022-03-01/examples/AvailableGroundStationsByCapabilityList.json b/specification/orbital/resource-manager/Microsoft.Orbital/stable/2022-03-01/examples/AvailableGroundStationsByCapabilityList.json new file mode 100644 index 000000000000..1e6b156a0dfe --- /dev/null +++ b/specification/orbital/resource-manager/Microsoft.Orbital/stable/2022-03-01/examples/AvailableGroundStationsByCapabilityList.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "api-version": "2022-03-01", + "subscriptionId": "subId", + "capability": "EarthObservation" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "westus_gs1", + "location": "westus", + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Orbital/availableGroundStations/westus_gs1", + "type": "Microsoft.Orbital/availableGroundStations", + "properties": { + "city": "redmond", + "providerName": "Microsoft", + "longitudeDegrees": 47.674, + "latitudeDegrees": -122.122, + "altitudeMeters": 1500.83, + "releaseMode": "" + } + }, + { + "name": "westus_gs2", + "location": "westus", + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Orbital/availableGroundStations/westus_gs2", + "type": "Microsoft.Orbital/availableGroundStations", + "properties": { + "city": "redmond", + "providerName": "Microsoft", + "longitudeDegrees": 47.674, + "latitudeDegrees": -122.122, + "altitudeMeters": 1500.83, + "releaseMode": "" + } + } + ], + "nextLink": "string" + } + } + } +} diff --git a/specification/orbital/resource-manager/Microsoft.Orbital/stable/2022-03-01/examples/ContactCreate.json b/specification/orbital/resource-manager/Microsoft.Orbital/stable/2022-03-01/examples/ContactCreate.json new file mode 100644 index 000000000000..ff00ed920f06 --- /dev/null +++ b/specification/orbital/resource-manager/Microsoft.Orbital/stable/2022-03-01/examples/ContactCreate.json @@ -0,0 +1,81 @@ +{ + "parameters": { + "api-version": "2022-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "contactName": "contact1", + "spacecraftName": "AQUA", + "parameters": { + "properties": { + "reservationStartTime": "2020-07-16T20:35:00.00Z", + "reservationEndTime": "2020-07-16T20:55:00.00Z", + "groundStationName": "westus_gs1", + "contactProfile": { + "id": "/subscriptions/subId/resourceGroups/rg/Microsoft.Orbital/contactProfiles/AQUA_DIRECTPLAYBACK_WITH_UPLINK" + } + } + } + }, + "responses": { + "200": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Microsoft.Orbital/operationResults/4e2ffff7-b331-4fcb-ab11-b5fa49368188?api-version=2022-03-01" + }, + "body": { + "name": "contact1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Orbital/spacecrafts/AQUA/contacts/contact1", + "properties": { + "status": "scheduled", + "provisioningState": "Updating", + "reservationStartTime": "2020-07-16T20:35:00.00Z", + "reservationEndTime": "2020-07-16T20:55:00.00Z", + "rxStartTime": "2020-07-16T20:40:21.00Z", + "rxEndTime": "2020-07-16T20:49:40.00Z", + "txStartTime": "2020-07-16T20:40:21.00Z", + "txEndTime": "2020-07-16T20:49:40.00Z", + "errorMessage": "", + "maximumElevationDegrees": 70.94, + "startAzimuthDegrees": 148.237, + "endAzimuthDegrees": 353.837, + "startElevationDegrees": 10.0, + "endElevationDegrees": 10.0, + "groundStationName": "westus_gs1", + "contactProfile": { + "id": "/subscriptions/subId/resourceGroups/rg/Microsoft.Orbital/contactProfiles/AQUA_DIRECTPLAYBACK_WITH_UPLINK" + } + }, + "type": "Microsoft.Orbital/contacts" + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Microsoft.Orbital/operationResults/4e2ffff7-b331-4fcb-ab11-b5fa49368188?api-version=2022-03-01" + }, + "body": { + "name": "contact1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Orbital/spacecrafts/AQUA/contacts/contact1", + "properties": { + "status": "scheduled", + "provisioningState": "Creating", + "reservationStartTime": "2020-07-16T20:35:00.00Z", + "reservationEndTime": "2020-07-16T20:55:00.00Z", + "rxStartTime": "2020-07-16T20:40:21.00Z", + "rxEndTime": "2020-07-16T20:49:40.00Z", + "txStartTime": "2020-07-16T20:40:21.00Z", + "txEndTime": "2020-07-16T20:49:40.00Z", + "errorMessage": "", + "maximumElevationDegrees": 70.94, + "startAzimuthDegrees": 148.237, + "endAzimuthDegrees": 353.837, + "startElevationDegrees": 10.0, + "endElevationDegrees": 10.0, + "groundStationName": "westus_gs1", + "contactProfile": { + "id": "/subscriptions/subId/resourceGroups/rg/Microsoft.Orbital/contactProfiles/AQUA_DIRECTPLAYBACK_WITH_UPLINK" + } + }, + "type": "Microsoft.Orbital/contacts" + } + } + } +} diff --git a/specification/orbital/resource-manager/Microsoft.Orbital/stable/2022-03-01/examples/ContactDelete.json b/specification/orbital/resource-manager/Microsoft.Orbital/stable/2022-03-01/examples/ContactDelete.json new file mode 100644 index 000000000000..7c62b7b48ffa --- /dev/null +++ b/specification/orbital/resource-manager/Microsoft.Orbital/stable/2022-03-01/examples/ContactDelete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2022-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "spacecraftName": "AQUA", + "contactName": "contact1" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/Microsoft.Orbital/operationResults/4e2ffff7-b331-4fcb-ab11-b5fa49368188?api-version=2022-03-01" + } + }, + "204": {} + } +} diff --git a/specification/orbital/resource-manager/Microsoft.Orbital/stable/2022-03-01/examples/ContactGet.json b/specification/orbital/resource-manager/Microsoft.Orbital/stable/2022-03-01/examples/ContactGet.json new file mode 100644 index 000000000000..10fbbeebcbf1 --- /dev/null +++ b/specification/orbital/resource-manager/Microsoft.Orbital/stable/2022-03-01/examples/ContactGet.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "api-version": "2022-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "spacecraftName": "AQUA", + "contactName": "contact1" + }, + "responses": { + "200": { + "body": { + "name": "contact1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Orbital/spacecrafts/AQUA/contacts/contact1", + "properties": { + "provisioningState": "Succeeded", + "status": "scheduled", + "reservationStartTime": "2020-07-16T20:35:00.00Z", + "reservationEndTime": "2020-07-16T20:55:00.00Z", + "rxStartTime": "2020-07-16T20:40:21.00Z", + "rxEndTime": "2020-07-16T20:49:40.00Z", + "txStartTime": "2020-07-16T20:40:21.00Z", + "txEndTime": "2020-07-16T20:49:40.00Z", + "errorMessage": "", + "maximumElevationDegrees": 70.94, + "startAzimuthDegrees": 148.237, + "endAzimuthDegrees": 353.837, + "startElevationDegrees": 10.0, + "endElevationDegrees": 10.0, + "groundStationName": "westus_gs1", + "contactProfile": { + "id": "/subscriptions/subId/resourceGroups/rg/Microsoft.Orbital/contactProfiles/AQUA_DIRECTPLAYBACK_WITH_UPLINK" + }, + "antennaConfiguration": { + "destinationIp": "172.16.0.254", + "sourceIps": [ + "172.16.0.1", + "172.16.0.2", + "172.16.0.254" + ] + } + }, + "type": "Microsoft.Orbital/contacts" + } + } + } +} diff --git a/specification/orbital/resource-manager/Microsoft.Orbital/stable/2022-03-01/examples/ContactProfileCreate.json b/specification/orbital/resource-manager/Microsoft.Orbital/stable/2022-03-01/examples/ContactProfileCreate.json new file mode 100644 index 000000000000..393f8b95421e --- /dev/null +++ b/specification/orbital/resource-manager/Microsoft.Orbital/stable/2022-03-01/examples/ContactProfileCreate.json @@ -0,0 +1,214 @@ +{ + "parameters": { + "api-version": "2022-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "contactProfileName": "AQUA_DIRECTPLAYBACK_WITH_UPLINK", + "parameters": { + "location": "westus", + "properties": { + "minimumViableContactDuration": "PT1M", + "minimumElevationDegrees": 10, + "autoTrackingConfiguration": "xBand", + "eventHubUri": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.EventHub/namespaces/orbitalppewestus2-ns/eventhubs/telemetry-hub/", + "networkConfiguration": { + "subnetId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnetName" + }, + "links": [ + { + "name": "RHCP_UL", + "polarization": "RHCP", + "direction": "uplink", + "gainOverTemperature": 0, + "eirpdBW": 45, + "channels": [ + { + "name": "channel1", + "centerFrequencyMHz": 2106.4063, + "bandwidthMHz": 0.036, + "endPoint": { + "ipAddress": "10.0.1.0", + "endPointName": "AQUA_command", + "port": "4000", + "protocol": "TCP" + }, + "modulationConfiguration": "AQUA_UPLINK_BPSK", + "demodulationConfiguration": "na", + "encodingConfiguration": "AQUA_CMD_CCSDS", + "decodingConfiguration": "na" + } + ] + }, + { + "name": "RHCP_DL", + "polarization": "RHCP", + "direction": "downlink", + "gainOverTemperature": 25, + "eirpdBW": 0, + "channels": [ + { + "name": "channel1", + "centerFrequencyMHz": 8160, + "bandwidthMHz": 150, + "endPoint": { + "ipAddress": "10.0.2.0", + "endPointName": "AQUA_directplayback", + "port": "4000", + "protocol": "TCP" + }, + "modulationConfiguration": "na", + "demodulationConfiguration": "AQUA_DOWNLINK_QPSK", + "encodingConfiguration": "na", + "decodingConfiguration": "AQUA_DIRECTPLAYBACK_CCSDS" + } + ] + } + ] + } + } + }, + "responses": { + "200": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Microsoft.Orbital/operationResults/4e2ffff7-b331-4fcb-ab11-b5fa49368188?api-version=2022-03-01" + }, + "body": { + "name": "AQUA_DIRECTPLAYBACK_WITH_UPLINK", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Orbital/contactProfiles/AQUA_DIRECTPLAYBACK_WITH_UPLINK", + "location": "westus", + "properties": { + "provisioningState": "Updating", + "minimumViableContactDuration": "PT1M", + "minimumElevationDegrees": 10, + "autoTrackingConfiguration": "xBand", + "eventHubUri": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.EventHub/namespaces/orbitalppewestus2-ns/eventhubs/telemetry-hub/", + "networkConfiguration": { + "subnetId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnetName" + }, + "links": [ + { + "name": "Link1", + "polarization": "RHCP", + "direction": "uplink", + "gainOverTemperature": 0, + "eirpdBW": 45, + "channels": [ + { + "name": "channel1", + "centerFrequencyMHz": 2106.4063, + "bandwidthMHz": 0.036, + "endPoint": { + "ipAddress": "10.0.1.0", + "endPointName": "AQUA_command", + "port": "4000", + "protocol": "TCP" + }, + "modulationConfiguration": "AQUA_UPLINK_BPSK", + "demodulationConfiguration": "na", + "encodingConfiguration": "AQUA_CMD_CCSDS", + "decodingConfiguration": "na" + } + ] + }, + { + "name": "Link2", + "polarization": "RHCP", + "direction": "downlink", + "gainOverTemperature": 25, + "eirpdBW": 0, + "channels": [ + { + "name": "channel2", + "centerFrequencyMHz": 8160, + "bandwidthMHz": 150, + "endPoint": { + "ipAddress": "10.0.2.0", + "endPointName": "AQUA_directplayback", + "port": "4000", + "protocol": "TCP" + }, + "modulationConfiguration": "na", + "demodulationConfiguration": "AQUA_DOWNLINK_QPSK", + "encodingConfiguration": "na", + "decodingConfiguration": "AQUA_DIRECTPLAYBACK_CCSDS" + } + ] + } + ] + }, + "type": "Microsoft.Orbital/contactProfiles" + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Microsoft.Orbital/operationResults/4e2ffff7-b331-4fcb-ab11-b5fa49368188?api-version=2022-03-01" + }, + "body": { + "name": "contactProfile1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Orbital/contactProfiles/contactProfile1", + "location": "westus", + "properties": { + "provisioningState": "Creating", + "minimumViableContactDuration": "PT1M", + "minimumElevationDegrees": 10, + "autoTrackingConfiguration": "xBand", + "eventHubUri": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.EventHub/namespaces/orbitalppewestus2-ns/eventhubs/telemetry-hub/", + "networkConfiguration": { + "subnetId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnetName" + }, + "links": [ + { + "name": "Link1", + "polarization": "RHCP", + "direction": "uplink", + "gainOverTemperature": 0, + "eirpdBW": 45, + "channels": [ + { + "name": "channel1", + "centerFrequencyMHz": 2106.4063, + "bandwidthMHz": 0.036, + "endPoint": { + "ipAddress": "10.0.1.0", + "endPointName": "AQUA_command", + "port": "4000", + "protocol": "TCP" + }, + "modulationConfiguration": "AQUA_UPLINK_BPSK", + "demodulationConfiguration": "na", + "encodingConfiguration": "AQUA_CMD_CCSDS", + "decodingConfiguration": "na" + } + ] + }, + { + "name": "Link2", + "polarization": "RHCP", + "direction": "downlink", + "gainOverTemperature": 25, + "eirpdBW": 0, + "channels": [ + { + "name": "channel1", + "centerFrequencyMHz": 8160, + "bandwidthMHz": 150, + "endPoint": { + "ipAddress": "10.0.2.0", + "endPointName": "AQUA_directplayback", + "port": "4000", + "protocol": "TCP" + }, + "modulationConfiguration": "na", + "demodulationConfiguration": "AQUA_DOWNLINK_QPSK", + "encodingConfiguration": "na", + "decodingConfiguration": "AQUA_DIRECTPLAYBACK_CCSDS" + } + ] + } + ] + }, + "type": "Microsoft.Orbital/contactProfiles" + } + } + } +} diff --git a/specification/orbital/resource-manager/Microsoft.Orbital/stable/2022-03-01/examples/ContactProfileDelete.json b/specification/orbital/resource-manager/Microsoft.Orbital/stable/2022-03-01/examples/ContactProfileDelete.json new file mode 100644 index 000000000000..fdd6a83719a7 --- /dev/null +++ b/specification/orbital/resource-manager/Microsoft.Orbital/stable/2022-03-01/examples/ContactProfileDelete.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2022-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "contactProfileName": "AQUA_DIRECTPLAYBACK_WITH_UPLINK" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/Microsoft.Orbital/operationResults/4e2ffff7-b331-4fcb-ab11-b5fa49368188?api-version=2022-03-01" + } + }, + "204": {} + } +} diff --git a/specification/orbital/resource-manager/Microsoft.Orbital/stable/2022-03-01/examples/ContactProfileGet.json b/specification/orbital/resource-manager/Microsoft.Orbital/stable/2022-03-01/examples/ContactProfileGet.json new file mode 100644 index 000000000000..782b4010d07d --- /dev/null +++ b/specification/orbital/resource-manager/Microsoft.Orbital/stable/2022-03-01/examples/ContactProfileGet.json @@ -0,0 +1,78 @@ +{ + "parameters": { + "api-version": "2022-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "contactProfileName": "AQUA_DIRECTPLAYBACK_WITH_UPLINK" + }, + "responses": { + "200": { + "body": { + "name": "AQUA_DIRECTPLAYBACK_WITH_UPLINK", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Orbital/contactProfiles/AQUA_DIRECTPLAYBACK_WITH_UPLINK", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "minimumViableContactDuration": "PT1M", + "minimumElevationDegrees": 10, + "autoTrackingConfiguration": "xBand", + "eventHubUri": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.EventHub/namespaces/orbitalppewestus2-ns/eventhubs/telemetry-hub/", + "networkConfiguration": { + "subnetId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnetName" + }, + "links": [ + { + "name": "RHCP_UL", + "polarization": "RHCP", + "direction": "uplink", + "gainOverTemperature": 0, + "eirpdBW": 45, + "channels": [ + { + "name": "channel1", + "centerFrequencyMHz": 2106.4063, + "bandwidthMHz": 0.036, + "endPoint": { + "ipAddress": "10.0.1.0", + "endPointName": "AQUA_command", + "port": "4000", + "protocol": "TCP" + }, + "modulationConfiguration": "AQUA_UPLINK_BPSK", + "demodulationConfiguration": "na", + "encodingConfiguration": "AQUA_CMD_CCSDS", + "decodingConfiguration": "na" + } + ] + }, + { + "name": "RHCP_DL", + "polarization": "RHCP", + "direction": "downlink", + "gainOverTemperature": 25, + "eirpdBW": 0, + "channels": [ + { + "name": "channel2", + "centerFrequencyMHz": 8160, + "bandwidthMHz": 150, + "endPoint": { + "ipAddress": "10.0.2.0", + "endPointName": "AQUA_directplayback", + "port": "4000", + "protocol": "TCP" + }, + "modulationConfiguration": "na", + "demodulationConfiguration": "AQUA_DOWNLINK_QPSK", + "encodingConfiguration": "na", + "decodingConfiguration": "AQUA_DIRECTPLAYBACK_CCSDS" + } + ] + } + ] + }, + "type": "Microsoft.Orbital/contactProfiles" + } + } + } +} diff --git a/specification/orbital/resource-manager/Microsoft.Orbital/stable/2022-03-01/examples/ContactProfileUpdateTag.json b/specification/orbital/resource-manager/Microsoft.Orbital/stable/2022-03-01/examples/ContactProfileUpdateTag.json new file mode 100644 index 000000000000..fb9ab4da785d --- /dev/null +++ b/specification/orbital/resource-manager/Microsoft.Orbital/stable/2022-03-01/examples/ContactProfileUpdateTag.json @@ -0,0 +1,93 @@ +{ + "parameters": { + "api-version": "2022-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "contactProfileName": "AQUA_DIRECTPLAYBACK_WITH_UPLINK", + "parameters": { + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + }, + "responses": { + "200": { + "body": { + "name": "AQUA_DIRECTPLAYBACK_WITH_UPLINK", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Orbital/contactProfiles/AQUA_DIRECTPLAYBACK_WITH_UPLINK", + "location": "westus", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "provisioningState": "Succeeded", + "minimumViableContactDuration": "PT1M", + "minimumElevationDegrees": 10, + "autoTrackingConfiguration": "xBand", + "eventHubUri": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.EventHub/namespaces/orbitalppewestus2-ns/eventhubs/telemetry-hub/", + "networkConfiguration": { + "subnetId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnetName" + }, + "links": [ + { + "name": "RHCP_UL", + "polarization": "RHCP", + "direction": "uplink", + "gainOverTemperature": 0, + "eirpdBW": 45, + "channels": [ + { + "name": "channel1", + "centerFrequencyMHz": 2106.4063, + "bandwidthMHz": 0.036, + "endPoint": { + "ipAddress": "10.0.1.0", + "endPointName": "AQUA_command", + "port": "4000", + "protocol": "TCP" + }, + "modulationConfiguration": "AQUA_UPLINK_BPSK", + "demodulationConfiguration": "na", + "encodingConfiguration": "AQUA_CMD_CCSDS", + "decodingConfiguration": "na" + } + ] + }, + { + "name": "RHCP_DL", + "polarization": "RHCP", + "direction": "downlink", + "gainOverTemperature": 25, + "eirpdBW": 0, + "channels": [ + { + "name": "channel1", + "centerFrequencyMHz": 8160, + "bandwidthMHz": 150, + "endPoint": { + "ipAddress": "10.0.2.0", + "endPointName": "AQUA_directplayback", + "port": "4000", + "protocol": "TCP" + }, + "modulationConfiguration": "na", + "demodulationConfiguration": "AQUA_DOWNLINK_QPSK", + "encodingConfiguration": "na", + "decodingConfiguration": "AQUA_DIRECTPLAYBACK_CCSDS" + } + ] + } + ] + }, + "type": "Microsoft.Orbital/contactProfiles" + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/Microsoft.Orbital/operationResults/4e2ffff7-b331-4fcb-ab11-b5fa49368188?api-version=2022-03-01" + } + } + } +} diff --git a/specification/orbital/resource-manager/Microsoft.Orbital/stable/2022-03-01/examples/ContactProfilesByResourceGroupList.json b/specification/orbital/resource-manager/Microsoft.Orbital/stable/2022-03-01/examples/ContactProfilesByResourceGroupList.json new file mode 100644 index 000000000000..d3f38cf15523 --- /dev/null +++ b/specification/orbital/resource-manager/Microsoft.Orbital/stable/2022-03-01/examples/ContactProfilesByResourceGroupList.json @@ -0,0 +1,83 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "api-version": "2022-03-01", + "$skipToken": "opaqueString" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "AQUA_DIRECTPLAYBACK_WITH_UPLINK", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Orbital/contactProfiles/AQUA_DIRECTPLAYBACK_WITH_UPLINK", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "minimumViableContactDuration": "PT1M", + "minimumElevationDegrees": 10, + "autoTrackingConfiguration": "xBand", + "eventHubUri": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.EventHub/namespaces/orbitalppewestus2-ns/eventhubs/telemetry-hub/", + "networkConfiguration": { + "subnetId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnetName" + }, + "links": [ + { + "name": "RHCP_UL", + "polarization": "RHCP", + "direction": "uplink", + "gainOverTemperature": 0, + "eirpdBW": 45, + "channels": [ + { + "name": "channel1", + "centerFrequencyMHz": 2106.4063, + "bandwidthMHz": 0.036, + "endPoint": { + "ipAddress": "10.0.1.0", + "endPointName": "AQUA_command", + "port": "4000", + "protocol": "TCP" + }, + "modulationConfiguration": "AQUA_UPLINK_BPSK", + "demodulationConfiguration": "na", + "encodingConfiguration": "AQUA_CMD_CCSDS", + "decodingConfiguration": "na" + } + ] + }, + { + "name": "RHCP_DL", + "polarization": "RHCP", + "direction": "downlink", + "gainOverTemperature": 25, + "eirpdBW": 0, + "channels": [ + { + "name": "channel1", + "centerFrequencyMHz": 8160, + "bandwidthMHz": 150, + "endPoint": { + "ipAddress": "10.0.2.0", + "endPointName": "AQUA_directplayback", + "port": "4000", + "protocol": "TCP" + }, + "modulationConfiguration": "na", + "demodulationConfiguration": "AQUA_DOWNLINK_QPSK", + "encodingConfiguration": "na", + "decodingConfiguration": "AQUA_DIRECTPLAYBACK_CCSDS" + } + ] + } + ] + }, + "type": "Microsoft.Orbital/contactProfiles" + } + ], + "nextLink": "string" + } + } + } +} diff --git a/specification/orbital/resource-manager/Microsoft.Orbital/stable/2022-03-01/examples/ContactProfilesBySubscriptionList.json b/specification/orbital/resource-manager/Microsoft.Orbital/stable/2022-03-01/examples/ContactProfilesBySubscriptionList.json new file mode 100644 index 000000000000..e3137af3108f --- /dev/null +++ b/specification/orbital/resource-manager/Microsoft.Orbital/stable/2022-03-01/examples/ContactProfilesBySubscriptionList.json @@ -0,0 +1,83 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "api-version": "2022-03-01", + "$skipToken": "opaqueString" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "AQUA_DIRECTPLAYBACK_WITH_UPLINK", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Orbital/contactProfiles/AQUA_DIRECTPLAYBACK_WITH_UPLINK", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "minimumViableContactDuration": "PT1M", + "minimumElevationDegrees": 10, + "autoTrackingConfiguration": "xBand", + "eventHubUri": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.EventHub/namespaces/orbitalppewestus2-ns/eventhubs/telemetry-hub/", + "networkConfiguration": { + "subnetId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnetName" + }, + "links": [ + { + "name": "RHCP_UL", + "polarization": "RHCP", + "direction": "uplink", + "gainOverTemperature": 0, + "eirpdBW": 45, + "channels": [ + { + "name": "channel1", + "centerFrequencyMHz": 2106.4063, + "bandwidthMHz": 0.036, + "endPoint": { + "ipAddress": "10.0.1.0", + "endPointName": "AQUA_command", + "port": "4000", + "protocol": "TCP" + }, + "modulationConfiguration": "AQUA_UPLINK_BPSK", + "demodulationConfiguration": "na", + "encodingConfiguration": "AQUA_CMD_CCSDS", + "decodingConfiguration": "na" + } + ] + }, + { + "name": "RHCP_DL", + "polarization": "RHCP", + "direction": "downlink", + "gainOverTemperature": 25, + "eirpdBW": 0, + "channels": [ + { + "name": "channel2", + "centerFrequencyMHz": 8160, + "bandwidthMHz": 150, + "endPoint": { + "ipAddress": "10.0.2.0", + "endPointName": "AQUA_directplayback", + "port": "4000", + "protocol": "TCP" + }, + "modulationConfiguration": "na", + "demodulationConfiguration": "AQUA_DOWNLINK_QPSK", + "encodingConfiguration": "na", + "decodingConfiguration": "AQUA_DIRECTPLAYBACK_CCSDS" + } + ] + } + ] + }, + "type": "Microsoft.Orbital/contactProfiles" + } + ], + "nextLink": "string" + } + } + } +} diff --git a/specification/orbital/resource-manager/Microsoft.Orbital/stable/2022-03-01/examples/ContactsBySpacecraftNameList.json b/specification/orbital/resource-manager/Microsoft.Orbital/stable/2022-03-01/examples/ContactsBySpacecraftNameList.json new file mode 100644 index 000000000000..2d519bab0397 --- /dev/null +++ b/specification/orbital/resource-manager/Microsoft.Orbital/stable/2022-03-01/examples/ContactsBySpacecraftNameList.json @@ -0,0 +1,68 @@ +{ + "parameters": { + "api-version": "2022-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "spacecraftName": "AQUA", + "$skipToken": "opaqueString" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "contact1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Orbital/spacecrafts/AQUA/contacts/contact1", + "properties": { + "provisioningState": "Succeeded", + "status": "scheduled", + "reservationStartTime": "2020-07-16T20:35:00.00Z", + "reservationEndTime": "2020-07-16T20:55:00.00Z", + "rxStartTime": "2020-07-16T20:40:21.00Z", + "rxEndTime": "2020-07-16T20:49:40.00Z", + "txStartTime": "2020-07-16T20:40:21.00Z", + "txEndTime": "2020-07-16T20:49:40.00Z", + "errorMessage": "", + "maximumElevationDegrees": 70.94, + "startAzimuthDegrees": 148.237, + "endAzimuthDegrees": 353.837, + "startElevationDegrees": 10.0, + "endElevationDegrees": 10.0, + "groundStationName": "westus_gs1", + "contactProfile": { + "id": "/subscriptions/subId/resourceGroups/rg/Microsoft.Orbital/contactProfiles/AQUA_DIRECTPLAYBACK_WITH_UPLINK" + } + }, + "type": "Microsoft.Orbital/contacts" + }, + { + "name": "contact2", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Orbital/spacecrafts/AQUA/contacts/contact2", + "properties": { + "provisioningState": "Succeeded", + "status": "scheduled", + "reservationStartTime": "2020-07-23T20:35:00.00Z", + "reservationEndTime": "2020-07-23T20:55:00.00Z", + "rxStartTime": "2020-07-23T20:40:21.00Z", + "rxEndTime": "2020-07-23T20:49:40.00Z", + "txStartTime": "2020-07-23T20:40:21.00Z", + "txEndTime": "2020-07-23T20:49:40.00Z", + "errorMessage": "", + "maximumElevationDegrees": 70.94, + "startAzimuthDegrees": 148.237, + "endAzimuthDegrees": 353.837, + "startElevationDegrees": 10.0, + "endElevationDegrees": 10.0, + "groundStationName": "westus_gs1", + "contactProfile": { + "id": "/subscriptions/subId/resourceGroups/rg/Microsoft.Orbital/contactProfiles/AQUA_DIRECTPLAYBACK_WITH_UPLINK" + } + }, + "type": "Microsoft.Orbital/contacts" + } + ], + "nextLink": "string" + } + } + } +} diff --git a/specification/orbital/resource-manager/Microsoft.Orbital/stable/2022-03-01/examples/OperationResultsGet.json b/specification/orbital/resource-manager/Microsoft.Orbital/stable/2022-03-01/examples/OperationResultsGet.json new file mode 100644 index 000000000000..47ee507d1be6 --- /dev/null +++ b/specification/orbital/resource-manager/Microsoft.Orbital/stable/2022-03-01/examples/OperationResultsGet.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-123456789098", + "location": "westus", + "operationId": "30972f1b-b61d-4fd8-bd34-3dcfa24670f3", + "api-version": "2022-03-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-123456789098/providers/Microsoft.Orbital/locations/westus/operationresults/30972f1b-b61d-4fd8-bd34-3dcfa24670f3", + "name": "30972f1b-b61d-4fd8-bd34-3dcfa24670f3", + "status": "Failed", + "startTime": "2020-10-26T13:45:39.6554616Z", + "endTime": "2020-10-26T13:45:42.7025301Z", + "percentComplete": 1.0, + "properties": {}, + "error": { + "code": "ReadOnlyPropertyError", + "message": "Cannot write to property, AuthorizationStatus, as it is read-only." + } + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/Microsoft.Orbital/operationResults/4e2ffff7-b331-4fcb-ab11-b5fa49368188?api-version=2022-03-01" + } + } + } +} diff --git a/specification/orbital/resource-manager/Microsoft.Orbital/stable/2022-03-01/examples/OperationsList.json b/specification/orbital/resource-manager/Microsoft.Orbital/stable/2022-03-01/examples/OperationsList.json new file mode 100644 index 000000000000..b0b158e7f94f --- /dev/null +++ b/specification/orbital/resource-manager/Microsoft.Orbital/stable/2022-03-01/examples/OperationsList.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2022-03-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.Orbital/spacecrafts/write", + "display": { + "provider": "Microsoft Orbital", + "resource": "Spacecraft", + "operation": "Create/Update a spacecraft", + "description": "Creates or Update a spacecraft" + } + } + ] + } + } + } +} diff --git a/specification/orbital/resource-manager/Microsoft.Orbital/stable/2022-03-01/examples/SpacecraftCreate.json b/specification/orbital/resource-manager/Microsoft.Orbital/stable/2022-03-01/examples/SpacecraftCreate.json new file mode 100644 index 000000000000..b1b2ef92d9be --- /dev/null +++ b/specification/orbital/resource-manager/Microsoft.Orbital/stable/2022-03-01/examples/SpacecraftCreate.json @@ -0,0 +1,117 @@ +{ + "parameters": { + "api-version": "2022-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "spacecraftName": "AQUA", + "parameters": { + "location": "westus", + "properties": { + "noradId": "27424", + "titleLine": "(AQUA)", + "tleLine1": "1 27424U 02022A 20195.59202355 .00000039 00000-0 18634-4 0 9991", + "tleLine2": "2 27424 98.2098 135.8486 0000176 28.4050 144.5909 14.57108832967671", + "links": [ + { + "name": "S_RHCP_UL", + "centerFrequencyMHz": 2106.4063, + "bandwidthMHz": 0.036, + "direction": "uplink", + "polarization": "RHCP" + }, + { + "name": "X_RHCP_DL", + "centerFrequencyMHz": 8125, + "bandwidthMHz": 150, + "direction": "downlink", + "polarization": "RHCP" + } + ] + } + } + }, + "responses": { + "200": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Microsoft.Orbital/operationResults/4e2ffff7-b331-4fcb-ab11-b5fa49368188?api-version=2022-03-01" + }, + "body": { + "name": "AQUA", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Orbital/spacecrafts/AQUA", + "location": "westus", + "properties": { + "provisioningState": "Updating", + "noradId": "27424", + "titleLine": "AQUA", + "tleLine1": "1 27424U 02022A 20195.59202355 .00000039 00000-0 18634-4 0 9991", + "tleLine2": "2 27424 98.2098 135.8486 0000176 28.4050 144.5909 14.57108832967671", + "links": [ + { + "name": "S_RHCP_UL", + "centerFrequencyMHz": 2106.4063, + "bandwidthMHz": 0.036, + "direction": "uplink", + "polarization": "RHCP", + "authorizations": [ + { + "groundStation": "Microsoft_Quincy", + "expirationDate": "2020-07-16" + } + ] + }, + { + "name": "X_RHCP_DL", + "centerFrequencyMHz": 8125, + "bandwidthMHz": 150, + "direction": "downlink", + "polarization": "RHCP", + "authorizations": [ + { + "groundStation": "Microsoft_Gavle", + "expirationDate": "2020-07-16" + } + ] + } + ] + }, + "type": "Microsoft.Orbital/spacecrafts" + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Microsoft.Orbital/operationResults/4e2ffff7-b331-4fcb-ab11-b5fa49368188?api-version=2022-03-01" + }, + "body": { + "name": "AQUA", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Orbital/spacecrafts/AQUA", + "location": "westus", + "properties": { + "provisioningState": "Creating", + "noradId": "27424", + "titleLine": "AQUA", + "tleLine1": "1 27424U 02022A 20195.59202355 .00000039 00000-0 18634-4 0 9991", + "tleLine2": "2 27424 98.2098 135.8486 0000176 28.4050 144.5909 14.57108832967671", + "links": [ + { + "name": "S_RHCP_UL", + "centerFrequencyMHz": 2106.4063, + "bandwidthMHz": 0.036, + "direction": "uplink", + "polarization": "RHCP", + "authorizations": [] + }, + { + "name": "XRHCP_DL", + "centerFrequencyMHz": 8125, + "bandwidthMHz": 150, + "direction": "downlink", + "polarization": "RHCP", + "authorizations": [] + } + ] + }, + "type": "Microsoft.Orbital/spacecrafts" + } + } + } +} diff --git a/specification/orbital/resource-manager/Microsoft.Orbital/stable/2022-03-01/examples/SpacecraftDelete.json b/specification/orbital/resource-manager/Microsoft.Orbital/stable/2022-03-01/examples/SpacecraftDelete.json new file mode 100644 index 000000000000..963d900b3528 --- /dev/null +++ b/specification/orbital/resource-manager/Microsoft.Orbital/stable/2022-03-01/examples/SpacecraftDelete.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2022-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "spacecraftName": "AQUA" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/Microsoft.Orbital/operationResults/4e2ffff7-b331-4fcb-ab11-b5fa49368188?api-version=2022-03-01" + } + }, + "204": {} + } +} diff --git a/specification/orbital/resource-manager/Microsoft.Orbital/stable/2022-03-01/examples/SpacecraftGet.json b/specification/orbital/resource-manager/Microsoft.Orbital/stable/2022-03-01/examples/SpacecraftGet.json new file mode 100644 index 000000000000..1ad3ebc98a4d --- /dev/null +++ b/specification/orbital/resource-manager/Microsoft.Orbital/stable/2022-03-01/examples/SpacecraftGet.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "api-version": "2022-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "spacecraftName": "AQUA" + }, + "responses": { + "200": { + "body": { + "name": "AQUA", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Orbital/spacecrafts/AQUA", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "noradId": "27424", + "titleLine": "AQUA", + "tleLine1": "1 27424U 02022A 20195.59202355 .00000039 00000-0 18634-4 0 9991", + "tleLine2": "2 27424 98.2098 135.8486 0000176 28.4050 144.5909 14.57108832967671", + "links": [ + { + "name": "S_RHCP_UL", + "centerFrequencyMHz": 2106.4063, + "bandwidthMHz": 0.036, + "direction": "uplink", + "polarization": "RHCP", + "authorizations": [ + { + "groundStation": "Microsoft_Quincy", + "expirationDate": "2020-07-16" + } + ] + }, + { + "name": "X_RHCP_DL", + "centerFrequencyMHz": 8125, + "bandwidthMHz": 150, + "direction": "downlink", + "polarization": "RHCP", + "authorizations": [ + { + "groundStation": "Microsoft_Gavle", + "expirationDate": "2020-07-16" + } + ] + } + ] + }, + "type": "Microsoft.Orbital/spacecrafts" + } + } + } +} diff --git a/specification/orbital/resource-manager/Microsoft.Orbital/stable/2022-03-01/examples/SpacecraftUpdateTags.json b/specification/orbital/resource-manager/Microsoft.Orbital/stable/2022-03-01/examples/SpacecraftUpdateTags.json new file mode 100644 index 000000000000..3559819779e7 --- /dev/null +++ b/specification/orbital/resource-manager/Microsoft.Orbital/stable/2022-03-01/examples/SpacecraftUpdateTags.json @@ -0,0 +1,68 @@ +{ + "parameters": { + "api-version": "2022-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "spacecraftName": "AQUA", + "parameters": { + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/Microsoft.Orbital/operationResults/4e2ffff7-b331-4fcb-ab11-b5fa49368188?api-version=2022-03-01" + } + }, + "200": { + "body": { + "name": "AQUA", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Orbital/spacecrafts/AQUA", + "location": "westus", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "provisioningState": "Succeeded", + "noradId": "27424", + "titleLine": "AQUA", + "tleLine1": "1 27424U 02022A 20195.59202355 .00000039 00000-0 18634-4 0 9991", + "tleLine2": "2 27424 98.2098 135.8486 0000176 28.4050 144.5909 14.57108832967671", + "links": [ + { + "name": "S_RHCP_UL", + "centerFrequencyMHz": 2106.4063, + "bandwidthMHz": 0.036, + "direction": "uplink", + "polarization": "RHCP", + "authorizations": [ + { + "groundStation": "Microsoft_Gavle", + "expirationDate": "2020-07-16" + } + ] + }, + { + "name": "XRHCP_DL", + "centerFrequencyMHz": 8125, + "bandwidthMHz": 150, + "direction": "downlink", + "polarization": "RHCP", + "authorizations": [ + { + "groundStation": "Microsoft_Gavle", + "expirationDate": "2020-07-16" + } + ] + } + ] + }, + "type": "Microsoft.Orbital/spacecrafts" + } + } + } +} diff --git a/specification/orbital/resource-manager/Microsoft.Orbital/stable/2022-03-01/examples/SpacecraftsByResourceGroupList.json b/specification/orbital/resource-manager/Microsoft.Orbital/stable/2022-03-01/examples/SpacecraftsByResourceGroupList.json new file mode 100644 index 000000000000..e4c2c6d395b0 --- /dev/null +++ b/specification/orbital/resource-manager/Microsoft.Orbital/stable/2022-03-01/examples/SpacecraftsByResourceGroupList.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "api-version": "2022-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "$skipToken": "opaqueString" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "AQUA", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Orbital/spacecrafts/AQUA", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "noradId": "27424", + "titleLine": "AQUA", + "tleLine1": "1 27424U 02022A 20195.59202355 .00000039 00000-0 18634-4 0 9991", + "tleLine2": "2 27424 98.2098 135.8486 0000176 28.4050 144.5909 14.57108832967671", + "links": [ + { + "name": "S_RHCP_UL", + "centerFrequencyMHz": 2106.4063, + "bandwidthMHz": 0.036, + "direction": "uplink", + "polarization": "RHCP", + "authorizations": [ + { + "groundStation": "Microsoft_Quincy", + "expirationDate": "2020-07-16" + } + ] + }, + { + "name": "X_RHCP_DL", + "centerFrequencyMHz": 8125, + "bandwidthMHz": 150, + "direction": "downlink", + "polarization": "RHCP", + "authorizations": [] + } + ] + }, + "type": "Microsoft.Orbital/spacecrafts" + } + ], + "nextLink": "string" + } + } + } +} diff --git a/specification/orbital/resource-manager/Microsoft.Orbital/stable/2022-03-01/examples/SpacecraftsBySubscriptionList.json b/specification/orbital/resource-manager/Microsoft.Orbital/stable/2022-03-01/examples/SpacecraftsBySubscriptionList.json new file mode 100644 index 000000000000..c43aaadb2e55 --- /dev/null +++ b/specification/orbital/resource-manager/Microsoft.Orbital/stable/2022-03-01/examples/SpacecraftsBySubscriptionList.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "api-version": "2022-03-01", + "subscriptionId": "subid", + "$skipToken": "opaqueString" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "AQUA", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Orbital/spacecrafts/AQUA", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "noradId": "27424", + "titleLine": "AQUA", + "tleLine1": "1 27424U 02022A 20195.59202355 .00000039 00000-0 18634-4 0 9991", + "tleLine2": "2 27424 98.2098 135.8486 0000176 28.4050 144.5909 14.57108832967671", + "links": [ + { + "name": "S_RHCP_DL", + "centerFrequencyMHz": 2106.4063, + "bandwidthMHz": 0.036, + "direction": "uplink", + "polarization": "RHCP", + "authorizations": [ + { + "groundStation": "Microsoft_Quincy", + "expirationDate": "2020-07-16" + } + ] + }, + { + "name": "X_RHCP_DL", + "centerFrequencyMHz": 8125, + "bandwidthMHz": 150, + "direction": "downlink", + "polarization": "RHCP", + "authorizations": [ + { + "groundStation": "Microsoft_Gavle", + "expirationDate": "2020-07-16" + } + ] + } + ] + }, + "type": "Microsoft.Orbital/spacecrafts" + } + ], + "nextLink": "string" + } + } + } +} diff --git a/specification/orbital/resource-manager/Microsoft.Orbital/stable/2022-03-01/orbital.json b/specification/orbital/resource-manager/Microsoft.Orbital/stable/2022-03-01/orbital.json new file mode 100644 index 000000000000..88303984823f --- /dev/null +++ b/specification/orbital/resource-manager/Microsoft.Orbital/stable/2022-03-01/orbital.json @@ -0,0 +1,2295 @@ +{ + "swagger": "2.0", + "info": { + "version": "2022-03-01", + "title": "Azure Orbital", + "description": "Azure Orbital service", + "license": { + "name": "Microsoft" + } + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/providers/Microsoft.Orbital/operations": { + "get": { + "tags": [ + "Operations" + ], + "description": "Lists all of the available Orbital Rest API operations.", + "operationId": "Operations_List", + "x-ms-examples": { + "OperationsList": { + "$ref": "./examples/OperationsList.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/OperationListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed. If the resource group does not exist, 404 (NotFound) will be returned.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Orbital/spacecrafts": { + "get": { + "tags": [ + "Spacecraft" + ], + "description": "Return list of spacecrafts", + "operationId": "Spacecrafts_ListBySubscription", + "x-ms-examples": { + "List of Spacecraft by Subscription": { + "$ref": "./examples/SpacecraftsBySubscriptionList.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/skipTokenParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of spacecraft resources.", + "schema": { + "$ref": "#/definitions/SpacecraftListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed. If the resource group does not exist, 404 (NotFound) will be returned.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Orbital/spacecrafts": { + "get": { + "tags": [ + "Spacecraft" + ], + "description": "Return list of spacecrafts", + "operationId": "Spacecrafts_List", + "x-ms-examples": { + "List of Spacecraft by Resource Group": { + "$ref": "./examples/SpacecraftsByResourceGroupList.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/skipTokenParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of spacecraft resources.", + "schema": { + "$ref": "#/definitions/SpacecraftListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed. If the resource group does not exist, 404 (NotFound) will be returned.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Orbital/spacecrafts/{spacecraftName}": { + "get": { + "tags": [ + "Spacecraft" + ], + "operationId": "Spacecrafts_Get", + "description": "Gets the specified spacecraft in a specified resource group", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/spacecraftNameParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting Spacecraft resource.", + "schema": { + "$ref": "#/definitions/Spacecraft" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get Spacecraft": { + "$ref": "./examples/SpacecraftGet.json" + } + } + }, + "put": { + "tags": [ + "Spacecraft" + ], + "description": "Creates or updates a spacecraft resource", + "operationId": "Spacecrafts_CreateOrUpdate", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/spacecraftNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "x-ms-client-flatten": true, + "schema": { + "$ref": "#/definitions/Spacecraft" + }, + "description": "The parameters to provide for the created spacecraft." + } + ], + "responses": { + "200": { + "description": "Update successful. The operation returns the resulting spacecraft resource.", + "schema": { + "$ref": "#/definitions/Spacecraft" + } + }, + "201": { + "description": "Create successful. The operation returns the resulting spacecraft resource.", + "schema": { + "$ref": "#/definitions/Spacecraft" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "URL for checking the ongoing status of the operation." + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Create a spacecraft": { + "$ref": "./examples/SpacecraftCreate.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "delete": { + "tags": [ + "Spacecraft" + ], + "operationId": "Spacecrafts_Delete", + "description": "Deletes a specified spacecraft resource.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/spacecraftNameParameter" + } + ], + "responses": { + "200": { + "description": "Delete successful." + }, + "202": { + "description": "Accepted and the operation will complete asynchronously.", + "headers": { + "Location": { + "type": "string", + "description": "URL for determining when an operation has completed." + } + } + }, + "204": { + "description": "Request successful. Resource does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Delete Spacecraft": { + "$ref": "./examples/SpacecraftDelete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "patch": { + "tags": [ + "Spacecraft" + ], + "operationId": "Spacecrafts_UpdateTags", + "x-ms-examples": { + "Update Spacecraft tags": { + "$ref": "./examples/SpacecraftUpdateTags.json" + } + }, + "description": "Updates the specified spacecraft tags.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/TagsObject" + }, + "description": "Parameters supplied to update spacecraft tags." + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/spacecraftNameParameter" + } + ], + "responses": { + "200": { + "description": "Update successful. The operation returns the resulting Spacecraft resource.", + "schema": { + "$ref": "#/definitions/Spacecraft" + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously.", + "headers": { + "Location": { + "type": "string", + "description": "URL for determining when an operation has completed." + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Orbital/spacecrafts/{spacecraftName}/contacts": { + "get": { + "tags": [ + "Contact" + ], + "description": "Returns list of contacts by spacecraftName", + "operationId": "Contacts_List", + "x-ms-examples": { + "List of Spacecraft": { + "$ref": "./examples/ContactsBySpacecraftNameList.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/spacecraftNameParameter" + }, + { + "$ref": "#/parameters/skipTokenParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of contacts by spacecraftName.", + "schema": { + "$ref": "#/definitions/ContactListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed. If the resource group does not exist, 404 (NotFound) will be returned.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Orbital/spacecrafts/{spacecraftName}/contacts/{contactName}": { + "get": { + "tags": [ + "Contact" + ], + "operationId": "Contacts_Get", + "description": "Gets the specified contact in a specified resource group", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/spacecraftNameParameter" + }, + { + "$ref": "#/parameters/contactNameParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting Contact resource.", + "schema": { + "$ref": "#/definitions/Contact" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get Contact": { + "$ref": "./examples/ContactGet.json" + } + } + }, + "put": { + "tags": [ + "Contact" + ], + "description": "Creates a contact.", + "operationId": "Contacts_Create", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/spacecraftNameParameter" + }, + { + "$ref": "#/parameters/contactNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Contact" + }, + "description": "The parameters to provide for the created contact." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Contact" + } + }, + "201": { + "description": "Create successful. The operation returns the resulting contact resource.", + "schema": { + "$ref": "#/definitions/Contact" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "URL for checking the ongoing status of the operation." + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Create a contact": { + "$ref": "./examples/ContactCreate.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "delete": { + "tags": [ + "Contact" + ], + "operationId": "Contacts_Delete", + "description": "Deletes a specified contact", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/spacecraftNameParameter" + }, + { + "$ref": "#/parameters/contactNameParameter" + } + ], + "responses": { + "200": { + "description": "Delete successful." + }, + "202": { + "description": "Accepted and the operation will complete asynchronously.", + "headers": { + "Location": { + "type": "string", + "description": "URL for determining when an operation has completed." + } + } + }, + "204": { + "description": "Request successful. Resource does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Delete Contact": { + "$ref": "./examples/ContactDelete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Orbital/spacecrafts/{spacecraftName}/listAvailableContacts": { + "post": { + "tags": [ + "Contact" + ], + "description": "Return list of available contacts", + "operationId": "Spacecrafts_ListAvailableContacts", + "x-ms-examples": { + "List of Contact": { + "$ref": "./examples/AvailableContactsList.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/spacecraftNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "x-ms-client-flatten": true, + "schema": { + "$ref": "#/definitions/ContactParameters" + }, + "description": "The parameters to provide for the contacts." + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of available contacts resources.", + "schema": { + "$ref": "#/definitions/AvailableContactsListResult" + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously.", + "headers": { + "Location": { + "type": "string", + "description": "URL for determining when an operation has completed." + } + } + }, + "default": { + "description": "Error response describing why the operation failed. If the resource group does not exist, 404 (NotFound) will be returned.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Orbital/contactProfiles/{contactProfileName}": { + "get": { + "tags": [ + "Contact Profile" + ], + "operationId": "ContactProfiles_Get", + "description": "Gets the specified contact Profile in a specified resource group", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/contactProfileNameParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting ContactProfile resource.", + "schema": { + "$ref": "#/definitions/ContactProfile" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get a contact profile": { + "$ref": "./examples/ContactProfileGet.json" + } + } + }, + "put": { + "tags": [ + "Contact Profile" + ], + "description": "Creates or updates a contact profile", + "operationId": "ContactProfiles_CreateOrUpdate", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/contactProfileNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "x-ms-client-flatten": true, + "schema": { + "$ref": "#/definitions/ContactProfile" + }, + "description": "The parameters to provide for the created Contact Profile." + } + ], + "responses": { + "200": { + "description": "Update successful. The operation returns the resulting ContactProfile resource.", + "schema": { + "$ref": "#/definitions/ContactProfile" + } + }, + "201": { + "description": "Create successful. The operation returns the resulting ContactProfile resource.", + "schema": { + "$ref": "#/definitions/ContactProfile" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "URL for checking the ongoing status of the operation." + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Create a contact profile": { + "$ref": "./examples/ContactProfileCreate.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "delete": { + "tags": [ + "Contact Profile" + ], + "operationId": "ContactProfiles_Delete", + "description": "Deletes a specified contact profile resource.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/contactProfileNameParameter" + } + ], + "responses": { + "200": { + "description": "Delete successful." + }, + "202": { + "description": "Accepted and the operation will complete asynchronously.", + "headers": { + "Location": { + "type": "string", + "description": "URL for determining when an operation has completed." + } + } + }, + "204": { + "description": "Request successful. Resource does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Delete Contact Profile": { + "$ref": "./examples/ContactProfileDelete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "patch": { + "tags": [ + "Contact Profile" + ], + "operationId": "ContactProfiles_UpdateTags", + "x-ms-examples": { + "Update Contact Profile tags": { + "$ref": "./examples/ContactProfileUpdateTag.json" + } + }, + "description": "Updates the specified contact profile tags.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/TagsObject" + }, + "description": "Parameters supplied to update contact profile tags." + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/contactProfileNameParameter" + } + ], + "responses": { + "200": { + "description": "Update successful. The operation returns the resulting Contact Profile resource.", + "schema": { + "$ref": "#/definitions/ContactProfile" + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously.", + "headers": { + "Location": { + "type": "string", + "description": "URL for determining when an operation has completed." + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Orbital/contactProfiles": { + "get": { + "tags": [ + "Contact Profile" + ], + "description": "Returns list of contact profiles by Subscription", + "operationId": "ContactProfiles_ListBySubscription", + "x-ms-examples": { + "List of Contact Profiles": { + "$ref": "./examples/ContactProfilesBySubscriptionList.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/skipTokenParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of contact profile resources.", + "schema": { + "$ref": "#/definitions/ContactProfileListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed. If the resource group does not exist, 404 (NotFound) will be returned.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Orbital/contactProfiles": { + "get": { + "tags": [ + "Contact Profile" + ], + "description": "Returns list of contact profiles by Resource Group", + "operationId": "ContactProfiles_List", + "x-ms-examples": { + "List of Contact Profiles": { + "$ref": "./examples/ContactProfilesByResourceGroupList.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/skipTokenParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of contact profile resources.", + "schema": { + "$ref": "#/definitions/ContactProfileListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed. If the resource group does not exist, 404 (NotFound) will be returned.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "get": { + "tags": [ + "Ground Station" + ], + "description": "Return list of ground stations", + "operationId": "GroundStations_ListBySubscription", + "x-ms-examples": { + "List of Ground Stations by Subscription": { + "$ref": "./examples/GroundStationsBySubscription.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/skipTokenParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of Ground Station resources.", + "schema": { + "$ref": "#/definitions/GroundStationListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed. If the resource group does not exist, 404 (NotFound) will be returned.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Orbital/availableGroundStations": { + "get": { + "tags": [ + "Ground Station" + ], + "description": "Returns list of available ground stations", + "operationId": "AvailableGroundStations_ListByCapability", + "x-ms-examples": { + "List of Ground Stations by Capability": { + "$ref": "./examples/AvailableGroundStationsByCapabilityList.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/capabilityParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of Ground Station resources.", + "schema": { + "$ref": "#/definitions/AvailableGroundStationListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed. If the resource group does not exist, 404 (NotFound) will be returned.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Orbital/availableGroundStations/{groundStationName}": { + "get": { + "tags": [ + "Ground Station" + ], + "operationId": "AvailableGroundStations_Get", + "description": "Gets the specified available ground station", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/groundStationNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting ground station resource.", + "schema": { + "$ref": "#/definitions/AvailableGroundStation" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get GroundStation": { + "$ref": "./examples/AvailableGroundStationGet.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Orbital/locations/{location}/operationResults/{operationId}": { + "get": { + "tags": [ + "OperationResults" + ], + "description": "Returns operation results.", + "operationId": "OperationsResults_Get", + "x-ms-examples": { + "KustoOperationResultsGet": { + "$ref": "./examples/OperationResultsGet.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/LocationParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/OperationIdParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved the operation result.", + "schema": { + "$ref": "#/definitions/OperationResult" + } + }, + "202": { + "description": "The operation is still in progress.", + "headers": { + "Location": { + "type": "string", + "description": "URL for determining when an operation has completed." + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + } + }, + "definitions": { + "TagsObject": { + "type": "object", + "properties": { + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Resource tags." + } + }, + "description": "Tags object for patch operations." + }, + "SpacecraftsProperties": { + "type": "object", + "required": [ + "noradId" + ], + "properties": { + "provisioningState": { + "type": "string", + "allOf": [ + { + "$ref": "#/definitions/ProvisioningState" + } + ], + "description": "The current state of the resource's creation, deletion, or modification" + }, + "noradId": { + "type": "string", + "description": "NORAD ID of the spacecraft." + }, + "titleLine": { + "type": "string", + "description": "Title line of Two Line Element (TLE)." + }, + "tleLine1": { + "type": "string", + "description": "Line 1 of Two Line Element (TLE)." + }, + "tleLine2": { + "type": "string", + "description": "Line 2 of Two Line Element (TLE)." + }, + "links": { + "type": "array", + "items": { + "$ref": "#/definitions/SpacecraftLink" + }, + "x-ms-identifiers": [], + "description": "Links of the Spacecraft", + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "description": "List of Spacecraft Resource Properties." + }, + "SpacecraftListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Spacecraft" + }, + "description": "A list of spacecraft resources in a resource group." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of results.", + "readOnly": true + } + }, + "description": "Response for the ListSpacecrafts API service call." + }, + "SpacecraftLink": { + "type": "object", + "required": [ + "name", + "centerFrequencyMHz", + "bandwidthMHz", + "direction", + "polarization" + ], + "properties": { + "name": { + "type": "string", + "description": "Link name", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "centerFrequencyMHz": { + "type": "number", + "description": "Center Frequency in MHz", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "bandwidthMHz": { + "type": "number", + "description": "Bandwidth in MHz", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "direction": { + "type": "string", + "description": "Direction (uplink or downlink)", + "enum": [ + "uplink", + "downlink" + ], + "x-ms-enum": { + "name": "direction", + "modelAsString": true + }, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "polarization": { + "type": "string", + "description": "polarization. eg (RHCP, LHCP)", + "enum": [ + "RHCP", + "LHCP", + "linearVertical", + "linearHorizontal" + ], + "x-ms-enum": { + "name": "polarization", + "modelAsString": true + }, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "authorizations": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/AuthorizedGroundstation" + }, + "x-ms-identifiers": [] + } + }, + "description": "Authorized Ground Stations for the link" + }, + "Spacecraft": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "allOf": [ + { + "$ref": "#/definitions/SpacecraftsProperties" + } + ] + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/TrackedResource" + } + ], + "description": "Customer creates a spacecraft resource to schedule a contact." + }, + "ResourceReference": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Resource ID." + } + }, + "x-ms-azure-resource": true, + "description": "Resource Reference" + }, + "OperationListResult": { + "type": "object", + "description": "Result of the request to list Orbital operations. It contains a list of operations and a URL link to get the next set of results.", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Operation" + }, + "description": "List of Orbital operations supported by the Orbital resource provider." + } + } + }, + "Operation": { + "description": "Orbital REST API operation definition.", + "type": "object", + "properties": { + "name": { + "description": "Operation name: {provider}/{resource}/{operation}", + "type": "string" + }, + "isDataAction": { + "type": "boolean", + "default": false, + "description": "Indicates whether the operation applies to data-plane." + }, + "display": { + "description": "Display metadata associated with the operation.", + "properties": { + "provider": { + "description": "Service provider: Microsoft Orbital.", + "type": "string" + }, + "resource": { + "description": "Resource on which the operation is performed etc.", + "type": "string" + }, + "operation": { + "description": "Type of operation: get, read, delete, etc.", + "type": "string" + }, + "description": { + "description": "Description of the operation.", + "type": "string" + } + } + }, + "origin": { + "type": "string", + "description": "The origin of operations." + } + } + }, + "EndPoint": { + "type": "object", + "required": [ + "ipAddress", + "endPointName", + "port", + "protocol" + ], + "properties": { + "ipAddress": { + "type": "string", + "description": "IP Address." + }, + "endPointName": { + "type": "string", + "description": "Name of an end point." + }, + "port": { + "type": "string", + "description": "TCP port to listen on to receive data." + }, + "protocol": { + "type": "string", + "description": "Protocol either UDP or TCP.", + "enum": [ + "TCP", + "UDP" + ], + "x-ms-enum": { + "name": "protocol", + "modelAsString": true + } + } + }, + "description": "Customer End point to store/retrieve data during a contact." + }, + "ContactsProperties": { + "type": "object", + "required": [ + "reservationStartTime", + "reservationEndTime", + "groundStationName", + "contactProfile" + ], + "properties": { + "provisioningState": { + "type": "string", + "allOf": [ + { + "$ref": "#/definitions/ProvisioningState" + } + ], + "description": "The current state of the resource's creation, deletion, or modification" + }, + "status": { + "type": "string", + "readOnly": true, + "enum": [ + "scheduled", + "cancelled", + "succeeded", + "failed", + "providerCancelled" + ], + "x-ms-enum": { + "name": "Status", + "modelAsString": false + }, + "description": "Status of a contact." + }, + "reservationStartTime": { + "type": "string", + "format": "date-time", + "description": "Reservation start time of a contact.", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "reservationEndTime": { + "type": "string", + "format": "date-time", + "description": "Reservation end time of a contact.", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "rxStartTime": { + "type": "string", + "format": "date-time", + "readOnly": true, + "description": "Receive start time of a contact." + }, + "rxEndTime": { + "type": "string", + "format": "date-time", + "readOnly": true, + "description": "Receive end time of a contact." + }, + "txStartTime": { + "type": "string", + "format": "date-time", + "readOnly": true, + "description": "Transmit start time of a contact." + }, + "txEndTime": { + "type": "string", + "format": "date-time", + "readOnly": true, + "description": "Transmit end time of a contact." + }, + "errorMessage": { + "type": "string", + "readOnly": true, + "description": "Any error message while scheduling a contact." + }, + "maximumElevationDegrees": { + "type": "number", + "readOnly": true, + "description": "Maximum elevation of the antenna during the contact in decimal degrees." + }, + "startAzimuthDegrees": { + "type": "number", + "readOnly": true, + "description": "Azimuth of the antenna at the start of the contact in decimal degrees." + }, + "endAzimuthDegrees": { + "type": "number", + "readOnly": true, + "description": "Azimuth of the antenna at the end of the contact in decimal degrees." + }, + "groundStationName": { + "type": "string", + "description": "Azure Ground Station name.", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "startElevationDegrees": { + "type": "number", + "readOnly": true, + "description": "Spacecraft elevation above the horizon at contact start." + }, + "endElevationDegrees": { + "type": "number", + "readOnly": true, + "description": "Spacecraft elevation above the horizon at contact end." + }, + "antennaConfiguration": { + "type": "object", + "readOnly": true, + "description": "The configuration associated with the allocated antenna.", + "properties": { + "destinationIp": { + "type": "string", + "description": "The destination IP a packet can be sent to. This would for example be the TCP endpoint you would send data to." + }, + "sourceIps": { + "type": "array", + "items": { + "type": "string", + "description": "The source IP a packet can have when being sent. You need to make sure you accept data from all these IPs in your application." + } + } + } + }, + "contactProfile": { + "allOf": [ + { + "$ref": "#/definitions/ResourceReference" + } + ], + "description": "The reference to the contact profile resource." + } + }, + "description": "Properties of the Contact Resource." + }, + "ContactProfilesProperties": { + "type": "object", + "required": [ + "links", + "networkConfiguration" + ], + "properties": { + "provisioningState": { + "type": "string", + "allOf": [ + { + "$ref": "#/definitions/ProvisioningState" + } + ], + "description": "The current state of the resource's creation, deletion, or modification" + }, + "minimumViableContactDuration": { + "type": "string", + "description": "Minimum viable contact duration in ISO 8601 format." + }, + "minimumElevationDegrees": { + "type": "number", + "description": "Minimum viable elevation for the contact in decimal degrees." + }, + "autoTrackingConfiguration": { + "type": "string", + "enum": [ + "disabled", + "xBand", + "sBand" + ], + "x-ms-enum": { + "name": "AutoTrackingConfiguration", + "modelAsString": false + }, + "description": "Auto track configuration." + }, + "eventHubUri": { + "type": "string", + "description": "The URI of the Event Hub used for telemetry" + }, + "networkConfiguration": { + "type": "object", + "required": [ + "subnetId" + ], + "description": "Network configuration of customer virtual network.", + "properties": { + "subnetId": { + "type": "string", + "description": "Customer subnet ARM resource identifier." + } + } + }, + "links": { + "type": "array", + "x-ms-identifiers": [], + "items": { + "$ref": "#/definitions/ContactProfileLink" + }, + "description": "Links of the Contact Profile" + } + }, + "description": "List of Contact Profile Resource Properties." + }, + "ContactProfileListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ContactProfile" + }, + "description": "A list of contact profile resources in a resource group." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of results.", + "readOnly": true + } + }, + "description": "Response for the ListContactProfiles API service call." + }, + "ContactProfileLinkChannel": { + "type": "object", + "required": [ + "name", + "centerFrequencyMHz", + "bandwidthMHz", + "endPoint" + ], + "properties": { + "name": { + "type": "string", + "description": "Channel name" + }, + "centerFrequencyMHz": { + "type": "number", + "description": "Center Frequency in MHz" + }, + "bandwidthMHz": { + "type": "number", + "description": "Bandwidth in MHz" + }, + "endPoint": { + "$ref": "#/definitions/EndPoint" + }, + "modulationConfiguration": { + "type": "string", + "description": "" + }, + "demodulationConfiguration": { + "type": "string", + "description": "" + }, + "encodingConfiguration": { + "type": "string", + "description": "" + }, + "decodingConfiguration": { + "type": "string", + "description": "" + } + } + }, + "ContactProfileLink": { + "type": "object", + "required": [ + "name", + "polarization", + "direction", + "channels" + ], + "properties": { + "name": { + "type": "string", + "description": "Link name" + }, + "polarization": { + "type": "string", + "description": "polarization. eg (RHCP, LHCP)", + "enum": [ + "RHCP", + "LHCP", + "linearVertical", + "linearHorizontal" + ] + }, + "direction": { + "type": "string", + "description": "Direction (uplink or downlink)", + "enum": [ + "uplink", + "downlink" + ] + }, + "gainOverTemperature": { + "type": "number", + "description": "Gain To Noise Temperature in db/K." + }, + "eirpdBW": { + "type": "number", + "description": "Effective Isotropic Radiated Power (EIRP) in dBW." + }, + "channels": { + "type": "array", + "items": { + "$ref": "#/definitions/ContactProfileLinkChannel" + } + } + } + }, + "ContactProfile": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "allOf": [ + { + "$ref": "#/definitions/ContactProfilesProperties" + } + ], + "description": "Properties of the contact profile resource." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/TrackedResource" + } + ], + "description": "Customer creates a Contact Profile Resource, which will contain all of the configurations required for scheduling a contact." + }, + "ContactParameters": { + "type": "object", + "description": "Parameters that define the contact resource.", + "required": [ + "contactProfile", + "groundStationName", + "startTime", + "endTime" + ], + "properties": { + "contactProfile": { + "allOf": [ + { + "$ref": "#/definitions/ResourceReference" + } + ], + "description": "The reference to the contact profile resource." + }, + "groundStationName": { + "type": "string", + "description": "Name of Azure Ground Station." + }, + "startTime": { + "type": "string", + "format": "date-time", + "description": "Start time of a contact." + }, + "endTime": { + "type": "string", + "format": "date-time", + "description": "End time of a contact." + } + } + }, + "ContactListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Contact" + }, + "description": "A list of contact resources in a resource group." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of results.", + "readOnly": true + } + }, + "description": "Response for the ListContacts API service call." + }, + "ContactInstanceProperties": { + "type": "object", + "properties": { + "maximumElevationDegrees": { + "type": "number", + "readOnly": true, + "description": "Maximum elevation of the antenna during the contact in decimal degrees." + }, + "txStartTime": { + "type": "string", + "format": "date-time", + "readOnly": true, + "description": "Time at which antenna transmit will be enabled." + }, + "txEndTime": { + "type": "string", + "format": "date-time", + "readOnly": true, + "description": "Time at which antenna transmit will be disabled." + }, + "rxStartTime": { + "type": "string", + "format": "date-time", + "readOnly": true, + "description": "Earliest time to receive a signal." + }, + "rxEndTime": { + "type": "string", + "format": "date-time", + "readOnly": true, + "description": "Time to lost receiving a signal." + }, + "startAzimuthDegrees": { + "type": "number", + "readOnly": true, + "description": "Azimuth of the antenna at the start of the contact in decimal degrees." + }, + "endAzimuthDegrees": { + "type": "number", + "readOnly": true, + "description": "Azimuth of the antenna at the end of the contact in decimal degrees." + }, + "startElevationDegrees": { + "type": "number", + "readOnly": true, + "description": "Spacecraft elevation above the horizon at contact start." + }, + "endElevationDegrees": { + "type": "number", + "readOnly": true, + "description": "Spacecraft elevation above the horizon at contact end." + } + }, + "description": "Contact Instance Properties" + }, + "Contact": { + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/ContactsProperties" + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ], + "description": "Customer creates a contact resource for a spacecraft resource." + }, + "CloudErrorBody": { + "type": "object", + "x-ms-external": true, + "properties": { + "code": { + "type": "string", + "description": "An identifier for the error. Codes are invariant and are intended to be consumed programmatically." + }, + "message": { + "type": "string", + "description": "A message describing the error, intended to be suitable for display in a user interface." + }, + "target": { + "type": "string", + "description": "The target of the particular error. For example, the name of the property in error." + }, + "details": { + "type": "array", + "items": { + "$ref": "#/definitions/CloudErrorBody" + }, + "description": "A list of additional details about the error." + } + }, + "description": "An error response from the service." + }, + "CloudError": { + "type": "object", + "x-ms-external": true, + "properties": { + "error": { + "$ref": "#/definitions/CloudErrorBody" + } + }, + "description": "An error response from the service." + }, + "AvailableContactsListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/AvailableContacts" + }, + "description": "A list of available contacts" + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of results.", + "readOnly": true + } + }, + "description": "Response for the ListAvailableContacts API service call." + }, + "AvailableContacts": { + "type": "object", + "properties": { + "spacecraft": { + "allOf": [ + { + "$ref": "#/definitions/ResourceReference" + } + ], + "description": "The reference to the spacecraft resource." + }, + "groundStationName": { + "type": "string", + "readOnly": true, + "description": "Name of Azure Ground Station." + }, + "properties": { + "x-ms-client-flatten": true, + "allOf": [ + { + "$ref": "#/definitions/ContactInstanceProperties" + } + ], + "description": "Properties of Contact resource." + } + }, + "description": "Customer retrieves list of Available Contacts for a spacecraft resource. Later, one of the available contact can be selected to create a contact." + }, + "AvailableGroundStationListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/AvailableGroundStation" + }, + "description": "A list of ground station resources." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of results.", + "readOnly": true + } + }, + "description": "Response for the AvailableGroundStations API service call." + }, + "AvailableGroundStation": { + "type": "object", + "x-ms-client-flatten": true, + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "Id of groundStation" + }, + "name": { + "readOnly": true, + "type": "string", + "description": "Name of the ground station." + }, + "location": { + "type": "string", + "description": "Azure region" + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Resource type." + }, + "properties": { + "x-ms-client-flatten": true, + "allOf": [ + { + "$ref": "#/definitions/AvailableGroundStationProperties" + } + ], + "description": "The properties bag for this resource" + } + }, + "description": "GroundStations available to schedule Contacts" + }, + "AvailableGroundStationProperties": { + "type": "object", + "properties": { + "city": { + "type": "string", + "description": "City of ground station." + }, + "providerName": { + "type": "string", + "description": "Ground station provider name." + }, + "longitudeDegrees": { + "type": "number", + "description": "Longitude of the ground station in decimal degrees." + }, + "latitudeDegrees": { + "type": "number", + "description": "Latitude of the ground station in decimal degrees." + }, + "altitudeMeters": { + "type": "number", + "description": "Altitude of the ground station" + }, + "releaseMode": { + "type": "string", + "enum": [ + "Preview", + "GA" + ], + "x-ms-enum": { + "name": "releaseMode", + "modelAsString": true + }, + "description": "Release Status of a ground station" + } + }, + "description": "Properties object for Available groundstation." + }, + "Capability": { + "type": "string", + "description": "Capability of the Ground Station.", + "enum": [ + "EarthObservation", + "Communication" + ], + "x-ms-enum": { + "name": "Capability", + "modelAsString": true + } + }, + "ResourceIdListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The Azure Resource ID" + } + } + }, + "description": "A list of Azure Resource IDs." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of results.", + "readOnly": true + } + }, + "description": "Response for an API service call that lists the resource IDs of resources associated with another resource." + }, + "Etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "ProvisioningState": { + "type": "string", + "enum": [ + "Creating", + "Succeeded", + "Failed", + "Canceled", + "Updating", + "Deleting" + ], + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true + }, + "description": "The current state of the resource's creation, deletion, or modification", + "readOnly": true + }, + "AuthorizedGroundstation": { + "type": "object", + "readOnly": true, + "properties": { + "groundStation": { + "type": "string", + "description": "Groundstation name" + }, + "expirationDate": { + "type": "string", + "format": "date", + "description": "Date of authorization expiration" + } + }, + "description": "Authorized groundstation" + }, + "OperationResult": { + "description": "Operation Result Entity.", + "type": "object", + "properties": { + "id": { + "readOnly": true, + "description": "ID of the resource.", + "type": "string" + }, + "name": { + "readOnly": true, + "description": "Name of the resource.", + "type": "string" + }, + "status": { + "$ref": "#/definitions/Status" + }, + "startTime": { + "description": "The operation start time", + "readOnly": true, + "type": "string", + "format": "date-time" + }, + "endTime": { + "description": "The operation end time", + "readOnly": true, + "type": "string", + "format": "date-time" + }, + "percentComplete": { + "type": "number", + "format": "double", + "minimum": 0, + "maximum": 100, + "description": "Percentage completed.", + "readOnly": true + }, + "properties": { + "$ref": "#/definitions/OperationResultProperties" + }, + "error": { + "$ref": "#/definitions/OperationResultErrorProperties" + } + } + }, + "Status": { + "readOnly": true, + "description": "The status of operation.", + "type": "string", + "enum": [ + "Succeeded", + "Canceled", + "Failed", + "Running" + ], + "x-ms-enum": { + "name": "Status", + "modelAsString": true + } + }, + "OperationResultProperties": { + "type": "object", + "properties": {}, + "description": "Operation result properties" + }, + "OperationResultErrorProperties": { + "type": "object", + "properties": { + "code": { + "type": "string", + "description": "The code of the error.", + "readOnly": true + }, + "message": { + "type": "string", + "description": "The error message.", + "readOnly": true + } + }, + "description": "Operation result error properties" + } + }, + "parameters": { + "apiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "2020-09-01-preview", + "2021-04-04-preview", + "2022-03-01" + ], + "default": "2022-03-01", + "description": "Version of the API to be used with the client request." + }, + "contactNameParameter": { + "name": "contactName", + "in": "path", + "description": "Contact Name", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "contactProfileNameParameter": { + "name": "contactProfileName", + "in": "path", + "description": "Contact Profile Name", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "groundStationNameParameter": { + "name": "groundStationName", + "in": "path", + "required": true, + "type": "string", + "description": "Ground Station name", + "x-ms-parameter-location": "method" + }, + "spacecraftNameParameter": { + "name": "spacecraftName", + "in": "path", + "description": "Spacecraft ID", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "capabilityParameter": { + "name": "capability", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "EarthObservation", + "Communication" + ], + "x-ms-enum": { + "name": "capabilityParameter", + "modelAsString": true + }, + "default": "EarthObservation", + "description": "Ground Station Capability", + "x-ms-parameter-location": "method" + }, + "skipTokenParameter": { + "name": "$skiptoken", + "description": "An opaque string that the resource provider uses to skip over previously-returned results. This is used when a previous list operation call returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skiptoken parameter that specifies a starting point to use for subsequent calls.", + "in": "query", + "required": false, + "type": "string" + } + } +} diff --git a/specification/orbital/resource-manager/readme.md b/specification/orbital/resource-manager/readme.md index 6e42dd89d6b8..325cb2a31828 100644 --- a/specification/orbital/resource-manager/readme.md +++ b/specification/orbital/resource-manager/readme.md @@ -29,6 +29,15 @@ openapi-type: arm tag: package-2021-04-04-preview ``` +### Tag: package-2022-03-01 + +These settings apply only when `--tag=package-2022-03-01` is specified on the command line. + +```yaml $(tag) == 'package-2022-03-01' +input-file: + - Microsoft.Orbital/stable/2022-03-01/orbital.json +``` + ### Tag: package-2021-04-04-preview These settings apply only when `--tag=package-2021-04-04-preview` is specified on the command line. From f684ced29f40a8999064cb510db764601f01fca0 Mon Sep 17 00:00:00 2001 From: Devanshu Singh Date: Fri, 18 Mar 2022 01:09:14 -0400 Subject: [PATCH 18/26] valid json --- .../stable/2022-03-01/orbital.json | 41 ------------------- 1 file changed, 41 deletions(-) diff --git a/specification/orbital/resource-manager/Microsoft.Orbital/stable/2022-03-01/orbital.json b/specification/orbital/resource-manager/Microsoft.Orbital/stable/2022-03-01/orbital.json index 88303984823f..025fdeb272a7 100644 --- a/specification/orbital/resource-manager/Microsoft.Orbital/stable/2022-03-01/orbital.json +++ b/specification/orbital/resource-manager/Microsoft.Orbital/stable/2022-03-01/orbital.json @@ -970,47 +970,6 @@ "nextLinkName": "nextLink" } } - }, - "get": { - "tags": [ - "Ground Station" - ], - "description": "Return list of ground stations", - "operationId": "GroundStations_ListBySubscription", - "x-ms-examples": { - "List of Ground Stations by Subscription": { - "$ref": "./examples/GroundStationsBySubscription.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - }, - { - "$ref": "#/parameters/skipTokenParameter" - } - ], - "responses": { - "200": { - "description": "Request successful. The operation returns a list of Ground Station resources.", - "schema": { - "$ref": "#/definitions/GroundStationListResult" - } - }, - "default": { - "description": "Error response describing why the operation failed. If the resource group does not exist, 404 (NotFound) will be returned.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } }, "/subscriptions/{subscriptionId}/providers/Microsoft.Orbital/availableGroundStations": { "get": { From c79fb88b807526e67daf288904d0b6cf20c32d06 Mon Sep 17 00:00:00 2001 From: Devanshu Singh Date: Fri, 18 Mar 2022 13:52:21 -0400 Subject: [PATCH 19/26] lint diff fix --- .../stable/2022-03-01/orbital.json | 76 +++++-------------- 1 file changed, 18 insertions(+), 58 deletions(-) diff --git a/specification/orbital/resource-manager/Microsoft.Orbital/stable/2022-03-01/orbital.json b/specification/orbital/resource-manager/Microsoft.Orbital/stable/2022-03-01/orbital.json index 025fdeb272a7..37c326aa4a7a 100644 --- a/specification/orbital/resource-manager/Microsoft.Orbital/stable/2022-03-01/orbital.json +++ b/specification/orbital/resource-manager/Microsoft.Orbital/stable/2022-03-01/orbital.json @@ -39,7 +39,7 @@ "operationId": "Operations_List", "x-ms-examples": { "OperationsList": { - "$ref": "./examples/OperationsList.json" + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/Operation" } }, "parameters": [ @@ -51,7 +51,7 @@ "200": { "description": "OK. The request has succeeded.", "schema": { - "$ref": "#/definitions/OperationListResult" + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/OperationListResult" } }, "default": { @@ -1296,59 +1296,6 @@ "x-ms-azure-resource": true, "description": "Resource Reference" }, - "OperationListResult": { - "type": "object", - "description": "Result of the request to list Orbital operations. It contains a list of operations and a URL link to get the next set of results.", - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/Operation" - }, - "description": "List of Orbital operations supported by the Orbital resource provider." - } - } - }, - "Operation": { - "description": "Orbital REST API operation definition.", - "type": "object", - "properties": { - "name": { - "description": "Operation name: {provider}/{resource}/{operation}", - "type": "string" - }, - "isDataAction": { - "type": "boolean", - "default": false, - "description": "Indicates whether the operation applies to data-plane." - }, - "display": { - "description": "Display metadata associated with the operation.", - "properties": { - "provider": { - "description": "Service provider: Microsoft Orbital.", - "type": "string" - }, - "resource": { - "description": "Resource on which the operation is performed etc.", - "type": "string" - }, - "operation": { - "description": "Type of operation: get, read, delete, etc.", - "type": "string" - }, - "description": { - "description": "Description of the operation.", - "type": "string" - } - } - }, - "origin": { - "type": "string", - "description": "The origin of operations." - } - } - }, "EndPoint": { "type": "object", "required": [ @@ -1674,7 +1621,11 @@ "LHCP", "linearVertical", "linearHorizontal" - ] + ], + "x-ms-enum": { + "name": "polarization", + "modelAsString": true + } }, "direction": { "type": "string", @@ -1682,7 +1633,11 @@ "enum": [ "uplink", "downlink" - ] + ], + "x-ms-enum": { + "name": "direction", + "modelAsString": true + } }, "gainOverTemperature": { "type": "number", @@ -2191,6 +2146,10 @@ "2021-04-04-preview", "2022-03-01" ], + "x-ms-enum": { + "name": "apiVersionParameter", + "modelAsString": true + }, "default": "2022-03-01", "description": "Version of the API to be used with the client request." }, @@ -2248,7 +2207,8 @@ "description": "An opaque string that the resource provider uses to skip over previously-returned results. This is used when a previous list operation call returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skiptoken parameter that specifies a starting point to use for subsequent calls.", "in": "query", "required": false, - "type": "string" + "type": "string", + "x-ms-parameter-location":"method" } } } From 64059f35eb247de1cd4e3b7014fd253859daf3f7 Mon Sep 17 00:00:00 2001 From: Devanshu Singh Date: Fri, 18 Mar 2022 14:43:28 -0400 Subject: [PATCH 20/26] lint diff fix 2 --- .../Microsoft.Orbital/stable/2022-03-01/orbital.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/specification/orbital/resource-manager/Microsoft.Orbital/stable/2022-03-01/orbital.json b/specification/orbital/resource-manager/Microsoft.Orbital/stable/2022-03-01/orbital.json index 37c326aa4a7a..e8a1f1987c85 100644 --- a/specification/orbital/resource-manager/Microsoft.Orbital/stable/2022-03-01/orbital.json +++ b/specification/orbital/resource-manager/Microsoft.Orbital/stable/2022-03-01/orbital.json @@ -2208,7 +2208,7 @@ "in": "query", "required": false, "type": "string", - "x-ms-parameter-location":"method" + "x-ms-parameter-location": "method" } } } From 7af90d374da28504ebb7d3d854c7976646370c67 Mon Sep 17 00:00:00 2001 From: Devanshu Singh Date: Fri, 18 Mar 2022 15:54:15 -0400 Subject: [PATCH 21/26] avocado fix --- .../Microsoft.Orbital/stable/2022-03-01/orbital.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/specification/orbital/resource-manager/Microsoft.Orbital/stable/2022-03-01/orbital.json b/specification/orbital/resource-manager/Microsoft.Orbital/stable/2022-03-01/orbital.json index e8a1f1987c85..60c6c046d383 100644 --- a/specification/orbital/resource-manager/Microsoft.Orbital/stable/2022-03-01/orbital.json +++ b/specification/orbital/resource-manager/Microsoft.Orbital/stable/2022-03-01/orbital.json @@ -39,7 +39,7 @@ "operationId": "Operations_List", "x-ms-examples": { "OperationsList": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/Operation" + "$ref": "./examples/OperationsList.json" } }, "parameters": [ From e5f839545387277e50a9d5d0665097e56796d2f1 Mon Sep 17 00:00:00 2001 From: Devanshu Singh Date: Fri, 18 Mar 2022 17:07:00 -0400 Subject: [PATCH 22/26] lint diff warninga 1 --- .../stable/2022-03-01/orbital.json | 38 ++++++++++++------- 1 file changed, 25 insertions(+), 13 deletions(-) diff --git a/specification/orbital/resource-manager/Microsoft.Orbital/stable/2022-03-01/orbital.json b/specification/orbital/resource-manager/Microsoft.Orbital/stable/2022-03-01/orbital.json index 60c6c046d383..d456fc772f7a 100644 --- a/specification/orbital/resource-manager/Microsoft.Orbital/stable/2022-03-01/orbital.json +++ b/specification/orbital/resource-manager/Microsoft.Orbital/stable/2022-03-01/orbital.json @@ -934,7 +934,7 @@ "description": "Returns list of contact profiles by Resource Group", "operationId": "ContactProfiles_List", "x-ms-examples": { - "List of Contact Profiles": { + "List of Contact Profiles by Resource Group": { "$ref": "./examples/ContactProfilesByResourceGroupList.json" } }, @@ -1100,7 +1100,8 @@ "$ref": "#/definitions/CloudError" } } - } + }, + "x-ms-long-running-operation": true } } }, @@ -1252,6 +1253,7 @@ }, "authorizations": { "type": "array", + "description": "Authorized Ground Stations", "readOnly": true, "items": { "$ref": "#/definitions/AuthorizedGroundstation" @@ -1266,11 +1268,8 @@ "properties": { "properties": { "x-ms-client-flatten": true, - "allOf": [ - { - "$ref": "#/definitions/SpacecraftsProperties" - } - ] + "$ref": "#/definitions/SpacecraftsProperties", + "description": "Spacecraft Properties" }, "etag": { "readOnly": true, @@ -1584,21 +1583,22 @@ }, "modulationConfiguration": { "type": "string", - "description": "" + "description": "Configuration for modulation" }, "demodulationConfiguration": { "type": "string", - "description": "" + "description": "Configuration for demodulation" }, "encodingConfiguration": { "type": "string", - "description": "" + "description": "Configuration for encoding" }, "decodingConfiguration": { "type": "string", - "description": "" + "description": "Configuration for decoding" } - } + }, + "description": "Contact Profile Link Channel" }, "ContactProfileLink": { "type": "object", @@ -1651,7 +1651,13 @@ "type": "array", "items": { "$ref": "#/definitions/ContactProfileLinkChannel" - } + }, + "x-ms-identifiers": [ + "centerFrequencyMHz", + "bandwidthMHz", + "/endPoint/endPointName" + ], + "description": "Contact Profile Link Channel" } } }, @@ -1791,6 +1797,7 @@ "type": "object", "properties": { "properties": { + "x-ms-client-flatten": true, "$ref": "#/definitions/ContactsProperties" }, "etag": { @@ -1827,6 +1834,9 @@ "items": { "$ref": "#/definitions/CloudErrorBody" }, + "x-ms-identifiers": [ + "code" + ], "description": "A list of additional details about the error." } }, @@ -1850,6 +1860,7 @@ "items": { "$ref": "#/definitions/AvailableContacts" }, + "x-ms-identifiers": [], "description": "A list of available contacts" }, "nextLink": { @@ -2091,6 +2102,7 @@ "readOnly": true }, "properties": { + "x-ms-client-flatten": true, "$ref": "#/definitions/OperationResultProperties" }, "error": { From b0dbd788761bb60c574a94144770070fe2d51df0 Mon Sep 17 00:00:00 2001 From: Devanshu Singh Date: Fri, 18 Mar 2022 17:46:19 -0400 Subject: [PATCH 23/26] lint diff warnings 2 --- .../Microsoft.Orbital/stable/2022-03-01/orbital.json | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/specification/orbital/resource-manager/Microsoft.Orbital/stable/2022-03-01/orbital.json b/specification/orbital/resource-manager/Microsoft.Orbital/stable/2022-03-01/orbital.json index d456fc772f7a..9b416b90aa36 100644 --- a/specification/orbital/resource-manager/Microsoft.Orbital/stable/2022-03-01/orbital.json +++ b/specification/orbital/resource-manager/Microsoft.Orbital/stable/2022-03-01/orbital.json @@ -1456,6 +1456,7 @@ }, "sourceIps": { "type": "array", + "description": "List of Source IP", "items": { "type": "string", "description": "The source IP a packet can have when being sent. You need to make sure you accept data from all these IPs in your application." @@ -1659,7 +1660,8 @@ ], "description": "Contact Profile Link Channel" } - } + }, + "description": "Contact Profile Link" }, "ContactProfile": { "type": "object", From 8e9c0a69b9e0ff2e10fd632517130066caa6e9ef Mon Sep 17 00:00:00 2001 From: Devanshu Singh Date: Thu, 24 Mar 2022 00:25:42 -0400 Subject: [PATCH 24/26] prettier fix --- .../2021-04-04-preview/examples/ContactProfileCreate.json | 2 +- .../preview/2021-04-04-preview/examples/ContactProfileGet.json | 2 +- .../2021-04-04-preview/examples/ContactProfileUpdateTag.json | 2 +- .../examples/ContactProfilesByResourceGroupList.json | 2 +- .../examples/ContactProfilesBySubscriptionList.json | 2 +- .../Microsoft.Orbital/preview/2021-04-04-preview/orbital.json | 2 +- 6 files changed, 6 insertions(+), 6 deletions(-) diff --git a/specification/orbital/resource-manager/Microsoft.Orbital/preview/2021-04-04-preview/examples/ContactProfileCreate.json b/specification/orbital/resource-manager/Microsoft.Orbital/preview/2021-04-04-preview/examples/ContactProfileCreate.json index 295a92937487..31d0ea8989d1 100644 --- a/specification/orbital/resource-manager/Microsoft.Orbital/preview/2021-04-04-preview/examples/ContactProfileCreate.json +++ b/specification/orbital/resource-manager/Microsoft.Orbital/preview/2021-04-04-preview/examples/ContactProfileCreate.json @@ -182,4 +182,4 @@ } } } -} \ No newline at end of file +} diff --git a/specification/orbital/resource-manager/Microsoft.Orbital/preview/2021-04-04-preview/examples/ContactProfileGet.json b/specification/orbital/resource-manager/Microsoft.Orbital/preview/2021-04-04-preview/examples/ContactProfileGet.json index 5a18ab0176e1..70cb971c6a13 100644 --- a/specification/orbital/resource-manager/Microsoft.Orbital/preview/2021-04-04-preview/examples/ContactProfileGet.json +++ b/specification/orbital/resource-manager/Microsoft.Orbital/preview/2021-04-04-preview/examples/ContactProfileGet.json @@ -67,4 +67,4 @@ } } } -} \ No newline at end of file +} diff --git a/specification/orbital/resource-manager/Microsoft.Orbital/preview/2021-04-04-preview/examples/ContactProfileUpdateTag.json b/specification/orbital/resource-manager/Microsoft.Orbital/preview/2021-04-04-preview/examples/ContactProfileUpdateTag.json index 7db184013d53..4d96987b4ace 100644 --- a/specification/orbital/resource-manager/Microsoft.Orbital/preview/2021-04-04-preview/examples/ContactProfileUpdateTag.json +++ b/specification/orbital/resource-manager/Microsoft.Orbital/preview/2021-04-04-preview/examples/ContactProfileUpdateTag.json @@ -77,4 +77,4 @@ } } } -} \ No newline at end of file +} diff --git a/specification/orbital/resource-manager/Microsoft.Orbital/preview/2021-04-04-preview/examples/ContactProfilesByResourceGroupList.json b/specification/orbital/resource-manager/Microsoft.Orbital/preview/2021-04-04-preview/examples/ContactProfilesByResourceGroupList.json index 91d5d820cce4..ed74e9db2e8e 100644 --- a/specification/orbital/resource-manager/Microsoft.Orbital/preview/2021-04-04-preview/examples/ContactProfilesByResourceGroupList.json +++ b/specification/orbital/resource-manager/Microsoft.Orbital/preview/2021-04-04-preview/examples/ContactProfilesByResourceGroupList.json @@ -71,4 +71,4 @@ } } } -} \ No newline at end of file +} diff --git a/specification/orbital/resource-manager/Microsoft.Orbital/preview/2021-04-04-preview/examples/ContactProfilesBySubscriptionList.json b/specification/orbital/resource-manager/Microsoft.Orbital/preview/2021-04-04-preview/examples/ContactProfilesBySubscriptionList.json index 91d5d820cce4..ed74e9db2e8e 100644 --- a/specification/orbital/resource-manager/Microsoft.Orbital/preview/2021-04-04-preview/examples/ContactProfilesBySubscriptionList.json +++ b/specification/orbital/resource-manager/Microsoft.Orbital/preview/2021-04-04-preview/examples/ContactProfilesBySubscriptionList.json @@ -71,4 +71,4 @@ } } } -} \ No newline at end of file +} diff --git a/specification/orbital/resource-manager/Microsoft.Orbital/preview/2021-04-04-preview/orbital.json b/specification/orbital/resource-manager/Microsoft.Orbital/preview/2021-04-04-preview/orbital.json index e4802c55be54..7ed1ea740acc 100644 --- a/specification/orbital/resource-manager/Microsoft.Orbital/preview/2021-04-04-preview/orbital.json +++ b/specification/orbital/resource-manager/Microsoft.Orbital/preview/2021-04-04-preview/orbital.json @@ -1845,4 +1845,4 @@ "x-ms-parameter-location": "method" } } -} \ No newline at end of file +} From f36a3d40f3bac4d4fdf55b56bfb6c10d679e3e5a Mon Sep 17 00:00:00 2001 From: Devanshu Singh Date: Wed, 30 Mar 2022 00:20:38 -0400 Subject: [PATCH 25/26] readme.me updated 2022-03-01 --- specification/orbital/resource-manager/readme.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/specification/orbital/resource-manager/readme.md b/specification/orbital/resource-manager/readme.md index 325cb2a31828..63932a1b74e6 100644 --- a/specification/orbital/resource-manager/readme.md +++ b/specification/orbital/resource-manager/readme.md @@ -26,7 +26,7 @@ These are the global settings for the orbital. ```yaml openapi-type: arm -tag: package-2021-04-04-preview +tag: package-2022-03-01 ``` ### Tag: package-2022-03-01 From b92ba5adb881e99059347e93a26873da1c5e41e0 Mon Sep 17 00:00:00 2001 From: Yuchao Yan Date: Fri, 8 Apr 2022 11:38:58 +0800 Subject: [PATCH 26/26] Update readme.python.md --- specification/orbital/resource-manager/readme.python.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/specification/orbital/resource-manager/readme.python.md b/specification/orbital/resource-manager/readme.python.md index 6ade02d03db5..189c4836ed2b 100644 --- a/specification/orbital/resource-manager/readme.python.md +++ b/specification/orbital/resource-manager/readme.python.md @@ -15,4 +15,9 @@ clear-output-folder: true ``` yaml $(python) no-namespace-folders: true output-folder: $(python-sdks-folder)/orbital/azure-mgmt-orbital/azure/mgmt/orbital -``` \ No newline at end of file +``` + +``` yaml $(python) +modelerfour: + lenient-model-deduplication: true +```