/
index.ts
1441 lines (1235 loc) · 57.8 KB
/
index.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/*
* Copyright (c) Microsoft Corporation.
* Licensed under the MIT License.
*
* Code generated by Microsoft (R) AutoRest Code Generator.
* Changes may cause incorrect behavior and will be lost if the code is regenerated.
*/
import * as coreClient from "@azure/core-client";
/** Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.). */
export interface ErrorResponse {
/** The error object. */
error?: ErrorDetail;
}
/** The error detail. */
export interface ErrorDetail {
/**
* The error code.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly code?: string;
/**
* The error message.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly message?: string;
/**
* The error target.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly target?: string;
/**
* The error details.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly details?: ErrorDetail[];
/**
* The error additional info.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly additionalInfo?: ErrorAdditionalInfo[];
}
/** The resource management error additional info. */
export interface ErrorAdditionalInfo {
/**
* The additional info type.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly type?: string;
/**
* The additional info.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly info?: Record<string, unknown>;
}
/** Interface properties */
export interface InterfaceProperties {
/** The logical name for this interface. This should match one of the interfaces configured on your Azure Stack Edge machine. */
name: string;
/** The IPv4 address. */
ipv4Address?: string;
/** The IPv4 subnet. */
ipv4Subnet?: string;
/** The default IPv4 gateway (router). */
ipv4Gateway?: string;
}
/** The Network Address and Port Translation settings to use for the attached data network. */
export interface NaptConfiguration {
/** Whether NAPT is enabled for connections to this attachedDataNetwork. */
enabled?: NaptEnabled;
/**
* Range of port numbers to use as translated ports on each translated address.
* If not specified and NAPT is enabled, this range defaults to 1,024 - 65,535. (Ports under 1,024 should not be used because these are special purpose ports reserved by IANA.)
*/
portRange?: PortRange;
/** The minimum time (in seconds) that will pass before a port that was used by a closed pinhole can be recycled for use by another pinhole. All hold times must be minimum 1 second. */
portReuseHoldTime?: PortReuseHoldTimes;
/** Maximum number of UDP and TCP pinholes that can be open simultaneously on the core interface. */
pinholeLimits?: number;
/** Expiry times of inactive NAPT pinholes, in seconds. All timers must be at least 1 second. */
pinholeTimeouts?: PinholeTimeouts;
}
/**
* Range of port numbers to use as translated ports on each translated address.
* If not specified and NAPT is enabled, this range defaults to 1,024 - 65,535. (Ports under 1,024 should not be used because these are special purpose ports reserved by IANA.)
*/
export interface PortRange {
/** The minimum port number */
minPort?: number;
/** The maximum port number */
maxPort?: number;
}
/** The minimum time (in seconds) that will pass before a port that was used by a closed pinhole can be recycled for use by another pinhole. All hold times must be minimum 1 second. */
export interface PortReuseHoldTimes {
/** Minimum time in seconds that will pass before a TCP port that was used by a closed pinhole can be reused. Default for TCP is 2 minutes. */
tcp?: number;
/** Minimum time in seconds that will pass before a UDP port that was used by a closed pinhole can be reused. Default for UDP is 1 minute. */
udp?: number;
}
/** Expiry times of inactive NAPT pinholes, in seconds. All timers must be at least 1 second. */
export interface PinholeTimeouts {
/** Pinhole timeout for TCP pinholes in seconds. Default for TCP is 2 hours 4 minutes per RFC 5382 section 5. */
tcp?: number;
/** Pinhole timeout for UDP pinholes in seconds. Default for UDP is 5 minutes per RFC 4787 section 4.3. */
udp?: number;
/** Pinhole timeout for ICMP pinholes in seconds. Default for ICMP Echo is 60 seconds per RFC 5508 section 3.2. */
icmp?: number;
}
/** Common fields that are returned in the response for all Azure Resource Manager resources */
export interface Resource {
/**
* Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly id?: string;
/**
* The name of the resource
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly name?: string;
/**
* The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly type?: string;
/**
* Azure Resource Manager metadata containing createdBy and modifiedBy information.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly systemData?: SystemData;
}
/** Metadata pertaining to creation and last modification of the resource. */
export interface SystemData {
/** The identity that created the resource. */
createdBy?: string;
/** The type of identity that created the resource. */
createdByType?: CreatedByType;
/** The timestamp of resource creation (UTC). */
createdAt?: Date;
/** The identity that last modified the resource. */
lastModifiedBy?: string;
/** The type of identity that last modified the resource. */
lastModifiedByType?: CreatedByType;
/** The timestamp of resource last modification (UTC) */
lastModifiedAt?: Date;
}
/** Tags object for patch operations. */
export interface TagsObject {
/** Resource tags. */
tags?: { [propertyName: string]: string };
}
/** Response for attached data network API service call. */
export interface AttachedDataNetworkListResult {
/** A list of data networks in a resource group. */
value?: AttachedDataNetwork[];
/**
* The URL to get the next set of results.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly nextLink?: string;
}
/** Response for data network API service call. */
export interface DataNetworkListResult {
/** A list of data networks in a resource group. */
value?: DataNetwork[];
/**
* The URL to get the next set of results.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly nextLink?: string;
}
/** Public Land Mobile Network (PLMN) ID. */
export interface PlmnId {
/** Mobile Country Code (MCC). */
mcc: string;
/** Mobile Network Code (MNC). */
mnc: string;
}
/** Response for mobile networks API service call. */
export interface MobileNetworkListResult {
/** A list of mobile networks in a resource group. */
value?: MobileNetwork[];
/**
* The URL to get the next set of results.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly nextLink?: string;
}
/** Response for list sim ids API service call. */
export interface SimIdListResult {
/** A list of sim profile ids in a resource group. */
value?: SubResource[];
/**
* The URL to get the next set of results.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly nextLink?: string;
}
/** Reference to another sub resource. */
export interface SubResource {
/** Resource ID. */
id: string;
}
/** Response for sites API service call. */
export interface SiteListResult {
/** A list of sites in a resource group. */
value?: Site[];
/**
* The URL to get the next set of results.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly nextLink?: string;
}
/** Reference to a Mobile Network resource. */
export interface MobileNetworkResourceId {
/** Mobile Network resource ID. */
id: string;
}
/** Reference to a SIM Policy resource. */
export interface SimPolicyResourceId {
/** SIM Policy resource ID. */
id: string;
}
/** Static IP configuration for a sim, scoped to a particular attached data network and slice. */
export interface SimStaticIpProperties {
/** The attached data network on which the static IP address will be used. The combination of attachedDataNetwork and slice defines the network scope of the IP address. */
attachedDataNetwork?: AttachedDataNetworkResourceId;
/** The network slice on which the static IP address will be used. The combination of attachedDataNetwork and slice defines the network scope of the IP address. */
slice?: SliceResourceId;
/** The static IP configuration for the sim to use at the defined network scope. */
staticIp?: SimStaticIpPropertiesStaticIp;
}
/** Reference to an Attached Data Network resource. */
export interface AttachedDataNetworkResourceId {
/** Attached Data Network resource ID. */
id: string;
}
/** Reference to a Slice resource. */
export interface SliceResourceId {
/** Slice resource ID. */
id: string;
}
/** The static IP configuration for the sim to use at the defined network scope. */
export interface SimStaticIpPropertiesStaticIp {
/** The IPv4 address assigned to the sim at this network scope. This address must be in the userEquipmentStaticAddressPoolPrefix defined in the attachedDataNetwork. */
ipv4Address?: string;
}
/** Response for list Sims API service call. */
export interface SimListResult {
/** A list of Sims in a resource group. */
value?: Sim[];
/**
* The URL to get the next set of results.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly nextLink?: string;
}
/** List of the operations. */
export interface OperationList {
/**
* List of Microsoft.MobileNetwork operations.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly value?: Operation[];
/**
* The URL to get the next set of results.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly nextLink?: string;
}
/** Object that describes a single Microsoft.MobileNetwork operation. */
export interface Operation {
/** Indicates whether the operation applies to data-plane. */
isDataAction?: boolean;
/**
* Operation name: {provider}/{resource}/{operation}
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly name?: string;
/**
* The object that represents the operation.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly display?: OperationDisplay;
}
/** The object that represents the operation. */
export interface OperationDisplay {
/** Service provider: Microsoft.MobileNetwork */
provider?: string;
/** Resource on which the operation is performed: Registration definition, registration assignment etc. */
resource?: string;
/** Operation type: Read, write, delete, etc. */
operation?: string;
/** Description of the operation. */
description?: string;
}
/** Reference to an Azure ARC custom location resource. */
export interface CustomLocationResourceId {
/** Azure ARC custom location resource ID. */
id: string;
}
/** Response for packet core control planes API service call. */
export interface PacketCoreControlPlaneListResult {
/** A list of packet core control planes in a resource group. */
value?: PacketCoreControlPlane[];
/**
* The URL to get the next set of results.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly nextLink?: string;
}
/** Response for packet core data planes API service call. */
export interface PacketCoreDataPlaneListResult {
/** A list of packet core data planes in a resource group. */
value?: PacketCoreDataPlane[];
/**
* The URL to get the next set of results.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly nextLink?: string;
}
/** QoS policy */
export interface QosPolicy {
/** QoS Flow 5G QoS Indicator value. The 5QI identifies a specific QoS forwarding treatment to be provided to a flow. This must not be a standardized 5QI value selecting a GBR (Guaranteed Bit Rate) QoS. The illegal GBR 5QI values are: 1, 2, 3, 4, 65, 66, 67, 71, 72, 73, 74, 75, 76, 82, 83, 84, and 85. See 3GPP TS23.501 section 5.7.2.1 for a full description of the 5Qi parameter, and table 5.7.4-1 for the definition of which are the GBR 5QI values. */
fiveQi?: number;
/** QoS Flow allocation and retention priority (ARP) level. Flows with higher priority preempt flows with lower priority, if the settings of `preemptionCapability` and `preemptionVulnerability` allow it. 1 is the highest level of priority. If this field is not specified then `5qi` is used to derive the ARP value. See 3GPP TS23.501 section 5.7.2.2 for a full description of the ARP parameters. */
allocationAndRetentionPriorityLevel?: number;
/** QoS Flow preemption capability. The Preemption Capability of a QoS Flow controls whether it can preempt another QoS Flow with a lower priority level. See 3GPP TS23.501 section 5.7.2.2 for a full description of the ARP parameters. */
preemptionCapability?: PreemptionCapability;
/** QoS Flow preemption vulnerability. The Preemption Vulnerability of a QoS Flow controls whether it can be preempted by QoS Flow with a higher priority level. See 3GPP TS23.501 section 5.7.2.2 for a full description of the ARP parameters. */
preemptionVulnerability?: PreemptionVulnerability;
/** The Maximum Bit Rate (MBR) for all service data flows that use this PCC Rule or Service. */
maximumBitRate: Ambr;
}
/** Aggregate Maximum Bit Rate. */
export interface Ambr {
/** Uplink bit rate. */
uplink: string;
/** Downlink bit rate. */
downlink: string;
}
/** PCC rule configuration */
export interface PccRuleConfiguration {
/** The name of the rule. This must be unique within the parent Service. You must not use any of the following reserved strings - `default`, `requested` or `service`. */
ruleName: string;
/** A precedence value that is used to decide between PCC Rules when identifying the QoS values to use for a particular Sim. A lower value means a higher priority. This value should be unique among all PCC Rules configured in the Mobile Network. */
rulePrecedence: number;
/** The QoS policy to use for packets matching this rule. If this field is null then the Service will define the QoS settings. */
ruleQosPolicy?: PccRuleQosPolicy;
/** Determines whether flows that match this PCC Rule are permitted. */
trafficControl?: TrafficControlPermission;
/** The set of service data flow templates to use for this PCC Rule. */
serviceDataFlowTemplates: ServiceDataFlowTemplate[];
}
/** Service data flow (SDF) template */
export interface ServiceDataFlowTemplate {
/** The name of the SDF template. This must be unique within the parent PccRuleConfiguration. You must not use any of the following reserved strings - `default`, `requested` or `service`. */
templateName: string;
/** The direction of this flow. */
direction: SdfDirection;
/** A list of the allowed protocol(s) for this flow. If you want this flow to be able to use any protocol within the internet protocol suite, use the value `ip`. If you only want to allow a selection of protocols, you must use the corresponding IANA Assigned Internet Protocol Number for each protocol, as described in https://www.iana.org/assignments/protocol-numbers/protocol-numbers.xhtml. For example, for UDP, you must use 17. If you use the value `ip` then you must leave the field `port` unspecified. */
protocol: string[];
/** The remote IP address(es) to which UEs will connect for this flow. If you want to allow connections on any IP address, use the value `any`. Otherwise, you must provide each of the remote IP addresses to which Fusion Core will connect for this flow. You must provide each IP address in CIDR notation, including the netmask (for example, 192.0.2.54/24). */
remoteIpList: string[];
/** The port(s) to which UEs will connect for this flow. You can specify zero or more ports or port ranges. If you specify one or more ports or port ranges then you must specify a value other than `ip` in the `protocol` field. This is an optional setting. If you do not specify it then connections will be allowed on all ports. Port ranges must be specified as <FirstPort>-<LastPort>. For example: [`8080`, `8082-8085`]. */
ports?: string[];
}
/** Response for Services API service call. */
export interface ServiceListResult {
/** A list of Services. */
value?: Service[];
/**
* The URL to get the next set of results.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly nextLink?: string;
}
/** Per-slice settings */
export interface SliceConfiguration {
/** A reference to the Slice that these settings apply to */
slice: SliceResourceId;
/** The default data network to use if the UE does not explicitly specify it. Configuration for this object must exist in the `dataNetworkConfigurations` map. */
defaultDataNetwork: DataNetworkResourceId;
/** The allowed data networks and the settings to use for them. The list must not contain duplicate items and must contain at least one item. */
dataNetworkConfigurations: DataNetworkConfiguration[];
}
/** Reference to a Data Network resource. */
export interface DataNetworkResourceId {
/** Data Network resource ID. */
id: string;
}
/** Settings controlling Data Network use */
export interface DataNetworkConfiguration {
/** A reference to the Data Network that these settings apply to */
dataNetwork: DataNetworkResourceId;
/** Aggregate maximum bit rate across all non-GBR QoS flows of a given PDU session. See 3GPP TS23.501 section 5.7.2.6 for a full description of the Session-AMBR. */
sessionAmbr: Ambr;
/** Default QoS Flow 5G QoS Indicator value. The 5QI identifies a specific QoS forwarding treatment to be provided to a flow. This must not be a standardized 5QI value selecting a GBR (Guaranteed Bit Rate) QoS. The illegal GBR 5QI values are: 1, 2, 3, 4, 65, 66, 67, 71, 72, 73, 74, 75, 76, 82, 83, 84, and 85. See 3GPP TS23.501 section 5.7.2.1 for a full description of the 5Qi parameter, and table 5.7.4-1 for the definition of which are the GBR 5QI values. */
fiveQi?: number;
/** Default QoS Flow allocation and retention priority (ARP) level. Flows with higher priority preempt flows with lower priority, if the settings of `preemptionCapability` and `preemptionVulnerability` allow it. 1 is the highest level of priority. If this field is not specified then `5qi` is used to derive the ARP value. See 3GPP TS23.501 section 5.7.2.2 for a full description of the ARP parameters. */
allocationAndRetentionPriorityLevel?: number;
/** Default QoS Flow preemption capability. The Preemption Capability of a QoS Flow controls whether it can preempt another QoS Flow with a lower priority level. See 3GPP TS23.501 section 5.7.2.2 for a full description of the ARP parameters. */
preemptionCapability?: PreemptionCapability;
/** Default QoS Flow preemption vulnerability. The Preemption Vulnerability of a QoS Flow controls whether it can be preempted by QoS Flow with a higher priority level. See 3GPP TS23.501 section 5.7.2.2 for a full description of the ARP parameters. */
preemptionVulnerability?: PreemptionVulnerability;
/** The default PDU session type, which is used if the UE does not request a specific session type. */
defaultSessionType?: PduSessionType;
/** Allowed session types in addition to the default session type. Must not duplicate the default session type. */
additionalAllowedSessionTypes?: PduSessionType[];
/** List of Services that can be used as part of this Sim Policy. The list must not contain duplicate items and must contain at least one item. */
allowedServices: ServiceResourceId[];
}
/** Reference to a Service resource. */
export interface ServiceResourceId {
/** Service resource ID. */
id: string;
}
/** Response for SimPolicies API service call. */
export interface SimPolicyListResult {
/** A list of SimPolicies. */
value?: SimPolicy[];
/**
* The URL to get the next set of results.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly nextLink?: string;
}
/** Single-Network Slice Selection Assistance Information (S-NSSAI). */
export interface Snssai {
/** Slice/Service Type (SST). */
sst: number;
/** Slice Differentiator (SD). */
sd?: string;
}
/** Response for attached data network API service call. */
export interface SliceListResult {
/** A list of data networks in a resource group. */
value?: Slice[];
/**
* The URL to get the next set of results.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly nextLink?: string;
}
/** Allocation and Retention Priority (ARP) parameters. */
export interface Arp {
/** ARP priority level. */
priorityLevel: number;
/** ARP preemption capability. */
preemptCap: PreemptionCapability;
/** ARP preemption vulnerability */
preemptVuln: PreemptionVulnerability;
}
/** The resource model definition for an Azure Resource Manager tracked top level resource which has 'tags' and a 'location' */
export type TrackedResource = Resource & {
/** Resource tags. */
tags?: { [propertyName: string]: string };
/** The geo-location where the resource lives */
location: string;
};
/** PCC rule QoS policy */
export type PccRuleQosPolicy = QosPolicy & {
/** The Guaranteed Bit Rate (GBR) for all service data flows that use this PCC Rule. This is an optional setting. If you do not provide a value, there will be no GBR set for the PCC Rule that uses this QoS definition. */
guaranteedBitRate?: Ambr;
};
/** Attached data network resource. */
export type AttachedDataNetwork = TrackedResource & {
/**
* The provisioning state of the attached data network resource.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly provisioningState?: ProvisioningState;
/** The user plane interface on the data network. In 5G networks this is called as N6 interface whereas in 4G networks this is called as SGi interface. */
userPlaneDataInterface: InterfaceProperties;
/**
* The Network Address and Port Translation configuration.
* If not specified the attached data network uses a default NAPT configuration with NAPT enabled.
*/
naptConfiguration?: NaptConfiguration;
/**
* The user equipment address pool prefixes for the attached data network that are dynamically assigned by the core to UEs when they set up a PDU session.
* At least one of userEquipmentAddressPoolPrefix and userEquipmentStaticAddressPoolPrefix must be defined. If both are defined then they must be the same size.
*/
userEquipmentAddressPoolPrefix?: string[];
/**
* The user equipment address pool prefixes for the attached data network that are statically assigned by the core to UEs when they set up a PDU session.
* The mapping of static IP to sim is configured in staticIpConfiguration on the sim resource.
* At least one of userEquipmentAddressPoolPrefix and userEquipmentStaticAddressPoolPrefix must be defined. If both are defined then they must be the same size.
*/
userEquipmentStaticAddressPoolPrefix?: string[];
};
/** Data network resource. */
export type DataNetwork = TrackedResource & {
/**
* The provisioning state of the data network resource.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly provisioningState?: ProvisioningState;
/** An optional description for this data network. */
description?: string;
};
/** Mobile network resource. */
export type MobileNetwork = TrackedResource & {
/**
* The provisioning state of the mobile network resource.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly provisioningState?: ProvisioningState;
/** The unique public land mobile network identifier for the network. This is made up of the Mobile Country Code and Mobile Network Code, as defined in https://www.itu.int/rec/T-REC-E.212. The values 001-01 and 001-001 can be used for testing and the values 999-99 and 999-999 can be used on internal private networks. */
publicLandMobileNetworkIdentifier: PlmnId;
/**
* The mobile network resource identifier
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly serviceKey?: string;
};
/** Site resource. */
export type Site = TrackedResource & {
/**
* The provisioning state of the site resource. **TODO**: Confirm if this is needed
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly provisioningState?: ProvisioningState;
/** An array of ids of the network functions deployed on the site, maintained by the user. */
networkFunctions?: SubResource[];
};
/** Sim resource. */
export type Sim = TrackedResource & {
/**
* The provisioning state of the sim resource.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly provisioningState?: ProvisioningState;
/**
* The state of the sim resource.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly simState?: SimState;
/** The International Mobile Subscriber Identity (IMSI) for the sim. */
internationalMobileSubscriberIdentity: string;
/** The Integrated Circuit Card ID (ICC Id) for the sim. */
integratedCircuitCardIdentifier?: string;
/** The ki value for the sim. */
authenticationKey?: string;
/** The Opc value for the sim. */
operatorKeyCode?: string;
/** Mobile network that this sim belongs to */
mobileNetwork?: MobileNetworkResourceId;
/** An optional free-form text field that can be used to record the device type this sim is associated with, for example 'Video camera'. The Azure portal allows Sims to be grouped and filtered based on this value. */
deviceType?: string;
/** The simPolicy used by this sim. */
simPolicy?: SimPolicyResourceId;
/** A list of static IP addresses assigned to this sim. Each address is assigned at a defined network scope, made up of {attached data network, slice}. */
staticIpConfiguration?: SimStaticIpProperties[];
};
/** Packet core control plane resource. */
export type PacketCoreControlPlane = TrackedResource & {
/**
* The provisioning state of the packet core control plane resource.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly provisioningState?: ProvisioningState;
/** Mobile network that this packet core control plane belongs to */
mobileNetwork: MobileNetworkResourceId;
/** Azure ARC custom location where the packet core is deployed. */
customLocation?: CustomLocationResourceId;
/** The core network technology generation. */
coreNetworkTechnology?: CoreNetworkType;
/** The version of the packet core software that is deployed. */
version?: string;
/** The control plane interface on the access network. In 5G networks this is called as N2 interface whereas in 4G networks this is called as S1-MME interface. */
controlPlaneAccessInterface: InterfaceProperties;
};
/** Packet core data plane resource. */
export type PacketCoreDataPlane = TrackedResource & {
/**
* The provisioning state of the packet core data plane resource.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly provisioningState?: ProvisioningState;
/** The user plane interface on the access network. In 5G networks this is called as N3 interface whereas in 4G networks this is called the S1-U interface. */
userPlaneAccessInterface: InterfaceProperties;
};
/** Service resource. */
export type Service = TrackedResource & {
/**
* The provisioning state of the service resource.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly provisioningState?: ProvisioningState;
/** A precedence value that is used to decide between services when identifying the QoS values to use for a particular Sim. A lower value means a higher priority. This value should be unique among all services configured in the Mobile Network. */
servicePrecedence: number;
/** The QoS policy to use for packets matching this service. This can be overridden for particular flows using the ruleQosPolicy field in a PccRuleConfiguration. If this field is null then the UE's simPolicy will define the QoS settings. */
serviceQosPolicy?: QosPolicy;
/** The set of PCC Rules that make up this service. */
pccRules: PccRuleConfiguration[];
};
/** Sim policy resource. */
export type SimPolicy = TrackedResource & {
/**
* The provisioning state of the sim policy resource.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly provisioningState?: ProvisioningState;
/** Aggregate maximum bit rate across all non-GBR QoS flows of all PDU sessions of a given UE. See 3GPP TS23.501 section 5.7.2.6 for a full description of the UE-AMBR. */
ueAmbr: Ambr;
/** The default slice to use if the UE does not explicitly specify it. This slice must exist in the `sliceConfigurations` map. */
defaultSlice: SliceResourceId;
/** RAT/Frequency Selection Priority Index, defined in 3GPP TS 36.413. This is an optional setting and by default is unspecified. */
rfspIndex?: number;
/** Interval for the UE periodic registration update procedure, in seconds. */
registrationTimer?: number;
/** The allowed slices and the settings to use for them. The list must not contain duplicate items and must contain at least one item. */
sliceConfigurations: SliceConfiguration[];
};
/** Network slice resource. */
export type Slice = TrackedResource & {
/**
* The provisioning state of the network slice resource.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly provisioningState?: ProvisioningState;
/** The S-NSSAI (single network slice selection assistance information). Unique at the scope of a MobileNetwork. */
snssai: Snssai;
/** An optional description for this network slice. */
description?: string;
};
/** Known values of {@link ProvisioningState} that the service accepts. */
export enum KnownProvisioningState {
Unknown = "Unknown",
Succeeded = "Succeeded",
Accepted = "Accepted",
Deleting = "Deleting",
Failed = "Failed",
Canceled = "Canceled",
Deleted = "Deleted"
}
/**
* Defines values for ProvisioningState. \
* {@link KnownProvisioningState} can be used interchangeably with ProvisioningState,
* this enum contains the known values that the service supports.
* ### Known values supported by the service
* **Unknown** \
* **Succeeded** \
* **Accepted** \
* **Deleting** \
* **Failed** \
* **Canceled** \
* **Deleted**
*/
export type ProvisioningState = string;
/** Known values of {@link NaptEnabled} that the service accepts. */
export enum KnownNaptEnabled {
/** NAPT is enabled */
Enabled = "Enabled",
/** NAPT is disabled */
Disabled = "Disabled"
}
/**
* Defines values for NaptEnabled. \
* {@link KnownNaptEnabled} can be used interchangeably with NaptEnabled,
* this enum contains the known values that the service supports.
* ### Known values supported by the service
* **Enabled**: NAPT is enabled \
* **Disabled**: NAPT is disabled
*/
export type NaptEnabled = string;
/** Known values of {@link CreatedByType} that the service accepts. */
export enum KnownCreatedByType {
User = "User",
Application = "Application",
ManagedIdentity = "ManagedIdentity",
Key = "Key"
}
/**
* Defines values for CreatedByType. \
* {@link KnownCreatedByType} can be used interchangeably with CreatedByType,
* this enum contains the known values that the service supports.
* ### Known values supported by the service
* **User** \
* **Application** \
* **ManagedIdentity** \
* **Key**
*/
export type CreatedByType = string;
/** Known values of {@link SimState} that the service accepts. */
export enum KnownSimState {
/** The sim is disabled because not all configuration required for enabling is present. */
Disabled = "Disabled",
/** The sim is enabled. */
Enabled = "Enabled",
/** The sim cannot be enabled because some of the associated configuration is invalid. */
Invalid = "Invalid"
}
/**
* Defines values for SimState. \
* {@link KnownSimState} can be used interchangeably with SimState,
* this enum contains the known values that the service supports.
* ### Known values supported by the service
* **Disabled**: The sim is disabled because not all configuration required for enabling is present. \
* **Enabled**: The sim is enabled. \
* **Invalid**: The sim cannot be enabled because some of the associated configuration is invalid.
*/
export type SimState = string;
/** Known values of {@link CoreNetworkType} that the service accepts. */
export enum KnownCoreNetworkType {
/** 5G core */
FiveGC = "5GC",
/** EPC / 4G core */
EPC = "EPC"
}
/**
* Defines values for CoreNetworkType. \
* {@link KnownCoreNetworkType} can be used interchangeably with CoreNetworkType,
* this enum contains the known values that the service supports.
* ### Known values supported by the service
* **5GC**: 5G core \
* **EPC**: EPC \/ 4G core
*/
export type CoreNetworkType = string;
/** Known values of {@link PreemptionCapability} that the service accepts. */
export enum KnownPreemptionCapability {
/** Cannot preempt */
NotPreempt = "NotPreempt",
/** May preempt */
MayPreempt = "MayPreempt"
}
/**
* Defines values for PreemptionCapability. \
* {@link KnownPreemptionCapability} can be used interchangeably with PreemptionCapability,
* this enum contains the known values that the service supports.
* ### Known values supported by the service
* **NotPreempt**: Cannot preempt \
* **MayPreempt**: May preempt
*/
export type PreemptionCapability = string;
/** Known values of {@link PreemptionVulnerability} that the service accepts. */
export enum KnownPreemptionVulnerability {
/** Cannot be preempted */
NotPreemptable = "NotPreemptable",
/** May be preempted */
Preemptable = "Preemptable"
}
/**
* Defines values for PreemptionVulnerability. \
* {@link KnownPreemptionVulnerability} can be used interchangeably with PreemptionVulnerability,
* this enum contains the known values that the service supports.
* ### Known values supported by the service
* **NotPreemptable**: Cannot be preempted \
* **Preemptable**: May be preempted
*/
export type PreemptionVulnerability = string;
/** Known values of {@link TrafficControlPermission} that the service accepts. */
export enum KnownTrafficControlPermission {
/** Traffic matching this rule is allowed to flow. */
Enabled = "Enabled",
/** Traffic matching this rule is not allowed to flow. */
Blocked = "Blocked"
}
/**
* Defines values for TrafficControlPermission. \
* {@link KnownTrafficControlPermission} can be used interchangeably with TrafficControlPermission,
* this enum contains the known values that the service supports.
* ### Known values supported by the service
* **Enabled**: Traffic matching this rule is allowed to flow. \
* **Blocked**: Traffic matching this rule is not allowed to flow.
*/
export type TrafficControlPermission = string;
/** Known values of {@link SdfDirection} that the service accepts. */
export enum KnownSdfDirection {
/** Traffic flowing from the UE to the data network. */
Uplink = "Uplink",
/** Traffic flowing from the data network to the UE. */
Downlink = "Downlink",
/** Traffic flowing both to and from the UE. */
Bidirectional = "Bidirectional"
}
/**
* Defines values for SdfDirection. \
* {@link KnownSdfDirection} can be used interchangeably with SdfDirection,
* this enum contains the known values that the service supports.
* ### Known values supported by the service
* **Uplink**: Traffic flowing from the UE to the data network. \
* **Downlink**: Traffic flowing from the data network to the UE. \
* **Bidirectional**: Traffic flowing both to and from the UE.
*/
export type SdfDirection = string;
/** Known values of {@link PduSessionType} that the service accepts. */
export enum KnownPduSessionType {
IPv4 = "IPv4",
IPv6 = "IPv6"
}
/**
* Defines values for PduSessionType. \
* {@link KnownPduSessionType} can be used interchangeably with PduSessionType,
* this enum contains the known values that the service supports.
* ### Known values supported by the service
* **IPv4** \
* **IPv6**
*/
export type PduSessionType = string;
/** Optional parameters. */
export interface AttachedDataNetworksDeleteOptionalParams
extends coreClient.OperationOptions {
/** Delay to wait until next poll, in milliseconds. */
updateIntervalInMs?: number;
/** A serialized poller which can be used to resume an existing paused Long-Running-Operation. */
resumeFrom?: string;
}
/** Optional parameters. */
export interface AttachedDataNetworksGetOptionalParams
extends coreClient.OperationOptions {}
/** Contains response data for the get operation. */
export type AttachedDataNetworksGetResponse = AttachedDataNetwork;
/** Optional parameters. */
export interface AttachedDataNetworksCreateOrUpdateOptionalParams
extends coreClient.OperationOptions {
/** Delay to wait until next poll, in milliseconds. */
updateIntervalInMs?: number;
/** A serialized poller which can be used to resume an existing paused Long-Running-Operation. */
resumeFrom?: string;
}
/** Contains response data for the createOrUpdate operation. */
export type AttachedDataNetworksCreateOrUpdateResponse = AttachedDataNetwork;
/** Optional parameters. */
export interface AttachedDataNetworksUpdateTagsOptionalParams
extends coreClient.OperationOptions {}
/** Contains response data for the updateTags operation. */
export type AttachedDataNetworksUpdateTagsResponse = AttachedDataNetwork;
/** Optional parameters. */
export interface AttachedDataNetworksListByPacketCoreDataPlaneOptionalParams
extends coreClient.OperationOptions {}
/** Contains response data for the listByPacketCoreDataPlane operation. */
export type AttachedDataNetworksListByPacketCoreDataPlaneResponse = AttachedDataNetworkListResult;
/** Optional parameters. */
export interface AttachedDataNetworksListByPacketCoreDataPlaneNextOptionalParams
extends coreClient.OperationOptions {}
/** Contains response data for the listByPacketCoreDataPlaneNext operation. */
export type AttachedDataNetworksListByPacketCoreDataPlaneNextResponse = AttachedDataNetworkListResult;
/** Optional parameters. */
export interface DataNetworksDeleteOptionalParams
extends coreClient.OperationOptions {
/** Delay to wait until next poll, in milliseconds. */
updateIntervalInMs?: number;
/** A serialized poller which can be used to resume an existing paused Long-Running-Operation. */
resumeFrom?: string;
}
/** Optional parameters. */
export interface DataNetworksGetOptionalParams
extends coreClient.OperationOptions {}
/** Contains response data for the get operation. */
export type DataNetworksGetResponse = DataNetwork;
/** Optional parameters. */
export interface DataNetworksCreateOrUpdateOptionalParams
extends coreClient.OperationOptions {
/** Delay to wait until next poll, in milliseconds. */
updateIntervalInMs?: number;
/** A serialized poller which can be used to resume an existing paused Long-Running-Operation. */
resumeFrom?: string;
}
/** Contains response data for the createOrUpdate operation. */
export type DataNetworksCreateOrUpdateResponse = DataNetwork;
/** Optional parameters. */
export interface DataNetworksUpdateTagsOptionalParams
extends coreClient.OperationOptions {}
/** Contains response data for the updateTags operation. */
export type DataNetworksUpdateTagsResponse = DataNetwork;
/** Optional parameters. */
export interface DataNetworksListByMobileNetworkOptionalParams
extends coreClient.OperationOptions {}
/** Contains response data for the listByMobileNetwork operation. */
export type DataNetworksListByMobileNetworkResponse = DataNetworkListResult;
/** Optional parameters. */
export interface DataNetworksListByMobileNetworkNextOptionalParams
extends coreClient.OperationOptions {}
/** Contains response data for the listByMobileNetworkNext operation. */
export type DataNetworksListByMobileNetworkNextResponse = DataNetworkListResult;
/** Optional parameters. */
export interface MobileNetworksDeleteOptionalParams
extends coreClient.OperationOptions {
/** Delay to wait until next poll, in milliseconds. */
updateIntervalInMs?: number;
/** A serialized poller which can be used to resume an existing paused Long-Running-Operation. */
resumeFrom?: string;
}
/** Optional parameters. */
export interface MobileNetworksGetOptionalParams
extends coreClient.OperationOptions {}
/** Contains response data for the get operation. */
export type MobileNetworksGetResponse = MobileNetwork;
/** Optional parameters. */
export interface MobileNetworksCreateOrUpdateOptionalParams
extends coreClient.OperationOptions {
/** Delay to wait until next poll, in milliseconds. */
updateIntervalInMs?: number;
/** A serialized poller which can be used to resume an existing paused Long-Running-Operation. */
resumeFrom?: string;
}