/
models.go
4779 lines (3590 loc) · 169 KB
/
models.go
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
//go:build go1.18
// +build go1.18
// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT License. See License.txt in the project root for license information.
// Code generated by Microsoft (R) AutoRest Code Generator. DO NOT EDIT.
// Changes may cause incorrect behavior and will be lost if the code is regenerated.
package armcosmos
import "time"
type APIProperties struct {
// Describes the ServerVersion of an a MongoDB account.
ServerVersion *ServerVersion
}
// ARMProxyResource - The resource model definition for a ARM proxy resource. It will have everything other than required
// location and tags
type ARMProxyResource struct {
// READ-ONLY; The unique resource identifier of the database account.
ID *string
// READ-ONLY; The name of the database account.
Name *string
// READ-ONLY; The type of Azure resource.
Type *string
}
// ARMResourceProperties - The core properties of ARM resources.
type ARMResourceProperties struct {
// The location of the resource group to which the resource belongs.
Location *string
// Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource
// (across resource groups). A maximum of 15 tags can be provided for a
// resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example,
// the default experience for a template type is set with "defaultExperience":
// "Cassandra". Current "defaultExperience" values also include "Table", "Graph", "DocumentDB", and "MongoDB".
Tags map[string]*string
// READ-ONLY; The unique resource identifier of the ARM resource.
ID *string
// READ-ONLY; The name of the ARM resource.
Name *string
// READ-ONLY; The type of Azure resource.
Type *string
}
// AccountKeyMetadata - The metadata related to an access key for a given database account.
type AccountKeyMetadata struct {
// READ-ONLY; Generation time in UTC of the key in ISO-8601 format. If the value is missing from the object, it means that
// the last key regeneration was triggered before 2022-06-18.
GenerationTime *time.Time
}
// AnalyticalStorageConfiguration - Analytical storage specific properties.
type AnalyticalStorageConfiguration struct {
// Describes the types of schema for analytical storage.
SchemaType *AnalyticalStorageSchemaType
}
// AuthenticationMethodLdapProperties - Ldap authentication method properties. This feature is in preview.
type AuthenticationMethodLdapProperties struct {
// Timeout for connecting to the LDAP server in miliseconds. The default is 5000 ms.
ConnectionTimeoutInMs *int32
// Distinguished name of the object to start the recursive search of users from.
SearchBaseDistinguishedName *string
// Template to use for searching. Defaults to (cn=%s) where %s will be replaced by the username used to login.
SearchFilterTemplate *string
ServerCertificates []*Certificate
// Hostname of the LDAP server.
ServerHostname *string
// Port of the LDAP server.
ServerPort *int32
// Distinguished name of the look up user account, who can look up user details on authentication.
ServiceUserDistinguishedName *string
// Password of the look up user.
ServiceUserPassword *string
}
// AutoUpgradePolicyResource - Cosmos DB resource auto-upgrade policy
type AutoUpgradePolicyResource struct {
// Represents throughput policy which service must adhere to for auto-upgrade
ThroughputPolicy *ThroughputPolicyResource
}
type AutoscaleSettings struct {
// Represents maximum throughput, the resource can scale up to.
MaxThroughput *int32
}
// AutoscaleSettingsResource - Cosmos DB provisioned throughput settings object
type AutoscaleSettingsResource struct {
// REQUIRED; Represents maximum throughput container can scale up to.
MaxThroughput *int32
// Cosmos DB resource auto-upgrade policy
AutoUpgradePolicy *AutoUpgradePolicyResource
// READ-ONLY; Represents target maximum throughput container can scale up to once offer is no longer in pending state.
TargetMaxThroughput *int32
}
// BackupInformation - Backup information of a resource.
type BackupInformation struct {
// READ-ONLY; Information about the status of continuous backups.
ContinuousBackupInformation *ContinuousBackupInformation
}
// BackupPolicy - The object representing the policy for taking backups on an account.
type BackupPolicy struct {
// REQUIRED; Describes the mode of backups.
Type *BackupPolicyType
// The object representing the state of the migration between the backup policies.
MigrationState *BackupPolicyMigrationState
}
// GetBackupPolicy implements the BackupPolicyClassification interface for type BackupPolicy.
func (b *BackupPolicy) GetBackupPolicy() *BackupPolicy { return b }
// BackupPolicyMigrationState - The object representing the state of the migration between the backup policies.
type BackupPolicyMigrationState struct {
// Time at which the backup policy migration started (ISO-8601 format).
StartTime *time.Time
// Describes the status of migration between backup policy types.
Status *BackupPolicyMigrationStatus
// Describes the target backup policy type of the backup policy migration.
TargetType *BackupPolicyType
}
// Capability - Cosmos DB capability object
type Capability struct {
// Name of the Cosmos DB capability. For example, "name": "EnableCassandra". Current values also include "EnableTable" and
// "EnableGremlin".
Name *string
}
// Capacity - The object that represents all properties related to capacity enforcement on an account.
type Capacity struct {
// The total throughput limit imposed on the account. A totalThroughputLimit of 2000 imposes a strict limit of max throughput
// that can be provisioned on that account to be 2000. A totalThroughputLimit of
// -1 indicates no limits on provisioning of throughput.
TotalThroughputLimit *int32
}
// CassandraClusterPublicStatus - Properties of a managed Cassandra cluster public status.
type CassandraClusterPublicStatus struct {
// List relevant information about any connection errors to the Datacenters.
ConnectionErrors []*ConnectionError
// List of the status of each datacenter in this cluster.
DataCenters []*CassandraClusterPublicStatusDataCentersItem
ETag *string
// List relevant information about any errors about cluster, data center and connection error.
Errors []*CassandraError
ReaperStatus *ManagedCassandraReaperStatus
}
type CassandraClusterPublicStatusDataCentersItem struct {
// The name of this Datacenter.
Name *string
Nodes []*ComponentsM9L909SchemasCassandraclusterpublicstatusPropertiesDatacentersItemsPropertiesNodesItems
// A list of all seed nodes in the cluster, managed and unmanaged.
SeedNodes []*string
}
type CassandraError struct {
// Additional information about the error.
AdditionalErrorInfo *string
// The code of error that occurred.
Code *string
// The message of the error.
Message *string
// The target resource of the error.
Target *string
}
// CassandraKeyspaceCreateUpdateParameters - Parameters to create and update Cosmos DB Cassandra keyspace.
type CassandraKeyspaceCreateUpdateParameters struct {
// REQUIRED; Properties to create and update Azure Cosmos DB Cassandra keyspace.
Properties *CassandraKeyspaceCreateUpdateProperties
// The location of the resource group to which the resource belongs.
Location *string
// Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource
// (across resource groups). A maximum of 15 tags can be provided for a
// resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example,
// the default experience for a template type is set with "defaultExperience":
// "Cassandra". Current "defaultExperience" values also include "Table", "Graph", "DocumentDB", and "MongoDB".
Tags map[string]*string
// READ-ONLY; The unique resource identifier of the ARM resource.
ID *string
// READ-ONLY; The name of the ARM resource.
Name *string
// READ-ONLY; The type of Azure resource.
Type *string
}
// CassandraKeyspaceCreateUpdateProperties - Properties to create and update Azure Cosmos DB Cassandra keyspace.
type CassandraKeyspaceCreateUpdateProperties struct {
// REQUIRED; The standard JSON format of a Cassandra keyspace
Resource *CassandraKeyspaceResource
// A key-value pair of options to be applied for the request. This corresponds to the headers sent with the request.
Options *CreateUpdateOptions
}
// CassandraKeyspaceGetProperties - The properties of an Azure Cosmos DB Cassandra keyspace
type CassandraKeyspaceGetProperties struct {
Options *CassandraKeyspaceGetPropertiesOptions
Resource *CassandraKeyspaceGetPropertiesResource
}
type CassandraKeyspaceGetPropertiesOptions struct {
// Specifies the Autoscale settings.
AutoscaleSettings *AutoscaleSettings
// Value of the Cosmos DB resource throughput or autoscaleSettings. Use the ThroughputSetting resource when retrieving offer
// details.
Throughput *int32
}
type CassandraKeyspaceGetPropertiesResource struct {
// REQUIRED; Name of the Cosmos DB Cassandra keyspace
ID *string
// READ-ONLY; A system generated property representing the resource etag required for optimistic concurrency control.
Etag *string
// READ-ONLY; A system generated property. A unique identifier.
Rid *string
// READ-ONLY; A system generated property that denotes the last updated timestamp of the resource.
Ts *float32
}
// CassandraKeyspaceGetResults - An Azure Cosmos DB Cassandra keyspace.
type CassandraKeyspaceGetResults struct {
// The location of the resource group to which the resource belongs.
Location *string
// The properties of an Azure Cosmos DB Cassandra keyspace
Properties *CassandraKeyspaceGetProperties
// Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource
// (across resource groups). A maximum of 15 tags can be provided for a
// resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example,
// the default experience for a template type is set with "defaultExperience":
// "Cassandra". Current "defaultExperience" values also include "Table", "Graph", "DocumentDB", and "MongoDB".
Tags map[string]*string
// READ-ONLY; The unique resource identifier of the ARM resource.
ID *string
// READ-ONLY; The name of the ARM resource.
Name *string
// READ-ONLY; The type of Azure resource.
Type *string
}
// CassandraKeyspaceListResult - The List operation response, that contains the Cassandra keyspaces and their properties.
type CassandraKeyspaceListResult struct {
// READ-ONLY; List of Cassandra keyspaces and their properties.
Value []*CassandraKeyspaceGetResults
}
// CassandraKeyspaceResource - Cosmos DB Cassandra keyspace resource object
type CassandraKeyspaceResource struct {
// REQUIRED; Name of the Cosmos DB Cassandra keyspace
ID *string
}
// CassandraPartitionKey - Cosmos DB Cassandra table partition key
type CassandraPartitionKey struct {
// Name of the Cosmos DB Cassandra table partition key
Name *string
}
// CassandraSchema - Cosmos DB Cassandra table schema
type CassandraSchema struct {
// List of cluster key.
ClusterKeys []*ClusterKey
// List of Cassandra table columns.
Columns []*Column
// List of partition key.
PartitionKeys []*CassandraPartitionKey
}
// CassandraTableCreateUpdateParameters - Parameters to create and update Cosmos DB Cassandra table.
type CassandraTableCreateUpdateParameters struct {
// REQUIRED; Properties to create and update Azure Cosmos DB Cassandra table.
Properties *CassandraTableCreateUpdateProperties
// The location of the resource group to which the resource belongs.
Location *string
// Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource
// (across resource groups). A maximum of 15 tags can be provided for a
// resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example,
// the default experience for a template type is set with "defaultExperience":
// "Cassandra". Current "defaultExperience" values also include "Table", "Graph", "DocumentDB", and "MongoDB".
Tags map[string]*string
// READ-ONLY; The unique resource identifier of the ARM resource.
ID *string
// READ-ONLY; The name of the ARM resource.
Name *string
// READ-ONLY; The type of Azure resource.
Type *string
}
// CassandraTableCreateUpdateProperties - Properties to create and update Azure Cosmos DB Cassandra table.
type CassandraTableCreateUpdateProperties struct {
// REQUIRED; The standard JSON format of a Cassandra table
Resource *CassandraTableResource
// A key-value pair of options to be applied for the request. This corresponds to the headers sent with the request.
Options *CreateUpdateOptions
}
// CassandraTableGetProperties - The properties of an Azure Cosmos DB Cassandra table
type CassandraTableGetProperties struct {
Options *CassandraTableGetPropertiesOptions
Resource *CassandraTableGetPropertiesResource
}
type CassandraTableGetPropertiesOptions struct {
// Specifies the Autoscale settings.
AutoscaleSettings *AutoscaleSettings
// Value of the Cosmos DB resource throughput or autoscaleSettings. Use the ThroughputSetting resource when retrieving offer
// details.
Throughput *int32
}
type CassandraTableGetPropertiesResource struct {
// REQUIRED; Name of the Cosmos DB Cassandra table
ID *string
// Analytical TTL.
AnalyticalStorageTTL *int32
// Time to live of the Cosmos DB Cassandra table
DefaultTTL *int32
// Schema of the Cosmos DB Cassandra table
Schema *CassandraSchema
// READ-ONLY; A system generated property representing the resource etag required for optimistic concurrency control.
Etag *string
// READ-ONLY; A system generated property. A unique identifier.
Rid *string
// READ-ONLY; A system generated property that denotes the last updated timestamp of the resource.
Ts *float32
}
// CassandraTableGetResults - An Azure Cosmos DB Cassandra table.
type CassandraTableGetResults struct {
// The location of the resource group to which the resource belongs.
Location *string
// The properties of an Azure Cosmos DB Cassandra table
Properties *CassandraTableGetProperties
// Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource
// (across resource groups). A maximum of 15 tags can be provided for a
// resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example,
// the default experience for a template type is set with "defaultExperience":
// "Cassandra". Current "defaultExperience" values also include "Table", "Graph", "DocumentDB", and "MongoDB".
Tags map[string]*string
// READ-ONLY; The unique resource identifier of the ARM resource.
ID *string
// READ-ONLY; The name of the ARM resource.
Name *string
// READ-ONLY; The type of Azure resource.
Type *string
}
// CassandraTableListResult - The List operation response, that contains the Cassandra tables and their properties.
type CassandraTableListResult struct {
// READ-ONLY; List of Cassandra tables and their properties.
Value []*CassandraTableGetResults
}
// CassandraTableResource - Cosmos DB Cassandra table resource object
type CassandraTableResource struct {
// REQUIRED; Name of the Cosmos DB Cassandra table
ID *string
// Analytical TTL.
AnalyticalStorageTTL *int32
// Time to live of the Cosmos DB Cassandra table
DefaultTTL *int32
// Schema of the Cosmos DB Cassandra table
Schema *CassandraSchema
}
type Certificate struct {
// PEM formatted public key.
Pem *string
}
// ClientEncryptionIncludedPath - .
type ClientEncryptionIncludedPath struct {
// REQUIRED; The identifier of the Client Encryption Key to be used to encrypt the path.
ClientEncryptionKeyID *string
// REQUIRED; The encryption algorithm which will be used. Eg - AEADAES256CBCHMAC_SHA256.
EncryptionAlgorithm *string
// REQUIRED; The type of encryption to be performed. Eg - Deterministic, Randomized.
EncryptionType *string
// REQUIRED; Path that needs to be encrypted.
Path *string
}
// ClientEncryptionKeyCreateUpdateParameters - Parameters to create and update ClientEncryptionKey.
type ClientEncryptionKeyCreateUpdateParameters struct {
// REQUIRED; Properties to create and update ClientEncryptionKey.
Properties *ClientEncryptionKeyCreateUpdateProperties
}
// ClientEncryptionKeyCreateUpdateProperties - Properties to create and update ClientEncryptionKey.
type ClientEncryptionKeyCreateUpdateProperties struct {
// REQUIRED; The standard JSON format of a ClientEncryptionKey
Resource *ClientEncryptionKeyResource
}
// ClientEncryptionKeyGetProperties - The properties of a ClientEncryptionKey resource
type ClientEncryptionKeyGetProperties struct {
Resource *ClientEncryptionKeyGetPropertiesResource
}
type ClientEncryptionKeyGetPropertiesResource struct {
// Encryption algorithm that will be used along with this client encryption key to encrypt/decrypt data.
EncryptionAlgorithm *string
// Name of the ClientEncryptionKey
ID *string
// Metadata for the wrapping provider that can be used to unwrap the wrapped client encryption key.
KeyWrapMetadata *KeyWrapMetadata
// Wrapped (encrypted) form of the key represented as a byte array.
WrappedDataEncryptionKey []byte
// READ-ONLY; A system generated property representing the resource etag required for optimistic concurrency control.
Etag *string
// READ-ONLY; A system generated property. A unique identifier.
Rid *string
// READ-ONLY; A system generated property that denotes the last updated timestamp of the resource.
Ts *float32
}
// ClientEncryptionKeyGetResults - Client Encryption Key.
type ClientEncryptionKeyGetResults struct {
// The properties of a ClientEncryptionKey
Properties *ClientEncryptionKeyGetProperties
// READ-ONLY; The unique resource identifier of the database account.
ID *string
// READ-ONLY; The name of the database account.
Name *string
// READ-ONLY; The type of Azure resource.
Type *string
}
// ClientEncryptionKeyResource - Cosmos DB client encryption key resource object.
type ClientEncryptionKeyResource struct {
// Encryption algorithm that will be used along with this client encryption key to encrypt/decrypt data.
EncryptionAlgorithm *string
// Name of the ClientEncryptionKey
ID *string
// Metadata for the wrapping provider that can be used to unwrap the wrapped client encryption key.
KeyWrapMetadata *KeyWrapMetadata
// Wrapped (encrypted) form of the key represented as a byte array.
WrappedDataEncryptionKey []byte
}
// ClientEncryptionKeysListResult - The List operation response, that contains the client encryption keys and their properties.
type ClientEncryptionKeysListResult struct {
// READ-ONLY; List of client encryption keys and their properties.
Value []*ClientEncryptionKeyGetResults
}
// ClientEncryptionPolicy - Cosmos DB client encryption policy.
type ClientEncryptionPolicy struct {
// REQUIRED; Paths of the item that need encryption along with path-specific settings.
IncludedPaths []*ClientEncryptionIncludedPath
// REQUIRED; Version of the client encryption policy definition. Supported versions are 1 and 2. Version 2 supports id and
// partition key path encryption.
PolicyFormatVersion *int32
}
// ClusterKey - Cosmos DB Cassandra table cluster key
type ClusterKey struct {
// Name of the Cosmos DB Cassandra table cluster key
Name *string
// Order of the Cosmos DB Cassandra table cluster key, only support "Asc" and "Desc"
OrderBy *string
}
// ClusterResource - Representation of a managed Cassandra cluster.
type ClusterResource struct {
// Identity for the resource.
Identity *ManagedCassandraManagedServiceIdentity
// The location of the resource group to which the resource belongs.
Location *string
// Properties of a managed Cassandra cluster.
Properties *ClusterResourceProperties
// Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource
// (across resource groups). A maximum of 15 tags can be provided for a
// resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example,
// the default experience for a template type is set with "defaultExperience":
// "Cassandra". Current "defaultExperience" values also include "Table", "Graph", "DocumentDB", and "MongoDB".
Tags map[string]*string
// READ-ONLY; The unique resource identifier of the ARM resource.
ID *string
// READ-ONLY; The name of the ARM resource.
Name *string
// READ-ONLY; The type of Azure resource.
Type *string
}
// ClusterResourceProperties - Properties of a managed Cassandra cluster.
type ClusterResourceProperties struct {
// Which authentication method Cassandra should use to authenticate clients. 'None' turns off authentication, so should not
// be used except in emergencies. 'Cassandra' is the default password based
// authentication. The default is 'Cassandra'.
AuthenticationMethod *AuthenticationMethod
// Whether Cassandra audit logging is enabled
CassandraAuditLoggingEnabled *bool
// Which version of Cassandra should this cluster converge to running (e.g., 3.11). When updated, the cluster may take some
// time to migrate to the new version.
CassandraVersion *string
// List of TLS certificates used to authorize clients connecting to the cluster. All connections are TLS encrypted whether
// clientCertificates is set or not, but if clientCertificates is set, the managed
// Cassandra cluster will reject all connections not bearing a TLS client certificate that can be validated from one or more
// of the public certificates in this property.
ClientCertificates []*Certificate
// If you need to set the clusterName property in cassandra.yaml to something besides the resource name of the cluster, set
// the value to use on this property.
ClusterNameOverride *string
// Whether the cluster and associated data centers has been deallocated.
Deallocated *bool
// Resource id of a subnet that this cluster's management service should have its network interface attached to. The subnet
// must be routable to all subnets that will be delegated to data centers. The
// resource id must be of the form '/subscriptions//resourceGroups//providers/Microsoft.Network/virtualNetworks//subnets/'
DelegatedManagementSubnetID *string
// List of TLS certificates used to authorize gossip from unmanaged data centers. The TLS certificates of all nodes in unmanaged
// data centers must be verifiable using one of the certificates provided in
// this property.
ExternalGossipCertificates []*Certificate
// List of IP addresses of seed nodes in unmanaged data centers. These will be added to the seed node lists of all managed
// nodes.
ExternalSeedNodes []*SeedNode
// (Deprecated) Number of hours to wait between taking a backup of the cluster.
HoursBetweenBackups *int32
// Initial password for clients connecting as admin to the cluster. Should be changed after cluster creation. Returns null
// on GET. This field only applies when the authenticationMethod field is
// 'Cassandra'.
InitialCassandraAdminPassword *string
// Hostname or IP address where the Prometheus endpoint containing data about the managed Cassandra nodes can be reached.
PrometheusEndpoint *SeedNode
// Error related to resource provisioning.
ProvisionError *CassandraError
// The status of the resource at the time the operation was called.
ProvisioningState *ManagedCassandraProvisioningState
// Should automatic repairs run on this cluster? If omitted, this is true, and should stay true unless you are running a hybrid
// cluster where you are already doing your own repairs.
RepairEnabled *bool
// To create an empty cluster, omit this field or set it to null. To restore a backup into a new cluster, set this field to
// the resource id of the backup.
RestoreFromBackupID *string
// READ-ONLY; List of TLS certificates that unmanaged nodes must trust for gossip with managed nodes. All managed nodes will
// present TLS client certificates that are verifiable using one of the certificates
// provided in this property.
GossipCertificates []*Certificate
// READ-ONLY; List of IP addresses of seed nodes in the managed data centers. These should be added to the seed node lists
// of all unmanaged nodes.
SeedNodes []*SeedNode
}
// Column - Cosmos DB Cassandra table column
type Column struct {
// Name of the Cosmos DB Cassandra table column
Name *string
// Type of the Cosmos DB Cassandra table column
Type *string
}
// CommandOutput - Response of /command api
type CommandOutput struct {
// Output of the command.
CommandOutput *string
}
// CommandPostBody - Specification of which command to run where
type CommandPostBody struct {
// REQUIRED; The command which should be run
Command *string
// REQUIRED; IP address of the cassandra host to run the command on
Host *string
// The arguments for the command to be run
Arguments map[string]*string
// If true, stops cassandra before executing the command and then start it again
CassandraStopStart *bool
// If true, allows the command to write to the cassandra directory, otherwise read-only.
Readwrite *bool
}
type Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties struct {
// READ-ONLY; The client id of user assigned identity.
ClientID *string
// READ-ONLY; The principal id of user assigned identity.
PrincipalID *string
}
type ComponentsM9L909SchemasCassandraclusterpublicstatusPropertiesDatacentersItemsPropertiesNodesItems struct {
// The node's IP address.
Address *string
// A float representing the current system-wide CPU utilization as a percentage.
CPUUsage *float64
// Cassandra service status on this node
CassandraProcessStatus *string
// The amount of disk free, in kB, of the directory /var/lib/cassandra.
DiskFreeKB *int64
// The amount of disk used, in kB, of the directory /var/lib/cassandra.
DiskUsedKB *int64
// The network ID of the node.
HostID *string
// The amount of file system data in the data directory (e.g., 47.66 kB), excluding all content in the snapshots subdirectories.
// Because all SSTable data files are included, any data that is not cleaned
// up (such as TTL-expired cells or tombstones) is counted.
Load *string
// Memory used by kernel buffers (Buffers in /proc/meminfo) and page cache and slabs (Cached and SReclaimable in /proc/meminfo),
// in kB.
MemoryBuffersAndCachedKB *int64
// Unused memory (MemFree and SwapFree in /proc/meminfo), in kB.
MemoryFreeKB *int64
// Total installed memory (MemTotal and SwapTotal in /proc/meminfo), in kB.
MemoryTotalKB *int64
// Used memory (calculated as total - free - buffers - cache), in kB.
MemoryUsedKB *int64
// The rack this node is part of.
Rack *string
Size *int32
// The state of the node in Cassandra ring.
State *NodeState
Status *string
// The timestamp when these statistics were captured.
Timestamp *string
// List of tokens this node covers.
Tokens []*string
}
type CompositePath struct {
// Sort order for composite paths.
Order *CompositePathSortOrder
// The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*)
Path *string
}
// ComputedProperty - The definition of a computed property
type ComputedProperty struct {
// The name of a computed property, for example - "cp_lowerName"
Name *string
// The query that evaluates the value for computed property, for example - "SELECT VALUE LOWER(c.name) FROM c"
Query *string
}
// ConflictResolutionPolicy - The conflict resolution policy for the container.
type ConflictResolutionPolicy struct {
// The conflict resolution path in the case of LastWriterWins mode.
ConflictResolutionPath *string
// The procedure to resolve conflicts in the case of custom mode.
ConflictResolutionProcedure *string
// Indicates the conflict resolution mode.
Mode *ConflictResolutionMode
}
type ConnectionError struct {
// The kind of connection error that occurred.
ConnectionState *ConnectionState
// Detailed error message about the failed connection.
Exception *string
// The IP of host that originated the failed connection.
IPFrom *string
// The IP that the connection attempted to reach.
IPTo *string
// The TCP port the connection was attempted on.
Port *int32
}
// ConsistencyPolicy - The consistency policy for the Cosmos DB database account.
type ConsistencyPolicy struct {
// REQUIRED; The default consistency level and configuration settings of the Cosmos DB account.
DefaultConsistencyLevel *DefaultConsistencyLevel
// When used with the Bounded Staleness consistency level, this value represents the time amount of staleness (in seconds)
// tolerated. Accepted range for this value is 5 - 86400. Required when
// defaultConsistencyPolicy is set to 'BoundedStaleness'.
MaxIntervalInSeconds *int32
// When used with the Bounded Staleness consistency level, this value represents the number of stale requests tolerated. Accepted
// range for this value is 1 – 2,147,483,647. Required when
// defaultConsistencyPolicy is set to 'BoundedStaleness'.
MaxStalenessPrefix *int64
}
// ContainerPartitionKey - The configuration of the partition key to be used for partitioning data into multiple partitions
type ContainerPartitionKey struct {
// Indicates the kind of algorithm used for partitioning. For MultiHash, multiple partition keys (upto three maximum) are
// supported for container create
Kind *PartitionKind
// List of paths using which data within the container can be partitioned
Paths []*string
// Indicates the version of the partition key definition
Version *int32
// READ-ONLY; Indicates if the container is using a system generated partition key
SystemKey *bool
}
// ContinuousBackupInformation - Information about the status of continuous backups.
type ContinuousBackupInformation struct {
// The latest restorable timestamp for a resource.
LatestRestorableTimestamp *string
}
// ContinuousBackupRestoreLocation - Properties of the regional restorable account.
type ContinuousBackupRestoreLocation struct {
// The name of the continuous backup restore location.
Location *string
}
// ContinuousModeBackupPolicy - The object representing continuous mode backup policy.
type ContinuousModeBackupPolicy struct {
// REQUIRED; Describes the mode of backups.
Type *BackupPolicyType
// Configuration values for continuous mode backup
ContinuousModeProperties *ContinuousModeProperties
// The object representing the state of the migration between the backup policies.
MigrationState *BackupPolicyMigrationState
}
// GetBackupPolicy implements the BackupPolicyClassification interface for type ContinuousModeBackupPolicy.
func (c *ContinuousModeBackupPolicy) GetBackupPolicy() *BackupPolicy {
return &BackupPolicy{
MigrationState: c.MigrationState,
Type: c.Type,
}
}
// ContinuousModeProperties - Configuration values for periodic mode backup
type ContinuousModeProperties struct {
// Enum to indicate type of Continuous backup mode
Tier *ContinuousTier
}
// CorsPolicy - The CORS policy for the Cosmos DB database account.
type CorsPolicy struct {
// REQUIRED; The origin domains that are permitted to make a request against the service via CORS.
AllowedOrigins *string
// The request headers that the origin domain may specify on the CORS request.
AllowedHeaders *string
// The methods (HTTP request verbs) that the origin domain may use for a CORS request.
AllowedMethods *string
// The response headers that may be sent in the response to the CORS request and exposed by the browser to the request issuer.
ExposedHeaders *string
// The maximum amount time that a browser should cache the preflight OPTIONS request.
MaxAgeInSeconds *int64
}
// CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match",
// "Session-Token" and "Throughput"
type CreateUpdateOptions struct {
// Specifies the Autoscale settings. Note: Either throughput or autoscaleSettings is required, but not both.
AutoscaleSettings *AutoscaleSettings
// Request Units per second. For example, "throughput": 10000.
Throughput *int32
}
// DataCenterResource - A managed Cassandra data center.
type DataCenterResource struct {
// Properties of a managed Cassandra data center.
Properties *DataCenterResourceProperties
// READ-ONLY; The unique resource identifier of the database account.
ID *string
// READ-ONLY; The name of the database account.
Name *string
// READ-ONLY; The type of Azure resource.
Type *string
}
// DataCenterResourceProperties - Properties of a managed Cassandra data center.
type DataCenterResourceProperties struct {
// Ldap authentication method properties. This feature is in preview.
AuthenticationMethodLdapProperties *AuthenticationMethodLdapProperties
// If the data center has Availability Zone support, apply it to the Virtual Machine ScaleSet that host the cassandra data
// center virtual machines.
AvailabilityZone *bool
// Indicates the Key Uri of the customer key to use for encryption of the backup storage account.
BackupStorageCustomerKeyURI *string
// A fragment of a cassandra.yaml configuration file to be included in the cassandra.yaml for all nodes in this data center.
// The fragment should be Base64 encoded, and only a subset of keys are allowed.
Base64EncodedCassandraYamlFragment *string
// The region this data center should be created in.
DataCenterLocation *string
// Whether the data center has been deallocated.
Deallocated *bool
// Resource id of a subnet the nodes in this data center should have their network interfaces connected to. The subnet must
// be in the same region specified in 'dataCenterLocation' and must be able to
// route to the subnet specified in the cluster's 'delegatedManagementSubnetId' property. This resource id will be of the
// form '/subscriptions//resourceGroups/
// /providers/Microsoft.Network/virtualNetworks//subnets/'.
DelegatedSubnetID *string
// Number of disks attached to each node. Default is 4.
DiskCapacity *int32
// Disk SKU used for data centers. Default value is P30.
DiskSKU *string
// Key uri to use for encryption of managed disks. Ensure the system assigned identity of the cluster has been assigned appropriate
// permissions(key get/wrap/unwrap permissions) on the key.
ManagedDiskCustomerKeyURI *string
// The number of nodes the data center should have. This is the desired number. After it is set, it may take some time for
// the data center to be scaled to match. To monitor the number of nodes and their
// status, use the fetchNodeStatus method on the cluster.
NodeCount *int32
// Error related to resource provisioning.
ProvisionError *CassandraError
// The status of the resource at the time the operation was called.
ProvisioningState *ManagedCassandraProvisioningState
// Virtual Machine SKU used for data centers. Default value is StandardDS14v2
SKU *string
// READ-ONLY; IP addresses for seed nodes in this data center. This is for reference. Generally you will want to use the seedNodes
// property on the cluster, which aggregates the seed nodes from all data centers in
// the cluster.
SeedNodes []*SeedNode
}
// DataTransferRegionalServiceResource - Resource for a regional service location.
type DataTransferRegionalServiceResource struct {
// READ-ONLY; The location name.
Location *string
// READ-ONLY; The regional service name.
Name *string
// READ-ONLY; Describes the status of a service.
Status *ServiceStatus
}
// DataTransferServiceResource - Describes the service response property.
type DataTransferServiceResource struct {
// Properties for DataTransferServiceResource.
Properties *DataTransferServiceResourceProperties
}
// DataTransferServiceResourceProperties - Properties for DataTransferServiceResource.
type DataTransferServiceResourceProperties struct {
// REQUIRED; ServiceType for the service.
ServiceType *ServiceType
// OPTIONAL; Contains additional key/value pairs not defined in the schema.
AdditionalProperties map[string]any
// Instance count for the service.
InstanceCount *int32
// Instance type for the service.
InstanceSize *ServiceSize
// READ-ONLY; Time of the last state change (ISO-8601 format).
CreationTime *time.Time
// READ-ONLY; An array that contains all of the locations for the service.
Locations []*DataTransferRegionalServiceResource
// READ-ONLY; Describes the status of a service.