@azure/arm-cosmosdbforpostgresql 1.0.1-alpha.20240321.1 → 1.1.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 +24 -10
  2. package/LICENSE +1 -1
  3. package/README.md +1 -1
  4. package/dist/index.js +1060 -948
  5. package/dist/index.js.map +1 -1
  6. package/dist/index.min.js +1 -1
  7. package/dist/index.min.js.map +1 -1
  8. package/dist-esm/samples-dev/clustersCheckNameAvailabilitySample.js +3 -3
  9. package/dist-esm/samples-dev/clustersCheckNameAvailabilitySample.js.map +1 -1
  10. package/dist-esm/samples-dev/clustersCreateSample.js +13 -13
  11. package/dist-esm/samples-dev/clustersCreateSample.js.map +1 -1
  12. package/dist-esm/samples-dev/clustersDeleteSample.js +1 -1
  13. package/dist-esm/samples-dev/clustersGetSample.js +1 -1
  14. package/dist-esm/samples-dev/clustersListByResourceGroupSample.js +1 -1
  15. package/dist-esm/samples-dev/clustersListSample.js +1 -1
  16. package/dist-esm/samples-dev/clustersPromoteReadReplicaSample.js +1 -1
  17. package/dist-esm/samples-dev/clustersRestartSample.js +1 -1
  18. package/dist-esm/samples-dev/clustersStartSample.js +1 -1
  19. package/dist-esm/samples-dev/clustersStopSample.js +1 -1
  20. package/dist-esm/samples-dev/clustersUpdateSample.js +9 -9
  21. package/dist-esm/samples-dev/clustersUpdateSample.js.map +1 -1
  22. package/dist-esm/samples-dev/configurationsGetCoordinatorSample.js +1 -1
  23. package/dist-esm/samples-dev/configurationsGetNodeSample.js +1 -1
  24. package/dist-esm/samples-dev/configurationsGetSample.js +1 -1
  25. package/dist-esm/samples-dev/configurationsListByClusterSample.js +1 -1
  26. package/dist-esm/samples-dev/configurationsListByServerSample.js +1 -1
  27. package/dist-esm/samples-dev/configurationsUpdateOnCoordinatorSample.js +2 -2
  28. package/dist-esm/samples-dev/configurationsUpdateOnCoordinatorSample.js.map +1 -1
  29. package/dist-esm/samples-dev/configurationsUpdateOnNodeSample.js +2 -2
  30. package/dist-esm/samples-dev/configurationsUpdateOnNodeSample.js.map +1 -1
  31. package/dist-esm/samples-dev/firewallRulesCreateOrUpdateSample.js +3 -3
  32. package/dist-esm/samples-dev/firewallRulesCreateOrUpdateSample.js.map +1 -1
  33. package/dist-esm/samples-dev/firewallRulesDeleteSample.js +1 -1
  34. package/dist-esm/samples-dev/firewallRulesGetSample.js +1 -1
  35. package/dist-esm/samples-dev/firewallRulesListByClusterSample.js +1 -1
  36. package/dist-esm/samples-dev/operationsListSample.js +1 -1
  37. package/dist-esm/samples-dev/privateEndpointConnectionsCreateOrUpdateSample.js +4 -4
  38. package/dist-esm/samples-dev/privateEndpointConnectionsCreateOrUpdateSample.js.map +1 -1
  39. package/dist-esm/samples-dev/privateEndpointConnectionsDeleteSample.js +1 -1
  40. package/dist-esm/samples-dev/privateEndpointConnectionsGetSample.js +1 -1
  41. package/dist-esm/samples-dev/privateEndpointConnectionsListByClusterSample.js +1 -1
  42. package/dist-esm/samples-dev/privateLinkResourcesGetSample.js +1 -1
  43. package/dist-esm/samples-dev/privateLinkResourcesListByClusterSample.js +1 -1
  44. package/dist-esm/samples-dev/rolesCreateSample.js +1 -1
  45. package/dist-esm/samples-dev/rolesDeleteSample.js +1 -1
  46. package/dist-esm/samples-dev/rolesGetSample.js +1 -1
  47. package/dist-esm/samples-dev/rolesListByClusterSample.js +1 -1
  48. package/dist-esm/samples-dev/serversGetSample.js +1 -1
  49. package/dist-esm/samples-dev/serversListByClusterSample.js +1 -1
  50. package/dist-esm/src/cosmosDBForPostgreSQL.d.ts.map +1 -1
  51. package/dist-esm/src/cosmosDBForPostgreSQL.js +9 -9
  52. package/dist-esm/src/cosmosDBForPostgreSQL.js.map +1 -1
  53. package/dist-esm/src/lroImpl.js +1 -1
  54. package/dist-esm/src/models/index.d.ts +91 -2
  55. package/dist-esm/src/models/index.d.ts.map +1 -1
  56. package/dist-esm/src/models/index.js +34 -0
  57. package/dist-esm/src/models/index.js.map +1 -1
  58. package/dist-esm/src/models/mappers.d.ts +2 -0
  59. package/dist-esm/src/models/mappers.d.ts.map +1 -1
  60. package/dist-esm/src/models/mappers.js +649 -579
  61. package/dist-esm/src/models/mappers.js.map +1 -1
  62. package/dist-esm/src/models/parameters.d.ts +1 -0
  63. package/dist-esm/src/models/parameters.d.ts.map +1 -1
  64. package/dist-esm/src/models/parameters.js +63 -59
  65. package/dist-esm/src/models/parameters.js.map +1 -1
  66. package/dist-esm/src/operations/clusters.d.ts.map +1 -1
  67. package/dist-esm/src/operations/clusters.js +106 -104
  68. package/dist-esm/src/operations/clusters.js.map +1 -1
  69. package/dist-esm/src/operations/configurations.d.ts.map +1 -1
  70. package/dist-esm/src/operations/configurations.js +64 -64
  71. package/dist-esm/src/operations/configurations.js.map +1 -1
  72. package/dist-esm/src/operations/firewallRules.d.ts.map +1 -1
  73. package/dist-esm/src/operations/firewallRules.js +37 -37
  74. package/dist-esm/src/operations/firewallRules.js.map +1 -1
  75. package/dist-esm/src/operations/operations.js +5 -5
  76. package/dist-esm/src/operations/privateEndpointConnections.d.ts.map +1 -1
  77. package/dist-esm/src/operations/privateEndpointConnections.js +39 -39
  78. package/dist-esm/src/operations/privateEndpointConnections.js.map +1 -1
  79. package/dist-esm/src/operations/privateLinkResources.js +11 -11
  80. package/dist-esm/src/operations/privateLinkResources.js.map +1 -1
  81. package/dist-esm/src/operations/roles.d.ts.map +1 -1
  82. package/dist-esm/src/operations/roles.js +36 -36
  83. package/dist-esm/src/operations/roles.js.map +1 -1
  84. package/dist-esm/src/operations/servers.js +11 -11
  85. package/dist-esm/src/operations/servers.js.map +1 -1
  86. package/dist-esm/test/cosmosdbforpostgresql_operations_test.spec.js +2 -2
  87. package/dist-esm/test/cosmosdbforpostgresql_operations_test.spec.js.map +1 -1
  88. package/package.json +9 -9
  89. package/review/arm-cosmosdbforpostgresql.api.md +63 -1
  90. package/src/cosmosDBForPostgreSQL.ts +18 -17
  91. package/src/lroImpl.ts +3 -3
  92. package/src/models/index.ts +124 -17
  93. package/src/models/mappers.ts +710 -628
  94. package/src/models/parameters.ts +66 -60
  95. package/src/operations/clusters.ts +208 -224
  96. package/src/operations/configurations.ts +122 -131
  97. package/src/operations/firewallRules.ts +72 -78
  98. package/src/operations/operations.ts +10 -10
  99. package/src/operations/privateEndpointConnections.ts +76 -81
  100. package/src/operations/privateLinkResources.ts +24 -26
  101. package/src/operations/roles.ts +71 -77
  102. package/src/operations/servers.ts +24 -26
  103. package/src/operationsInterfaces/clusters.ts +19 -19
  104. package/src/operationsInterfaces/configurations.ts +10 -10
  105. package/src/operationsInterfaces/firewallRules.ts +7 -7
  106. package/src/operationsInterfaces/operations.ts +1 -1
  107. package/src/operationsInterfaces/privateEndpointConnections.ts +7 -7
  108. package/src/operationsInterfaces/privateLinkResources.ts +3 -3
  109. package/src/operationsInterfaces/roles.ts +7 -7
  110. package/src/operationsInterfaces/servers.ts +3 -3
  111. package/src/pagingHelper.ts +1 -1
  112. package/types/arm-cosmosdbforpostgresql.d.ts +101 -2
@@ -98,6 +98,12 @@ export interface SystemData {
98
98
  lastModifiedAt?: Date;
99
99
  }
100
100
 
101
+ /** Authentication configuration of a cluster. */
102
+ export interface AuthConfig {
103
+ activeDirectoryAuth?: ActiveDirectoryAuth;
104
+ passwordAuth?: PasswordAuth;
105
+ }
106
+
101
107
  /** Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.). */
102
108
  export interface ErrorResponse {
103
109
  /** The error object. */
@@ -276,6 +282,12 @@ export interface RoleListResult {
276
282
  value?: Role[];
277
283
  }
278
284
 
285
+ /** Request from client to promote geo-redundant replica */
286
+ export interface PromoteRequest {
287
+ /** Cluster name to verify. */
288
+ enableGeoBackup?: boolean;
289
+ }
290
+
279
291
  /** Request from client to check cluster name availability. */
280
292
  export interface NameAvailabilityRequest {
281
293
  /** Cluster name to verify. */
@@ -595,16 +607,20 @@ export interface FirewallRule extends ProxyResource {
595
607
 
596
608
  /** Represents a cluster role. */
597
609
  export interface Role extends ProxyResource {
610
+ roleType?: RoleType;
598
611
  /**
599
- * The password of the cluster role.
612
+ * The password of the cluster role. If an identity is used, password will not be required.
600
613
  * This value contains a credential. Consider obscuring before showing to users
601
614
  */
602
- password: string;
615
+ password?: string;
603
616
  /**
604
617
  * Provisioning state of the role
605
618
  * NOTE: This property will not be serialized. It can only be populated by the server.
606
619
  */
607
620
  readonly provisioningState?: ProvisioningState;
621
+ objectId?: string;
622
+ principalType?: PrincipalType;
623
+ tenantId?: string;
608
624
  }
609
625
 
610
626
  /** Represents a cluster. */
@@ -685,6 +701,12 @@ export interface Cluster extends TrackedResource {
685
701
  * NOTE: This property will not be serialized. It can only be populated by the server.
686
702
  */
687
703
  readonly privateEndpointConnections?: SimplePrivateEndpointConnection[];
704
+ /** The database name of the cluster. Only one database per cluster is supported. */
705
+ databaseName?: string;
706
+ /** If cluster backup is stored in another Azure region in addition to the copy of the backup stored in the cluster's region. Enabled only at the time of cluster creation. */
707
+ enableGeoBackup?: boolean;
708
+ /** Authentication configuration of a cluster. */
709
+ authConfig?: AuthConfig;
688
710
  }
689
711
 
690
712
  /** Defines headers for Clusters_create operation. */
@@ -784,7 +806,7 @@ export enum KnownPrivateEndpointServiceConnectionStatus {
784
806
  /** Approved */
785
807
  Approved = "Approved",
786
808
  /** Rejected */
787
- Rejected = "Rejected"
809
+ Rejected = "Rejected",
788
810
  }
789
811
 
790
812
  /**
@@ -807,7 +829,7 @@ export enum KnownCreatedByType {
807
829
  /** ManagedIdentity */
808
830
  ManagedIdentity = "ManagedIdentity",
809
831
  /** Key */
810
- Key = "Key"
832
+ Key = "Key",
811
833
  }
812
834
 
813
835
  /**
@@ -822,12 +844,48 @@ export enum KnownCreatedByType {
822
844
  */
823
845
  export type CreatedByType = string;
824
846
 
847
+ /** Known values of {@link ActiveDirectoryAuth} that the service accepts. */
848
+ export enum KnownActiveDirectoryAuth {
849
+ /** Enabled */
850
+ Enabled = "enabled",
851
+ /** Disabled */
852
+ Disabled = "disabled",
853
+ }
854
+
855
+ /**
856
+ * Defines values for ActiveDirectoryAuth. \
857
+ * {@link KnownActiveDirectoryAuth} can be used interchangeably with ActiveDirectoryAuth,
858
+ * this enum contains the known values that the service supports.
859
+ * ### Known values supported by the service
860
+ * **enabled** \
861
+ * **disabled**
862
+ */
863
+ export type ActiveDirectoryAuth = string;
864
+
865
+ /** Known values of {@link PasswordAuth} that the service accepts. */
866
+ export enum KnownPasswordAuth {
867
+ /** Enabled */
868
+ Enabled = "enabled",
869
+ /** Disabled */
870
+ Disabled = "disabled",
871
+ }
872
+
873
+ /**
874
+ * Defines values for PasswordAuth. \
875
+ * {@link KnownPasswordAuth} can be used interchangeably with PasswordAuth,
876
+ * this enum contains the known values that the service supports.
877
+ * ### Known values supported by the service
878
+ * **enabled** \
879
+ * **disabled**
880
+ */
881
+ export type PasswordAuth = string;
882
+
825
883
  /** Known values of {@link ServerRole} that the service accepts. */
826
884
  export enum KnownServerRole {
827
885
  /** Coordinator */
828
886
  Coordinator = "Coordinator",
829
887
  /** Worker */
830
- Worker = "Worker"
888
+ Worker = "Worker",
831
889
  }
832
890
 
833
891
  /**
@@ -849,7 +907,7 @@ export enum KnownConfigurationDataType {
849
907
  /** Integer */
850
908
  Integer = "Integer",
851
909
  /** Enumeration */
852
- Enumeration = "Enumeration"
910
+ Enumeration = "Enumeration",
853
911
  }
854
912
 
855
913
  /**
@@ -873,7 +931,7 @@ export enum KnownProvisioningState {
873
931
  /** InProgress */
874
932
  InProgress = "InProgress",
875
933
  /** Failed */
876
- Failed = "Failed"
934
+ Failed = "Failed",
877
935
  }
878
936
 
879
937
  /**
@@ -888,6 +946,45 @@ export enum KnownProvisioningState {
888
946
  */
889
947
  export type ProvisioningState = string;
890
948
 
949
+ /** Known values of {@link RoleType} that the service accepts. */
950
+ export enum KnownRoleType {
951
+ /** User */
952
+ User = "user",
953
+ /** Admin */
954
+ Admin = "admin",
955
+ }
956
+
957
+ /**
958
+ * Defines values for RoleType. \
959
+ * {@link KnownRoleType} can be used interchangeably with RoleType,
960
+ * this enum contains the known values that the service supports.
961
+ * ### Known values supported by the service
962
+ * **user** \
963
+ * **admin**
964
+ */
965
+ export type RoleType = string;
966
+
967
+ /** Known values of {@link PrincipalType} that the service accepts. */
968
+ export enum KnownPrincipalType {
969
+ /** User */
970
+ User = "user",
971
+ /** ServicePrincipal */
972
+ ServicePrincipal = "servicePrincipal",
973
+ /** Group */
974
+ Group = "group",
975
+ }
976
+
977
+ /**
978
+ * Defines values for PrincipalType. \
979
+ * {@link KnownPrincipalType} can be used interchangeably with PrincipalType,
980
+ * this enum contains the known values that the service supports.
981
+ * ### Known values supported by the service
982
+ * **user** \
983
+ * **servicePrincipal** \
984
+ * **group**
985
+ */
986
+ export type PrincipalType = string;
987
+
891
988
  /** Known values of {@link OperationOrigin} that the service accepts. */
892
989
  export enum KnownOperationOrigin {
893
990
  /** NotSpecified */
@@ -895,7 +992,7 @@ export enum KnownOperationOrigin {
895
992
  /** User */
896
993
  User = "user",
897
994
  /** System */
898
- System = "system"
995
+ System = "system",
899
996
  }
900
997
 
901
998
  /**
@@ -918,7 +1015,7 @@ export enum KnownPrivateEndpointConnectionProvisioningState {
918
1015
  /** Deleting */
919
1016
  Deleting = "Deleting",
920
1017
  /** Failed */
921
- Failed = "Failed"
1018
+ Failed = "Failed",
922
1019
  }
923
1020
 
924
1021
  /**
@@ -1020,6 +1117,8 @@ export interface ClustersStopOptionalParams
1020
1117
  /** Optional parameters. */
1021
1118
  export interface ClustersPromoteReadReplicaOptionalParams
1022
1119
  extends coreClient.OperationOptions {
1120
+ /** The parameter for enabling geo-redundant backup while promoting read replica. */
1121
+ promoteRequest?: PromoteRequest;
1023
1122
  /** Delay to wait until next poll, in milliseconds. */
1024
1123
  updateIntervalInMs?: number;
1025
1124
  /** A serialized poller which can be used to resume an existing paused Long-Running-Operation. */
@@ -1027,7 +1126,8 @@ export interface ClustersPromoteReadReplicaOptionalParams
1027
1126
  }
1028
1127
 
1029
1128
  /** Contains response data for the promoteReadReplica operation. */
1030
- export type ClustersPromoteReadReplicaResponse = ClustersPromoteReadReplicaHeaders;
1129
+ export type ClustersPromoteReadReplicaResponse =
1130
+ ClustersPromoteReadReplicaHeaders;
1031
1131
 
1032
1132
  /** Optional parameters. */
1033
1133
  export interface ClustersCheckNameAvailabilityOptionalParams
@@ -1075,7 +1175,8 @@ export interface ConfigurationsListByClusterOptionalParams
1075
1175
  extends coreClient.OperationOptions {}
1076
1176
 
1077
1177
  /** Contains response data for the listByCluster operation. */
1078
- export type ConfigurationsListByClusterResponse = ClusterConfigurationListResult;
1178
+ export type ConfigurationsListByClusterResponse =
1179
+ ClusterConfigurationListResult;
1079
1180
 
1080
1181
  /** Optional parameters. */
1081
1182
  export interface ConfigurationsGetOptionalParams
@@ -1127,14 +1228,16 @@ export interface ConfigurationsListByServerNextOptionalParams
1127
1228
  extends coreClient.OperationOptions {}
1128
1229
 
1129
1230
  /** Contains response data for the listByServerNext operation. */
1130
- export type ConfigurationsListByServerNextResponse = ServerConfigurationListResult;
1231
+ export type ConfigurationsListByServerNextResponse =
1232
+ ServerConfigurationListResult;
1131
1233
 
1132
1234
  /** Optional parameters. */
1133
1235
  export interface ConfigurationsListByClusterNextOptionalParams
1134
1236
  extends coreClient.OperationOptions {}
1135
1237
 
1136
1238
  /** Contains response data for the listByClusterNext operation. */
1137
- export type ConfigurationsListByClusterNextResponse = ClusterConfigurationListResult;
1239
+ export type ConfigurationsListByClusterNextResponse =
1240
+ ClusterConfigurationListResult;
1138
1241
 
1139
1242
  /** Optional parameters. */
1140
1243
  export interface FirewallRulesCreateOrUpdateOptionalParams
@@ -1221,7 +1324,8 @@ export interface PrivateEndpointConnectionsListByClusterOptionalParams
1221
1324
  extends coreClient.OperationOptions {}
1222
1325
 
1223
1326
  /** Contains response data for the listByCluster operation. */
1224
- export type PrivateEndpointConnectionsListByClusterResponse = PrivateEndpointConnectionListResult;
1327
+ export type PrivateEndpointConnectionsListByClusterResponse =
1328
+ PrivateEndpointConnectionListResult;
1225
1329
 
1226
1330
  /** Optional parameters. */
1227
1331
  export interface PrivateEndpointConnectionsGetOptionalParams
@@ -1240,7 +1344,8 @@ export interface PrivateEndpointConnectionsCreateOrUpdateOptionalParams
1240
1344
  }
1241
1345
 
1242
1346
  /** Contains response data for the createOrUpdate operation. */
1243
- export type PrivateEndpointConnectionsCreateOrUpdateResponse = PrivateEndpointConnection;
1347
+ export type PrivateEndpointConnectionsCreateOrUpdateResponse =
1348
+ PrivateEndpointConnection;
1244
1349
 
1245
1350
  /** Optional parameters. */
1246
1351
  export interface PrivateEndpointConnectionsDeleteOptionalParams
@@ -1252,14 +1357,16 @@ export interface PrivateEndpointConnectionsDeleteOptionalParams
1252
1357
  }
1253
1358
 
1254
1359
  /** Contains response data for the delete operation. */
1255
- export type PrivateEndpointConnectionsDeleteResponse = PrivateEndpointConnectionsDeleteHeaders;
1360
+ export type PrivateEndpointConnectionsDeleteResponse =
1361
+ PrivateEndpointConnectionsDeleteHeaders;
1256
1362
 
1257
1363
  /** Optional parameters. */
1258
1364
  export interface PrivateLinkResourcesListByClusterOptionalParams
1259
1365
  extends coreClient.OperationOptions {}
1260
1366
 
1261
1367
  /** Contains response data for the listByCluster operation. */
1262
- export type PrivateLinkResourcesListByClusterResponse = PrivateLinkResourceListResult;
1368
+ export type PrivateLinkResourcesListByClusterResponse =
1369
+ PrivateLinkResourceListResult;
1263
1370
 
1264
1371
  /** Optional parameters. */
1265
1372
  export interface PrivateLinkResourcesGetOptionalParams