diff --git a/specification/orbital/resource-manager/Microsoft.Orbital/stable/2022-11-01/examples/AvailableContactsList.json b/specification/orbital/resource-manager/Microsoft.Orbital/stable/2022-11-01/examples/AvailableContactsList.json new file mode 100644 index 000000000000..82771bcf3928 --- /dev/null +++ b/specification/orbital/resource-manager/Microsoft.Orbital/stable/2022-11-01/examples/AvailableContactsList.json @@ -0,0 +1,64 @@ +{ + "parameters": { + "api-version": "2022-11-01", + "subscriptionId": "c1be1141-a7c9-4aac-9608-3c2e2f1152c3", + "resourceGroupName": "contoso-Rgp", + "spacecraftName": "CONTOSO_SAT", + "parameters": { + "contactProfile": { + "id": "/subscriptions/c1be1141-a7c9-4aac-9608-3c2e2f1152c3/resourceGroups/contoso-Rgp/providers/Microsoft.Orbital/contactProfiles/CONTOSO-CP" + }, + "groundStationName": "EASTUS2_0", + "startTime": "2022-11-01T11:30:00Z", + "endTime": "2022-11-02T11:30:00Z" + } + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/Microsoft.Orbital/operationResults/4e2ffff7-b331-4fcb-ab11-b5fa49368188?api-version=2022-11-01" + } + }, + "200": { + "body": { + "value": [ + { + "spacecraft": { + "id": "/subscriptions/c1be1141-a7c9-4aac-9608-3c2e2f1152c3/resourceGroups/contoso-Rgp/providers/Microsoft.Orbital/spacecrafts/CONTOSO_SAT" + }, + "groundStationName": "EASTUS2_0", + "properties": { + "maximumElevationDegrees": 26.617297, + "txStartTime": "2022-11-01T11:55:01Z", + "txEndTime": "2022-11-01T12:05:25Z", + "rxStartTime": "2022-11-01T11:55:01Z", + "rxEndTime": "2022-11-01T12:05:25Z", + "startAzimuthDegrees": 201.340472, + "endAzimuthDegrees": 330.489627, + "startElevationDegrees": 5.0, + "endElevationDegrees": 5.040625 + } + }, + { + "spacecraft": { + "id": "/subscriptions/c1be1141-a7c9-4aac-9608-3c2e2f1152c3/resourceGroups/contoso-Rgp/providers/Microsoft.Orbital/spacecrafts/CONTOSO_SAT" + }, + "groundStationName": "EASTUS2_0", + "properties": { + "maximumElevationDegrees": 85.9796, + "txStartTime": "2022-11-02T10:58:30Z", + "txEndTime": "2022-11-02T11:10:45Z", + "rxStartTime": "2022-11-02T10:58:30Z", + "rxEndTime": "2022-11-02T11:10:45Z", + "startAzimuthDegrees": 165.758896, + "endAzimuthDegrees": 345.848482, + "startElevationDegrees": 5.0, + "endElevationDegrees": 5.048656 + } + } + ], + "nextLink": "https://management.azure.com/subscriptions/c1be1141-a7c9-4aac-9608-3c2e2f1152c3/resourceGroups/contoso-Rgp/providers/Microsoft.Orbital/spacecrafts/CONTOSO_SAT/listAvailableContacts?api-version=2022-11-01&$skiptoken=opaqueString" + } + } + } +} diff --git a/specification/orbital/resource-manager/Microsoft.Orbital/stable/2022-11-01/examples/AvailableGroundStationsByCapabilityList.json b/specification/orbital/resource-manager/Microsoft.Orbital/stable/2022-11-01/examples/AvailableGroundStationsByCapabilityList.json new file mode 100644 index 000000000000..5a6b230b41f8 --- /dev/null +++ b/specification/orbital/resource-manager/Microsoft.Orbital/stable/2022-11-01/examples/AvailableGroundStationsByCapabilityList.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "api-version": "2022-11-01", + "subscriptionId": "c1be1141-a7c9-4aac-9608-3c2e2f1152c3", + "capability": "EarthObservation" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "location": "eastus2", + "id": "/subscriptions/c1be1141-a7c9-4aac-9608-3c2e2f1152c3/providers/Microsoft.Orbital/availableGroundStations/EASTUS2_0", + "name": "EASTUS2_0", + "type": "Microsoft.Orbital/availableGroundStations", + "properties": { + "city": "Atlanta", + "providerName": "Microsoft", + "longitudeDegrees": -84.39111, + "latitudeDegrees": 33.74831, + "altitudeMeters": 1641.0 + } + }, + { + "location": "eastus2", + "id": "/subscriptions/c1be1141-a7c9-4aac-9608-3c2e2f1152c3/providers/Microsoft.Orbital/availableGroundStations/EASTUS_1", + "name": "EASTUS_1", + "type": "Microsoft.Orbital/availableGroundStations", + "properties": { + "city": "Reston", + "providerName": "Microsoft", + "longitudeDegrees": -77.357002, + "latitudeDegrees": 38.9586307, + "altitudeMeters": 128.0 + } + } + ], + "nextLink": "string" + } + } + } +} diff --git a/specification/orbital/resource-manager/Microsoft.Orbital/stable/2022-11-01/examples/ContactCreate.json b/specification/orbital/resource-manager/Microsoft.Orbital/stable/2022-11-01/examples/ContactCreate.json new file mode 100644 index 000000000000..7a5573c21030 --- /dev/null +++ b/specification/orbital/resource-manager/Microsoft.Orbital/stable/2022-11-01/examples/ContactCreate.json @@ -0,0 +1,81 @@ +{ + "parameters": { + "api-version": "2022-11-01", + "subscriptionId": "c1be1141-a7c9-4aac-9608-3c2e2f1152c3", + "resourceGroupName": "contoso-Rgp", + "contactName": "contact1", + "spacecraftName": "CONTOSO_SAT", + "parameters": { + "properties": { + "reservationStartTime": "2023-02-22T10:58:30Z", + "reservationEndTime": "2023-02-22T11:10:45Z", + "groundStationName": "EASTUS2_0", + "contactProfile": { + "id": "/subscriptions/c1be1141-a7c9-4aac-9608-3c2e2f1152c3/resourceGroups/contoso-Rgp/providers/Microsoft.Orbital/contactProfiles/CONTOSO-CP" + } + } + } + }, + "responses": { + "200": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Microsoft.Orbital/operationResults/4e2ffff7-b331-4fcb-ab11-b5fa49368188?api-version=2022-11-01" + }, + "body": { + "id": "/subscriptions/c1be1141-a7c9-4aac-9608-3c2e2f1152c3/resourceGroups/contoso-Rgp/providers/Microsoft.Orbital/spacecrafts/CONTOSO_SAT/contacts/contact1", + "name": "contact1", + "type": "Microsoft.Orbital/spacecrafts/contacts", + "properties": { + "status": "scheduled", + "reservationStartTime": "2023-02-22T10:58:30Z", + "reservationEndTime": "2023-02-22T11:10:45Z", + "errorMessage": null, + "groundStationName": "EASTUS2_0", + "contactProfile": { + "id": "/subscriptions/c1be1141-a7c9-4aac-9608-3c2e2f1152c3/resourceGroups/contoso-Rgp/providers/Microsoft.Orbital/contactProfiles/CONTOSO-CP" + }, + "antennaConfiguration": null, + "maximumElevationDegrees": 85.9796, + "txStartTime": "2023-02-22T10:58:30Z", + "txEndTime": "2023-02-22T11:10:45Z", + "rxStartTime": "2023-02-22T10:58:30Z", + "rxEndTime": "2023-02-22T11:10:45Z", + "startAzimuthDegrees": 165.758896, + "endAzimuthDegrees": 345.848482, + "startElevationDegrees": 5.0, + "endElevationDegrees": 5.048656 + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Microsoft.Orbital/operationResults/4e2ffff7-b331-4fcb-ab11-b5fa49368188?api-version=2022-11-01" + }, + "body": { + "id": "/subscriptions/c1be1141-a7c9-4aac-9608-3c2e2f1152c3/resourceGroups/contoso-Rgp/providers/Microsoft.Orbital/spacecrafts/CONTOSO_SAT/contacts/contact1", + "name": "contact1", + "type": "Microsoft.Orbital/spacecrafts/contacts", + "properties": { + "status": "scheduled", + "reservationStartTime": "2023-02-22T10:58:30Z", + "reservationEndTime": "2023-02-22T11:10:45Z", + "errorMessage": null, + "groundStationName": "EASTUS2_0", + "contactProfile": { + "id": "/subscriptions/c1be1141-a7c9-4aac-9608-3c2e2f1152c3/resourceGroups/contoso-Rgp/providers/Microsoft.Orbital/contactProfiles/CONTOSO-CP" + }, + "antennaConfiguration": null, + "maximumElevationDegrees": 0.0, + "txStartTime": null, + "txEndTime": null, + "rxStartTime": null, + "rxEndTime": null, + "startAzimuthDegrees": 0.0, + "endAzimuthDegrees": 0.0, + "startElevationDegrees": 0.0, + "endElevationDegrees": 0.0 + } + } + } + } +} diff --git a/specification/orbital/resource-manager/Microsoft.Orbital/stable/2022-11-01/examples/ContactDelete.json b/specification/orbital/resource-manager/Microsoft.Orbital/stable/2022-11-01/examples/ContactDelete.json new file mode 100644 index 000000000000..96f112bb401d --- /dev/null +++ b/specification/orbital/resource-manager/Microsoft.Orbital/stable/2022-11-01/examples/ContactDelete.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2022-11-01", + "subscriptionId": "c1be1141-a7c9-4aac-9608-3c2e2f1152c3", + "resourceGroupName": "contoso-Rgp", + "spacecraftName": "CONTOSO_SAT", + "contactName": "contact1" + }, + "responses": { + "200": { + "headers": { + "Location": "https://management.azure.com/Microsoft.Orbital/operationResults/4e2ffff7-b331-4fcb-ab11-b5fa49368188?api-version=2022-11-01" + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/Microsoft.Orbital/operationResults/4e2ffff7-b331-4fcb-ab11-b5fa49368188?api-version=2022-11-01" + } + }, + "204": {} + } +} diff --git a/specification/orbital/resource-manager/Microsoft.Orbital/stable/2022-11-01/examples/ContactGet.json b/specification/orbital/resource-manager/Microsoft.Orbital/stable/2022-11-01/examples/ContactGet.json new file mode 100644 index 000000000000..45f1d2589000 --- /dev/null +++ b/specification/orbital/resource-manager/Microsoft.Orbital/stable/2022-11-01/examples/ContactGet.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "api-version": "2022-11-01", + "subscriptionId": "c1be1141-a7c9-4aac-9608-3c2e2f1152c3", + "resourceGroupName": "contoso-Rgp", + "spacecraftName": "CONTOSO_SAT", + "contactName": "contact1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/c1be1141-a7c9-4aac-9608-3c2e2f1152c3/resourceGroups/contoso-Rgp/providers/Microsoft.Orbital/spacecrafts/CONTOSO_SAT/contacts/contact1", + "name": "contact1", + "type": "Microsoft.Orbital/spacecrafts/contacts", + "properties": { + "status": "scheduled", + "provisioningState": "succeeded", + "reservationStartTime": "2022-03-02T10:58:30Z", + "reservationEndTime": "2022-03-02T11:10:45Z", + "errorMessage": null, + "groundStationName": "EASTUS2_0", + "contactProfile": { + "id": "/subscriptions/c1be1141-a7c9-4aac-9608-3c2e2f1152c3/resourceGroups/contoso-Rgp/providers/Microsoft.Orbital/contactProfiles/CONTOSO-CP" + }, + "antennaConfiguration": { + "destinationIp": "10.1.1.171", + "sourceIps": [ + "10.1.1.4", + "10.1.1.5" + ] + }, + "maximumElevationDegrees": 85.9796, + "txStartTime": "2022-03-02T10:58:30Z", + "txEndTime": "2022-03-02T11:10:45Z", + "rxStartTime": "2022-03-02T10:58:30Z", + "rxEndTime": "2022-03-02T11:10:45Z", + "startAzimuthDegrees": 165.758896, + "endAzimuthDegrees": 345.848482, + "startElevationDegrees": 5.0, + "endElevationDegrees": 5.048656 + } + } + } + } +} diff --git a/specification/orbital/resource-manager/Microsoft.Orbital/stable/2022-11-01/examples/ContactProfileCreate.json b/specification/orbital/resource-manager/Microsoft.Orbital/stable/2022-11-01/examples/ContactProfileCreate.json new file mode 100644 index 000000000000..9e371b778239 --- /dev/null +++ b/specification/orbital/resource-manager/Microsoft.Orbital/stable/2022-11-01/examples/ContactProfileCreate.json @@ -0,0 +1,238 @@ +{ + "parameters": { + "api-version": "2022-11-01", + "subscriptionId": "c1be1141-a7c9-4aac-9608-3c2e2f1152c3", + "resourceGroupName": "contoso-Rgp", + "contactProfileName": "CONTOSO-CP", + "parameters": { + "location": "eastus2", + "properties": { + "minimumViableContactDuration": "PT1M", + "minimumElevationDegrees": 5.0, + "autoTrackingConfiguration": "disabled", + "eventHubUri": "/subscriptions/c1be1141-a7c9-4aac-9608-3c2e2f1152c3/resourceGroups/contoso-Rgp/providers/Microsoft.EventHub/namespaces/contosoHub/eventhubs/contosoHub", + "networkConfiguration": { + "subnetId": "/subscriptions/c1be1141-a7c9-4aac-9608-3c2e2f1152c3/resourceGroups/contoso-Rgp/providers/Microsoft.Network/virtualNetworks/contoso-vnet/subnets/orbital-delegated-subnet" + }, + "thirdPartyConfigurations": [ + { + "providerName": "KSAT", + "missionConfiguration": "Ksat_MissionConfiguration" + }, + { + "providerName": "VIASAT", + "missionConfiguration": "Viasat_Configuration" + } + ], + "links": [ + { + "name": "contoso-uplink", + "polarization": "LHCP", + "direction": "Uplink", + "gainOverTemperature": 0, + "eirpdBW": 45, + "channels": [ + { + "name": "contoso-uplink-channel", + "centerFrequencyMHz": 2250.0, + "bandwidthMHz": 2.0, + "endPoint": { + "ipAddress": "10.1.0.4", + "endPointName": "ContosoTest_Uplink", + "port": "50000", + "protocol": "TCP" + } + } + ] + }, + { + "name": "contoso-downlink", + "polarization": "RHCP", + "direction": "Downlink", + "gainOverTemperature": 25.0, + "eirpdBW": 0.0, + "channels": [ + { + "name": "contoso-downlink-channel", + "centerFrequencyMHz": 8160.0, + "bandwidthMHz": 15.0, + "endPoint": { + "ipAddress": "10.1.0.5", + "endPointName": "ContosoTest_Downlink", + "port": "50001", + "protocol": "UDP" + } + } + ] + } + ] + } + } + }, + "responses": { + "200": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Microsoft.Orbital/operationResults/4e2ffff7-b331-4fcb-ab11-b5fa49368188?api-version=2022-11-01" + }, + "body": { + "location": "eastus2", + "tags": null, + "id": "/subscriptions/c1be1141-a7c9-4aac-9608-3c2e2f1152c3/resourceGroups/contoso-Rgp/providers/Microsoft.Orbital/contactProfiles/CONTOSO-CP", + "name": "CONTOSO-CP", + "type": "Microsoft.Orbital/contactProfiles", + "properties": { + "provisioningState": "updating", + "minimumViableContactDuration": "PT1M", + "minimumElevationDegrees": 5.0, + "autoTrackingConfiguration": "disabled", + "eventHubUri": "/subscriptions/c1be1141-a7c9-4aac-9608-3c2e2f1152c3/resourceGroups/contoso-Rgp/providers/Microsoft.EventHub/namespaces/contosoHub/eventhubs/contosoHub", + "networkConfiguration": { + "subnetId": "/subscriptions/c1be1141-a7c9-4aac-9608-3c2e2f1152c3/resourceGroups/contoso-Rgp/providers/Microsoft.Network/virtualNetworks/contoso-vnet/subnets/orbital-delegated-subnet" + }, + "thirdPartyConfigurations": [ + { + "providerName": "KSAT", + "missionConfiguration": "Ksat_MissionConfiguration" + }, + { + "providerName": "VIASAT", + "missionConfiguration": "Viasat_Configuration" + } + ], + "links": [ + { + "name": "contoso-uplink", + "polarization": "LHCP", + "direction": "Uplink", + "gainOverTemperature": 0, + "eirpdBW": 45, + "channels": [ + { + "name": "contoso-uplink-channel", + "centerFrequencyMHz": 2250.0, + "bandwidthMHz": 2.0, + "endPoint": { + "ipAddress": "10.1.0.4", + "endPointName": "ContosoTest_Uplink", + "port": "50000", + "protocol": "TCP" + }, + "modulationConfiguration": null, + "demodulationConfiguration": null, + "encodingConfiguration": null, + "decodingConfiguration": null + } + ] + }, + { + "name": "contoso-downlink", + "polarization": "RHCP", + "direction": "Downlink", + "gainOverTemperature": 25.0, + "eirpdBW": 0.0, + "channels": [ + { + "name": "contoso-downlink-channel", + "centerFrequencyMHz": 8160.0, + "bandwidthMHz": 15.0, + "endPoint": { + "ipAddress": "10.1.0.5", + "endPointName": "ContosoTest_Downlink", + "port": "50001", + "protocol": "UDP" + }, + "modulationConfiguration": null, + "demodulationConfiguration": null, + "encodingConfiguration": null, + "decodingConfiguration": null + } + ] + } + ] + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Microsoft.Orbital/operationResults/4e2ffff7-b331-4fcb-ab11-b5fa49368188?api-version=2022-11-01" + }, + "body": { + "location": "eastus2", + "tags": null, + "id": "/subscriptions/c1be1141-a7c9-4aac-9608-3c2e2f1152c3/resourceGroups/contoso-Rgp/providers/Microsoft.Orbital/contactProfiles/CONTOSO-CP", + "name": "CONTOSO-CP", + "type": "Microsoft.Orbital/contactProfiles", + "properties": { + "provisioningState": "succeeded", + "minimumViableContactDuration": "PT1M", + "minimumElevationDegrees": 5.0, + "autoTrackingConfiguration": "disabled", + "eventHubUri": "/subscriptions/c1be1141-a7c9-4aac-9608-3c2e2f1152c3/resourceGroups/contoso-Rgp/providers/Microsoft.EventHub/namespaces/contosoHub/eventhubs/contosoHub", + "networkConfiguration": { + "subnetId": "/subscriptions/c1be1141-a7c9-4aac-9608-3c2e2f1152c3/resourceGroups/contoso-Rgp/providers/Microsoft.Network/virtualNetworks/contoso-vnet/subnets/orbital-delegated-subnet" + }, + "thirdPartyConfigurations": [ + { + "providerName": "KSAT", + "missionConfiguration": "Ksat_MissionConfiguration" + }, + { + "providerName": "VIASAT", + "missionConfiguration": "Viasat_Configuration" + } + ], + "links": [ + { + "name": "contoso-uplink", + "polarization": "LHCP", + "direction": "Uplink", + "gainOverTemperature": 0, + "eirpdBW": 45, + "channels": [ + { + "name": "contoso-uplink-channel", + "centerFrequencyMHz": 2250.0, + "bandwidthMHz": 2.0, + "endPoint": { + "ipAddress": "10.1.0.4", + "endPointName": "ContosoTest_Uplink", + "port": "50000", + "protocol": "TCP" + }, + "modulationConfiguration": null, + "demodulationConfiguration": null, + "encodingConfiguration": null, + "decodingConfiguration": null + } + ] + }, + { + "name": "contoso-downlink", + "polarization": "RHCP", + "direction": "Downlink", + "gainOverTemperature": 25.0, + "eirpdBW": 0.0, + "channels": [ + { + "name": "contoso-downlink-channel", + "centerFrequencyMHz": 8160.0, + "bandwidthMHz": 15.0, + "endPoint": { + "ipAddress": "10.1.0.5", + "endPointName": "ContosoTest_Downlink", + "port": "50001", + "protocol": "UDP" + }, + "modulationConfiguration": null, + "demodulationConfiguration": null, + "encodingConfiguration": null, + "decodingConfiguration": null + } + ] + } + ] + } + } + } + } +} diff --git a/specification/orbital/resource-manager/Microsoft.Orbital/stable/2022-11-01/examples/ContactProfileDelete.json b/specification/orbital/resource-manager/Microsoft.Orbital/stable/2022-11-01/examples/ContactProfileDelete.json new file mode 100644 index 000000000000..4cde90c3886c --- /dev/null +++ b/specification/orbital/resource-manager/Microsoft.Orbital/stable/2022-11-01/examples/ContactProfileDelete.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2022-11-01", + "subscriptionId": "c1be1141-a7c9-4aac-9608-3c2e2f1152c3", + "resourceGroupName": "contoso-Rgp", + "contactProfileName": "CONTOSO-CP" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/Microsoft.Orbital/operationResults/4e2ffff7-b331-4fcb-ab11-b5fa49368188?api-version=2022-11-01" + } + }, + "204": {} + } +} diff --git a/specification/orbital/resource-manager/Microsoft.Orbital/stable/2022-11-01/examples/ContactProfileGet.json b/specification/orbital/resource-manager/Microsoft.Orbital/stable/2022-11-01/examples/ContactProfileGet.json new file mode 100644 index 000000000000..e7a2ccc42343 --- /dev/null +++ b/specification/orbital/resource-manager/Microsoft.Orbital/stable/2022-11-01/examples/ContactProfileGet.json @@ -0,0 +1,89 @@ +{ + "parameters": { + "api-version": "2022-11-01", + "subscriptionId": "c1be1141-a7c9-4aac-9608-3c2e2f1152c3", + "resourceGroupName": "contoso-Rgp", + "contactProfileName": "CONTOSO-CP" + }, + "responses": { + "200": { + "body": { + "location": "eastus2", + "tags": null, + "id": "/subscriptions/c1be1141-a7c9-4aac-9608-3c2e2f1152c3/resourceGroups/contoso-Rgp/providers/Microsoft.Orbital/contactProfiles/CONTOSO-CP", + "name": "CONTOSO-CP", + "type": "Microsoft.Orbital/contactProfiles", + "properties": { + "provisioningState": "succeeded", + "minimumViableContactDuration": "PT1M", + "minimumElevationDegrees": 5.0, + "autoTrackingConfiguration": "disabled", + "eventHubUri": "/subscriptions/c1be1141-a7c9-4aac-9608-3c2e2f1152c3/resourceGroups/contoso-Rgp/providers/Microsoft.EventHub/namespaces/contosoHub/eventhubs/contosoHub", + "networkConfiguration": { + "subnetId": "/subscriptions/c1be1141-a7c9-4aac-9608-3c2e2f1152c3/resourceGroups/contoso-Rgp/providers/Microsoft.Network/virtualNetworks/contoso-vnet/subnets/orbital-delegated-subnet" + }, + "thirdPartyConfigurations": [ + { + "providerName": "KSAT", + "missionConfiguration": "Ksat_MissionConfiguration" + }, + { + "providerName": "VIASAT", + "missionConfiguration": "Viasat_Configuration" + } + ], + "links": [ + { + "name": "contoso-uplink", + "polarization": "LHCP", + "direction": "Uplink", + "gainOverTemperature": 0, + "eirpdBW": 45, + "channels": [ + { + "name": "contoso-uplink-channel", + "centerFrequencyMHz": 2250.0, + "bandwidthMHz": 2.0, + "endPoint": { + "ipAddress": "10.1.0.4", + "endPointName": "ContosoTest_Uplink", + "port": "50000", + "protocol": "TCP" + }, + "modulationConfiguration": null, + "demodulationConfiguration": null, + "encodingConfiguration": null, + "decodingConfiguration": null + } + ] + }, + { + "name": "contoso-downlink", + "polarization": "RHCP", + "direction": "Downlink", + "gainOverTemperature": 25.0, + "eirpdBW": 0.0, + "channels": [ + { + "name": "contoso-downlink-channel", + "centerFrequencyMHz": 8160.0, + "bandwidthMHz": 15.0, + "endPoint": { + "ipAddress": "10.1.0.5", + "endPointName": "ContosoTest_Downlink", + "port": "51103", + "protocol": "UDP" + }, + "modulationConfiguration": null, + "demodulationConfiguration": null, + "encodingConfiguration": null, + "decodingConfiguration": null + } + ] + } + ] + } + } + } + } +} diff --git a/specification/orbital/resource-manager/Microsoft.Orbital/stable/2022-11-01/examples/ContactProfileUpdateTag.json b/specification/orbital/resource-manager/Microsoft.Orbital/stable/2022-11-01/examples/ContactProfileUpdateTag.json new file mode 100644 index 000000000000..23230e0226e6 --- /dev/null +++ b/specification/orbital/resource-manager/Microsoft.Orbital/stable/2022-11-01/examples/ContactProfileUpdateTag.json @@ -0,0 +1,103 @@ +{ + "parameters": { + "api-version": "2022-11-01", + "subscriptionId": "c1be1141-a7c9-4aac-9608-3c2e2f1152c3", + "resourceGroupName": "contoso-Rgp", + "contactProfileName": "CONTOSO-CP", + "parameters": { + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + }, + "responses": { + "200": { + "body": { + "location": "eastus2", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "id": "/subscriptions/c1be1141-a7c9-4aac-9608-3c2e2f1152c3/resourceGroups/contoso-Rgp/providers/Microsoft.Orbital/contactProfiles/CONTOSO-CP", + "name": "CONTOSO-CP", + "type": "Microsoft.Orbital/contactProfiles", + "properties": { + "provisioningState": "succeeded", + "minimumViableContactDuration": "PT1M", + "minimumElevationDegrees": 5.0, + "autoTrackingConfiguration": "disabled", + "eventHubUri": "/subscriptions/c1be1141-a7c9-4aac-9608-3c2e2f1152c3/resourceGroups/contoso-Rgp/providers/Microsoft.EventHub/namespaces/contosoHub/eventhubs/contosoHub", + "networkConfiguration": { + "subnetId": "/subscriptions/c1be1141-a7c9-4aac-9608-3c2e2f1152c3/resourceGroups/contoso-Rgp/providers/Microsoft.Network/virtualNetworks/contoso-vnet/subnets/orbital-delegated-subnet" + }, + "thirdPartyConfigurations": [ + { + "providerName": "KSAT", + "missionConfiguration": "Ksat_MissionConfiguration" + }, + { + "providerName": "VIASAT", + "missionConfiguration": "Viasat_Configuration" + } + ], + "links": [ + { + "name": "contoso-uplink", + "polarization": "LHCP", + "direction": "Uplink", + "gainOverTemperature": 0, + "eirpdBW": 45, + "channels": [ + { + "name": "contoso-uplink-channel", + "centerFrequencyMHz": 2250.0, + "bandwidthMHz": 2.0, + "endPoint": { + "ipAddress": "10.1.0.4", + "endPointName": "ContosoTest_Uplink", + "port": "50000", + "protocol": "TCP" + }, + "modulationConfiguration": null, + "demodulationConfiguration": null, + "encodingConfiguration": null, + "decodingConfiguration": null + } + ] + }, + { + "name": "contoso-downlink", + "polarization": "RHCP", + "direction": "Downlink", + "gainOverTemperature": 25.0, + "eirpdBW": 0.0, + "channels": [ + { + "name": "contoso-downlink-channel", + "centerFrequencyMHz": 8160.0, + "bandwidthMHz": 15.0, + "endPoint": { + "ipAddress": "10.1.0.5", + "endPointName": "ContosoTest_Downlink", + "port": "50001", + "protocol": "UDP" + }, + "modulationConfiguration": null, + "demodulationConfiguration": null, + "encodingConfiguration": null, + "decodingConfiguration": null + } + ] + } + ] + } + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/Microsoft.Orbital/operationResults/4e2ffff7-b331-4fcb-ab11-b5fa49368188?api-version=2022-11-01" + } + } + } +} diff --git a/specification/orbital/resource-manager/Microsoft.Orbital/stable/2022-11-01/examples/ContactProfilesByResourceGroupList.json b/specification/orbital/resource-manager/Microsoft.Orbital/stable/2022-11-01/examples/ContactProfilesByResourceGroupList.json new file mode 100644 index 000000000000..dadc5b4df4aa --- /dev/null +++ b/specification/orbital/resource-manager/Microsoft.Orbital/stable/2022-11-01/examples/ContactProfilesByResourceGroupList.json @@ -0,0 +1,94 @@ +{ + "parameters": { + "subscriptionId": "c1be1141-a7c9-4aac-9608-3c2e2f1152c3", + "resourceGroupName": "contoso-Rgp", + "api-version": "2022-11-01", + "$skipToken": "opaqueString" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "location": "eastus2", + "tags": null, + "id": "/subscriptions/c1be1141-a7c9-4aac-9608-3c2e2f1152c3/resourceGroups/contoso-Rgp/providers/Microsoft.Orbital/contactProfiles/CONTOSO-CP", + "name": "CONTOSO-CP", + "type": "Microsoft.Orbital/contactProfiles", + "properties": { + "provisioningState": "succeeded", + "minimumViableContactDuration": "PT1M", + "minimumElevationDegrees": 5.0, + "autoTrackingConfiguration": "disabled", + "eventHubUri": "/subscriptions/c1be1141-a7c9-4aac-9608-3c2e2f1152c3/resourceGroups/contoso-Rgp/providers/Microsoft.EventHub/namespaces/contosoHub/eventhubs/contosoHub", + "networkConfiguration": { + "subnetId": "/subscriptions/c1be1141-a7c9-4aac-9608-3c2e2f1152c3/resourceGroups/contoso-Rgp/providers/Microsoft.Network/virtualNetworks/contoso-vnet/subnets/orbital-delegated-subnet" + }, + "thirdPartyConfigurations": [ + { + "providerName": "KSAT", + "missionConfiguration": "Ksat_MissionConfiguration" + }, + { + "providerName": "VIASAT", + "missionConfiguration": "Viasat_Configuration" + } + ], + "links": [ + { + "name": "contoso-uplink", + "polarization": "LHCP", + "direction": "Uplink", + "gainOverTemperature": 0, + "eirpdBW": 45, + "channels": [ + { + "name": "contoso-uplink-channel", + "centerFrequencyMHz": 2250.0, + "bandwidthMHz": 2.0, + "endPoint": { + "ipAddress": "10.1.0.4", + "endPointName": "ContosoTest_Uplink", + "port": "50000", + "protocol": "TCP" + }, + "modulationConfiguration": null, + "demodulationConfiguration": null, + "encodingConfiguration": null, + "decodingConfiguration": null + } + ] + }, + { + "name": "contoso-downlink", + "polarization": "RHCP", + "direction": "Downlink", + "gainOverTemperature": 25.0, + "eirpdBW": 0.0, + "channels": [ + { + "name": "contoso-downlink-channel", + "centerFrequencyMHz": 8160.0, + "bandwidthMHz": 15.0, + "endPoint": { + "ipAddress": "10.1.0.5", + "endPointName": "ContosoTest_Downlink", + "port": "50001", + "protocol": "UDP" + }, + "modulationConfiguration": null, + "demodulationConfiguration": null, + "encodingConfiguration": null, + "decodingConfiguration": null + } + ] + } + ] + } + } + ], + "nextLink": "https://management.azure.com/subscriptions/c1be1141-a7c9-4aac-9608-3c2e2f1152c3/resourceGroups/contoso-Rgp/providers/Microsoft.Orbital/contactProfiles?api-version=2022-11-01&$skiptoken=opaqueString" + } + } + } +} diff --git a/specification/orbital/resource-manager/Microsoft.Orbital/stable/2022-11-01/examples/ContactProfilesBySubscriptionList.json b/specification/orbital/resource-manager/Microsoft.Orbital/stable/2022-11-01/examples/ContactProfilesBySubscriptionList.json new file mode 100644 index 000000000000..140c39a68952 --- /dev/null +++ b/specification/orbital/resource-manager/Microsoft.Orbital/stable/2022-11-01/examples/ContactProfilesBySubscriptionList.json @@ -0,0 +1,94 @@ +{ + "parameters": { + "subscriptionId": "c1be1141-a7c9-4aac-9608-3c2e2f1152c3", + "resourceGroupName": "contoso-Rgp", + "api-version": "2022-11-01", + "$skipToken": "opaqueString" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "location": "eastus2", + "tags": null, + "id": "/subscriptions/c1be1141-a7c9-4aac-9608-3c2e2f1152c3/resourceGroups/contoso-Rgp/providers/Microsoft.Orbital/contactProfiles/CONTOSO-CP", + "name": "CONTOSO-CP", + "type": "Microsoft.Orbital/contactProfiles", + "properties": { + "provisioningState": "succeeded", + "minimumViableContactDuration": "PT1M", + "minimumElevationDegrees": 5.0, + "autoTrackingConfiguration": "disabled", + "eventHubUri": "/subscriptions/c1be1141-a7c9-4aac-9608-3c2e2f1152c3/resourceGroups/contoso-Rgp/providers/Microsoft.EventHub/namespaces/contosoHub/eventhubs/contosoHub", + "networkConfiguration": { + "subnetId": "/subscriptions/c1be1141-a7c9-4aac-9608-3c2e2f1152c3/resourceGroups/contoso-Rgp/providers/Microsoft.Network/virtualNetworks/contoso-vnet/subnets/orbital-delegated-subnet" + }, + "thirdPartyConfigurations": [ + { + "providerName": "KSAT", + "missionConfiguration": "Ksat_MissionConfiguration" + }, + { + "providerName": "VIASAT", + "missionConfiguration": "Viasat_Configuration" + } + ], + "links": [ + { + "name": "contoso-uplink", + "polarization": "LHCP", + "direction": "Uplink", + "gainOverTemperature": 0, + "eirpdBW": 45, + "channels": [ + { + "name": "contoso-uplink-channel", + "centerFrequencyMHz": 2250.0, + "bandwidthMHz": 2.0, + "endPoint": { + "ipAddress": "10.1.0.4", + "endPointName": "ContosoTest_Uplink", + "port": "50000", + "protocol": "TCP" + }, + "modulationConfiguration": null, + "demodulationConfiguration": null, + "encodingConfiguration": null, + "decodingConfiguration": null + } + ] + }, + { + "name": "contoso-downlink", + "polarization": "RHCP", + "direction": "Downlink", + "gainOverTemperature": 25.0, + "eirpdBW": 0.0, + "channels": [ + { + "name": "contoso-downlink-channel", + "centerFrequencyMHz": 8160.0, + "bandwidthMHz": 15.0, + "endPoint": { + "ipAddress": "10.1.0.5", + "endPointName": "ContosoTest_Downlink", + "port": "50001", + "protocol": "UDP" + }, + "modulationConfiguration": null, + "demodulationConfiguration": null, + "encodingConfiguration": null, + "decodingConfiguration": null + } + ] + } + ] + } + } + ], + "nextLink": "https://management.azure.com/subscriptions/c1be1141-a7c9-4aac-9608-3c2e2f1152c3/providers/Microsoft.Orbital/contactProfiles?api-version=2022-11-01&$skiptoken=opaqueString" + } + } + } +} diff --git a/specification/orbital/resource-manager/Microsoft.Orbital/stable/2022-11-01/examples/ContactsBySpacecraftNameList.json b/specification/orbital/resource-manager/Microsoft.Orbital/stable/2022-11-01/examples/ContactsBySpacecraftNameList.json new file mode 100644 index 000000000000..066128d9b5a9 --- /dev/null +++ b/specification/orbital/resource-manager/Microsoft.Orbital/stable/2022-11-01/examples/ContactsBySpacecraftNameList.json @@ -0,0 +1,82 @@ +{ + "parameters": { + "api-version": "2022-11-01", + "subscriptionId": "c1be1141-a7c9-4aac-9608-3c2e2f1152c3", + "resourceGroupName": "contoso-Rgp", + "spacecraftName": "CONTOSO_SAT", + "$skipToken": "opaqueString" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/c1be1141-a7c9-4aac-9608-3c2e2f1152c3/resourceGroups/contoso-Rgp/providers/Microsoft.Orbital/spacecrafts/CONTOSO_SAT/contacts/contact2", + "name": "contact1", + "type": "Microsoft.Orbital/spacecrafts/contacts", + "properties": { + "status": "succeeded", + "provisioningState": "succeeded", + "reservationStartTime": "2022-03-01T11:55:01Z", + "reservationEndTime": "2022-03-01T12:05:25Z", + "errorMessage": null, + "groundStationName": "EASTUS2_0", + "contactProfile": { + "id": "/subscriptions/c1be1141-a7c9-4aac-9608-3c2e2f1152c3/resourceGroups/contoso-Rgp/providers/Microsoft.Orbital/contactProfiles/CONTOSO-CP" + }, + "antennaConfiguration": { + "destinationIp": "10.1.1.171", + "sourceIps": [ + "10.1.1.4", + "10.1.1.5" + ] + }, + "maximumElevationDegrees": 26.617297, + "txStartTime": "2022-03-01T11:55:01Z", + "txEndTime": "2022-03-01T12:05:25Z", + "rxStartTime": "2022-03-01T11:55:01Z", + "rxEndTime": "2022-03-01T12:05:25Z", + "startAzimuthDegrees": 201.340472, + "endAzimuthDegrees": 330.489627, + "startElevationDegrees": 5.0, + "endElevationDegrees": 5.040625 + } + }, + { + "id": "/subscriptions/c1be1141-a7c9-4aac-9608-3c2e2f1152c3/resourceGroups/contoso-Rgp/providers/Microsoft.Orbital/spacecrafts/CONTOSO_SAT/contacts/contact1", + "name": "contact2", + "type": "Microsoft.Orbital/spacecrafts/contacts", + "properties": { + "status": "succeeded", + "provisioningState": "succeeded", + "reservationStartTime": "2022-03-02T10:58:30Z", + "reservationEndTime": "2022-03-02T11:10:45Z", + "errorMessage": null, + "groundStationName": "EASTUS2_0", + "contactProfile": { + "id": "/subscriptions/c1be1141-a7c9-4aac-9608-3c2e2f1152c3/resourceGroups/contoso-Rgp/providers/Microsoft.Orbital/contactProfiles/CONTOSO-CP" + }, + "antennaConfiguration": { + "destinationIp": "10.1.1.171", + "sourceIps": [ + "10.1.1.4", + "10.1.1.5" + ] + }, + "maximumElevationDegrees": 85.9796, + "txStartTime": "2022-03-02T10:58:30Z", + "txEndTime": "2022-03-02T11:10:45Z", + "rxStartTime": "2022-03-02T10:58:30Z", + "rxEndTime": "2022-03-02T11:10:45Z", + "startAzimuthDegrees": 165.758896, + "endAzimuthDegrees": 345.848482, + "startElevationDegrees": 5.0, + "endElevationDegrees": 5.048656 + } + } + ], + "nextLink": "https://management.azure.com/subscriptions/c1be1141-a7c9-4aac-9608-3c2e2f1152c3/resourceGroups/contoso-Rgp/providers/Microsoft.Orbital/spacecrafts/CONTOSO_SAT/contacts?api-version=2022-11-01&$skiptoken=opaqueString" + } + } + } +} diff --git a/specification/orbital/resource-manager/Microsoft.Orbital/stable/2022-11-01/examples/OperationResultsGet.json b/specification/orbital/resource-manager/Microsoft.Orbital/stable/2022-11-01/examples/OperationResultsGet.json new file mode 100644 index 000000000000..5656d6c36e31 --- /dev/null +++ b/specification/orbital/resource-manager/Microsoft.Orbital/stable/2022-11-01/examples/OperationResultsGet.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-123456789098", + "location": "eastus2", + "operationId": "30972f1b-b61d-4fd8-bd34-3dcfa24670f3", + "api-version": "2022-11-01" + }, + "responses": { + "200": { + "body": { + "id": "https://management.azure.com/Microsoft.Orbital/operationResults/4e2ffff7-b331-4fcb-ab11-b5fa49368188?api-version=2022-11-01", + "name": "30972f1b-b61d-4fd8-bd34-3dcfa24670f3", + "status": "Failed", + "startTime": "2022-06-10T13:54:53.6554616Z", + "endTime": "2022-06-10T13:54:55.7025301Z", + "percentComplete": 1.0, + "properties": {}, + "error": { + "code": "ReadOnlyPropertyError", + "message": "Cannot write to property, AuthorizationStatus, as it is read-only." + } + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/Microsoft.Orbital/operationResults/4e2ffff7-b331-4fcb-ab11-b5fa49368188?api-version=2022-11-01" + } + } + } +} diff --git a/specification/orbital/resource-manager/Microsoft.Orbital/stable/2022-11-01/examples/OperationsList.json b/specification/orbital/resource-manager/Microsoft.Orbital/stable/2022-11-01/examples/OperationsList.json new file mode 100644 index 000000000000..6bca51e92a8d --- /dev/null +++ b/specification/orbital/resource-manager/Microsoft.Orbital/stable/2022-11-01/examples/OperationsList.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2022-11-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.Orbital/spacecrafts/write", + "display": { + "provider": "Microsoft Orbital", + "resource": "Spacecraft", + "operation": "Create/Update a spacecraft", + "description": "Creates or Update a spacecraft." + } + } + ] + } + } + } +} diff --git a/specification/orbital/resource-manager/Microsoft.Orbital/stable/2022-11-01/examples/SpacecraftCreate.json b/specification/orbital/resource-manager/Microsoft.Orbital/stable/2022-11-01/examples/SpacecraftCreate.json new file mode 100644 index 000000000000..57345713c639 --- /dev/null +++ b/specification/orbital/resource-manager/Microsoft.Orbital/stable/2022-11-01/examples/SpacecraftCreate.json @@ -0,0 +1,129 @@ +{ + "parameters": { + "api-version": "2022-11-01", + "subscriptionId": "c1be1141-a7c9-4aac-9608-3c2e2f1152c3", + "resourceGroupName": "contoso-Rgp", + "spacecraftName": "CONTOSO_SAT", + "parameters": { + "location": "eastus2", + "properties": { + "noradId": "36411", + "titleLine": "CONTOSO_SAT", + "tleLine1": "1 27424U 02022A 22167.05119303 .00000638 00000+0 15103-3 0 9994", + "tleLine2": "2 27424 98.2477 108.9546 0000928 92.9194 327.0802 14.57300770 69982", + "links": [ + { + "name": "uplink_lhcp1", + "centerFrequencyMHz": 2250.0, + "bandwidthMHz": 2.0, + "direction": "Uplink", + "polarization": "LHCP" + }, + { + "name": "downlink_rhcp1", + "centerFrequencyMHz": 8160.0, + "bandwidthMHz": 15.0, + "direction": "Downlink", + "polarization": "RHCP" + } + ] + } + } + }, + "responses": { + "200": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Microsoft.Orbital/operationResults/4e2ffff7-b331-4fcb-ab11-b5fa49368188?api-version=2022-11-01" + }, + "body": { + "location": "eastus2", + "tags": null, + "id": "/subscriptions/c1be1141-a7c9-4aac-9608-3c2e2f1152c3/resourceGroups/contoso-Rgp/providers/Microsoft.Orbital/spacecrafts/CONTOSO_SAT", + "name": "CONTOSO_SAT", + "type": "Microsoft.Orbital/spacecrafts", + "properties": { + "provisioningState": "updating", + "noradId": "36411", + "titleLine": "CONTOSO_SAT", + "tleLine1": "1 27424U 02022A 22167.05119303 .00000638 00000+0 15103-3 0 9994", + "tleLine2": "2 27424 98.2477 108.9546 0000928 92.9194 327.0802 14.57300770 69982", + "links": [ + { + "name": "uplink_lhcp1", + "centerFrequencyMHz": 2250.0, + "bandwidthMHz": 2.0, + "direction": "Uplink", + "polarization": "LHCP", + "authorizations": [ + { + "groundStation": "EASTUS2_0", + "expirationDate": "2023-06-02" + } + ] + }, + { + "name": "downlink_rhcp1", + "centerFrequencyMHz": 8160.0, + "bandwidthMHz": 15.0, + "direction": "Downlink", + "polarization": "RHCP", + "authorizations": [ + { + "groundStation": "EASTUS2_0", + "expirationDate": "2023-06-02" + } + ] + } + ] + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Microsoft.Orbital/operationResults/4e2ffff7-b331-4fcb-ab11-b5fa49368188?api-version=2022-11-01" + }, + "body": { + "location": "eastus2", + "tags": null, + "id": "/subscriptions/c1be1141-a7c9-4aac-9608-3c2e2f1152c3/resourceGroups/contoso-Rgp/providers/Microsoft.Orbital/spacecrafts/CONTOSO_SAT", + "name": "CONTOSO_SAT", + "type": "Microsoft.Orbital/spacecrafts", + "properties": { + "provisioningState": "creating", + "noradId": "36411", + "titleLine": "CONTOSO_SAT", + "tleLine1": "1 27424U 02022A 22167.05119303 .00000638 00000+0 15103-3 0 9994", + "tleLine2": "2 27424 98.2477 108.9546 0000928 92.9194 327.0802 14.57300770 69982", + "links": [ + { + "name": "uplink_lhcp1", + "centerFrequencyMHz": 2250.0, + "bandwidthMHz": 2.0, + "direction": "Uplink", + "polarization": "LHCP", + "authorizations": [ + { + "groundStation": "EASTUS2_0", + "expirationDate": "2023-06-02" + } + ] + }, + { + "name": "downlink_rhcp1", + "centerFrequencyMHz": 8160.0, + "bandwidthMHz": 15.0, + "direction": "Downlink", + "polarization": "RHCP", + "authorizations": [ + { + "groundStation": "EASTUS2_0", + "expirationDate": "2023-06-02" + } + ] + } + ] + } + } + } + } +} diff --git a/specification/orbital/resource-manager/Microsoft.Orbital/stable/2022-11-01/examples/SpacecraftDelete.json b/specification/orbital/resource-manager/Microsoft.Orbital/stable/2022-11-01/examples/SpacecraftDelete.json new file mode 100644 index 000000000000..0227b99dfae2 --- /dev/null +++ b/specification/orbital/resource-manager/Microsoft.Orbital/stable/2022-11-01/examples/SpacecraftDelete.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2022-11-01", + "subscriptionId": "c1be1141-a7c9-4aac-9608-3c2e2f1152c3", + "resourceGroupName": "contoso-Rgp", + "spacecraftName": "CONTOSO_SAT" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/Microsoft.Orbital/operationResults/4e2ffff7-b331-4fcb-ab11-b5fa49368188?api-version=2022-11-01" + } + }, + "204": {} + } +} diff --git a/specification/orbital/resource-manager/Microsoft.Orbital/stable/2022-11-01/examples/SpacecraftGet.json b/specification/orbital/resource-manager/Microsoft.Orbital/stable/2022-11-01/examples/SpacecraftGet.json new file mode 100644 index 000000000000..4a5e412c0d80 --- /dev/null +++ b/specification/orbital/resource-manager/Microsoft.Orbital/stable/2022-11-01/examples/SpacecraftGet.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "api-version": "2022-11-01", + "subscriptionId": "c1be1141-a7c9-4aac-9608-3c2e2f1152c3", + "resourceGroupName": "contoso-Rgp", + "spacecraftName": "CONTOSO_SAT" + }, + "responses": { + "200": { + "body": { + "location": "eastus2", + "tags": null, + "id": "/subscriptions/c1be1141-a7c9-4aac-9608-3c2e2f1152c3/resourceGroups/contoso-Rgp/providers/Microsoft.Orbital/spacecrafts/CONTOSO_SAT", + "name": "CONTOSO_SAT", + "type": "Microsoft.Orbital/spacecrafts", + "properties": { + "provisioningState": "succeeded", + "noradId": "36411", + "titleLine": "CONTOSO_SAT", + "tleLine1": "1 27424U 02022A 22167.05119303 .00000638 00000+0 15103-3 0 9994", + "tleLine2": "2 27424 98.2477 108.9546 0000928 92.9194 327.0802 14.57300770 69982", + "links": [ + { + "name": "uplink_lhcp1", + "centerFrequencyMHz": 2250.0, + "bandwidthMHz": 2.0, + "direction": "Uplink", + "polarization": "LHCP", + "authorizations": [ + { + "groundStation": "EASTUS2_0", + "expirationDate": "2023-06-02" + } + ] + }, + { + "name": "downlink_rhcp1", + "centerFrequencyMHz": 8160.0, + "bandwidthMHz": 15.0, + "direction": "Downlink", + "polarization": "RHCP", + "authorizations": [ + { + "groundStation": "EASTUS2_0", + "expirationDate": "2023-06-02" + } + ] + } + ] + } + } + } + } +} diff --git a/specification/orbital/resource-manager/Microsoft.Orbital/stable/2022-11-01/examples/SpacecraftUpdateTags.json b/specification/orbital/resource-manager/Microsoft.Orbital/stable/2022-11-01/examples/SpacecraftUpdateTags.json new file mode 100644 index 000000000000..82e3f5175bee --- /dev/null +++ b/specification/orbital/resource-manager/Microsoft.Orbital/stable/2022-11-01/examples/SpacecraftUpdateTags.json @@ -0,0 +1,68 @@ +{ + "parameters": { + "api-version": "2022-11-01", + "subscriptionId": "c1be1141-a7c9-4aac-9608-3c2e2f1152c3", + "resourceGroupName": "contoso-Rgp", + "spacecraftName": "CONTOSO_SAT", + "parameters": { + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/Microsoft.Orbital/operationResults/4e2ffff7-b331-4fcb-ab11-b5fa49368188?api-version=2022-11-01" + } + }, + "200": { + "body": { + "location": "eastus2", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "id": "/subscriptions/c1be1141-a7c9-4aac-9608-3c2e2f1152c3/resourceGroups/contoso-Rgp/providers/Microsoft.Orbital/spacecrafts/CONTOSO_SAT", + "name": "CONTOSO_SAT", + "type": "Microsoft.Orbital/spacecrafts", + "properties": { + "provisioningState": "succeeded", + "noradId": "36411", + "titleLine": "CONTOSO_SAT", + "tleLine1": "1 27424U 02022A 22167.05119303 .00000638 00000+0 15103-3 0 9994", + "tleLine2": "2 27424 98.2477 108.9546 0000928 92.9194 327.0802 14.57300770 69982", + "links": [ + { + "name": "uplink_lhcp1", + "centerFrequencyMHz": 2250.0, + "bandwidthMHz": 2.0, + "direction": "Uplink", + "polarization": "LHCP", + "authorizations": [ + { + "groundStation": "EASTUS2_0", + "expirationDate": "2023-06-02" + } + ] + }, + { + "name": "downlink_rhcp1", + "centerFrequencyMHz": 8160.0, + "bandwidthMHz": 15.0, + "direction": "Downlink", + "polarization": "RHCP", + "authorizations": [ + { + "groundStation": "EASTUS2_0", + "expirationDate": "2023-06-02" + } + ] + } + ] + } + } + } + } +} diff --git a/specification/orbital/resource-manager/Microsoft.Orbital/stable/2022-11-01/examples/SpacecraftsByResourceGroupList.json b/specification/orbital/resource-manager/Microsoft.Orbital/stable/2022-11-01/examples/SpacecraftsByResourceGroupList.json new file mode 100644 index 000000000000..8bd85bba7459 --- /dev/null +++ b/specification/orbital/resource-manager/Microsoft.Orbital/stable/2022-11-01/examples/SpacecraftsByResourceGroupList.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "api-version": "2022-11-01", + "subscriptionId": "c1be1141-a7c9-4aac-9608-3c2e2f1152c3", + "resourceGroupName": "contoso-Rgp", + "$skipToken": "opaqueString" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "location": "eastus2", + "tags": null, + "id": "/subscriptions/c1be1141-a7c9-4aac-9608-3c2e2f1152c3/resourceGroups/contoso-Rgp/providers/Microsoft.Orbital/spacecrafts/CONTOSO_SAT", + "name": "CONTOSO_SAT", + "type": "Microsoft.Orbital/spacecrafts", + "properties": { + "provisioningState": "succeeded", + "noradId": "36411", + "titleLine": "CONTOSO_SAT", + "tleLine1": "1 27424U 02022A 22167.05119303 .00000638 00000+0 15103-3 0 9994", + "tleLine2": "2 27424 98.2477 108.9546 0000928 92.9194 327.0802 14.57300770 69982", + "links": [ + { + "name": "uplink_lhcp1", + "centerFrequencyMHz": 2250.0, + "bandwidthMHz": 2.0, + "direction": "Uplink", + "polarization": "LHCP", + "authorizations": [ + { + "groundStation": "EASTUS2_0", + "expirationDate": "2023-06-02" + } + ] + }, + { + "name": "downlink_rhcp1", + "centerFrequencyMHz": 8160.0, + "bandwidthMHz": 15.0, + "direction": "Downlink", + "polarization": "RHCP", + "authorizations": [ + { + "groundStation": "EASTUS2_0", + "expirationDate": "2023-06-02" + } + ] + } + ] + } + } + ], + "nextLink": "https://management.azure.com/subscriptions/c1be1141-a7c9-4aac-9608-3c2e2f1152c3/resourceGroups/contoso-Rgp/providers/Microsoft.Orbital/spacecrafts?api-version=2022-11-01&$skiptoken=opaqueString" + } + } + } +} diff --git a/specification/orbital/resource-manager/Microsoft.Orbital/stable/2022-11-01/examples/SpacecraftsBySubscriptionList.json b/specification/orbital/resource-manager/Microsoft.Orbital/stable/2022-11-01/examples/SpacecraftsBySubscriptionList.json new file mode 100644 index 000000000000..321f8b382185 --- /dev/null +++ b/specification/orbital/resource-manager/Microsoft.Orbital/stable/2022-11-01/examples/SpacecraftsBySubscriptionList.json @@ -0,0 +1,58 @@ +{ + "parameters": { + "api-version": "2022-11-01", + "subscriptionId": "c1be1141-a7c9-4aac-9608-3c2e2f1152c3", + "$skipToken": "opaqueString" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "location": "eastus2", + "tags": null, + "id": "/subscriptions/c1be1141-a7c9-4aac-9608-3c2e2f1152c3/resourceGroups/contoso-Rgp/providers/Microsoft.Orbital/spacecrafts/CONTOSO_SAT", + "name": "CONTOSO_SAT", + "type": "Microsoft.Orbital/spacecrafts", + "properties": { + "provisioningState": "succeeded", + "noradId": "36411", + "titleLine": "CONTOSO_SAT", + "tleLine1": "1 27424U 02022A 22167.05119303 .00000638 00000+0 15103-3 0 9994", + "tleLine2": "2 27424 98.2477 108.9546 0000928 92.9194 327.0802 14.57300770 69982", + "links": [ + { + "name": "uplink_lhcp1", + "centerFrequencyMHz": 2250.0, + "bandwidthMHz": 2.0, + "direction": "Uplink", + "polarization": "LHCP", + "authorizations": [ + { + "groundStation": "EASTUS2_0", + "expirationDate": "2023-06-02" + } + ] + }, + { + "name": "downlink_rhcp1", + "centerFrequencyMHz": 8160.0, + "bandwidthMHz": 15.0, + "direction": "Downlink", + "polarization": "RHCP", + "authorizations": [ + { + "groundStation": "EASTUS2_0", + "expirationDate": "2023-06-02" + } + ] + } + ] + } + } + ], + "nextLink": "https://management.azure.com/subscriptions/c1be1141-a7c9-4aac-9608-3c2e2f1152c3/providers/Microsoft.Orbital/spacecrafts?api-version=2022-11-01&$skiptoken=opaqueString" + } + } + } +} diff --git a/specification/orbital/resource-manager/Microsoft.Orbital/stable/2022-11-01/orbital.json b/specification/orbital/resource-manager/Microsoft.Orbital/stable/2022-11-01/orbital.json new file mode 100644 index 000000000000..a1ac3b5b8142 --- /dev/null +++ b/specification/orbital/resource-manager/Microsoft.Orbital/stable/2022-11-01/orbital.json @@ -0,0 +1,2172 @@ +{ + "swagger": "2.0", + "info": { + "version": "2022-11-01", + "title": "Azure Orbital", + "description": "Azure Orbital service.", + "license": { + "name": "Microsoft" + } + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/providers/Microsoft.Orbital/operations": { + "get": { + "tags": [ + "Operations" + ], + "description": "Lists all of the available Orbital Rest API operations.", + "operationId": "Operations_List", + "x-ms-examples": { + "OperationsList": { + "$ref": "./examples/OperationsList.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../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": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Orbital/spacecrafts": { + "get": { + "tags": [ + "Spacecraft" + ], + "description": "Returns list of spacecrafts by subscription.", + "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" + }, + { + "$ref": "#/parameters/skipTokenParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of spacecraft resources.", + "schema": { + "$ref": "#/definitions/SpacecraftListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed. If the resource group does not exist, 404 (NotFound) will be returned.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Orbital/spacecrafts": { + "get": { + "tags": [ + "Spacecraft" + ], + "description": "Returns list of spacecrafts by resource group.", + "operationId": "Spacecrafts_List", + "x-ms-examples": { + "List of Spacecraft by Resource Group": { + "$ref": "./examples/SpacecraftsByResourceGroupList.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/skipTokenParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of spacecraft resources.", + "schema": { + "$ref": "#/definitions/SpacecraftListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed. If the resource group does not exist, 404 (NotFound) will be returned.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Orbital/spacecrafts/{spacecraftName}": { + "get": { + "tags": [ + "Spacecraft" + ], + "operationId": "Spacecrafts_Get", + "description": "Gets the specified spacecraft in a specified resource group.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../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": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Spacecraft": { + "$ref": "./examples/SpacecraftGet.json" + } + } + }, + "put": { + "tags": [ + "Spacecraft" + ], + "description": "Creates or updates a spacecraft resource.", + "operationId": "Spacecrafts_CreateOrUpdate", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../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" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "URL for checking the ongoing status of the operation." + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Create a spacecraft": { + "$ref": "./examples/SpacecraftCreate.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "delete": { + "tags": [ + "Spacecraft" + ], + "operationId": "Spacecrafts_Delete", + "description": "Deletes a specified spacecraft resource.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../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.", + "headers": { + "Location": { + "type": "string", + "description": "URL for determining when an operation has completed." + } + } + }, + "204": { + "description": "Request successful. Resource does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete Spacecraft": { + "$ref": "./examples/SpacecraftDelete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "patch": { + "tags": [ + "Spacecraft" + ], + "operationId": "Spacecrafts_UpdateTags", + "x-ms-examples": { + "Update Spacecraft tags": { + "$ref": "./examples/SpacecraftUpdateTags.json" + } + }, + "description": "Updates the specified spacecraft tags.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/TagsObject" + }, + "description": "Parameters supplied to update spacecraft tags." + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/spacecraftNameParameter" + } + ], + "responses": { + "200": { + "description": "Update successful. The operation returns the resulting Spacecraft resource.", + "schema": { + "$ref": "#/definitions/Spacecraft" + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously.", + "headers": { + "Location": { + "type": "string", + "description": "URL for determining when an operation has completed." + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Orbital/spacecrafts/{spacecraftName}/contacts": { + "get": { + "tags": [ + "Contact" + ], + "description": "Returns list of contacts by spacecraftName.", + "operationId": "Contacts_List", + "x-ms-examples": { + "List of Spacecraft": { + "$ref": "./examples/ContactsBySpacecraftNameList.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/spacecraftNameParameter" + }, + { + "$ref": "#/parameters/skipTokenParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of contacts by spacecraftName.", + "schema": { + "$ref": "#/definitions/ContactListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed. If the resource group does not exist, 404 (NotFound) will be returned.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Orbital/spacecrafts/{spacecraftName}/contacts/{contactName}": { + "get": { + "tags": [ + "Contact" + ], + "operationId": "Contacts_Get", + "description": "Gets the specified contact in a specified resource group.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/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": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Contact": { + "$ref": "./examples/ContactGet.json" + } + } + }, + "put": { + "tags": [ + "Contact" + ], + "description": "Creates a contact.", + "operationId": "Contacts_Create", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/spacecraftNameParameter" + }, + { + "$ref": "#/parameters/contactNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Contact" + }, + "description": "The parameters to provide for the created contact." + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/Contact" + } + }, + "201": { + "description": "Create successful. The operation returns the resulting contact resource.", + "schema": { + "$ref": "#/definitions/Contact" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "URL for checking the ongoing status of the operation." + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Create a contact": { + "$ref": "./examples/ContactCreate.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "delete": { + "tags": [ + "Contact" + ], + "operationId": "Contacts_Delete", + "description": "Deletes a specified contact.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/spacecraftNameParameter" + }, + { + "$ref": "#/parameters/contactNameParameter" + } + ], + "responses": { + "200": { + "description": "Delete successful." + }, + "202": { + "description": "Accepted and the operation will complete asynchronously.", + "headers": { + "Location": { + "type": "string", + "description": "URL for determining when an operation has completed." + } + } + }, + "204": { + "description": "Request successful. Resource does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "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": "Returns list of available contacts. A contact is available if the spacecraft is visible from the ground station for more than the minimum viable contact duration provided in the contact profile.", + "operationId": "Spacecrafts_ListAvailableContacts", + "x-ms-examples": { + "List of Contact": { + "$ref": "./examples/AvailableContactsList.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../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/ContactParameters" + }, + "description": "The parameters to provide for the contacts." + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of available contacts resources.", + "schema": { + "$ref": "#/definitions/AvailableContactsListResult" + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously.", + "headers": { + "Location": { + "type": "string", + "description": "URL for determining when an operation has completed." + } + } + }, + "default": { + "description": "Error response describing why the operation failed. If the resource group does not exist, 404 (NotFound) will be returned.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Orbital/contactProfiles/{contactProfileName}": { + "get": { + "tags": [ + "Contact Profile" + ], + "operationId": "ContactProfiles_Get", + "description": "Gets the specified contact Profile in a specified resource group.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/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": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get a contact profile": { + "$ref": "./examples/ContactProfileGet.json" + } + } + }, + "put": { + "tags": [ + "Contact Profile" + ], + "description": "Creates or updates a contact profile.", + "operationId": "ContactProfiles_CreateOrUpdate", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../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" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "URL for checking the ongoing status of the operation." + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Create a contact profile": { + "$ref": "./examples/ContactProfileCreate.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "delete": { + "tags": [ + "Contact Profile" + ], + "operationId": "ContactProfiles_Delete", + "description": "Deletes a specified contact profile resource.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../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.", + "headers": { + "Location": { + "type": "string", + "description": "URL for determining when an operation has completed." + } + } + }, + "204": { + "description": "Request successful. Resource does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete Contact Profile": { + "$ref": "./examples/ContactProfileDelete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "patch": { + "tags": [ + "Contact Profile" + ], + "operationId": "ContactProfiles_UpdateTags", + "x-ms-examples": { + "Update Contact Profile tags": { + "$ref": "./examples/ContactProfileUpdateTag.json" + } + }, + "description": "Updates the specified contact profile tags.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/TagsObject" + }, + "description": "Parameters supplied to update contact profile tags." + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../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" + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously.", + "headers": { + "Location": { + "type": "string", + "description": "URL for determining when an operation has completed." + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Orbital/contactProfiles": { + "get": { + "tags": [ + "Contact Profile" + ], + "description": "Returns list of contact profiles by Subscription.", + "operationId": "ContactProfiles_ListBySubscription", + "x-ms-examples": { + "List of Contact Profiles": { + "$ref": "./examples/ContactProfilesBySubscriptionList.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/skipTokenParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of contact profile resources.", + "schema": { + "$ref": "#/definitions/ContactProfileListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed. If the resource group does not exist, 404 (NotFound) will be returned.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Orbital/contactProfiles": { + "get": { + "tags": [ + "Contact Profile" + ], + "description": "Returns list of contact profiles by Resource Group.", + "operationId": "ContactProfiles_List", + "x-ms-examples": { + "List of Contact Profiles by Resource Group": { + "$ref": "./examples/ContactProfilesByResourceGroupList.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/skipTokenParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of contact profile resources.", + "schema": { + "$ref": "#/definitions/ContactProfileListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed. If the resource group does not exist, 404 (NotFound) will be returned.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Orbital/availableGroundStations": { + "get": { + "tags": [ + "Ground Station" + ], + "description": "Returns list of available ground stations.", + "operationId": "AvailableGroundStations_ListByCapability", + "x-ms-examples": { + "List of Ground Stations by Capability": { + "$ref": "./examples/AvailableGroundStationsByCapabilityList.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../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": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Orbital/locations/{location}/operationResults/{operationId}": { + "get": { + "tags": [ + "OperationResults" + ], + "description": "Returns operation results.", + "operationId": "OperationsResults_Get", + "x-ms-examples": { + "KustoOperationResultsGet": { + "$ref": "./examples/OperationResultsGet.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/LocationParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/OperationIdParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved the operation result.", + "schema": { + "$ref": "#/definitions/OperationResult" + } + }, + "202": { + "description": "The operation is still in progress.", + "headers": { + "Location": { + "type": "string", + "description": "URL for determining when an operation has completed." + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + } + }, + "definitions": { + "TagsObject": { + "type": "object", + "properties": { + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Resource tags." + } + }, + "description": "Tags object for patch operations." + }, + "SpacecraftsProperties": { + "type": "object", + "required": [ + "titleLine", + "tleLine1", + "tleLine2", + "links" + ], + "properties": { + "provisioningState": { + "type": "string", + "allOf": [ + { + "$ref": "#/definitions/ProvisioningState" + } + ], + "description": "The current state of the resource's creation, deletion, or modification." + }, + "noradId": { + "type": "string", + "description": "NORAD ID of the spacecraft." + }, + "titleLine": { + "type": "string", + "description": "Title line of the two-line element set (TLE)." + }, + "tleLine1": { + "type": "string", + "description": "Line 1 of the two-line element set (TLE)." + }, + "tleLine2": { + "type": "string", + "description": "Line 2 of the two-line element set (TLE)." + }, + "links": { + "type": "array", + "items": { + "$ref": "#/definitions/SpacecraftLink" + }, + "x-ms-identifiers": [], + "description": "Immutable list of Spacecraft links.", + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "description": "List of Spacecraft Resource Properties." + }, + "SpacecraftListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Spacecraft" + }, + "description": "A list of spacecraft resources in a resource group." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of results.", + "readOnly": true + } + }, + "description": "Response for the ListSpacecrafts API service call." + }, + "SpacecraftLink": { + "type": "object", + "required": [ + "name", + "centerFrequencyMHz", + "bandwidthMHz", + "direction", + "polarization" + ], + "properties": { + "name": { + "type": "string", + "description": "Link name.", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "centerFrequencyMHz": { + "type": "number", + "description": "Center Frequency in MHz.", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "bandwidthMHz": { + "type": "number", + "description": "Bandwidth in MHz.", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "direction": { + "type": "string", + "description": "Direction (Uplink or Downlink).", + "enum": [ + "Uplink", + "Downlink" + ], + "x-ms-enum": { + "name": "direction", + "modelAsString": true + }, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "polarization": { + "type": "string", + "description": "Polarization. e.g. (RHCP, LHCP).", + "enum": [ + "RHCP", + "LHCP", + "linearVertical", + "linearHorizontal" + ], + "x-ms-enum": { + "name": "polarization", + "modelAsString": true + }, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "authorizations": { + "type": "array", + "description": "Authorized Ground Stations", + "readOnly": true, + "items": { + "$ref": "#/definitions/AuthorizedGroundstation" + }, + "x-ms-identifiers": [] + } + }, + "description": "List of authorized spacecraft links per ground station and the expiration date of the authorization." + }, + "Spacecraft": { + "type": "object", + "required": [ + "properties" + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/SpacecraftsProperties", + "description": "Spacecraft Properties", + "allOf": [ + { + "$ref": "#/definitions/SpacecraftsProperties" + } + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/TrackedResource" + } + ], + "description": "Customer creates a spacecraft resource to schedule a contact." + }, + "ResourceReference": { + "type": "object", + "required": [ + "id" + ], + "properties": { + "id": { + "type": "string", + "description": "Resource ID." + } + }, + "description": "Resource Reference." + }, + "EndPoint": { + "type": "object", + "required": [ + "ipAddress", + "endPointName", + "port", + "protocol" + ], + "properties": { + "ipAddress": { + "type": "string", + "description": "IP Address (IPv4)." + }, + "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 and retrieve data during a contact with the spacecraft." + }, + "ContactsProperties": { + "type": "object", + "required": [ + "reservationStartTime", + "reservationEndTime", + "groundStationName", + "contactProfile" + ], + "properties": { + "provisioningState": { + "type": "string", + "allOf": [ + { + "$ref": "#/definitions/ProvisioningState" + } + ], + "description": "The current state of the resource's creation, deletion, or modification." + }, + "status": { + "type": "string", + "readOnly": true, + "enum": [ + "scheduled", + "cancelled", + "succeeded", + "failed", + "providerCancelled" + ], + "x-ms-enum": { + "name": "ContactsStatus", + "modelAsString": true + }, + "description": "Status of a contact." + }, + "reservationStartTime": { + "type": "string", + "format": "date-time", + "description": "Reservation start time of a contact (ISO 8601 UTC standard).", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "reservationEndTime": { + "type": "string", + "format": "date-time", + "description": "Reservation end time of a contact (ISO 8601 UTC standard).", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "rxStartTime": { + "type": "string", + "format": "date-time", + "readOnly": true, + "description": "Receive start time of a contact (ISO 8601 UTC standard)." + }, + "rxEndTime": { + "type": "string", + "format": "date-time", + "readOnly": true, + "description": "Receive end time of a contact (ISO 8601 UTC standard)." + }, + "txStartTime": { + "type": "string", + "format": "date-time", + "readOnly": true, + "description": "Transmit start time of a contact (ISO 8601 UTC standard)." + }, + "txEndTime": { + "type": "string", + "format": "date-time", + "readOnly": true, + "description": "Transmit end time of a contact (ISO 8601 UTC standard)." + }, + "errorMessage": { + "type": "string", + "readOnly": true, + "description": "Any error message while scheduling a contact." + }, + "maximumElevationDegrees": { + "type": "number", + "readOnly": true, + "description": "Maximum elevation of the antenna during the contact in decimal degrees." + }, + "startAzimuthDegrees": { + "type": "number", + "readOnly": true, + "description": "Azimuth of the antenna at the start of the contact in decimal degrees." + }, + "endAzimuthDegrees": { + "type": "number", + "readOnly": true, + "description": "Azimuth of the antenna at the end of the contact in decimal degrees." + }, + "groundStationName": { + "type": "string", + "description": "Azure Ground Station name.", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "startElevationDegrees": { + "type": "number", + "readOnly": true, + "description": "Spacecraft elevation above the horizon at contact start." + }, + "endElevationDegrees": { + "type": "number", + "readOnly": true, + "description": "Spacecraft elevation above the horizon at contact end." + }, + "antennaConfiguration": { + "type": "object", + "readOnly": true, + "description": "The configuration associated with the allocated antenna.", + "properties": { + "destinationIp": { + "type": "string", + "description": "The destination IP a packet can be sent to. This would for example be the TCP endpoint you would send data to." + }, + "sourceIps": { + "type": "array", + "description": "List of Source IP", + "items": { + "type": "string", + "description": "The source IP a packet can have when being sent. You need to make sure you accept data from all these IPs in your application." + } + } + } + }, + "contactProfile": { + "allOf": [ + { + "$ref": "#/definitions/ResourceReference" + } + ], + "description": "The reference to the contact profile resource." + } + }, + "description": "Properties of the Contact Resource." + }, + "ContactProfilesProperties": { + "type": "object", + "required": [ + "links", + "networkConfiguration" + ], + "properties": { + "provisioningState": { + "type": "string", + "allOf": [ + { + "$ref": "#/definitions/ProvisioningState" + } + ], + "description": "The current state of the resource's creation, deletion, or modification." + }, + "minimumViableContactDuration": { + "type": "string", + "description": "Minimum viable contact duration in ISO 8601 format. Used for listing the available contacts with a spacecraft at a given ground station." + }, + "minimumElevationDegrees": { + "type": "number", + "description": "Minimum viable elevation for the contact in decimal degrees. Used for listing the available contacts with a spacecraft at a given ground station." + }, + "autoTrackingConfiguration": { + "type": "string", + "enum": [ + "disabled", + "xBand", + "sBand" + ], + "x-ms-enum": { + "name": "AutoTrackingConfiguration", + "modelAsString": false + }, + "description": "Auto-tracking configuration." + }, + "eventHubUri": { + "type": "string", + "description": "ARM resource identifier of the Event Hub used for telemetry. Requires granting Orbital Resource Provider the rights to send telemetry into the hub." + }, + "networkConfiguration": { + "type": "object", + "required": [ + "subnetId" + ], + "description": "Network configuration of customer virtual network.", + "properties": { + "subnetId": { + "type": "string", + "description": "ARM resource identifier of the subnet delegated to the Microsoft.Orbital/orbitalGateways. Needs to be at least a class C subnet, and should not have any IP created in it." + } + } + }, + "thirdPartyConfigurations": { + "type": "array", + "x-ms-identifiers": [], + "items": { + "$ref": "#/definitions/ContactProfileThirdPartyConfiguration" + }, + "description": "Third-party mission configuration of the Contact Profile. Describes RF links, modem processing, and IP endpoints." + }, + "links": { + "type": "array", + "x-ms-identifiers": [], + "items": { + "$ref": "#/definitions/ContactProfileLink" + }, + "description": "Links of the Contact Profile. Describes RF links, modem processing, and IP endpoints." + } + }, + "description": "List of Contact Profile Resource Properties." + }, + "ContactProfileListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ContactProfile" + }, + "description": "A list of contact profile resources in a resource group." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of results.", + "readOnly": true + } + }, + "description": "Response for the ListContactProfiles API service call." + }, + "ContactProfileLinkChannel": { + "type": "object", + "required": [ + "name", + "centerFrequencyMHz", + "bandwidthMHz", + "endPoint" + ], + "properties": { + "name": { + "type": "string", + "description": "Channel name." + }, + "centerFrequencyMHz": { + "type": "number", + "description": "Center Frequency in MHz." + }, + "bandwidthMHz": { + "type": "number", + "description": "Bandwidth in MHz." + }, + "endPoint": { + "$ref": "#/definitions/EndPoint" + }, + "modulationConfiguration": { + "type": "string", + "description": "Copy of the modem configuration file such as Kratos QRadio. Only valid for uplink directions. If provided, the modem connects to the customer endpoint and accepts commands from the customer instead of a VITA.49 stream." + }, + "demodulationConfiguration": { + "type": "string", + "description": "Copy of the modem configuration file such as Kratos QRadio or Kratos QuantumRx. Only valid for downlink directions. If provided, the modem connects to the customer endpoint and sends demodulated data instead of a VITA.49 stream." + }, + "encodingConfiguration": { + "type": "string", + "description": "Currently unused." + }, + "decodingConfiguration": { + "type": "string", + "description": "Currently unused." + } + }, + "description": "Contact Profile Link Channel." + }, + "ContactProfileLink": { + "type": "object", + "required": [ + "name", + "polarization", + "direction", + "channels" + ], + "properties": { + "name": { + "type": "string", + "description": "Link name." + }, + "polarization": { + "type": "string", + "description": "Polarization. e.g. (RHCP, LHCP).", + "enum": [ + "RHCP", + "LHCP", + "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. It is the required G/T by the customer. Not used yet." + }, + "eirpdBW": { + "type": "number", + "description": "Effective Isotropic Radiated Power (EIRP) in dBW. It is the required EIRP by the customer. Not used yet." + }, + "channels": { + "type": "array", + "items": { + "$ref": "#/definitions/ContactProfileLinkChannel" + }, + "x-ms-identifiers": [ + "name" + ], + "description": "Contact Profile Link Channel." + } + }, + "description": "Contact Profile Link." + }, + "ContactProfile": { + "type": "object", + "required": [ + "properties" + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "allOf": [ + { + "$ref": "#/definitions/ContactProfilesProperties" + } + ], + "description": "Properties of the contact profile resource." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/TrackedResource" + } + ], + "description": "Customer creates a Contact Profile Resource, which will contain all of the configurations required for scheduling a contact." + }, + "ContactParameters": { + "type": "object", + "description": "Parameters that define the contact resource.", + "required": [ + "contactProfile", + "groundStationName", + "startTime", + "endTime" + ], + "properties": { + "contactProfile": { + "allOf": [ + { + "$ref": "#/definitions/ResourceReference" + } + ], + "description": "The reference to the contact profile resource." + }, + "groundStationName": { + "type": "string", + "description": "Name of Azure Ground Station." + }, + "startTime": { + "type": "string", + "format": "date-time", + "description": "Start time of a contact (ISO 8601 UTC standard)." + }, + "endTime": { + "type": "string", + "format": "date-time", + "description": "End time of a contact (ISO 8601 UTC standard)." + } + } + }, + "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 (ISO 8601 UTC standard)." + }, + "txEndTime": { + "type": "string", + "format": "date-time", + "readOnly": true, + "description": "Time at which antenna transmit will be disabled (ISO 8601 UTC standard)." + }, + "rxStartTime": { + "type": "string", + "format": "date-time", + "readOnly": true, + "description": "Earliest time to receive a signal (ISO 8601 UTC standard)." + }, + "rxEndTime": { + "type": "string", + "format": "date-time", + "readOnly": true, + "description": "Time to lost receiving a signal (ISO 8601 UTC standard)." + }, + "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", + "required": [ + "properties" + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ContactsProperties" + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ], + "description": "Customer creates a contact resource for a spacecraft resource." + }, + "AvailableContactsListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/AvailableContacts" + }, + "x-ms-identifiers": [], + "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, + "required": [ + "properties" + ], + "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": "Ground Stations available to schedule Contacts." + }, + "AvailableGroundStationProperties": { + "type": "object", + "properties": { + "city": { + "type": "string", + "description": "City of ground station." + }, + "providerName": { + "type": "string", + "description": "Ground station provider name." + }, + "longitudeDegrees": { + "type": "number", + "description": "Longitude of the ground station in decimal degrees." + }, + "latitudeDegrees": { + "type": "number", + "description": "Latitude of the ground station in decimal degrees." + }, + "altitudeMeters": { + "type": "number", + "description": "Altitude of the ground station." + }, + "releaseMode": { + "type": "string", + "enum": [ + "Preview", + "GA" + ], + "x-ms-enum": { + "name": "releaseMode", + "modelAsString": true + }, + "description": "Release Status of a ground station." + } + }, + "description": "Properties object for Available groundstation." + }, + "Capability": { + "type": "string", + "description": "Capability of the Ground Station.", + "enum": [ + "EarthObservation", + "Communication" + ], + "x-ms-enum": { + "name": "Capability", + "modelAsString": true + } + }, + "ResourceIdListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The Azure Resource ID." + } + } + }, + "description": "A list of Azure Resource IDs." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of results.", + "readOnly": true + } + }, + "description": "Response for an API service call that lists the resource IDs of resources associated with another resource." + }, + "ProvisioningState": { + "type": "string", + "enum": [ + "creating", + "succeeded", + "failed", + "canceled", + "updating", + "deleting" + ], + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true + }, + "description": "The current state of the resource's creation, deletion, or modification.", + "readOnly": true + }, + "AuthorizedGroundstation": { + "type": "object", + "required": [ + "groundStation", + "expirationDate" + ], + "readOnly": true, + "properties": { + "groundStation": { + "type": "string", + "description": "Groundstation name." + }, + "expirationDate": { + "type": "string", + "format": "date", + "description": "Date of authorization expiration." + } + }, + "description": "Authorized groundstation." + }, + "OperationResult": { + "description": "Operation Result Entity.", + "type": "object", + "properties": { + "id": { + "readOnly": true, + "description": "ID of the resource.", + "type": "string" + }, + "name": { + "readOnly": true, + "description": "Name of the resource.", + "type": "string" + }, + "status": { + "$ref": "#/definitions/Status" + }, + "startTime": { + "description": "The operation start time (ISO 8601 UTC standard).", + "readOnly": true, + "type": "string", + "format": "date-time" + }, + "endTime": { + "description": "The operation end time (ISO 8601 UTC standard).", + "readOnly": true, + "type": "string", + "format": "date-time" + }, + "percentComplete": { + "type": "number", + "format": "double", + "minimum": 0, + "maximum": 100, + "description": "Percentage completed.", + "readOnly": true + }, + "value": { + "type": "array", + "readOnly": true, + "items": { + "type": "object", + "properties": {} + }, + "x-ms-identifiers": [], + "description": "A list of results when the operation returns multiple results." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of results.", + "readOnly": true + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/OperationResultProperties" + }, + "error": { + "$ref": "#/definitions/OperationResultErrorProperties" + } + } + }, + "Status": { + "readOnly": true, + "description": "The status of operation.", + "type": "string", + "enum": [ + "Succeeded", + "Canceled", + "Failed", + "Running" + ], + "x-ms-enum": { + "name": "Status", + "modelAsString": true + } + }, + "OperationResultProperties": { + "type": "object", + "properties": {}, + "description": "Operation result properties." + }, + "OperationResultErrorProperties": { + "type": "object", + "properties": { + "code": { + "type": "string", + "description": "The code of the error.", + "readOnly": true + }, + "message": { + "type": "string", + "description": "The error message.", + "readOnly": true + } + }, + "description": "Operation result error properties." + }, + "ContactProfileThirdPartyConfiguration": { + "type": "object", + "required": [ + "providerName", + "missionConfiguration" + ], + "description": "Contact Profile third-party partner configuration.", + "properties": { + "providerName": { + "type": "string", + "description": "Name of the third-party provider." + }, + "missionConfiguration": { + "type": "string", + "description": "Name of string referencing the configuration describing contact set-up for a particular mission. Expected values are those which have been created in collaboration with the partner network." + } + } + } + }, + "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" + }, + "spacecraftNameParameter": { + "name": "spacecraftName", + "in": "path", + "description": "Spacecraft ID.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "capabilityParameter": { + "name": "capability", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "EarthObservation", + "Communication" + ], + "x-ms-enum": { + "name": "capabilityParameter", + "modelAsString": true + }, + "description": "Ground Station Capability.", + "x-ms-parameter-location": "method" + }, + "skipTokenParameter": { + "name": "$skiptoken", + "description": "An opaque string that the resource provider uses to skip over previously-returned results. This is used when a previous list operation call returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skiptoken parameter that specifies a starting point to use for subsequent calls.", + "in": "query", + "required": false, + "type": "string", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/orbital/resource-manager/readme.md b/specification/orbital/resource-manager/readme.md index 116ea10e6ad8..4d912f4d37ad 100644 --- a/specification/orbital/resource-manager/readme.md +++ b/specification/orbital/resource-manager/readme.md @@ -26,7 +26,16 @@ These are the global settings for the orbital. ```yaml openapi-type: arm -tag: package-2022-03-01 +tag: package-2022-11-01 +``` + +### Tag: package-2022-11-01 + +These settings apply only when `--tag=package-2022-11-01` is specified on the command line. + +```yaml $(tag) == 'package-2022-11-01' +input-file: + - Microsoft.Orbital/stable/2022-11-01/orbital.json ``` ### Tag: package-2022-03-01