From 8c7612b823f693c6d7bc607594ed30b5ecb72730 Mon Sep 17 00:00:00 2001 From: Devanshu Singh <8132290+thisisdevanshu@users.noreply.github.com> Date: Wed, 17 Nov 2021 21:33:08 -0500 Subject: [PATCH] [Hub Generated] Public private branch 'dev-orbital-Microsoft.Orbital-2021-04-04-preview' (#16781) * New Swagger Spec File * New Swagger Example Spec File * New Readme Config File * New Azure AZ Readme Config File * New Azure CLI Readme Config File * New Go Language Readme Config File * New Python Language Readme Config File * New Typescript Language Readme Config File * New C# Language Readme Config File * Orbital sdk 2021 04 04 preview (#5253) * New Readme Config File * New Go Language Readme Config File * New Typescript Language Readme Config File * New Python Language Readme Config File * New C# Language Readme Config File * New Ruby Language Readme Config File * New Swagger Spec File * New Swagger Example Spec File * Added orbital.json file * Passed linting using AutoRest for 2020-09-01 Azure Orbital Private Privew * Updated Operation object under Azure Orbital 2020-09-01 preview. * Updated Operation object under Azure Orbital 2020-09-01 preview. * Updated Satellites object for Azure Orbital 2020-09-01 preview * Updated examples for Azure Orbital Private Preview 2020-09-01 * Updated examples for Azure Orbital Private Preview 2020-09-01 * Updated examples for Azure Orbital Private Preview 2020-09-01 * Addressed feedback from ARMChangesRequested * Updated the GetAvailableContacts api to add long running operation * Updated the api version * Updated the objects based on discussion with PM. * list available ground station made a POST request (#2521) * list available ground station made a POST request * Swagger LintDiff fix Co-authored-by: Devanshu Singh * 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 * operation IDs updated (#5461) Co-authored-by: Devanshu Singh * Dev orbital microsoft.orbital 2021 04 04 preview (#5491) * operation IDs updated * updated OperationListResult definition * review points implemented Co-authored-by: Devanshu Singh * 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 * 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 * 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 * 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 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 Co-authored-by: ArcturusZhang --- 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/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 | 1829 +++++++++++++++++ .../orbital/resource-manager/readme.az.md | 28 + .../orbital/resource-manager/readme.cli.md | 1 + .../orbital/resource-manager/readme.csharp.md | 15 + .../orbital/resource-manager/readme.go.md | 11 + .../orbital/resource-manager/readme.md | 77 + .../orbital/resource-manager/readme.python.md | 23 + .../resource-manager/readme.typescript.md | 14 + 29 files changed, 3113 insertions(+) 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 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 create mode 100644 specification/orbital/resource-manager/Microsoft.Orbital/preview/2021-04-04-preview/orbital.json create mode 100644 specification/orbital/resource-manager/readme.az.md create mode 100644 specification/orbital/resource-manager/readme.cli.md create mode 100644 specification/orbital/resource-manager/readme.csharp.md create mode 100644 specification/orbital/resource-manager/readme.go.md create mode 100644 specification/orbital/resource-manager/readme.md create mode 100644 specification/orbital/resource-manager/readme.python.md create mode 100644 specification/orbital/resource-manager/readme.typescript.md diff --git a/custom-words.txt b/custom-words.txt index c8fc8175067f..8a82526fe146 100644 --- a/custom-words.txt +++ b/custom-words.txt @@ -638,6 +638,8 @@ Edgenode edgenodes EDIFACT EDMX +EIRP +eirpd Einsteinweg Ekaterinburg ekus @@ -835,6 +837,7 @@ GRANTACE granularities graphrbac Greenplum +groundstation Groupby groupedby GRPC @@ -1073,6 +1076,8 @@ leavingpool LEDs legalhold Lfot +LHCP +Lhcp libtrust lifecycle lifecycles @@ -1713,6 +1718,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/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 new file mode 100644 index 000000000000..c8d0a4592c47 --- /dev/null +++ b/specification/orbital/resource-manager/Microsoft.Orbital/preview/2021-04-04-preview/orbital.json @@ -0,0 +1,1829 @@ +{ + "swagger": "2.0", + "info": { + "version": "2021-04-04-preview", + "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": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/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": "../../../../../common-types/resource-management/v3/types.json#/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": "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/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/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": "Spacecrafts_Get", + "description": "Gets the specified spacecraft in a specified resource group", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/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/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/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": "Spacecrafts_Delete", + "description": "Deletes a specified spacecraft resource.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/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": "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/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/spacecraftNameParameter" + }, + { + "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/ApiVersionParameter" + } + ], + "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": [ + "Contact" + ], + "description": "Returns list of contacts by spacecraftName", + "operationId": "Contacts_List", + "x-ms-examples": { + "List of Contacts": { + "$ref": "./examples/ContactsBySpacecraftNameList.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/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": [ + "Contact" + ], + "operationId": "Contacts_Get", + "description": "Gets the specified contact in a specified resource group", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/spacecraftNameParameter" + }, + { + "$ref": "#/parameters/contactNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "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/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$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." + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "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": "Contacts_Delete", + "description": "Deletes a specified contact", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/spacecraftNameParameter" + }, + { + "$ref": "#/parameters/contactNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "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": "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": "azure-async-operation" + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$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." + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "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": "ContactProfiles_Get", + "description": "Gets the specified contact Profile in a specified resource group", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/contactProfileNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "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/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/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": "ContactProfiles_Delete", + "description": "Deletes a specified contact profile resource.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/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": "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/SubscriptionIdParameter" + }, + { + "$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/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": "ContactProfiles_ListBySubscription", + "x-ms-examples": { + "List of Contact Profiles by Subscription": { + "$ref": "./examples/ContactProfilesBySubscriptionList.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/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": "ContactProfiles_List", + "x-ms-examples": { + "List of Contact Profiles by Resource Group": { + "$ref": "./examples/ContactProfilesByResourceGroupList.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/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": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/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": "../../../../../common-types/resource-management/v3/types.json#/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, + "$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": "../../../../../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" + }, + "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." + }, + "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": { + "$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 + }, + "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 + } + }, + "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" + }, + "description": "Contact Profile Link Channel" + } + }, + "description": "Contact Profile link" + }, + "ContactProfile": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$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." + } + }, + "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": { + "$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": { + "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": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ], + "description": "Customer creates a contact resource for a spacecraft resource." + }, + "CloudErrorBody": { + "x-ms-external": true, + "type": "object", + "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": { + "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": { + "$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, + "$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, + "$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" + ] + }, + "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": { + "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" + ], + "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.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 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 diff --git a/specification/orbital/resource-manager/readme.csharp.md b/specification/orbital/resource-manager/readme.csharp.md new file mode 100644 index 000000000000..4d2d5ea6cbe7 --- /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 +``` \ No newline at end of file diff --git a/specification/orbital/resource-manager/readme.go.md b/specification/orbital/resource-manager/readme.go.md new file mode 100644 index 000000000000..0d2ae571be72 --- /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/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 diff --git a/specification/orbital/resource-manager/readme.md b/specification/orbital/resource-manager/readme.md new file mode 100644 index 000000000000..6e42dd89d6b8 --- /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) \ No newline at end of file diff --git a/specification/orbital/resource-manager/readme.python.md b/specification/orbital/resource-manager/readme.python.md new file mode 100644 index 000000000000..a9f5c099a5a4 --- /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 +``` \ No newline at end of file diff --git a/specification/orbital/resource-manager/readme.typescript.md b/specification/orbital/resource-manager/readme.typescript.md new file mode 100644 index 000000000000..1fd450daf586 --- /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 +``` \ No newline at end of file