Skip to content

Commit 2a9aa4e

Browse files
author
msftbot[bot]
authored
[ReleasePR orbital] Updating descriptions and examples (#2437)
Create to sync Azure/azure-rest-api-specs#19536 [ReCreate this PR](https://github.com/azure-resource-manager-schemas/compare/main...azure-sdk:sdkAuto/orbital?expand=1)
2 parents 689e8a2 + e9e30a3 commit 2a9aa4e

File tree

1 file changed

+38
-38
lines changed

1 file changed

+38
-38
lines changed

‎schemas/2022-03-01/Microsoft.Orbital.json

Lines changed: 38 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@
1919
},
2020
"name": {
2121
"type": "string",
22-
"description": "Contact Profile Name"
22+
"description": "Contact Profile name."
2323
},
2424
"properties": {
2525
"oneOf": [
@@ -78,7 +78,7 @@
7878
},
7979
"name": {
8080
"type": "string",
81-
"description": "Spacecraft ID"
81+
"description": "Spacecraft ID."
8282
},
8383
"properties": {
8484
"oneOf": [
@@ -143,7 +143,7 @@
143143
},
144144
"name": {
145145
"type": "string",
146-
"description": "Contact Name"
146+
"description": "Contact name."
147147
},
148148
"properties": {
149149
"oneOf": [
@@ -188,7 +188,7 @@
188188
"$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression"
189189
}
190190
],
191-
"description": "Contact Profile Link Channel"
191+
"description": "Contact Profile Link Channel."
192192
},
193193
"direction": {
194194
"oneOf": [
@@ -214,7 +214,7 @@
214214
"$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression"
215215
}
216216
],
217-
"description": "Effective Isotropic Radiated Power (EIRP) in dBW."
217+
"description": "Effective Isotropic Radiated Power (EIRP) in dBW. It is the required EIRP by the customer. Not used yet."
218218
},
219219
"gainOverTemperature": {
220220
"oneOf": [
@@ -225,11 +225,11 @@
225225
"$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression"
226226
}
227227
],
228-
"description": "Gain To Noise Temperature in db/K."
228+
"description": "Gain To Noise Temperature in db/K. It is the required G/T by the customer. Not used yet."
229229
},
230230
"name": {
231231
"type": "string",
232-
"description": "Link name"
232+
"description": "Link name."
233233
},
234234
"polarization": {
235235
"oneOf": [
@@ -246,7 +246,7 @@
246246
"$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression"
247247
}
248248
],
249-
"description": "polarization. eg (RHCP, LHCP)."
249+
"description": "Polarization. e.g. (RHCP, LHCP)."
250250
}
251251
},
252252
"required": [
@@ -255,7 +255,7 @@
255255
"name",
256256
"polarization"
257257
],
258-
"description": "Contact Profile Link"
258+
"description": "Contact Profile Link."
259259
},
260260
"ContactProfileLinkChannel": {
261261
"type": "object",
@@ -269,7 +269,7 @@
269269
"$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression"
270270
}
271271
],
272-
"description": "Bandwidth in MHz"
272+
"description": "Bandwidth in MHz."
273273
},
274274
"centerFrequencyMHz": {
275275
"oneOf": [
@@ -280,19 +280,19 @@
280280
"$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression"
281281
}
282282
],
283-
"description": "Center Frequency in MHz"
283+
"description": "Center Frequency in MHz."
284284
},
285285
"decodingConfiguration": {
286286
"type": "string",
287-
"description": "Configuration for decoding"
287+
"description": "Currently unused."
288288
},
289289
"demodulationConfiguration": {
290290
"type": "string",
291-
"description": "Configuration for demodulation"
291+
"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."
292292
},
293293
"encodingConfiguration": {
294294
"type": "string",
295-
"description": "Configuration for encoding"
295+
"description": "Currently unused."
296296
},
297297
"endPoint": {
298298
"oneOf": [
@@ -307,11 +307,11 @@
307307
},
308308
"modulationConfiguration": {
309309
"type": "string",
310-
"description": "Configuration for modulation"
310+
"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."
311311
},
312312
"name": {
313313
"type": "string",
314-
"description": "Channel name"
314+
"description": "Channel name."
315315
}
316316
},
317317
"required": [
@@ -320,7 +320,7 @@
320320
"endPoint",
321321
"name"
322322
],
323-
"description": "Contact Profile Link Channel"
323+
"description": "Contact Profile Link Channel."
324324
},
325325
"ContactProfileProperties": {
326326
"type": "object",
@@ -339,11 +339,11 @@
339339
"$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression"
340340
}
341341
],
342-
"description": "Auto track configuration."
342+
"description": "Auto-tracking configuration."
343343
},
344344
"eventHubUri": {
345345
"type": "string",
346-
"description": "The URI of the Event Hub used for telemetry"
346+
"description": "ARM resource identifier of the Event Hub used for telemetry. Requires granting Orbital Resource Provider the rights to send telemetry into the hub."
347347
},
348348
"links": {
349349
"oneOf": [
@@ -357,7 +357,7 @@
357357
"$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression"
358358
}
359359
],
360-
"description": "Links of the Contact Profile"
360+
"description": "Links of the Contact Profile. Describes RF links, modem processing, and IP endpoints."
361361
},
362362
"minimumElevationDegrees": {
363363
"oneOf": [
@@ -368,11 +368,11 @@
368368
"$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression"
369369
}
370370
],
371-
"description": "Minimum viable elevation for the contact in decimal degrees."
371+
"description": "Minimum viable elevation for the contact in decimal degrees. Used for listing the available contacts with a spacecraft at a given ground station."
372372
},
373373
"minimumViableContactDuration": {
374374
"type": "string",
375-
"description": "Minimum viable contact duration in ISO 8601 format."
375+
"description": "Minimum viable contact duration in ISO 8601 format. Used for listing the available contacts with a spacecraft at a given ground station."
376376
},
377377
"networkConfiguration": {
378378
"oneOf": [
@@ -387,7 +387,7 @@
387387
},
388388
"provisioningState": {
389389
"type": "string",
390-
"description": "The current state of the resource's creation, deletion, or modification"
390+
"description": "The current state of the resource's creation, deletion, or modification."
391391
}
392392
},
393393
"required": [
@@ -401,7 +401,7 @@
401401
"properties": {
402402
"subnetId": {
403403
"type": "string",
404-
"description": "Customer subnet ARM resource identifier."
404+
"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."
405405
}
406406
},
407407
"required": [
@@ -429,17 +429,17 @@
429429
},
430430
"provisioningState": {
431431
"type": "string",
432-
"description": "The current state of the resource's creation, deletion, or modification"
432+
"description": "The current state of the resource's creation, deletion, or modification."
433433
},
434434
"reservationEndTime": {
435435
"type": "string",
436436
"format": "date-time",
437-
"description": "Reservation end time of a contact."
437+
"description": "Reservation end time of a contact (ISO 8601 UTC standard)."
438438
},
439439
"reservationStartTime": {
440440
"type": "string",
441441
"format": "date-time",
442-
"description": "Reservation start time of a contact."
442+
"description": "Reservation start time of a contact (ISO 8601 UTC standard)."
443443
}
444444
},
445445
"required": [
@@ -511,7 +511,7 @@
511511
"$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression"
512512
}
513513
],
514-
"description": "Bandwidth in MHz"
514+
"description": "Bandwidth in MHz."
515515
},
516516
"centerFrequencyMHz": {
517517
"oneOf": [
@@ -522,7 +522,7 @@
522522
"$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression"
523523
}
524524
],
525-
"description": "Center Frequency in MHz"
525+
"description": "Center Frequency in MHz."
526526
},
527527
"direction": {
528528
"oneOf": [
@@ -541,7 +541,7 @@
541541
},
542542
"name": {
543543
"type": "string",
544-
"description": "Link name"
544+
"description": "Link name."
545545
},
546546
"polarization": {
547547
"oneOf": [
@@ -558,7 +558,7 @@
558558
"$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression"
559559
}
560560
],
561-
"description": "polarization. eg (RHCP, LHCP)."
561+
"description": "Polarization. e.g. (RHCP, LHCP)."
562562
}
563563
},
564564
"required": [
@@ -568,7 +568,7 @@
568568
"name",
569569
"polarization"
570570
],
571-
"description": "Authorized Ground Stations for the link"
571+
"description": "List of authorized spacecraft links per ground station and the expiration date of the authorization."
572572
},
573573
"SpacecraftsProperties": {
574574
"type": "object",
@@ -585,27 +585,27 @@
585585
"$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression"
586586
}
587587
],
588-
"description": "Links of the Spacecraft"
588+
"description": "Immutable list of Spacecraft links."
589589
},
590590
"noradId": {
591591
"type": "string",
592592
"description": "NORAD ID of the spacecraft."
593593
},
594594
"provisioningState": {
595595
"type": "string",
596-
"description": "The current state of the resource's creation, deletion, or modification"
596+
"description": "The current state of the resource's creation, deletion, or modification."
597597
},
598598
"titleLine": {
599599
"type": "string",
600-
"description": "Title line of Two Line Element (TLE)."
600+
"description": "Title line of the two-line element set (TLE)."
601601
},
602602
"tleLine1": {
603603
"type": "string",
604-
"description": "Line 1 of Two Line Element (TLE)."
604+
"description": "Line 1 of the two-line element set (TLE)."
605605
},
606606
"tleLine2": {
607607
"type": "string",
608-
"description": "Line 1 of Two Line Element (TLE)."
608+
"description": "Line 1 of the two-line element set (TLE)."
609609
}
610610
},
611611
"required": [
@@ -624,7 +624,7 @@
624624
},
625625
"name": {
626626
"type": "string",
627-
"description": "Contact Name"
627+
"description": "Contact name."
628628
},
629629
"properties": {
630630
"oneOf": [

0 commit comments

Comments
 (0)