diff --git a/custom-words.txt b/custom-words.txt index 65ed31f317a2..4fa60af3b575 100644 --- a/custom-words.txt +++ b/custom-words.txt @@ -631,6 +631,8 @@ Edgenode edgenodes EDIFACT EDMX +EIRP +eirpd Einsteinweg Ekaterinburg ekus @@ -821,6 +823,7 @@ GRANTACE granularities graphrbac Greenplum +groundstation Groupby groupedby GRPC @@ -1055,6 +1058,8 @@ leavingpool LEDs legalhold Lfot +LHCP +Lhcp libtrust lifecycle lifecycles @@ -1690,6 +1695,8 @@ REVOKEACE RGBARGBA RGBRGB rgname +RHCP +Rhcp rhel RIRs rmem diff --git a/specification/orbital/resource-manager/Microsoft.Orbital/preview/2021-04-04-preview/examples/AvailableContactsList.json b/specification/orbital/resource-manager/Microsoft.Orbital/preview/2021-04-04-preview/examples/AvailableContactsList.json new file mode 100644 index 000000000000..2a6f279cc11b --- /dev/null +++ b/specification/orbital/resource-manager/Microsoft.Orbital/preview/2021-04-04-preview/examples/AvailableContactsList.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "api-version": "2021-04-04-preview", + "subscriptionId": "subid", + "resourceGroupName": "rgName", + "spacecraftName": "AQUA", + "parameters": { + "contactProfile": { + "id": "/subscriptions/subId/resourceGroups/rg/Microsoft.Orbital/contactProfiles/AQUA_DIRECTPLAYBACK_WITH_UPLINK" + }, + "groundStationName": "westus_gs1", + "startTime": "2020-07-16T05:40:21.00Z", + "endTime": "2020-07-17T23:49:40.00Z" + } + }, + "responses": { + "200": { + "body": { + "value": [ + { + "spacecraft": { + "id": "/subscriptions/subId/resourceGroups/rg/Microsoft.Orbital/spacecrafts/AQUA" + }, + "groundStationName": "westus_gs1", + "properties": { + "maximumElevationDegrees": 70.94, + "rxStartTime": "2020-07-16T20:40:21.00Z", + "rxEndTime": "2020-07-16T20:49:40.00Z", + "txStartTime": "2020-07-16T20:40:21.00Z", + "txEndTime": "2020-07-16T20:49:40.00Z", + "startAzimuthDegrees": 148.237, + "endAzimuthDegrees": 353.837, + "startElevationDegrees": 10.0, + "endElevationDegrees": 10.0 + } + }, + { + "spacecraft": { + "id": "/subscriptions/subId/resourceGroups/rg/Microsoft.Orbital/spacecrafts/AQUA" + }, + "groundStationName": "westus_gs1", + "properties": { + "maximumElevationDegrees": 87.153, + "rxStartTime": "2020-07-17T10:13:55.00Z", + "rxEndTime": "2020-07-17T10:23:30.00Z", + "txStartTime": "2020-07-17T10:13:55.00Z", + "txEndTime": "2020-07-17T10:23:30.00Z", + "startAzimuthDegrees": 14.392, + "endAzimuthDegrees": 194.36, + "startElevationDegrees": 10.0, + "endElevationDegrees": 10.0 + } + } + ], + "nextLink": "string" + } + } + } +} diff --git a/specification/orbital/resource-manager/Microsoft.Orbital/preview/2021-04-04-preview/examples/AvailableGroundStationGet.json b/specification/orbital/resource-manager/Microsoft.Orbital/preview/2021-04-04-preview/examples/AvailableGroundStationGet.json new file mode 100644 index 000000000000..782e5291c0d2 --- /dev/null +++ b/specification/orbital/resource-manager/Microsoft.Orbital/preview/2021-04-04-preview/examples/AvailableGroundStationGet.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "api-version": "2021-04-04-preview", + "subscriptionId": "subid", + "groundStationName": "westus_gs1" + }, + "responses": { + "200": { + "body": { + "name": "westus_gs1", + "location": "westus", + "id": "/subscriptions/subid/providers/Microsoft.Orbital/availableGroundStations/westus_gs1", + "type": "Microsoft.Orbital/availableGroundStations", + "properties": { + "city": "redmond", + "providerName": "Microsoft", + "longitudeDegrees": 47.674, + "latitudeDegrees": -122.122, + "altitudeMeters": 1500.83 + } + } + } + } +} diff --git a/specification/orbital/resource-manager/Microsoft.Orbital/preview/2021-04-04-preview/examples/AvailableGroundStationsByCapabilityList.json b/specification/orbital/resource-manager/Microsoft.Orbital/preview/2021-04-04-preview/examples/AvailableGroundStationsByCapabilityList.json new file mode 100644 index 000000000000..af85bcb2551a --- /dev/null +++ b/specification/orbital/resource-manager/Microsoft.Orbital/preview/2021-04-04-preview/examples/AvailableGroundStationsByCapabilityList.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "api-version": "2021-04-04-preview", + "subscriptionId": "subId", + "capability": "EarthObservation" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "westus_gs1", + "location": "westus", + "id": "/subscriptions/subId/providers/Microsoft.Orbital/availableGroundStations/westus_gs1", + "type": "Microsoft.Orbital/availableGroundStations", + "properties": { + "city": "redmond", + "providerName": "Microsoft", + "longitudeDegrees": 47.674, + "latitudeDegrees": -122.122, + "altitudeMeters": 1500.83 + } + }, + { + "name": "westus_gs2", + "location": "westus", + "id": "/subscriptions/subId/providers/Microsoft.Orbital/availableGroundStations/westus_gs2", + "type": "Microsoft.Orbital/availableGroundStations", + "properties": { + "city": "redmond", + "providerName": "Microsoft", + "longitudeDegrees": 47.674, + "latitudeDegrees": -122.122, + "altitudeMeters": 1500.83 + } + } + ], + "nextLink": "string" + } + } + } +} diff --git a/specification/orbital/resource-manager/Microsoft.Orbital/preview/2021-04-04-preview/examples/ContactCreate.json b/specification/orbital/resource-manager/Microsoft.Orbital/preview/2021-04-04-preview/examples/ContactCreate.json new file mode 100644 index 000000000000..ef80f8f8a95c --- /dev/null +++ b/specification/orbital/resource-manager/Microsoft.Orbital/preview/2021-04-04-preview/examples/ContactCreate.json @@ -0,0 +1,73 @@ +{ + "parameters": { + "api-version": "2021-04-04-preview", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "contactName": "contact1", + "spacecraftName": "AQUA", + "parameters": { + "properties": { + "reservationStartTime": "2020-07-16T20:35:00.00Z", + "reservationEndTime": "2020-07-16T20:55:00.00Z", + "groundStationName": "westus_gs1", + "contactProfile": { + "id": "/subscriptions/subId/resourceGroups/rg/Microsoft.Orbital/contactProfiles/AQUA_DIRECTPLAYBACK_WITH_UPLINK" + } + } + } + }, + "responses": { + "200": { + "body": { + "name": "contact1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Orbital/spacecrafts/AQUA/contacts/contact1", + "properties": { + "status": "scheduled", + "reservationStartTime": "2020-07-16T20:35:00.00Z", + "reservationEndTime": "2020-07-16T20:55:00.00Z", + "rxStartTime": "2020-07-16T20:40:21.00Z", + "rxEndTime": "2020-07-16T20:49:40.00Z", + "txStartTime": "2020-07-16T20:40:21.00Z", + "txEndTime": "2020-07-16T20:49:40.00Z", + "errorMessage": "", + "maximumElevationDegrees": 70.94, + "startAzimuthDegrees": 148.237, + "endAzimuthDegrees": 353.837, + "startElevationDegrees": 10.0, + "endElevationDegrees": 10.0, + "groundStationName": "westus_gs1", + "contactProfile": { + "id": "/subscriptions/subId/resourceGroups/rg/Microsoft.Orbital/contactProfiles/AQUA_DIRECTPLAYBACK_WITH_UPLINK" + } + }, + "type": "Microsoft.Orbital/contacts" + } + }, + "201": { + "body": { + "name": "contact1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Orbital/spacecrafts/AQUA/contacts/contact1", + "properties": { + "status": "scheduled", + "reservationStartTime": "2020-07-16T20:35:00.00Z", + "reservationEndTime": "2020-07-16T20:55:00.00Z", + "rxStartTime": "2020-07-16T20:40:21.00Z", + "rxEndTime": "2020-07-16T20:49:40.00Z", + "txStartTime": "2020-07-16T20:40:21.00Z", + "txEndTime": "2020-07-16T20:49:40.00Z", + "errorMessage": "", + "maximumElevationDegrees": 70.94, + "startAzimuthDegrees": 148.237, + "endAzimuthDegrees": 353.837, + "startElevationDegrees": 10.0, + "endElevationDegrees": 10.0, + "groundStationName": "westus_gs1", + "contactProfile": { + "id": "/subscriptions/subId/resourceGroups/rg/Microsoft.Orbital/contactProfiles/AQUA_DIRECTPLAYBACK_WITH_UPLINK" + } + }, + "type": "Microsoft.Orbital/contacts" + } + } + } +} diff --git a/specification/orbital/resource-manager/Microsoft.Orbital/preview/2021-04-04-preview/examples/ContactDelete.json b/specification/orbital/resource-manager/Microsoft.Orbital/preview/2021-04-04-preview/examples/ContactDelete.json new file mode 100644 index 000000000000..ae80d2569db8 --- /dev/null +++ b/specification/orbital/resource-manager/Microsoft.Orbital/preview/2021-04-04-preview/examples/ContactDelete.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "api-version": "2021-04-04-preview", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "spacecraftName": "AQUA", + "contactName": "contact1" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/orbital/resource-manager/Microsoft.Orbital/preview/2021-04-04-preview/examples/ContactGet.json b/specification/orbital/resource-manager/Microsoft.Orbital/preview/2021-04-04-preview/examples/ContactGet.json new file mode 100644 index 000000000000..9b10f94c0486 --- /dev/null +++ b/specification/orbital/resource-manager/Microsoft.Orbital/preview/2021-04-04-preview/examples/ContactGet.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "api-version": "2021-04-04-preview", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "spacecraftName": "AQUA", + "contactName": "contact1" + }, + "responses": { + "200": { + "body": { + "name": "contact1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Orbital/spacecrafts/AQUA/contacts/contact1", + "properties": { + "status": "scheduled", + "reservationStartTime": "2020-07-16T20:35:00.00Z", + "reservationEndTime": "2020-07-16T20:55:00.00Z", + "rxStartTime": "2020-07-16T20:40:21.00Z", + "rxEndTime": "2020-07-16T20:49:40.00Z", + "txStartTime": "2020-07-16T20:40:21.00Z", + "txEndTime": "2020-07-16T20:49:40.00Z", + "errorMessage": "", + "maximumElevationDegrees": 70.94, + "startAzimuthDegrees": 148.237, + "endAzimuthDegrees": 353.837, + "startElevationDegrees": 10.0, + "endElevationDegrees": 10.0, + "groundStationName": "westus_gs1", + "contactProfile": { + "id": "/subscriptions/subId/resourceGroups/rg/Microsoft.Orbital/contactProfiles/AQUA_DIRECTPLAYBACK_WITH_UPLINK" + } + }, + "type": "Microsoft.Orbital/contacts" + } + } + } +} diff --git a/specification/orbital/resource-manager/Microsoft.Orbital/preview/2021-04-04-preview/examples/ContactProfileCreate.json b/specification/orbital/resource-manager/Microsoft.Orbital/preview/2021-04-04-preview/examples/ContactProfileCreate.json new file mode 100644 index 000000000000..4070e8fddd14 --- /dev/null +++ b/specification/orbital/resource-manager/Microsoft.Orbital/preview/2021-04-04-preview/examples/ContactProfileCreate.json @@ -0,0 +1,182 @@ +{ + "parameters": { + "api-version": "2021-04-04-preview", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "contactProfileName": "AQUA_DIRECTPLAYBACK_WITH_UPLINK", + "parameters": { + "location": "westus", + "properties": { + "minimumViableContactDuration": "PT1M", + "minimumElevationDegrees": 10, + "autoTrackingConfiguration": "xBand", + "links": [ + { + "polarization": "RHCP", + "direction": "uplink", + "gainOverTemperature": 0, + "eirpdBW": 45, + "channels": [ + { + "centerFrequencyMHz": 2106.4063, + "bandwidthMHz": 0.036, + "endPoint": { + "ipAddress": "10.0.1.0", + "endPointName": "AQUA_command", + "port": "4000", + "protocol": "TCP" + }, + "modulationConfiguration": "AQUA_UPLINK_BPSK", + "demodulationConfiguration": "na", + "encodingConfiguration": "AQUA_CMD_CCSDS", + "decodingConfiguration": "na" + } + ] + }, + { + "polarization": "RHCP", + "direction": "downlink", + "gainOverTemperature": 25, + "eirpdBW": 0, + "channels": [ + { + "centerFrequencyMHz": 8160, + "bandwidthMHz": 150, + "endPoint": { + "ipAddress": "10.0.2.0", + "endPointName": "AQUA_directplayback", + "port": "4000", + "protocol": "TCP" + }, + "modulationConfiguration": "na", + "demodulationConfiguration": "AQUA_DOWNLINK_QPSK", + "encodingConfiguration": "na", + "decodingConfiguration": "AQUA_DIRECTPLAYBACK_CCSDS" + } + ] + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "name": "AQUA_DIRECTPLAYBACK_WITH_UPLINK", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Orbital/contactProfiles/AQUA_DIRECTPLAYBACK_WITH_UPLINK", + "location": "westus", + "properties": { + "minimumViableContactDuration": "PT1M", + "minimumElevationDegrees": 10, + "autoTrackingConfiguration": "xBand", + "links": [ + { + "polarization": "RHCP", + "direction": "uplink", + "gainOverTemperature": 0, + "eirpdBW": 45, + "channels": [ + { + "centerFrequencyMHz": 2106.4063, + "bandwidthMHz": 0.036, + "endPoint": { + "ipAddress": "10.0.1.0", + "endPointName": "AQUA_command", + "port": "4000", + "protocol": "TCP" + }, + "modulationConfiguration": "AQUA_UPLINK_BPSK", + "demodulationConfiguration": "na", + "encodingConfiguration": "AQUA_CMD_CCSDS", + "decodingConfiguration": "na" + } + ] + }, + { + "polarization": "RHCP", + "direction": "downlink", + "gainOverTemperature": 25, + "eirpdBW": 0, + "channels": [ + { + "centerFrequencyMHz": 8160, + "bandwidthMHz": 150, + "endPoint": { + "ipAddress": "10.0.2.0", + "endPointName": "AQUA_directplayback", + "port": "4000", + "protocol": "TCP" + }, + "modulationConfiguration": "na", + "demodulationConfiguration": "AQUA_DOWNLINK_QPSK", + "encodingConfiguration": "na", + "decodingConfiguration": "AQUA_DIRECTPLAYBACK_CCSDS" + } + ] + } + ] + }, + "type": "Microsoft.Orbital/contactProfiles" + } + }, + "201": { + "body": { + "name": "contactProfile1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Orbital/contactProfiles/contactProfile1", + "location": "westus", + "properties": { + "minimumViableContactDuration": "PT1M", + "minimumElevationDegrees": 10, + "autoTrackingConfiguration": "xBand", + "links": [ + { + "polarization": "RHCP", + "direction": "uplink", + "gainOverTemperature": 0, + "eirpdBW": 45, + "channels": [ + { + "centerFrequencyMHz": 2106.4063, + "bandwidthMHz": 0.036, + "endPoint": { + "ipAddress": "10.0.1.0", + "endPointName": "AQUA_command", + "port": "4000", + "protocol": "TCP" + }, + "modulationConfiguration": "AQUA_UPLINK_BPSK", + "demodulationConfiguration": "na", + "encodingConfiguration": "AQUA_CMD_CCSDS", + "decodingConfiguration": "na" + } + ] + }, + { + "polarization": "RHCP", + "direction": "downlink", + "gainOverTemperature": 25, + "eirpdBW": 0, + "channels": [ + { + "centerFrequencyMHz": 8160, + "bandwidthMHz": 150, + "endPoint": { + "ipAddress": "10.0.2.0", + "endPointName": "AQUA_directplayback", + "port": "4000", + "protocol": "TCP" + }, + "modulationConfiguration": "na", + "demodulationConfiguration": "AQUA_DOWNLINK_QPSK", + "encodingConfiguration": "na", + "decodingConfiguration": "AQUA_DIRECTPLAYBACK_CCSDS" + } + ] + } + ] + }, + "type": "Microsoft.Orbital/contactProfiles" + } + } + } +} diff --git a/specification/orbital/resource-manager/Microsoft.Orbital/preview/2021-04-04-preview/examples/ContactProfileDelete.json b/specification/orbital/resource-manager/Microsoft.Orbital/preview/2021-04-04-preview/examples/ContactProfileDelete.json new file mode 100644 index 000000000000..19c7bc19f3da --- /dev/null +++ b/specification/orbital/resource-manager/Microsoft.Orbital/preview/2021-04-04-preview/examples/ContactProfileDelete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2021-04-04-preview", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "contactProfileName": "AQUA_DIRECTPLAYBACK_WITH_UPLINK" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/orbital/resource-manager/Microsoft.Orbital/preview/2021-04-04-preview/examples/ContactProfileGet.json b/specification/orbital/resource-manager/Microsoft.Orbital/preview/2021-04-04-preview/examples/ContactProfileGet.json new file mode 100644 index 000000000000..a2c64f92db8c --- /dev/null +++ b/specification/orbital/resource-manager/Microsoft.Orbital/preview/2021-04-04-preview/examples/ContactProfileGet.json @@ -0,0 +1,69 @@ +{ + "parameters": { + "api-version": "2021-04-04-preview", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "contactProfileName": "AQUA_DIRECTPLAYBACK_WITH_UPLINK" + }, + "responses": { + "200": { + "body": { + "name": "AQUA_DIRECTPLAYBACK_WITH_UPLINK", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Orbital/contactProfiles/AQUA_DIRECTPLAYBACK_WITH_UPLINK", + "location": "westus", + "properties": { + "minimumViableContactDuration": "PT1M", + "minimumElevationDegrees": 10, + "autoTrackingConfiguration": "xBand", + "links": [ + { + "polarization": "RHCP", + "direction": "uplink", + "gainOverTemperature": 0, + "eirpdBW": 45, + "channels": [ + { + "centerFrequencyMHz": 2106.4063, + "bandwidthMHz": 0.036, + "endPoint": { + "ipAddress": "10.0.1.0", + "endPointName": "AQUA_command", + "port": "4000", + "protocol": "TCP" + }, + "modulationConfiguration": "AQUA_UPLINK_BPSK", + "demodulationConfiguration": "na", + "encodingConfiguration": "AQUA_CMD_CCSDS", + "decodingConfiguration": "na" + } + ] + }, + { + "polarization": "RHCP", + "direction": "downlink", + "gainOverTemperature": 25, + "eirpdBW": 0, + "channels": [ + { + "centerFrequencyMHz": 8160, + "bandwidthMHz": 150, + "endPoint": { + "ipAddress": "10.0.2.0", + "endPointName": "AQUA_directplayback", + "port": "4000", + "protocol": "TCP" + }, + "modulationConfiguration": "na", + "demodulationConfiguration": "AQUA_DOWNLINK_QPSK", + "encodingConfiguration": "na", + "decodingConfiguration": "AQUA_DIRECTPLAYBACK_CCSDS" + } + ] + } + ] + }, + "type": "Microsoft.Orbital/contactProfiles" + } + } + } +} diff --git a/specification/orbital/resource-manager/Microsoft.Orbital/preview/2021-04-04-preview/examples/ContactProfileUpdateTag.json b/specification/orbital/resource-manager/Microsoft.Orbital/preview/2021-04-04-preview/examples/ContactProfileUpdateTag.json new file mode 100644 index 000000000000..6719ea248a4c --- /dev/null +++ b/specification/orbital/resource-manager/Microsoft.Orbital/preview/2021-04-04-preview/examples/ContactProfileUpdateTag.json @@ -0,0 +1,79 @@ +{ + "parameters": { + "api-version": "2021-04-04-preview", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "contactProfileName": "AQUA_DIRECTPLAYBACK_WITH_UPLINK", + "parameters": { + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + }, + "responses": { + "200": { + "body": { + "name": "AQUA_DIRECTPLAYBACK_WITH_UPLINK", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Orbital/contactProfiles/AQUA_DIRECTPLAYBACK_WITH_UPLINK", + "location": "westus", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "minimumViableContactDuration": "PT1M", + "minimumElevationDegrees": 10, + "autoTrackingConfiguration": "xBand", + "links": [ + { + "polarization": "RHCP", + "direction": "uplink", + "gainOverTemperature": 0, + "eirpdBW": 45, + "channels": [ + { + "centerFrequencyMHz": 2106.4063, + "bandwidthMHz": 0.036, + "endPoint": { + "ipAddress": "10.0.1.0", + "endPointName": "AQUA_command", + "port": "4000", + "protocol": "TCP" + }, + "modulationConfiguration": "AQUA_UPLINK_BPSK", + "demodulationConfiguration": "na", + "encodingConfiguration": "AQUA_CMD_CCSDS", + "decodingConfiguration": "na" + } + ] + }, + { + "polarization": "RHCP", + "direction": "downlink", + "gainOverTemperature": 25, + "eirpdBW": 0, + "channels": [ + { + "centerFrequencyMHz": 8160, + "bandwidthMHz": 150, + "endPoint": { + "ipAddress": "10.0.2.0", + "endPointName": "AQUA_directplayback", + "port": "4000", + "protocol": "TCP" + }, + "modulationConfiguration": "na", + "demodulationConfiguration": "AQUA_DOWNLINK_QPSK", + "encodingConfiguration": "na", + "decodingConfiguration": "AQUA_DIRECTPLAYBACK_CCSDS" + } + ] + } + ] + }, + "type": "Microsoft.Orbital/contactProfiles" + } + } + } +} diff --git a/specification/orbital/resource-manager/Microsoft.Orbital/preview/2021-04-04-preview/examples/ContactProfilesByResourceGroupList.json b/specification/orbital/resource-manager/Microsoft.Orbital/preview/2021-04-04-preview/examples/ContactProfilesByResourceGroupList.json new file mode 100644 index 000000000000..97a974eb3e41 --- /dev/null +++ b/specification/orbital/resource-manager/Microsoft.Orbital/preview/2021-04-04-preview/examples/ContactProfilesByResourceGroupList.json @@ -0,0 +1,73 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "api-version": "2021-04-04-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "AQUA_DIRECTPLAYBACK_WITH_UPLINK", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Orbital/contactProfiles/AQUA_DIRECTPLAYBACK_WITH_UPLINK", + "location": "westus", + "properties": { + "minimumViableContactDuration": "PT1M", + "minimumElevationDegrees": 10, + "autoTrackingConfiguration": "xBand", + "links": [ + { + "polarization": "RHCP", + "direction": "uplink", + "gainOverTemperature": 0, + "eirpdBW": 45, + "channels": [ + { + "centerFrequencyMHz": 2106.4063, + "bandwidthMHz": 0.036, + "endPoint": { + "ipAddress": "10.0.1.0", + "endPointName": "AQUA_command", + "port": "4000", + "protocol": "TCP" + }, + "modulationConfiguration": "AQUA_UPLINK_BPSK", + "demodulationConfiguration": "na", + "encodingConfiguration": "AQUA_CMD_CCSDS", + "decodingConfiguration": "na" + } + ] + }, + { + "polarization": "RHCP", + "direction": "downlink", + "gainOverTemperature": 25, + "eirpdBW": 0, + "channels": [ + { + "centerFrequencyMHz": 8160, + "bandwidthMHz": 150, + "endPoint": { + "ipAddress": "10.0.2.0", + "endPointName": "AQUA_directplayback", + "port": "4000", + "protocol": "TCP" + }, + "modulationConfiguration": "na", + "demodulationConfiguration": "AQUA_DOWNLINK_QPSK", + "encodingConfiguration": "na", + "decodingConfiguration": "AQUA_DIRECTPLAYBACK_CCSDS" + } + ] + } + ] + }, + "type": "Microsoft.Orbital/contactProfiles" + } + ], + "nextLink": "string" + } + } + } +} diff --git a/specification/orbital/resource-manager/Microsoft.Orbital/preview/2021-04-04-preview/examples/ContactProfilesBySubscriptionList.json b/specification/orbital/resource-manager/Microsoft.Orbital/preview/2021-04-04-preview/examples/ContactProfilesBySubscriptionList.json new file mode 100644 index 000000000000..97a974eb3e41 --- /dev/null +++ b/specification/orbital/resource-manager/Microsoft.Orbital/preview/2021-04-04-preview/examples/ContactProfilesBySubscriptionList.json @@ -0,0 +1,73 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "api-version": "2021-04-04-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "AQUA_DIRECTPLAYBACK_WITH_UPLINK", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Orbital/contactProfiles/AQUA_DIRECTPLAYBACK_WITH_UPLINK", + "location": "westus", + "properties": { + "minimumViableContactDuration": "PT1M", + "minimumElevationDegrees": 10, + "autoTrackingConfiguration": "xBand", + "links": [ + { + "polarization": "RHCP", + "direction": "uplink", + "gainOverTemperature": 0, + "eirpdBW": 45, + "channels": [ + { + "centerFrequencyMHz": 2106.4063, + "bandwidthMHz": 0.036, + "endPoint": { + "ipAddress": "10.0.1.0", + "endPointName": "AQUA_command", + "port": "4000", + "protocol": "TCP" + }, + "modulationConfiguration": "AQUA_UPLINK_BPSK", + "demodulationConfiguration": "na", + "encodingConfiguration": "AQUA_CMD_CCSDS", + "decodingConfiguration": "na" + } + ] + }, + { + "polarization": "RHCP", + "direction": "downlink", + "gainOverTemperature": 25, + "eirpdBW": 0, + "channels": [ + { + "centerFrequencyMHz": 8160, + "bandwidthMHz": 150, + "endPoint": { + "ipAddress": "10.0.2.0", + "endPointName": "AQUA_directplayback", + "port": "4000", + "protocol": "TCP" + }, + "modulationConfiguration": "na", + "demodulationConfiguration": "AQUA_DOWNLINK_QPSK", + "encodingConfiguration": "na", + "decodingConfiguration": "AQUA_DIRECTPLAYBACK_CCSDS" + } + ] + } + ] + }, + "type": "Microsoft.Orbital/contactProfiles" + } + ], + "nextLink": "string" + } + } + } +} diff --git a/specification/orbital/resource-manager/Microsoft.Orbital/preview/2021-04-04-preview/examples/ContactsBySpacecraftNameList.json b/specification/orbital/resource-manager/Microsoft.Orbital/preview/2021-04-04-preview/examples/ContactsBySpacecraftNameList.json new file mode 100644 index 000000000000..00f19a553ac8 --- /dev/null +++ b/specification/orbital/resource-manager/Microsoft.Orbital/preview/2021-04-04-preview/examples/ContactsBySpacecraftNameList.json @@ -0,0 +1,65 @@ +{ + "parameters": { + "api-version": "2021-04-04-preview", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "spacecraftName": "AQUA" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "contact1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Orbital/spacecrafts/AQUA/contacts/contact1", + "properties": { + "status": "scheduled", + "reservationStartTime": "2020-07-16T20:35:00.00Z", + "reservationEndTime": "2020-07-16T20:55:00.00Z", + "rxStartTime": "2020-07-16T20:40:21.00Z", + "rxEndTime": "2020-07-16T20:49:40.00Z", + "txStartTime": "2020-07-16T20:40:21.00Z", + "txEndTime": "2020-07-16T20:49:40.00Z", + "errorMessage": "", + "maximumElevationDegrees": 70.94, + "startAzimuthDegrees": 148.237, + "endAzimuthDegrees": 353.837, + "startElevationDegrees": 10.0, + "endElevationDegrees": 10.0, + "groundStationName": "westus_gs1", + "contactProfile": { + "id": "/subscriptions/subId/resourceGroups/rg/Microsoft.Orbital/contactProfiles/AQUA_DIRECTPLAYBACK_WITH_UPLINK" + } + }, + "type": "Microsoft.Orbital/contacts" + }, + { + "name": "contact2", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Orbital/spacecrafts/AQUA/contacts/contact2", + "properties": { + "status": "scheduled", + "reservationStartTime": "2020-07-23T20:35:00.00Z", + "reservationEndTime": "2020-07-23T20:55:00.00Z", + "rxStartTime": "2020-07-23T20:40:21.00Z", + "rxEndTime": "2020-07-23T20:49:40.00Z", + "txStartTime": "2020-07-23T20:40:21.00Z", + "txEndTime": "2020-07-23T20:49:40.00Z", + "errorMessage": "", + "maximumElevationDegrees": 70.94, + "startAzimuthDegrees": 148.237, + "endAzimuthDegrees": 353.837, + "startElevationDegrees": 10.0, + "endElevationDegrees": 10.0, + "groundStationName": "westus_gs1", + "contactProfile": { + "id": "/subscriptions/subId/resourceGroups/rg/Microsoft.Orbital/contactProfiles/AQUA_DIRECTPLAYBACK_WITH_UPLINK" + } + }, + "type": "Microsoft.Orbital/contacts" + } + ], + "nextLink": "string" + } + } + } +} diff --git a/specification/orbital/resource-manager/Microsoft.Orbital/preview/2021-04-04-preview/examples/OperationGroupGet.json b/specification/orbital/resource-manager/Microsoft.Orbital/preview/2021-04-04-preview/examples/OperationGroupGet.json deleted file mode 100644 index 74dbf6de33e1..000000000000 --- a/specification/orbital/resource-manager/Microsoft.Orbital/preview/2021-04-04-preview/examples/OperationGroupGet.json +++ /dev/null @@ -1,15 +0,0 @@ -{ - "parameters": { - "accountName": "sampleacct", - "resourceGroupName": "orbitalClient", - "api-version": "2021-04-04-preview", - "subscriptionId": "subid" - }, - "responses": { - "200": { - "body": { - "sampleProperty": "sampleProperty" - } - } - } -} diff --git a/specification/orbital/resource-manager/Microsoft.Orbital/preview/2021-04-04-preview/examples/OperationsList.json b/specification/orbital/resource-manager/Microsoft.Orbital/preview/2021-04-04-preview/examples/OperationsList.json new file mode 100644 index 000000000000..c911b02a08b5 --- /dev/null +++ b/specification/orbital/resource-manager/Microsoft.Orbital/preview/2021-04-04-preview/examples/OperationsList.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2021-04-04-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.Orbital/spacecrafts/write", + "display": { + "provider": "Microsoft Orbital", + "resource": "Spacecraft", + "operation": "Create/Update a spacecraft", + "description": "Creates or Update a spacecraft" + } + } + ] + } + } + } +} diff --git a/specification/orbital/resource-manager/Microsoft.Orbital/preview/2021-04-04-preview/examples/SpacecraftCreate.json b/specification/orbital/resource-manager/Microsoft.Orbital/preview/2021-04-04-preview/examples/SpacecraftCreate.json new file mode 100644 index 000000000000..cab52f2d1bcb --- /dev/null +++ b/specification/orbital/resource-manager/Microsoft.Orbital/preview/2021-04-04-preview/examples/SpacecraftCreate.json @@ -0,0 +1,93 @@ +{ + "parameters": { + "api-version": "2021-04-04-preview", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "spacecraftName": "AQUA", + "parameters": { + "location": "westus", + "properties": { + "noradId": "27424", + "titleLine": "(AQUA)", + "tleLine1": "1 27424U 02022A 20195.59202355 .00000039 00000-0 18634-4 0 9991", + "tleLine2": "2 27424 98.2098 135.8486 0000176 28.4050 144.5909 14.57108832967671", + "links": [ + { + "centerFrequencyMHz": 2106.4063, + "bandwidthMHz": 0.036, + "direction": "uplink", + "polarization": "RHCP" + }, + { + "centerFrequencyMHz": 8125, + "bandwidthMHz": 150, + "direction": "downlink", + "polarization": "RHCP" + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "name": "AQUA", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Orbital/spacecrafts/AQUA", + "location": "westus", + "properties": { + "noradId": "27424", + "authorizationStatus": "Allowed", + "authorizationStatusExtended": "string", + "titleLine": "AQUA", + "tleLine1": "1 27424U 02022A 20195.59202355 .00000039 00000-0 18634-4 0 9991", + "tleLine2": "2 27424 98.2098 135.8486 0000176 28.4050 144.5909 14.57108832967671", + "links": [ + { + "centerFrequencyMHz": 2106.4063, + "bandwidthMHz": 0.036, + "direction": "uplink", + "polarization": "RHCP" + }, + { + "centerFrequencyMHz": 8125, + "bandwidthMHz": 150, + "direction": "downlink", + "polarization": "RHCP" + } + ] + }, + "type": "Microsoft.Orbital/spacecrafts" + } + }, + "201": { + "body": { + "name": "AQUA", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Orbital/spacecrafts/AQUA", + "location": "westus", + "properties": { + "noradId": "27424", + "authorizationStatus": "Allowed", + "authorizationStatusExtended": "string", + "titleLine": "AQUA", + "tleLine1": "1 27424U 02022A 20195.59202355 .00000039 00000-0 18634-4 0 9991", + "tleLine2": "2 27424 98.2098 135.8486 0000176 28.4050 144.5909 14.57108832967671", + "links": [ + { + "centerFrequencyMHz": 2106.4063, + "bandwidthMHz": 0.036, + "direction": "uplink", + "polarization": "RHCP" + }, + { + "centerFrequencyMHz": 8125, + "bandwidthMHz": 150, + "direction": "downlink", + "polarization": "RHCP" + } + ] + }, + "type": "Microsoft.Orbital/spacecrafts" + } + } + } +} diff --git a/specification/orbital/resource-manager/Microsoft.Orbital/preview/2021-04-04-preview/examples/SpacecraftDelete.json b/specification/orbital/resource-manager/Microsoft.Orbital/preview/2021-04-04-preview/examples/SpacecraftDelete.json new file mode 100644 index 000000000000..d14d3761813f --- /dev/null +++ b/specification/orbital/resource-manager/Microsoft.Orbital/preview/2021-04-04-preview/examples/SpacecraftDelete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2021-04-04-preview", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "spacecraftName": "AQUA" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/orbital/resource-manager/Microsoft.Orbital/preview/2021-04-04-preview/examples/SpacecraftGet.json b/specification/orbital/resource-manager/Microsoft.Orbital/preview/2021-04-04-preview/examples/SpacecraftGet.json new file mode 100644 index 000000000000..adb245426dcb --- /dev/null +++ b/specification/orbital/resource-manager/Microsoft.Orbital/preview/2021-04-04-preview/examples/SpacecraftGet.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "api-version": "2021-04-04-preview", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "spacecraftName": "AQUA" + }, + "responses": { + "200": { + "body": { + "name": "AQUA", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Orbital/spacecrafts/AQUA", + "location": "westus", + "properties": { + "noradId": "27424", + "authorizationStatus": "Allowed", + "authorizationStatusExtended": "string", + "titleLine": "AQUA", + "tleLine1": "1 27424U 02022A 20195.59202355 .00000039 00000-0 18634-4 0 9991", + "tleLine2": "2 27424 98.2098 135.8486 0000176 28.4050 144.5909 14.57108832967671", + "links": [ + { + "centerFrequencyMHz": 2106.4063, + "bandwidthMHz": 0.036, + "direction": "uplink", + "polarization": "RHCP" + }, + { + "centerFrequencyMHz": 8125, + "bandwidthMHz": 150, + "direction": "downlink", + "polarization": "RHCP" + } + ] + }, + "type": "Microsoft.Orbital/spacecrafts" + } + } + } +} diff --git a/specification/orbital/resource-manager/Microsoft.Orbital/preview/2021-04-04-preview/examples/SpacecraftUpdateTags.json b/specification/orbital/resource-manager/Microsoft.Orbital/preview/2021-04-04-preview/examples/SpacecraftUpdateTags.json new file mode 100644 index 000000000000..73567f047303 --- /dev/null +++ b/specification/orbital/resource-manager/Microsoft.Orbital/preview/2021-04-04-preview/examples/SpacecraftUpdateTags.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "api-version": "2021-04-04-preview", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "spacecraftName": "AQUA", + "parameters": { + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + }, + "responses": { + "200": { + "body": { + "name": "AQUA", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Orbital/spacecrafts/AQUA", + "location": "westus", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "noradId": "27424", + "authorizationStatus": "Allowed", + "authorizationStatusExtended": "string", + "titleLine": "AQUA", + "tleLine1": "1 27424U 02022A 20195.59202355 .00000039 00000-0 18634-4 0 9991", + "tleLine2": "2 27424 98.2098 135.8486 0000176 28.4050 144.5909 14.57108832967671", + "links": [ + { + "centerFrequencyMHz": 2106.4063, + "bandwidthMHz": 0.036, + "direction": "uplink", + "polarization": "RHCP" + }, + { + "centerFrequencyMHz": 8125, + "bandwidthMHz": 150, + "direction": "downlink", + "polarization": "RHCP" + } + ] + }, + "type": "Microsoft.Orbital/spacecrafts" + } + } + } +} diff --git a/specification/orbital/resource-manager/Microsoft.Orbital/preview/2021-04-04-preview/examples/SpacecraftsByResourceGroupList.json b/specification/orbital/resource-manager/Microsoft.Orbital/preview/2021-04-04-preview/examples/SpacecraftsByResourceGroupList.json new file mode 100644 index 000000000000..ba1c875ca853 --- /dev/null +++ b/specification/orbital/resource-manager/Microsoft.Orbital/preview/2021-04-04-preview/examples/SpacecraftsByResourceGroupList.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "api-version": "2021-04-04-preview", + "subscriptionId": "subid", + "resourceGroupName": "rg1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "AQUA", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Orbital/spacecrafts/AQUA", + "location": "westus", + "properties": { + "noradId": "27424", + "authorizationStatus": "Allowed", + "authorizationStatusExtended": "string", + "titleLine": "AQUA", + "tleLine1": "1 27424U 02022A 20195.59202355 .00000039 00000-0 18634-4 0 9991", + "tleLine2": "2 27424 98.2098 135.8486 0000176 28.4050 144.5909 14.57108832967671", + "links": [ + { + "centerFrequencyMHz": 2106.4063, + "bandwidthMHz": 0.036, + "direction": "uplink", + "polarization": "RHCP" + }, + { + "centerFrequencyMHz": 8125, + "bandwidthMHz": 150, + "direction": "downlink", + "polarization": "RHCP" + } + ] + }, + "type": "Microsoft.Orbital/spacecrafts" + } + ], + "nextLink": "string" + } + } + } +} diff --git a/specification/orbital/resource-manager/Microsoft.Orbital/preview/2021-04-04-preview/examples/SpacecraftsBySubscriptionList.json b/specification/orbital/resource-manager/Microsoft.Orbital/preview/2021-04-04-preview/examples/SpacecraftsBySubscriptionList.json new file mode 100644 index 000000000000..7f12b8f89dbc --- /dev/null +++ b/specification/orbital/resource-manager/Microsoft.Orbital/preview/2021-04-04-preview/examples/SpacecraftsBySubscriptionList.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "api-version": "2021-04-04-preview", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "AQUA", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Orbital/spacecrafts/AQUA", + "location": "westus", + "properties": { + "noradId": "27424", + "authorizationStatus": "Allowed", + "authorizationStatusExtended": "string", + "titleLine": "AQUA", + "tleLine1": "1 27424U 02022A 20195.59202355 .00000039 00000-0 18634-4 0 9991", + "tleLine2": "2 27424 98.2098 135.8486 0000176 28.4050 144.5909 14.57108832967671", + "links": [ + { + "centerFrequencyMHz": 2106.4063, + "bandwidthMHz": 0.036, + "direction": "uplink", + "polarization": "RHCP" + }, + { + "centerFrequencyMHz": 8125, + "bandwidthMHz": 150, + "direction": "downlink", + "polarization": "RHCP" + } + ] + }, + "type": "Microsoft.Orbital/spacecrafts" + } + ], + "nextLink": "string" + } + } + } +} diff --git a/specification/orbital/resource-manager/Microsoft.Orbital/preview/2021-04-04-preview/orbital.json b/specification/orbital/resource-manager/Microsoft.Orbital/preview/2021-04-04-preview/orbital.json index c4311c6cec7d..db53e0e588a9 100644 --- a/specification/orbital/resource-manager/Microsoft.Orbital/preview/2021-04-04-preview/orbital.json +++ b/specification/orbital/resource-manager/Microsoft.Orbital/preview/2021-04-04-preview/orbital.json @@ -2,20 +2,21 @@ "swagger": "2.0", "info": { "version": "2021-04-04-preview", - "title": "orbital", - "description": "Description of the new service", - "x-ms-code-generation-settings": { - "name": "orbitalClient" + "title": "Azure Orbital", + "description": "Azure Orbital service", + "license": { + "name": "Microsoft" } }, "host": "management.azure.com", - "schemes": ["https"], - "consumes": ["application/json"], - "produces": ["application/json"], - "security": [ - { - "azure_auth": ["user_impersonation"] - } + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" ], "securityDefinitions": { "azure_auth": { @@ -29,91 +30,1956 @@ } }, "paths": { - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Orbital/operations": { + "/providers/Microsoft.Orbital/operations": { + "get": { + "tags": [ + "Operations" + ], + "description": "Lists all of the available Orbital Rest API operations.", + "operationId": "Orbital_ListOperations", + "x-ms-examples": { + "OperationsList": { + "$ref": "./examples/OperationsList.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/OperationListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed. If the resource group does not exist, 404 (NotFound) will be returned.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Orbital/spacecrafts": { + "get": { + "tags": [ + "Spacecraft" + ], + "description": "Return list of spacecrafts", + "operationId": "Orbital_ListSpacecraftsBySubscription", + "x-ms-examples": { + "List of Spacecraft by Subscription": { + "$ref": "./examples/SpacecraftsBySubscriptionList.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of spacecraft resources.", + "schema": { + "$ref": "#/definitions/SpacecraftListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed. If the resource group does not exist, 404 (NotFound) will be returned.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Orbital/spacecrafts": { + "get": { + "tags": [ + "Spacecraft" + ], + "description": "Return list of spacecrafts", + "operationId": "Orbital_ListSpacecraftsByResourceGroup", + "x-ms-examples": { + "List of Spacecraft by Resource Group": { + "$ref": "./examples/SpacecraftsByResourceGroupList.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of spacecraft resources.", + "schema": { + "$ref": "#/definitions/SpacecraftListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed. If the resource group does not exist, 404 (NotFound) will be returned.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Orbital/spacecrafts/{spacecraftName}": { + "get": { + "tags": [ + "Spacecraft" + ], + "operationId": "Orbital_GetSpacecraft", + "description": "Gets the specified spacecraft in a specified resource group", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/spacecraftNameParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting Spacecraft resource.", + "schema": { + "$ref": "#/definitions/Spacecraft" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get Spacecraft": { + "$ref": "./examples/SpacecraftGet.json" + } + } + }, + "put": { + "tags": [ + "Spacecraft" + ], + "description": "Creates or updates a spacecraft resource", + "operationId": "Orbital_CreateOrUpdateSpacecraft", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/spacecraftNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "x-ms-client-flatten": true, + "schema": { + "$ref": "#/definitions/Spacecraft" + }, + "description": "The parameters to provide for the created spacecraft." + } + ], + "responses": { + "200": { + "description": "Update successful. The operation returns the resulting spacecraft resource.", + "schema": { + "$ref": "#/definitions/Spacecraft" + } + }, + "201": { + "description": "Create successful. The operation returns the resulting spacecraft resource.", + "schema": { + "$ref": "#/definitions/Spacecraft" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Create a spacecraft": { + "$ref": "./examples/SpacecraftCreate.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "delete": { + "tags": [ + "Spacecraft" + ], + "operationId": "Orbital_DeleteSpacecraft", + "description": "Deletes a specified spacecraft resource.", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/spacecraftNameParameter" + } + ], + "responses": { + "200": { + "description": "Delete successful." + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "204": { + "description": "Request successful. Resource does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Delete Spacecraft": { + "$ref": "./examples/SpacecraftDelete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "patch": { + "tags": [ + "Spacecraft" + ], + "operationId": "Orbital_UpdateTagsSpacecraft", + "x-ms-examples": { + "Update Spacecraft tags": { + "$ref": "./examples/SpacecraftUpdateTags.json" + } + }, + "description": "Updates the specified spacecraft tags.", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/TagsObject" + }, + "description": "Parameters supplied to update spacecraft tags." + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/spacecraftNameParameter" + } + ], + "responses": { + "200": { + "description": "Update successful. The operation returns the resulting Spacecraft resource.", + "schema": { + "$ref": "#/definitions/Spacecraft" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Orbital/spacecrafts/{spacecraftName}/contacts": { + "get": { + "tags": [ + "Spacecraft" + ], + "description": "Returns list of contacts by spacecraftName", + "operationId": "Orbital_ListContactsBySpacecraftName", + "x-ms-examples": { + "List of Contacts": { + "$ref": "./examples/ContactsBySpacecraftNameList.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/spacecraftNameParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of contacts by spacecraftName.", + "schema": { + "$ref": "#/definitions/ContactListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed. If the resource group does not exist, 404 (NotFound) will be returned.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Orbital/spacecrafts/{spacecraftName}/contacts/{contactName}": { "get": { - "tags": ["Tag1"], - "operationId": "OperationGroup_Get", + "tags": [ + "Contact" + ], + "operationId": "Orbital_GetContact", + "description": "Gets the specified contact in a specified resource group", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/spacecraftNameParameter" + }, + { + "$ref": "#/parameters/contactNameParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting Contact resource.", + "schema": { + "$ref": "#/definitions/Contact" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, "x-ms-examples": { - "BatchAccountDelete": { "$ref": "./examples/OperationGroupGet.json" } + "Get Contact": { + "$ref": "./examples/ContactGet.json" + } + } + }, + "put": { + "tags": [ + "Contact" + ], + "description": "Creates a contact.", + "operationId": "Orbital_CreateContact", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/spacecraftNameParameter" + }, + { + "$ref": "#/parameters/contactNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Contact" + }, + "description": "The parameters to provide for the created contact." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Contact" + } + }, + "201": { + "description": "Create successful. The operation returns the resulting contact resource.", + "schema": { + "$ref": "#/definitions/Contact" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Create a contact": { + "$ref": "./examples/ContactCreate.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "delete": { + "tags": [ + "Contact" + ], + "operationId": "Orbital_DeleteContact", + "description": "Deletes a specified contact", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/spacecraftNameParameter" + }, + { + "$ref": "#/parameters/contactNameParameter" + } + ], + "responses": { + "200": { + "description": "Delete successful." + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "204": { + "description": "Request successful. Resource does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Delete Contact": { + "$ref": "./examples/ContactDelete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Orbital/spacecrafts/{spacecraftName}/listAvailableContacts": { + "post": { + "tags": [ + "Contact" + ], + "description": "Return list of available contacts", + "operationId": "Orbital_ListAvailableContacts", + "x-ms-examples": { + "List of Contact": { + "$ref": "./examples/AvailableContactsList.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/spacecraftNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "x-ms-client-flatten": true, + "schema": { + "$ref": "#/definitions/ContactParameters" + }, + "description": "The parameters to provide for the contacts." + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of available contacts resources.", + "schema": { + "$ref": "#/definitions/AvailableContactsListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed. If the resource group does not exist, 404 (NotFound) will be returned.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Orbital/contactProfiles/{contactProfileName}": { + "get": { + "tags": [ + "Contact Profile" + ], + "operationId": "Orbital_GetContactProfile", + "description": "Gets the specified contact Profile in a specified resource group", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/contactProfileNameParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting ContactProfile resource.", + "schema": { + "$ref": "#/definitions/ContactProfile" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get a contact profile": { + "$ref": "./examples/ContactProfileGet.json" + } + } + }, + "put": { + "tags": [ + "Contact Profile" + ], + "description": "Creates or updates a contact profile", + "operationId": "Orbital_CreateOrUpdateContactProfile", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/contactProfileNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "x-ms-client-flatten": true, + "schema": { + "$ref": "#/definitions/ContactProfile" + }, + "description": "The parameters to provide for the created Contact Profile." + } + ], + "responses": { + "200": { + "description": "Update successful. The operation returns the resulting ContactProfile resource.", + "schema": { + "$ref": "#/definitions/ContactProfile" + } + }, + "201": { + "description": "Create successful. The operation returns the resulting ContactProfile resource.", + "schema": { + "$ref": "#/definitions/ContactProfile" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Create a contact profile": { + "$ref": "./examples/ContactProfileCreate.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "delete": { + "tags": [ + "Contact Profile" + ], + "operationId": "Orbital_DeleteContactProfile", + "description": "Deletes a specified contact profile resource.", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/contactProfileNameParameter" + } + ], + "responses": { + "200": { + "description": "Delete successful." + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "204": { + "description": "Request successful. Resource does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Delete Contact Profile": { + "$ref": "./examples/ContactProfileDelete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "patch": { + "tags": [ + "Contact Profile" + ], + "operationId": "Orbital_UpdateTagsContactProfile", + "x-ms-examples": { + "Update Contact Profile tags": { + "$ref": "./examples/ContactProfileUpdateTag.json" + } + }, + "description": "Updates the specified contact profile tags.", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/TagsObject" + }, + "description": "Parameters supplied to update contact profile tags." + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/contactProfileNameParameter" + } + ], + "responses": { + "200": { + "description": "Update successful. The operation returns the resulting Contact Profile resource.", + "schema": { + "$ref": "#/definitions/ContactProfile" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Orbital/contactProfiles": { + "get": { + "tags": [ + "Contact Profile" + ], + "description": "Returns list of contact profiles", + "operationId": "Orbital_ListContactProfilesBySubscription", + "x-ms-examples": { + "List of Contact Profiles by Subscription": { + "$ref": "./examples/ContactProfilesBySubscriptionList.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of contact profile resources.", + "schema": { + "$ref": "#/definitions/ContactProfileListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed. If the resource group does not exist, 404 (NotFound) will be returned.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Orbital/contactProfiles": { + "get": { + "tags": [ + "Contact Profile" + ], + "description": "Returns list of contact profiles", + "operationId": "Orbital_ListContactProfilesByResourceGroup", + "x-ms-examples": { + "List of Contact Profiles by Resource Group": { + "$ref": "./examples/ContactProfilesByResourceGroupList.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of contact profile resources.", + "schema": { + "$ref": "#/definitions/ContactProfileListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed. If the resource group does not exist, 404 (NotFound) will be returned.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Orbital/availableGroundStations": { + "get": { + "tags": [ + "Ground Station" + ], + "description": "Returns list of available ground stations", + "operationId": "AvailableGroundStations_ListByCapability", + "x-ms-examples": { + "List of Ground Stations by Capability": { + "$ref": "./examples/AvailableGroundStationsByCapabilityList.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/capabilityParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of Ground Station resources.", + "schema": { + "$ref": "#/definitions/AvailableGroundStationListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed. If the resource group does not exist, 404 (NotFound) will be returned.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Orbital/availableGroundStations/{groundStationName}": { + "get": { + "tags": [ + "Ground Station" + ], + "operationId": "AvailableGroundStations_Get", + "description": "Gets the specified available ground station", + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/groundStationNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting ground station resource.", + "schema": { + "$ref": "#/definitions/AvailableGroundStation" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get GroundStation": { + "$ref": "./examples/AvailableGroundStationGet.json" + } + } + } + } + }, + "definitions": { + "TagsObject": { + "type": "object", + "properties": { + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Resource tags." + } + }, + "description": "Tags object for patch operations." + }, + "SpacecraftsProperties": { + "type": "object", + "required": [ + "noradId" + ], + "properties": { + "noradId": { + "type": "string", + "description": "NORAD ID of the spacecraft." + }, + "authorizationStatus": { + "type": "string", + "readOnly": true, + "enum": [ + "Allowed", + "Pending", + "Denied" + ], + "x-ms-enum": { + "name": "AuthorizationStatus", + "modelAsString": false + }, + "description": "Authorization status of spacecraft." + }, + "authorizationStatusExtended": { + "type": "string", + "readOnly": true, + "description": "Details of the authorization status." + }, + "titleLine": { + "type": "string", + "description": "Title line of Two Line Element (TLE)." + }, + "tleLine1": { + "type": "string", + "description": "Line 1 of Two Line Element (TLE)." + }, + "tleLine2": { + "type": "string", + "description": "Line 2 of Two Line Element (TLE)." + }, + "links": { + "type": "array", + "items": { + "$ref": "#/definitions/SpacecraftLink" + }, + "description": "Links of the Spacecraft" + } + }, + "description": "List of Spacecraft Resource Properties." + }, + "SpacecraftListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Spacecraft" + }, + "description": "A list of spacecraft resources in a resource group." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of results.", + "readOnly": true + } + }, + "description": "Response for the ListSpacecrafts API service call." + }, + "SpacecraftLink": { + "type": "object", + "required": [ + "centerFrequencyMHz", + "bandwidthMHz", + "direction", + "polarization" + ], + "properties": { + "centerFrequencyMHz": { + "type": "number", + "description": "Center Frequency in MHz" + }, + "bandwidthMHz": { + "type": "number", + "description": "Bandwidth in MHz" + }, + "direction": { + "type": "string", + "description": "Direction (uplink or downlink)", + "enum": [ + "uplink", + "downlink" + ], + "x-ms-enum": { + "name": "direction", + "modelAsString": true + } + }, + "polarization": { + "type": "string", + "description": "polarization. eg (RHCP, LHCP)", + "enum": [ + "RHCP", + "LHCP", + "dualRhcpLhcp", + "linearVertical", + "linearHorizontal" + ], + "x-ms-enum": { + "name": "polarization", + "modelAsString": true + } + } + }, + "description": "Spacecraft Link" + }, + "Spacecraft": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "allOf": [ + { + "$ref": "#/definitions/SpacecraftsProperties" + } + ], + "description": "Spacecraft Properties" + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "description": "Customer creates a spacecraft resource to schedule a contact." + }, + "ResourceReference": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Resource ID." + } + }, + "x-ms-azure-resource": true, + "description": "Resource Reference" + }, + "Resource": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Resource ID.", + "readOnly": true + }, + "name": { + "type": "string", + "description": "Resource name.", + "readOnly": true + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Resource type." + }, + "location": { + "type": "string", + "description": "Resource location." + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Resource tags." + }, + "systemData": { + "allOf": [ + { + "$ref": "#/definitions/SystemData" + } + ], + "description": "Metadata pertaining to creation and last modification of the resource.", + "readOnly": true + } + }, + "description": "Common resource representation.", + "x-ms-azure-resource": true + }, + "ProxyResource": { + "type": "object", + "x-ms-azure-resource": true, + "description": "An azure resource object", + "properties": { + "id": { + "type": "string", + "readOnly": true, + "description": "Azure resource Id" + }, + "type": { + "type": "string", + "readOnly": true, + "description": "Azure resource type" + }, + "name": { + "type": "string", + "readOnly": true, + "description": "Azure resource name" + }, + "systemData": { + "allOf": [ + { + "$ref": "#/definitions/SystemData" + } + ], + "description": "Metadata pertaining to creation and last modification of the resource.", + "readOnly": true + } + } + }, + "OperationListResult": { + "type": "object", + "description": "Result of the request to list Orbital operations. It contains a list of operations and a URL link to get the next set of results.", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Operation" + }, + "description": "List of Orbital operations supported by the Orbital resource provider." + } + } + }, + "Operation": { + "description": "Orbital REST API operation definition.", + "type": "object", + "properties": { + "name": { + "description": "Operation name: {provider}/{resource}/{operation}", + "type": "string" + }, + "isDataAction": { + "type": "boolean", + "default": false, + "description": "Indicates whether the operation applies to data-plane." + }, + "display": { + "type": "object", + "description": "Display metadata associated with the operation.", + "properties": { + "provider": { + "description": "Service provider: Microsoft Orbital.", + "type": "string" + }, + "resource": { + "description": "Resource on which the operation is performed etc.", + "type": "string" + }, + "operation": { + "description": "Type of operation: get, read, delete, etc.", + "type": "string" + }, + "description": { + "description": "Description of the operation.", + "type": "string" + } + } + }, + "origin": { + "type": "string", + "description": "The origin of operations." + } + } + }, + "EndPoint": { + "type": "object", + "required": [ + "ipAddress", + "endPointName", + "port", + "protocol" + ], + "properties": { + "ipAddress": { + "type": "string", + "description": "IP Address." + }, + "endPointName": { + "type": "string", + "description": "Name of an end point." + }, + "port": { + "type": "string", + "description": "TCP port to listen on to receive data." + }, + "protocol": { + "type": "string", + "description": "Protocol either UDP or TCP.", + "enum": [ + "TCP", + "UDP" + ], + "x-ms-enum": { + "name": "protocol", + "modelAsString": true + } + } + }, + "description": "Customer End point to store/retrieve data during a contact." + }, + "ContactsProperties": { + "type": "object", + "required": [ + "reservationStartTime", + "reservationEndTime", + "groundStationName", + "contactProfile" + ], + "properties": { + "status": { + "type": "string", + "readOnly": true, + "enum": [ + "scheduled", + "cancelled", + "succeeded", + "failed", + "providerCancelled" + ], + "x-ms-enum": { + "name": "Status", + "modelAsString": false + }, + "description": "Status of a contact." + }, + "reservationStartTime": { + "type": "string", + "format": "date-time", + "description": "Reservation start time of a contact." + }, + "reservationEndTime": { + "type": "string", + "format": "date-time", + "description": "Reservation end time of a contact." }, - "description": "This is a sample get operation, please see guidelines in azure-rest-api-specs repository for more info", - "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" + "rxStartTime": { + "type": "string", + "format": "date-time", + "readOnly": true, + "description": "Receive start time of a contact." + }, + "rxEndTime": { + "type": "string", + "format": "date-time", + "readOnly": true, + "description": "Receive end time of a contact." + }, + "txStartTime": { + "type": "string", + "format": "date-time", + "readOnly": true, + "description": "Transmit start time of a contact." + }, + "txEndTime": { + "type": "string", + "format": "date-time", + "readOnly": true, + "description": "Transmit end time of a contact." + }, + "errorMessage": { + "type": "string", + "readOnly": true, + "description": "Any error message while scheduling a contact." + }, + "maximumElevationDegrees": { + "type": "number", + "readOnly": true, + "description": "Maximum elevation of the antenna during the contact in decimal degrees." + }, + "startAzimuthDegrees": { + "type": "number", + "readOnly": true, + "description": "Azimuth of the antenna at the start of the contact in decimal degrees." + }, + "endAzimuthDegrees": { + "type": "number", + "readOnly": true, + "description": "Azimuth of the antenna at the end of the contact in decimal degrees." + }, + "groundStationName": { + "type": "string", + "description": "Azure Ground Station name." + }, + "startElevationDegrees": { + "type": "number", + "readOnly": true, + "description": "Spacecraft elevation above the horizon at contact start." + }, + "endElevationDegrees": { + "type": "number", + "readOnly": true, + "description": "Spacecraft elevation above the horizon at contact end." + }, + "contactProfile": { + "allOf": [ + { + "$ref": "#/definitions/ResourceReference" + } + ], + "description": "The reference to the contact profile resource." + } + }, + "description": "Properties of the Contact Resource." + }, + "ContactProfilesProperties": { + "type": "object", + "required": [ + "links" + ], + "properties": { + "minimumViableContactDuration": { + "type": "string", + "description": "Minimum viable contact duration in ISO 8601 format." + }, + "minimumElevationDegrees": { + "type": "number", + "description": "Minimum viable elevation for the contact in decimal degrees." + }, + "autoTrackingConfiguration": { + "type": "string", + "enum": [ + "disabled", + "xBand", + "sBand" + ], + "x-ms-enum": { + "name": "AutoTrackingConfiguration", + "modelAsString": false }, - { - "$ref": "#/parameters/ResourceGroupNameParameter" + "description": "Auto track configuration." + }, + "links": { + "type": "array", + "items": { + "$ref": "#/definitions/ContactProfileLink" + }, + "description": "Links of the Contact Profile" + } + }, + "description": "List of Contact Profile Resource Properties." + }, + "ContactProfileListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ContactProfile" + }, + "description": "A list of contact profile resources in a resource group." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of results.", + "readOnly": true + } + }, + "description": "Response for the ListContactProfiles API service call." + }, + "ContactProfileLinkChannel": { + "type": "object", + "required": [ + "centerFrequencyMHz", + "bandwidthMHz", + "endPoint" + ], + "properties": { + "centerFrequencyMHz": { + "type": "number", + "description": "Center Frequency in MHz" + }, + "bandwidthMHz": { + "type": "number", + "description": "Bandwidth in MHz" + }, + "endPoint": { + "$ref": "#/definitions/EndPoint" + }, + "modulationConfiguration": { + "type": "string", + "description": "Configuration for modulation" + }, + "demodulationConfiguration": { + "type": "string", + "description": "Configuration for demodulation" + }, + "encodingConfiguration": { + "type": "string", + "description": "Configuration for encoding" + }, + "decodingConfiguration": { + "type": "string", + "description": "Configuration for decoding" + } + }, + "description": "Contact Profile Link Channel" + }, + "ContactProfileLink": { + "type": "object", + "required": [ + "polarization", + "direction", + "channels" + ], + "properties": { + "polarization": { + "type": "string", + "description": "polarization. eg (RHCP, LHCP)", + "enum": [ + "RHCP", + "LHCP", + "dualRhcpLhcp", + "linearVertical", + "linearHorizontal" + ], + "x-ms-enum": { + "name": "polarization", + "modelAsString": true } - ], - "responses": { - "200": { - "description": "Describe the result of a successful operation.", - "schema": { - "$ref": "#/definitions/Result" - } + }, + "direction": { + "type": "string", + "description": "Direction (uplink or downlink)", + "enum": [ + "uplink", + "downlink" + ], + "x-ms-enum": { + "name": "direction", + "modelAsString": true + } + }, + "gainOverTemperature": { + "type": "number", + "description": "Gain To Noise Temperature in db/K." + }, + "eirpdBW": { + "type": "number", + "description": "Effective Isotropic Radiated Power (EIRP) in dBW." + }, + "channels": { + "type": "array", + "items": { + "$ref": "#/definitions/ContactProfileLinkChannel" }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" + "description": "Contact Profile Link Channel" + } + }, + "description": "Contact Profile link" + }, + "ContactProfile": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "allOf": [ + { + "$ref": "#/definitions/ContactProfilesProperties" } - } + ], + "description": "Properties of the spacecraft resource." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." } - } - } - }, - "definitions": { - "Result": { - "description": "Sample result definition", + }, + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "description": "Customer creates a Contact Profile Resource, which will contain all of the configurations required for scheduling a contact." + }, + "ContactParameters": { + "type": "object", + "description": "Parameters that define the contact resource.", + "required": [ + "contactProfile", + "groundStationName", + "startTime", + "endTime" + ], "properties": { - "sampleProperty": { + "contactProfile": { + "allOf": [ + { + "$ref": "#/definitions/ResourceReference" + } + ], + "description": "The reference to the contact profile resource." + }, + "groundStationName": { "type": "string", - "description": "Sample property of type string" + "description": "Name of Azure Ground Station." + }, + "startTime": { + "type": "string", + "format": "date-time", + "description": "Start time of a contact." + }, + "endTime": { + "type": "string", + "format": "date-time", + "description": "End time of a contact." } } }, - "ErrorResponse": { - "description": "Error response.", + "ContactListResult": { + "type": "object", "properties": { - "error": { - "$ref": "#/definitions/ErrorDefinition", - "description": "The error details." + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Contact" + }, + "description": "A list of contact resources in a resource group." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of results.", + "readOnly": true } - } + }, + "description": "Response for the ListContacts API service call." + }, + "ContactInstanceProperties": { + "type": "object", + "properties": { + "maximumElevationDegrees": { + "type": "number", + "readOnly": true, + "description": "Maximum elevation of the antenna during the contact in decimal degrees." + }, + "txStartTime": { + "type": "string", + "format": "date-time", + "readOnly": true, + "description": "Time at which antenna transmit will be enabled." + }, + "txEndTime": { + "type": "string", + "format": "date-time", + "readOnly": true, + "description": "Time at which antenna transmit will be disabled." + }, + "rxStartTime": { + "type": "string", + "format": "date-time", + "readOnly": true, + "description": "Earliest time to receive a signal." + }, + "rxEndTime": { + "type": "string", + "format": "date-time", + "readOnly": true, + "description": "Time to lost receiving a signal." + }, + "startAzimuthDegrees": { + "type": "number", + "readOnly": true, + "description": "Azimuth of the antenna at the start of the contact in decimal degrees." + }, + "endAzimuthDegrees": { + "type": "number", + "readOnly": true, + "description": "Azimuth of the antenna at the end of the contact in decimal degrees." + }, + "startElevationDegrees": { + "type": "number", + "readOnly": true, + "description": "Spacecraft elevation above the horizon at contact start." + }, + "endElevationDegrees": { + "type": "number", + "readOnly": true, + "description": "Spacecraft elevation above the horizon at contact end." + } + }, + "description": "Contact Instance Properties" + }, + "Contact": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ContactsProperties" + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "#/definitions/ProxyResource" + } + ], + "description": "Customer creates a contact resource for a spacecraft resource." }, - "ErrorDefinition": { - "description": "Error definition.", + "CloudErrorBody": { + "x-ms-external": true, + "type": "object", "properties": { "code": { - "description": "Service specific error code which serves as the substatus for the HTTP error code.", "type": "string", - "readOnly": true + "description": "An identifier for the error. Codes are invariant and are intended to be consumed programmatically." }, "message": { - "description": "Description of the error.", "type": "string", - "readOnly": true + "description": "A message describing the error, intended to be suitable for display in a user interface." + }, + "target": { + "type": "string", + "description": "The target of the particular error. For example, the name of the property in error." }, "details": { - "description": "Internal error details.", "type": "array", "items": { - "$ref": "#/definitions/ErrorDefinition" + "$ref": "#/definitions/CloudErrorBody" + }, + "description": "A list of additional details about the error." + } + }, + "description": "An error response from the service." + }, + "CloudError": { + "x-ms-external": true, + "type": "object", + "properties": { + "error": { + "$ref": "#/definitions/CloudErrorBody" + } + }, + "description": "An error response from the service." + }, + "AvailableContactsListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/AvailableContacts" + }, + "description": "A list of available contacts" + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of results.", + "readOnly": true + } + }, + "description": "Response for the ListAvailableContacts API service call." + }, + "AvailableContacts": { + "type": "object", + "properties": { + "spacecraft": { + "allOf": [ + { + "$ref": "#/definitions/ResourceReference" + } + ], + "description": "The reference to the spacecraft resource." + }, + "groundStationName": { + "type": "string", + "readOnly": true, + "description": "Name of Azure Ground Station." + }, + "properties": { + "x-ms-client-flatten": true, + "allOf": [ + { + "$ref": "#/definitions/ContactInstanceProperties" + } + ], + "description": "Properties of Contact resource." + } + }, + "description": "Customer retrieves list of Available Contacts for a spacecraft resource. Later, one of the available contact can be selected to create a contact." + }, + "AvailableGroundStationListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/AvailableGroundStation" }, + "description": "A list of ground station resources." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of results.", "readOnly": true } + }, + "description": "Response for the AvailableGroundStations API service call." + }, + "AvailableGroundStation": { + "type": "object", + "x-ms-client-flatten": true, + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "Id of groundStation" + }, + "name": { + "readOnly": true, + "type": "string", + "description": "Name of the ground station." + }, + "location": { + "type": "string", + "description": "Azure region" + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Resource type." + }, + "properties": { + "x-ms-client-flatten": true, + "allOf": [ + { + "$ref": "#/definitions/AvailableGroundStationProperties" + } + ], + "description": "The properties bag for this resource" + } + }, + "description": "GroundStations available to schedule Contacts" + }, + "AvailableGroundStationProperties": { + "type": "object", + "properties": { + "city": { + "type": "string", + "description": "City of ground station." + }, + "providerName": { + "type": "string", + "description": "Ground station provider name." + }, + "longitudeDegrees": { + "type": "number", + "description": "Longitude of the ground station in decimal degrees." + }, + "latitudeDegrees": { + "type": "number", + "description": "Latitude of the ground station in decimal degrees." + }, + "altitudeMeters": { + "type": "number", + "description": "Altitude of the ground station" + } + }, + "description": "Properties object for Available groundstation." + }, + "Capability": { + "type": "string", + "description": "Capability of the Ground Station.", + "enum": [ + "EarthObservation", + "Communication" + ] + }, + "SystemData": { + "description": "Metadata pertaining to creation and last modification of the resource.", + "type": "object", + "readOnly": true, + "properties": { + "createdBy": { + "type": "string", + "description": "The identity that created the resource." + }, + "createdByType": { + "type": "string", + "description": "The type of identity that created the resource.", + "enum": [ + "User", + "Application", + "ManagedIdentity", + "Key" + ], + "x-ms-enum": { + "name": "createdByType", + "modelAsString": true + } + }, + "createdAt": { + "type": "string", + "format": "date-time", + "description": "The timestamp of resource creation (UTC)." + }, + "lastModifiedBy": { + "type": "string", + "description": "The identity that last modified the resource." + }, + "lastModifiedByType": { + "type": "string", + "description": "The type of identity that last modified the resource.", + "enum": [ + "User", + "Application", + "ManagedIdentity", + "Key" + ], + "x-ms-enum": { + "name": "createdByType", + "modelAsString": true + } + } } + }, + "ResourceIdListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The Azure Resource ID" + } + } + }, + "description": "A list of Azure Resource IDs." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of results.", + "readOnly": true + } + }, + "description": "Response for an API service call that lists the resource IDs of resources associated with another resource." + }, + "Etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." } }, "parameters": { - "SubscriptionIdParameter": { - "name": "subscriptionId", + "apiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "2020-09-01-preview", + "2021-04-04-preview" + ], + "default": "2021-04-04-preview", + "description": "Version of the API to be used with the client request." + }, + "contactNameParameter": { + "name": "contactName", + "in": "path", + "description": "Contact Name", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "contactProfileNameParameter": { + "name": "contactProfileName", + "in": "path", + "description": "Contact Profile Name", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "groundStationNameParameter": { + "name": "groundStationName", "in": "path", "required": true, "type": "string", - "description": "The Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000)" + "description": "Ground Station name", + "x-ms-parameter-location": "method" }, - "ResourceGroupNameParameter": { + "resourceGroupName": { "name": "resourceGroupName", "in": "path", "required": true, @@ -121,12 +1987,73 @@ "description": "The name of the resource group.", "x-ms-parameter-location": "method" }, - "ApiVersionParameter": { - "name": "api-version", + "spacecraftNameParameter": { + "name": "spacecraftName", + "in": "path", + "description": "Spacecraft ID", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "subscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "description": "Azure Subscription ID.", + "required": true, + "type": "string" + }, + "capabilityParameter": { + "name": "capability", "in": "query", "required": true, "type": "string", - "description": "The API version to be used with the HTTP request." + "enum": [ + "EarthObservation", + "Communication" + ], + "default": "EarthObservation", + "description": "Ground Station Capability", + "x-ms-parameter-location": "method" + }, + "orbitalGatewayNameParameter": { + "name": "orbitalGatewayName", + "in": "path", + "description": "Orbital gateway name", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "edgeSiteNameParameter": { + "name": "edgeSiteName", + "in": "path", + "description": "Edge site name", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "l2ConnectionNameParameter": { + "name": "l2ConnectionName", + "in": "path", + "description": "L2 Connection name", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "l3ConnectionNameParameter": { + "name": "l3ConnectionName", + "in": "path", + "description": "L3 connection name", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "globalCommunicationsSiteNameParameter": { + "name": "globalCommunicationsSiteName", + "in": "path", + "description": "Global communications Site name", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" } } } diff --git a/specification/orbital/resource-manager/readme.csharp.md b/specification/orbital/resource-manager/readme.csharp.md index 7d800fe8ef4e..4d2d5ea6cbe7 100644 --- a/specification/orbital/resource-manager/readme.csharp.md +++ b/specification/orbital/resource-manager/readme.csharp.md @@ -12,4 +12,4 @@ csharp: client-side-validation: false namespace: Microsoft.Orbital output-folder: $(csharp-sdks-folder)/orbital/management/Microsoft.Orbital/GeneratedProtocol -``` +``` \ No newline at end of file diff --git a/specification/orbital/resource-manager/readme.go.md b/specification/orbital/resource-manager/readme.go.md index 61b1f03cb3ec..7a6eb638c1ac 100644 --- a/specification/orbital/resource-manager/readme.go.md +++ b/specification/orbital/resource-manager/readme.go.md @@ -8,4 +8,4 @@ license-header: MICROSOFT_MIT_NO_VERSION module-name: sdk/orbital/armorbital module: github.com/Azure/azure-sdk-for-go/$(module-name) output-folder: $(go-sdk-folder)/$(module-name) -``` +``` \ No newline at end of file diff --git a/specification/orbital/resource-manager/readme.md b/specification/orbital/resource-manager/readme.md index 19db38fee1ef..6e42dd89d6b8 100644 --- a/specification/orbital/resource-manager/readme.md +++ b/specification/orbital/resource-manager/readme.md @@ -74,4 +74,4 @@ See configuration in [readme.typescript.md](./readme.typescript.md) ## CSharp -See configuration in [readme.csharp.md](./readme.csharp.md) +See configuration in [readme.csharp.md](./readme.csharp.md) \ No newline at end of file diff --git a/specification/orbital/resource-manager/readme.python.md b/specification/orbital/resource-manager/readme.python.md index ee93d0c55312..a9f5c099a5a4 100644 --- a/specification/orbital/resource-manager/readme.python.md +++ b/specification/orbital/resource-manager/readme.python.md @@ -20,4 +20,4 @@ output-folder: $(python-sdks-folder)/orbital/azure-mgmt-orbital/azure/mgmt/orbit ``` yaml $(python-mode) == 'create' && $(track2) basic-setup-py: true output-folder: $(python-sdks-folder)/orbital/azure-mgmt-orbital -``` +``` \ No newline at end of file diff --git a/specification/orbital/resource-manager/readme.typescript.md b/specification/orbital/resource-manager/readme.typescript.md index 0d531d938a32..1fd450daf586 100644 --- a/specification/orbital/resource-manager/readme.typescript.md +++ b/specification/orbital/resource-manager/readme.typescript.md @@ -11,4 +11,4 @@ typescript: payload-flattening-threshold: 1 clear-output-folder: true generate-metadata: true -``` +``` \ No newline at end of file