@azure/arm-orbital 1.0.0-beta.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (112) hide show
  1. package/CHANGELOG.md +5 -0
  2. package/LICENSE +21 -0
  3. package/README.md +98 -0
  4. package/dist/index.js +2783 -0
  5. package/dist/index.js.map +1 -0
  6. package/dist/index.min.js +1 -0
  7. package/dist/index.min.js.map +1 -0
  8. package/dist-esm/src/azureOrbital.d.ts +19 -0
  9. package/dist-esm/src/azureOrbital.d.ts.map +1 -0
  10. package/dist-esm/src/azureOrbital.js +26 -0
  11. package/dist-esm/src/azureOrbital.js.map +1 -0
  12. package/dist-esm/src/azureOrbitalContext.d.ts +16 -0
  13. package/dist-esm/src/azureOrbitalContext.d.ts.map +1 -0
  14. package/dist-esm/src/azureOrbitalContext.js +49 -0
  15. package/dist-esm/src/azureOrbitalContext.js.map +1 -0
  16. package/dist-esm/src/index.d.ts +6 -0
  17. package/dist-esm/src/index.d.ts.map +1 -0
  18. package/dist-esm/src/index.js +13 -0
  19. package/dist-esm/src/index.js.map +1 -0
  20. package/dist-esm/src/lroImpl.d.ts +16 -0
  21. package/dist-esm/src/lroImpl.d.ts.map +1 -0
  22. package/dist-esm/src/lroImpl.js +29 -0
  23. package/dist-esm/src/lroImpl.js.map +1 -0
  24. package/dist-esm/src/models/index.d.ts +757 -0
  25. package/dist-esm/src/models/index.d.ts.map +1 -0
  26. package/dist-esm/src/models/index.js +61 -0
  27. package/dist-esm/src/models/index.js.map +1 -0
  28. package/dist-esm/src/models/mappers.d.ts +30 -0
  29. package/dist-esm/src/models/mappers.d.ts.map +1 -0
  30. package/dist-esm/src/models/mappers.js +1041 -0
  31. package/dist-esm/src/models/mappers.js.map +1 -0
  32. package/dist-esm/src/models/parameters.d.ts +33 -0
  33. package/dist-esm/src/models/parameters.d.ts.map +1 -0
  34. package/dist-esm/src/models/parameters.js +218 -0
  35. package/dist-esm/src/models/parameters.js.map +1 -0
  36. package/dist-esm/src/operations/availableGroundStations.d.ts +41 -0
  37. package/dist-esm/src/operations/availableGroundStations.d.ts.map +1 -0
  38. package/dist-esm/src/operations/availableGroundStations.js +155 -0
  39. package/dist-esm/src/operations/availableGroundStations.js.map +1 -0
  40. package/dist-esm/src/operations/contactProfiles.d.ts +86 -0
  41. package/dist-esm/src/operations/contactProfiles.d.ts.map +1 -0
  42. package/dist-esm/src/operations/contactProfiles.js +392 -0
  43. package/dist-esm/src/operations/contactProfiles.js.map +1 -0
  44. package/dist-esm/src/operations/contacts.d.ts +73 -0
  45. package/dist-esm/src/operations/contacts.d.ts.map +1 -0
  46. package/dist-esm/src/operations/contacts.js +295 -0
  47. package/dist-esm/src/operations/contacts.js.map +1 -0
  48. package/dist-esm/src/operations/index.d.ts +6 -0
  49. package/dist-esm/src/operations/index.d.ts.map +1 -0
  50. package/dist-esm/src/operations/index.js +13 -0
  51. package/dist-esm/src/operations/index.js.map +1 -0
  52. package/dist-esm/src/operations/operations.d.ts +26 -0
  53. package/dist-esm/src/operations/operations.d.ts.map +1 -0
  54. package/dist-esm/src/operations/operations.js +90 -0
  55. package/dist-esm/src/operations/operations.js.map +1 -0
  56. package/dist-esm/src/operations/spacecrafts.d.ts +108 -0
  57. package/dist-esm/src/operations/spacecrafts.d.ts.map +1 -0
  58. package/dist-esm/src/operations/spacecrafts.js +499 -0
  59. package/dist-esm/src/operations/spacecrafts.js.map +1 -0
  60. package/dist-esm/src/operationsInterfaces/availableGroundStations.d.ts +18 -0
  61. package/dist-esm/src/operationsInterfaces/availableGroundStations.d.ts.map +1 -0
  62. package/dist-esm/src/operationsInterfaces/availableGroundStations.js +9 -0
  63. package/dist-esm/src/operationsInterfaces/availableGroundStations.js.map +1 -0
  64. package/dist-esm/src/operationsInterfaces/contactProfiles.d.ts +63 -0
  65. package/dist-esm/src/operationsInterfaces/contactProfiles.d.ts.map +1 -0
  66. package/dist-esm/src/operationsInterfaces/contactProfiles.js +9 -0
  67. package/dist-esm/src/operationsInterfaces/contactProfiles.js.map +1 -0
  68. package/dist-esm/src/operationsInterfaces/contacts.d.ts +56 -0
  69. package/dist-esm/src/operationsInterfaces/contacts.d.ts.map +1 -0
  70. package/dist-esm/src/operationsInterfaces/contacts.js +9 -0
  71. package/dist-esm/src/operationsInterfaces/contacts.js.map +1 -0
  72. package/dist-esm/src/operationsInterfaces/index.d.ts +6 -0
  73. package/dist-esm/src/operationsInterfaces/index.d.ts.map +1 -0
  74. package/dist-esm/src/operationsInterfaces/index.js +13 -0
  75. package/dist-esm/src/operationsInterfaces/index.js.map +1 -0
  76. package/dist-esm/src/operationsInterfaces/operations.d.ts +11 -0
  77. package/dist-esm/src/operationsInterfaces/operations.d.ts.map +1 -0
  78. package/dist-esm/src/operationsInterfaces/operations.js +9 -0
  79. package/dist-esm/src/operationsInterfaces/operations.js.map +1 -0
  80. package/dist-esm/src/operationsInterfaces/spacecrafts.d.ts +85 -0
  81. package/dist-esm/src/operationsInterfaces/spacecrafts.d.ts.map +1 -0
  82. package/dist-esm/src/operationsInterfaces/spacecrafts.js +9 -0
  83. package/dist-esm/src/operationsInterfaces/spacecrafts.js.map +1 -0
  84. package/dist-esm/test/sampleTest.d.ts +2 -0
  85. package/dist-esm/test/sampleTest.d.ts.map +1 -0
  86. package/dist-esm/test/sampleTest.js +40 -0
  87. package/dist-esm/test/sampleTest.js.map +1 -0
  88. package/package.json +92 -0
  89. package/review/arm-orbital.api.md +600 -0
  90. package/rollup.config.js +188 -0
  91. package/src/azureOrbital.ts +52 -0
  92. package/src/azureOrbitalContext.ts +70 -0
  93. package/src/index.ts +13 -0
  94. package/src/lroImpl.ts +34 -0
  95. package/src/models/index.ts +853 -0
  96. package/src/models/mappers.ts +1111 -0
  97. package/src/models/parameters.ts +260 -0
  98. package/src/operations/availableGroundStations.ts +199 -0
  99. package/src/operations/contactProfiles.ts +510 -0
  100. package/src/operations/contacts.ts +412 -0
  101. package/src/operations/index.ts +13 -0
  102. package/src/operations/operations.ts +98 -0
  103. package/src/operations/spacecrafts.ts +669 -0
  104. package/src/operationsInterfaces/availableGroundStations.ts +39 -0
  105. package/src/operationsInterfaces/contactProfiles.ts +121 -0
  106. package/src/operationsInterfaces/contacts.ts +109 -0
  107. package/src/operationsInterfaces/index.ts +13 -0
  108. package/src/operationsInterfaces/operations.ts +22 -0
  109. package/src/operationsInterfaces/spacecrafts.ts +167 -0
  110. package/tsconfig.json +19 -0
  111. package/types/arm-orbital.d.ts +1097 -0
  112. package/types/tsdoc-metadata.json +11 -0
@@ -0,0 +1,757 @@
1
+ import * as coreClient from "@azure/core-client";
2
+ /** A list of REST API operations supported by an Azure Resource Provider. It contains an URL link to get the next set of results. */
3
+ export interface OperationListResult {
4
+ /**
5
+ * List of operations supported by the resource provider
6
+ * NOTE: This property will not be serialized. It can only be populated by the server.
7
+ */
8
+ readonly value?: Operation[];
9
+ /**
10
+ * URL to get the next set of operation list results (if there are any).
11
+ * NOTE: This property will not be serialized. It can only be populated by the server.
12
+ */
13
+ readonly nextLink?: string;
14
+ }
15
+ /** Details of a REST API operation, returned from the Resource Provider Operations API */
16
+ export interface Operation {
17
+ /**
18
+ * The name of the operation, as per Resource-Based Access Control (RBAC). Examples: "Microsoft.Compute/virtualMachines/write", "Microsoft.Compute/virtualMachines/capture/action"
19
+ * NOTE: This property will not be serialized. It can only be populated by the server.
20
+ */
21
+ readonly name?: string;
22
+ /**
23
+ * Whether the operation applies to data-plane. This is "true" for data-plane operations and "false" for ARM/control-plane operations.
24
+ * NOTE: This property will not be serialized. It can only be populated by the server.
25
+ */
26
+ readonly isDataAction?: boolean;
27
+ /** Localized display information for this particular operation. */
28
+ display?: OperationDisplay;
29
+ /**
30
+ * The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system"
31
+ * NOTE: This property will not be serialized. It can only be populated by the server.
32
+ */
33
+ readonly origin?: Origin;
34
+ /**
35
+ * Enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs.
36
+ * NOTE: This property will not be serialized. It can only be populated by the server.
37
+ */
38
+ readonly actionType?: ActionType;
39
+ }
40
+ /** Localized display information for this particular operation. */
41
+ export interface OperationDisplay {
42
+ /**
43
+ * The localized friendly form of the resource provider name, e.g. "Microsoft Monitoring Insights" or "Microsoft Compute".
44
+ * NOTE: This property will not be serialized. It can only be populated by the server.
45
+ */
46
+ readonly provider?: string;
47
+ /**
48
+ * The localized friendly name of the resource type related to this operation. E.g. "Virtual Machines" or "Job Schedule Collections".
49
+ * NOTE: This property will not be serialized. It can only be populated by the server.
50
+ */
51
+ readonly resource?: string;
52
+ /**
53
+ * The concise, localized friendly name for the operation; suitable for dropdowns. E.g. "Create or Update Virtual Machine", "Restart Virtual Machine".
54
+ * NOTE: This property will not be serialized. It can only be populated by the server.
55
+ */
56
+ readonly operation?: string;
57
+ /**
58
+ * The short, localized friendly description of the operation; suitable for tool tips and detailed views.
59
+ * NOTE: This property will not be serialized. It can only be populated by the server.
60
+ */
61
+ readonly description?: string;
62
+ }
63
+ /** An error response from the service. */
64
+ export interface CloudError {
65
+ /** An error response from the service. */
66
+ error?: CloudErrorBody;
67
+ }
68
+ /** An error response from the service. */
69
+ export interface CloudErrorBody {
70
+ /** An identifier for the error. Codes are invariant and are intended to be consumed programmatically. */
71
+ code?: string;
72
+ /** A message describing the error, intended to be suitable for display in a user interface. */
73
+ message?: string;
74
+ /** The target of the particular error. For example, the name of the property in error. */
75
+ target?: string;
76
+ /** A list of additional details about the error. */
77
+ details?: CloudErrorBody[];
78
+ }
79
+ /** Response for the ListSpacecrafts API service call. */
80
+ export interface SpacecraftListResult {
81
+ /** A list of spacecraft resources in a resource group. */
82
+ value?: Spacecraft[];
83
+ /**
84
+ * The URL to get the next set of results.
85
+ * NOTE: This property will not be serialized. It can only be populated by the server.
86
+ */
87
+ readonly nextLink?: string;
88
+ }
89
+ /** Spacecraft Link */
90
+ export interface SpacecraftLink {
91
+ /** Center Frequency in MHz */
92
+ centerFrequencyMHz: number;
93
+ /** Bandwidth in MHz */
94
+ bandwidthMHz: number;
95
+ /** Direction (uplink or downlink) */
96
+ direction: Direction;
97
+ /** polarization. eg (RHCP, LHCP) */
98
+ polarization: Polarization;
99
+ }
100
+ /** Common fields that are returned in the response for all Azure Resource Manager resources */
101
+ export interface Resource {
102
+ /**
103
+ * Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
104
+ * NOTE: This property will not be serialized. It can only be populated by the server.
105
+ */
106
+ readonly id?: string;
107
+ /**
108
+ * The name of the resource
109
+ * NOTE: This property will not be serialized. It can only be populated by the server.
110
+ */
111
+ readonly name?: string;
112
+ /**
113
+ * The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
114
+ * NOTE: This property will not be serialized. It can only be populated by the server.
115
+ */
116
+ readonly type?: string;
117
+ /**
118
+ * Azure Resource Manager metadata containing createdBy and modifiedBy information.
119
+ * NOTE: This property will not be serialized. It can only be populated by the server.
120
+ */
121
+ readonly systemData?: SystemData;
122
+ }
123
+ /** Metadata pertaining to creation and last modification of the resource. */
124
+ export interface SystemData {
125
+ /** The identity that created the resource. */
126
+ createdBy?: string;
127
+ /** The type of identity that created the resource. */
128
+ createdByType?: CreatedByType;
129
+ /** The timestamp of resource creation (UTC). */
130
+ createdAt?: Date;
131
+ /** The identity that last modified the resource. */
132
+ lastModifiedBy?: string;
133
+ /** The type of identity that last modified the resource. */
134
+ lastModifiedByType?: CreatedByType;
135
+ /** The timestamp of resource last modification (UTC) */
136
+ lastModifiedAt?: Date;
137
+ }
138
+ /** Tags object for patch operations. */
139
+ export interface TagsObject {
140
+ /** Resource tags. */
141
+ tags?: {
142
+ [propertyName: string]: string;
143
+ };
144
+ }
145
+ /** Response for the ListContacts API service call. */
146
+ export interface ContactListResult {
147
+ /** A list of contact resources in a resource group. */
148
+ value?: Contact[];
149
+ /**
150
+ * The URL to get the next set of results.
151
+ * NOTE: This property will not be serialized. It can only be populated by the server.
152
+ */
153
+ readonly nextLink?: string;
154
+ }
155
+ /** Resource Reference */
156
+ export interface ResourceReference {
157
+ /** Resource ID. */
158
+ id?: string;
159
+ }
160
+ /** Parameters that define the contact resource. */
161
+ export interface ContactParameters {
162
+ /** The reference to the contact profile resource. */
163
+ contactProfile: ResourceReference;
164
+ /** Name of Azure Ground Station. */
165
+ groundStationName: string;
166
+ /** Start time of a contact. */
167
+ startTime: Date;
168
+ /** End time of a contact. */
169
+ endTime: Date;
170
+ }
171
+ /** Response for the ListAvailableContacts API service call. */
172
+ export interface AvailableContactsListResult {
173
+ /** A list of available contacts */
174
+ value?: AvailableContacts[];
175
+ /**
176
+ * The URL to get the next set of results.
177
+ * NOTE: This property will not be serialized. It can only be populated by the server.
178
+ */
179
+ readonly nextLink?: string;
180
+ }
181
+ /** Customer retrieves list of Available Contacts for a spacecraft resource. Later, one of the available contact can be selected to create a contact. */
182
+ export interface AvailableContacts {
183
+ /** The reference to the spacecraft resource. */
184
+ spacecraft?: ResourceReference;
185
+ /**
186
+ * Name of Azure Ground Station.
187
+ * NOTE: This property will not be serialized. It can only be populated by the server.
188
+ */
189
+ readonly groundStationName?: string;
190
+ /**
191
+ * Maximum elevation of the antenna during the contact in decimal degrees.
192
+ * NOTE: This property will not be serialized. It can only be populated by the server.
193
+ */
194
+ readonly maximumElevationDegrees?: number;
195
+ /**
196
+ * Time at which antenna transmit will be enabled.
197
+ * NOTE: This property will not be serialized. It can only be populated by the server.
198
+ */
199
+ readonly txStartTime?: Date;
200
+ /**
201
+ * Time at which antenna transmit will be disabled.
202
+ * NOTE: This property will not be serialized. It can only be populated by the server.
203
+ */
204
+ readonly txEndTime?: Date;
205
+ /**
206
+ * Earliest time to receive a signal.
207
+ * NOTE: This property will not be serialized. It can only be populated by the server.
208
+ */
209
+ readonly rxStartTime?: Date;
210
+ /**
211
+ * Time to lost receiving a signal.
212
+ * NOTE: This property will not be serialized. It can only be populated by the server.
213
+ */
214
+ readonly rxEndTime?: Date;
215
+ /**
216
+ * Azimuth of the antenna at the start of the contact in decimal degrees.
217
+ * NOTE: This property will not be serialized. It can only be populated by the server.
218
+ */
219
+ readonly startAzimuthDegrees?: number;
220
+ /**
221
+ * Azimuth of the antenna at the end of the contact in decimal degrees.
222
+ * NOTE: This property will not be serialized. It can only be populated by the server.
223
+ */
224
+ readonly endAzimuthDegrees?: number;
225
+ /**
226
+ * Spacecraft elevation above the horizon at contact start.
227
+ * NOTE: This property will not be serialized. It can only be populated by the server.
228
+ */
229
+ readonly startElevationDegrees?: number;
230
+ /**
231
+ * Spacecraft elevation above the horizon at contact end.
232
+ * NOTE: This property will not be serialized. It can only be populated by the server.
233
+ */
234
+ readonly endElevationDegrees?: number;
235
+ }
236
+ /** Contact Profile link */
237
+ export interface ContactProfileLink {
238
+ /** polarization. eg (RHCP, LHCP) */
239
+ polarization: Polarization;
240
+ /** Direction (uplink or downlink) */
241
+ direction: Direction;
242
+ /** Gain To Noise Temperature in db/K. */
243
+ gainOverTemperature?: number;
244
+ /** Effective Isotropic Radiated Power (EIRP) in dBW. */
245
+ eirpdBW?: number;
246
+ /** Contact Profile Link Channel */
247
+ channels: ContactProfileLinkChannel[];
248
+ }
249
+ /** Contact Profile Link Channel */
250
+ export interface ContactProfileLinkChannel {
251
+ /** Center Frequency in MHz */
252
+ centerFrequencyMHz: number;
253
+ /** Bandwidth in MHz */
254
+ bandwidthMHz: number;
255
+ /** Customer End point to store/retrieve data during a contact. */
256
+ endPoint: EndPoint;
257
+ /** Configuration for modulation */
258
+ modulationConfiguration?: string;
259
+ /** Configuration for demodulation */
260
+ demodulationConfiguration?: string;
261
+ /** Configuration for encoding */
262
+ encodingConfiguration?: string;
263
+ /** Configuration for decoding */
264
+ decodingConfiguration?: string;
265
+ }
266
+ /** Customer End point to store/retrieve data during a contact. */
267
+ export interface EndPoint {
268
+ /** IP Address. */
269
+ ipAddress: string;
270
+ /** Name of an end point. */
271
+ endPointName: string;
272
+ /** TCP port to listen on to receive data. */
273
+ port: string;
274
+ /** Protocol either UDP or TCP. */
275
+ protocol: Protocol;
276
+ }
277
+ /** Response for the ListContactProfiles API service call. */
278
+ export interface ContactProfileListResult {
279
+ /** A list of contact profile resources in a resource group. */
280
+ value?: ContactProfile[];
281
+ /**
282
+ * The URL to get the next set of results.
283
+ * NOTE: This property will not be serialized. It can only be populated by the server.
284
+ */
285
+ readonly nextLink?: string;
286
+ }
287
+ /** Response for the AvailableGroundStations API service call. */
288
+ export interface AvailableGroundStationListResult {
289
+ /** A list of ground station resources. */
290
+ value?: AvailableGroundStation[];
291
+ /**
292
+ * The URL to get the next set of results.
293
+ * NOTE: This property will not be serialized. It can only be populated by the server.
294
+ */
295
+ readonly nextLink?: string;
296
+ }
297
+ /** GroundStations available to schedule Contacts */
298
+ export interface AvailableGroundStation {
299
+ /**
300
+ * Id of groundStation
301
+ * NOTE: This property will not be serialized. It can only be populated by the server.
302
+ */
303
+ readonly id?: string;
304
+ /**
305
+ * Name of the ground station.
306
+ * NOTE: This property will not be serialized. It can only be populated by the server.
307
+ */
308
+ readonly name?: string;
309
+ /** Azure region */
310
+ location?: string;
311
+ /**
312
+ * Resource type.
313
+ * NOTE: This property will not be serialized. It can only be populated by the server.
314
+ */
315
+ readonly type?: string;
316
+ /** City of ground station. */
317
+ city?: string;
318
+ /** Ground station provider name. */
319
+ providerName?: string;
320
+ /** Longitude of the ground station in decimal degrees. */
321
+ longitudeDegrees?: number;
322
+ /** Latitude of the ground station in decimal degrees. */
323
+ latitudeDegrees?: number;
324
+ /** Altitude of the ground station */
325
+ altitudeMeters?: number;
326
+ }
327
+ /** Response for an API service call that lists the resource IDs of resources associated with another resource. */
328
+ export interface ResourceIdListResult {
329
+ /** A list of Azure Resource IDs. */
330
+ value?: ResourceIdListResultValueItem[];
331
+ /**
332
+ * The URL to get the next set of results.
333
+ * NOTE: This property will not be serialized. It can only be populated by the server.
334
+ */
335
+ readonly nextLink?: string;
336
+ }
337
+ export interface ResourceIdListResultValueItem {
338
+ /** The Azure Resource ID */
339
+ id?: string;
340
+ }
341
+ /** The resource model definition for an Azure Resource Manager tracked top level resource which has 'tags' and a 'location' */
342
+ export declare type TrackedResource = Resource & {
343
+ /** Resource tags. */
344
+ tags?: {
345
+ [propertyName: string]: string;
346
+ };
347
+ /** The geo-location where the resource lives */
348
+ location: string;
349
+ };
350
+ /** The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location */
351
+ export declare type ProxyResource = Resource & {};
352
+ /** Customer creates a spacecraft resource to schedule a contact. */
353
+ export declare type Spacecraft = TrackedResource & {
354
+ /**
355
+ * A unique read-only string that changes whenever the resource is updated.
356
+ * NOTE: This property will not be serialized. It can only be populated by the server.
357
+ */
358
+ readonly etag?: string;
359
+ /** NORAD ID of the spacecraft. */
360
+ noradId?: string;
361
+ /**
362
+ * Authorization status of spacecraft.
363
+ * NOTE: This property will not be serialized. It can only be populated by the server.
364
+ */
365
+ readonly authorizationStatus?: AuthorizationStatus;
366
+ /**
367
+ * Details of the authorization status.
368
+ * NOTE: This property will not be serialized. It can only be populated by the server.
369
+ */
370
+ readonly authorizationStatusExtended?: string;
371
+ /** Title line of Two Line Element (TLE). */
372
+ titleLine?: string;
373
+ /** Line 1 of Two Line Element (TLE). */
374
+ tleLine1?: string;
375
+ /** Line 2 of Two Line Element (TLE). */
376
+ tleLine2?: string;
377
+ /** Links of the Spacecraft */
378
+ links?: SpacecraftLink[];
379
+ };
380
+ /** Customer creates a Contact Profile Resource, which will contain all of the configurations required for scheduling a contact. */
381
+ export declare type ContactProfile = TrackedResource & {
382
+ /**
383
+ * A unique read-only string that changes whenever the resource is updated.
384
+ * NOTE: This property will not be serialized. It can only be populated by the server.
385
+ */
386
+ readonly etag?: string;
387
+ /** Minimum viable contact duration in ISO 8601 format. */
388
+ minimumViableContactDuration?: string;
389
+ /** Minimum viable elevation for the contact in decimal degrees. */
390
+ minimumElevationDegrees?: number;
391
+ /** Auto track configuration. */
392
+ autoTrackingConfiguration?: AutoTrackingConfiguration;
393
+ /** Links of the Contact Profile */
394
+ links?: ContactProfileLink[];
395
+ };
396
+ /** Customer creates a contact resource for a spacecraft resource. */
397
+ export declare type Contact = ProxyResource & {
398
+ /**
399
+ * A unique read-only string that changes whenever the resource is updated.
400
+ * NOTE: This property will not be serialized. It can only be populated by the server.
401
+ */
402
+ readonly etag?: string;
403
+ /**
404
+ * Status of a contact.
405
+ * NOTE: This property will not be serialized. It can only be populated by the server.
406
+ */
407
+ readonly status?: Status;
408
+ /** Reservation start time of a contact. */
409
+ reservationStartTime?: Date;
410
+ /** Reservation end time of a contact. */
411
+ reservationEndTime?: Date;
412
+ /**
413
+ * Receive start time of a contact.
414
+ * NOTE: This property will not be serialized. It can only be populated by the server.
415
+ */
416
+ readonly rxStartTime?: Date;
417
+ /**
418
+ * Receive end time of a contact.
419
+ * NOTE: This property will not be serialized. It can only be populated by the server.
420
+ */
421
+ readonly rxEndTime?: Date;
422
+ /**
423
+ * Transmit start time of a contact.
424
+ * NOTE: This property will not be serialized. It can only be populated by the server.
425
+ */
426
+ readonly txStartTime?: Date;
427
+ /**
428
+ * Transmit end time of a contact.
429
+ * NOTE: This property will not be serialized. It can only be populated by the server.
430
+ */
431
+ readonly txEndTime?: Date;
432
+ /**
433
+ * Any error message while scheduling a contact.
434
+ * NOTE: This property will not be serialized. It can only be populated by the server.
435
+ */
436
+ readonly errorMessage?: string;
437
+ /**
438
+ * Maximum elevation of the antenna during the contact in decimal degrees.
439
+ * NOTE: This property will not be serialized. It can only be populated by the server.
440
+ */
441
+ readonly maximumElevationDegrees?: number;
442
+ /**
443
+ * Azimuth of the antenna at the start of the contact in decimal degrees.
444
+ * NOTE: This property will not be serialized. It can only be populated by the server.
445
+ */
446
+ readonly startAzimuthDegrees?: number;
447
+ /**
448
+ * Azimuth of the antenna at the end of the contact in decimal degrees.
449
+ * NOTE: This property will not be serialized. It can only be populated by the server.
450
+ */
451
+ readonly endAzimuthDegrees?: number;
452
+ /** Azure Ground Station name. */
453
+ groundStationName?: string;
454
+ /**
455
+ * Spacecraft elevation above the horizon at contact start.
456
+ * NOTE: This property will not be serialized. It can only be populated by the server.
457
+ */
458
+ readonly startElevationDegrees?: number;
459
+ /**
460
+ * Spacecraft elevation above the horizon at contact end.
461
+ * NOTE: This property will not be serialized. It can only be populated by the server.
462
+ */
463
+ readonly endElevationDegrees?: number;
464
+ /** The reference to the contact profile resource. */
465
+ contactProfile?: ResourceReference;
466
+ };
467
+ /** Known values of {@link Origin} that the service accepts. */
468
+ export declare enum KnownOrigin {
469
+ User = "user",
470
+ System = "system",
471
+ UserSystem = "user,system"
472
+ }
473
+ /**
474
+ * Defines values for Origin. \
475
+ * {@link KnownOrigin} can be used interchangeably with Origin,
476
+ * this enum contains the known values that the service supports.
477
+ * ### Known values supported by the service
478
+ * **user** \
479
+ * **system** \
480
+ * **user,system**
481
+ */
482
+ export declare type Origin = string;
483
+ /** Known values of {@link ActionType} that the service accepts. */
484
+ export declare enum KnownActionType {
485
+ Internal = "Internal"
486
+ }
487
+ /**
488
+ * Defines values for ActionType. \
489
+ * {@link KnownActionType} can be used interchangeably with ActionType,
490
+ * this enum contains the known values that the service supports.
491
+ * ### Known values supported by the service
492
+ * **Internal**
493
+ */
494
+ export declare type ActionType = string;
495
+ /** Known values of {@link Direction} that the service accepts. */
496
+ export declare enum KnownDirection {
497
+ Uplink = "uplink",
498
+ Downlink = "downlink"
499
+ }
500
+ /**
501
+ * Defines values for Direction. \
502
+ * {@link KnownDirection} can be used interchangeably with Direction,
503
+ * this enum contains the known values that the service supports.
504
+ * ### Known values supported by the service
505
+ * **uplink** \
506
+ * **downlink**
507
+ */
508
+ export declare type Direction = string;
509
+ /** Known values of {@link Polarization} that the service accepts. */
510
+ export declare enum KnownPolarization {
511
+ Rhcp = "RHCP",
512
+ Lhcp = "LHCP",
513
+ DualRhcpLhcp = "dualRhcpLhcp",
514
+ LinearVertical = "linearVertical",
515
+ LinearHorizontal = "linearHorizontal"
516
+ }
517
+ /**
518
+ * Defines values for Polarization. \
519
+ * {@link KnownPolarization} can be used interchangeably with Polarization,
520
+ * this enum contains the known values that the service supports.
521
+ * ### Known values supported by the service
522
+ * **RHCP** \
523
+ * **LHCP** \
524
+ * **dualRhcpLhcp** \
525
+ * **linearVertical** \
526
+ * **linearHorizontal**
527
+ */
528
+ export declare type Polarization = string;
529
+ /** Known values of {@link CreatedByType} that the service accepts. */
530
+ export declare enum KnownCreatedByType {
531
+ User = "User",
532
+ Application = "Application",
533
+ ManagedIdentity = "ManagedIdentity",
534
+ Key = "Key"
535
+ }
536
+ /**
537
+ * Defines values for CreatedByType. \
538
+ * {@link KnownCreatedByType} can be used interchangeably with CreatedByType,
539
+ * this enum contains the known values that the service supports.
540
+ * ### Known values supported by the service
541
+ * **User** \
542
+ * **Application** \
543
+ * **ManagedIdentity** \
544
+ * **Key**
545
+ */
546
+ export declare type CreatedByType = string;
547
+ /** Known values of {@link Protocol} that the service accepts. */
548
+ export declare enum KnownProtocol {
549
+ TCP = "TCP",
550
+ UDP = "UDP"
551
+ }
552
+ /**
553
+ * Defines values for Protocol. \
554
+ * {@link KnownProtocol} can be used interchangeably with Protocol,
555
+ * this enum contains the known values that the service supports.
556
+ * ### Known values supported by the service
557
+ * **TCP** \
558
+ * **UDP**
559
+ */
560
+ export declare type Protocol = string;
561
+ /** Known values of {@link Enum6} that the service accepts. */
562
+ export declare enum KnownEnum6 {
563
+ EarthObservation = "EarthObservation",
564
+ Communication = "Communication"
565
+ }
566
+ /**
567
+ * Defines values for Enum6. \
568
+ * {@link KnownEnum6} can be used interchangeably with Enum6,
569
+ * this enum contains the known values that the service supports.
570
+ * ### Known values supported by the service
571
+ * **EarthObservation** \
572
+ * **Communication**
573
+ */
574
+ export declare type Enum6 = string;
575
+ /** Known values of {@link Capability} that the service accepts. */
576
+ export declare enum KnownCapability {
577
+ EarthObservation = "EarthObservation",
578
+ Communication = "Communication"
579
+ }
580
+ /**
581
+ * Defines values for Capability. \
582
+ * {@link KnownCapability} can be used interchangeably with Capability,
583
+ * this enum contains the known values that the service supports.
584
+ * ### Known values supported by the service
585
+ * **EarthObservation** \
586
+ * **Communication**
587
+ */
588
+ export declare type Capability = string;
589
+ /** Defines values for AuthorizationStatus. */
590
+ export declare type AuthorizationStatus = "Allowed" | "Pending" | "Denied";
591
+ /** Defines values for Status. */
592
+ export declare type Status = "scheduled" | "cancelled" | "succeeded" | "failed" | "providerCancelled";
593
+ /** Defines values for AutoTrackingConfiguration. */
594
+ export declare type AutoTrackingConfiguration = "disabled" | "xBand" | "sBand";
595
+ /** Optional parameters. */
596
+ export interface OperationsListOptionalParams extends coreClient.OperationOptions {
597
+ }
598
+ /** Contains response data for the list operation. */
599
+ export declare type OperationsListResponse = OperationListResult;
600
+ /** Optional parameters. */
601
+ export interface SpacecraftsListBySubscriptionOptionalParams extends coreClient.OperationOptions {
602
+ }
603
+ /** Contains response data for the listBySubscription operation. */
604
+ export declare type SpacecraftsListBySubscriptionResponse = SpacecraftListResult;
605
+ /** Optional parameters. */
606
+ export interface SpacecraftsListOptionalParams extends coreClient.OperationOptions {
607
+ }
608
+ /** Contains response data for the list operation. */
609
+ export declare type SpacecraftsListResponse = SpacecraftListResult;
610
+ /** Optional parameters. */
611
+ export interface SpacecraftsGetOptionalParams extends coreClient.OperationOptions {
612
+ }
613
+ /** Contains response data for the get operation. */
614
+ export declare type SpacecraftsGetResponse = Spacecraft;
615
+ /** Optional parameters. */
616
+ export interface SpacecraftsCreateOrUpdateOptionalParams extends coreClient.OperationOptions {
617
+ /** Resource tags. */
618
+ tags?: {
619
+ [propertyName: string]: string;
620
+ };
621
+ /** NORAD ID of the spacecraft. */
622
+ noradId?: string;
623
+ /** Title line of Two Line Element (TLE). */
624
+ titleLine?: string;
625
+ /** Line 1 of Two Line Element (TLE). */
626
+ tleLine1?: string;
627
+ /** Line 2 of Two Line Element (TLE). */
628
+ tleLine2?: string;
629
+ /** Links of the Spacecraft */
630
+ links?: SpacecraftLink[];
631
+ /** Delay to wait until next poll, in milliseconds. */
632
+ updateIntervalInMs?: number;
633
+ /** A serialized poller which can be used to resume an existing paused Long-Running-Operation. */
634
+ resumeFrom?: string;
635
+ }
636
+ /** Contains response data for the createOrUpdate operation. */
637
+ export declare type SpacecraftsCreateOrUpdateResponse = Spacecraft;
638
+ /** Optional parameters. */
639
+ export interface SpacecraftsDeleteOptionalParams extends coreClient.OperationOptions {
640
+ /** Delay to wait until next poll, in milliseconds. */
641
+ updateIntervalInMs?: number;
642
+ /** A serialized poller which can be used to resume an existing paused Long-Running-Operation. */
643
+ resumeFrom?: string;
644
+ }
645
+ /** Optional parameters. */
646
+ export interface SpacecraftsUpdateTagsOptionalParams extends coreClient.OperationOptions {
647
+ }
648
+ /** Contains response data for the updateTags operation. */
649
+ export declare type SpacecraftsUpdateTagsResponse = Spacecraft;
650
+ /** Optional parameters. */
651
+ export interface SpacecraftsListAvailableContactsOptionalParams extends coreClient.OperationOptions {
652
+ /** Delay to wait until next poll, in milliseconds. */
653
+ updateIntervalInMs?: number;
654
+ /** A serialized poller which can be used to resume an existing paused Long-Running-Operation. */
655
+ resumeFrom?: string;
656
+ }
657
+ /** Contains response data for the listAvailableContacts operation. */
658
+ export declare type SpacecraftsListAvailableContactsResponse = AvailableContactsListResult;
659
+ /** Optional parameters. */
660
+ export interface ContactsListOptionalParams extends coreClient.OperationOptions {
661
+ }
662
+ /** Contains response data for the list operation. */
663
+ export declare type ContactsListResponse = ContactListResult;
664
+ /** Optional parameters. */
665
+ export interface ContactsGetOptionalParams extends coreClient.OperationOptions {
666
+ }
667
+ /** Contains response data for the get operation. */
668
+ export declare type ContactsGetResponse = Contact;
669
+ /** Optional parameters. */
670
+ export interface ContactsCreateOptionalParams extends coreClient.OperationOptions {
671
+ /** Delay to wait until next poll, in milliseconds. */
672
+ updateIntervalInMs?: number;
673
+ /** A serialized poller which can be used to resume an existing paused Long-Running-Operation. */
674
+ resumeFrom?: string;
675
+ }
676
+ /** Contains response data for the create operation. */
677
+ export declare type ContactsCreateResponse = Contact;
678
+ /** Optional parameters. */
679
+ export interface ContactsDeleteOptionalParams extends coreClient.OperationOptions {
680
+ /** Delay to wait until next poll, in milliseconds. */
681
+ updateIntervalInMs?: number;
682
+ /** A serialized poller which can be used to resume an existing paused Long-Running-Operation. */
683
+ resumeFrom?: string;
684
+ }
685
+ /** Optional parameters. */
686
+ export interface ContactProfilesGetOptionalParams extends coreClient.OperationOptions {
687
+ }
688
+ /** Contains response data for the get operation. */
689
+ export declare type ContactProfilesGetResponse = ContactProfile;
690
+ /** Optional parameters. */
691
+ export interface ContactProfilesCreateOrUpdateOptionalParams extends coreClient.OperationOptions {
692
+ /** Resource tags. */
693
+ tags?: {
694
+ [propertyName: string]: string;
695
+ };
696
+ /** Minimum viable contact duration in ISO 8601 format. */
697
+ minimumViableContactDuration?: string;
698
+ /** Minimum viable elevation for the contact in decimal degrees. */
699
+ minimumElevationDegrees?: number;
700
+ /** Auto track configuration. */
701
+ autoTrackingConfiguration?: AutoTrackingConfiguration;
702
+ /** Links of the Contact Profile */
703
+ links?: ContactProfileLink[];
704
+ /** Delay to wait until next poll, in milliseconds. */
705
+ updateIntervalInMs?: number;
706
+ /** A serialized poller which can be used to resume an existing paused Long-Running-Operation. */
707
+ resumeFrom?: string;
708
+ }
709
+ /** Contains response data for the createOrUpdate operation. */
710
+ export declare type ContactProfilesCreateOrUpdateResponse = ContactProfile;
711
+ /** Optional parameters. */
712
+ export interface ContactProfilesDeleteOptionalParams extends coreClient.OperationOptions {
713
+ /** Delay to wait until next poll, in milliseconds. */
714
+ updateIntervalInMs?: number;
715
+ /** A serialized poller which can be used to resume an existing paused Long-Running-Operation. */
716
+ resumeFrom?: string;
717
+ }
718
+ /** Optional parameters. */
719
+ export interface ContactProfilesUpdateTagsOptionalParams extends coreClient.OperationOptions {
720
+ }
721
+ /** Contains response data for the updateTags operation. */
722
+ export declare type ContactProfilesUpdateTagsResponse = ContactProfile;
723
+ /** Optional parameters. */
724
+ export interface ContactProfilesListBySubscriptionOptionalParams extends coreClient.OperationOptions {
725
+ }
726
+ /** Contains response data for the listBySubscription operation. */
727
+ export declare type ContactProfilesListBySubscriptionResponse = ContactProfileListResult;
728
+ /** Optional parameters. */
729
+ export interface ContactProfilesListOptionalParams extends coreClient.OperationOptions {
730
+ }
731
+ /** Contains response data for the list operation. */
732
+ export declare type ContactProfilesListResponse = ContactProfileListResult;
733
+ /** Optional parameters. */
734
+ export interface AvailableGroundStationsListByCapabilityOptionalParams extends coreClient.OperationOptions {
735
+ }
736
+ /** Contains response data for the listByCapability operation. */
737
+ export declare type AvailableGroundStationsListByCapabilityResponse = AvailableGroundStationListResult;
738
+ /** Optional parameters. */
739
+ export interface AvailableGroundStationsGetOptionalParams extends coreClient.OperationOptions {
740
+ }
741
+ /** Contains response data for the get operation. */
742
+ export declare type AvailableGroundStationsGetResponse = AvailableGroundStation;
743
+ /** Optional parameters. */
744
+ export interface AvailableGroundStationsListByCapabilityNextOptionalParams extends coreClient.OperationOptions {
745
+ }
746
+ /** Contains response data for the listByCapabilityNext operation. */
747
+ export declare type AvailableGroundStationsListByCapabilityNextResponse = AvailableGroundStationListResult;
748
+ /** Optional parameters. */
749
+ export interface AzureOrbitalOptionalParams extends coreClient.ServiceClientOptions {
750
+ /** server parameter */
751
+ $host?: string;
752
+ /** Api Version */
753
+ apiVersion?: string;
754
+ /** Overrides client endpoint. */
755
+ endpoint?: string;
756
+ }
757
+ //# sourceMappingURL=index.d.ts.map