@googleapis/sqladmin 34.1.0 → 34.2.0

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.
package/v1beta4.ts CHANGED
@@ -1564,6 +1564,23 @@ export namespace sqladmin_v1beta4 {
1564
1564
  */
1565
1565
  importContext?: Schema$ImportContext;
1566
1566
  }
1567
+ /**
1568
+ * Instances ListEntraIdCertificates response.
1569
+ */
1570
+ export interface Schema$InstancesListEntraIdCertificatesResponse {
1571
+ /**
1572
+ * The `sha1_fingerprint` of the active certificate from `certs`.
1573
+ */
1574
+ activeVersion?: string | null;
1575
+ /**
1576
+ * List of Entra ID certificates for the instance.
1577
+ */
1578
+ certs?: Schema$SslCert[];
1579
+ /**
1580
+ * This is always `sql#instancesListEntraIdCertificates`.
1581
+ */
1582
+ kind?: string | null;
1583
+ }
1567
1584
  /**
1568
1585
  * Database instances list response.
1569
1586
  */
@@ -1663,6 +1680,15 @@ export namespace sqladmin_v1beta4 {
1663
1680
  */
1664
1681
  restoreInstanceSettings?: Schema$DatabaseInstance;
1665
1682
  }
1683
+ /**
1684
+ * Rotate Entra ID Certificate request.
1685
+ */
1686
+ export interface Schema$InstancesRotateEntraIdCertificateRequest {
1687
+ /**
1688
+ * Optional. Contains details about the rotate Entra ID certificate operation.
1689
+ */
1690
+ rotateEntraIdCertificateContext?: Schema$RotateEntraIdCertificateContext;
1691
+ }
1666
1692
  /**
1667
1693
  * Rotate Server CA request.
1668
1694
  */
@@ -1747,6 +1773,10 @@ export namespace sqladmin_v1beta4 {
1747
1773
  * Optional. The resource name of the server CA pool for an instance with `CUSTOMER_MANAGED_CAS_CA` as the `server_ca_mode`. Format: projects/{PROJECT\}/locations/{REGION\}/caPools/{CA_POOL_ID\}
1748
1774
  */
1749
1775
  serverCaPool?: string | null;
1776
+ /**
1777
+ * Optional. Controls the automatic server certificate rotation feature. This feature is disabled by default. When enabled, the server certificate will be automatically rotated during Cloud SQL scheduled maintenance or self-service maintenance updates up to six months before it expires. This setting can only be set if server_ca_mode is either GOOGLE_MANAGED_CAS_CA or CUSTOMER_MANAGED_CAS_CA.
1778
+ */
1779
+ serverCertificateRotationMode?: string | null;
1750
1780
  /**
1751
1781
  * Specify how SSL/TLS is enforced in database connections. If you must use the `require_ssl` flag for backward compatibility, then only the following value pairs are valid: For PostgreSQL and MySQL: * `ssl_mode=ALLOW_UNENCRYPTED_AND_ENCRYPTED` and `require_ssl=false` * `ssl_mode=ENCRYPTED_ONLY` and `require_ssl=false` * `ssl_mode=TRUSTED_CLIENT_CERTIFICATE_REQUIRED` and `require_ssl=true` For SQL Server: * `ssl_mode=ALLOW_UNENCRYPTED_AND_ENCRYPTED` and `require_ssl=false` * `ssl_mode=ENCRYPTED_ONLY` and `require_ssl=true` The value of `ssl_mode` has priority over the value of `require_ssl`. For example, for the pair `ssl_mode=ENCRYPTED_ONLY` and `require_ssl=false`, `ssl_mode=ENCRYPTED_ONLY` means accept only SSL connections, while `require_ssl=false` means accept both non-SSL and SSL connections. In this case, MySQL and PostgreSQL databases respect `ssl_mode` and accepts only SSL connections.
1752
1782
  */
@@ -2175,7 +2205,7 @@ export namespace sqladmin_v1beta4 {
2175
2205
  targetSizeGb?: string | null;
2176
2206
  }
2177
2207
  /**
2178
- * Context to perform a point-in-time restore of an instance managed by Google Cloud Backup and Disaster Recovery.
2208
+ * Context to perform a point-in-time restore of an instance managed by Backup and Disaster Recovery (DR) Service.
2179
2209
  */
2180
2210
  export interface Schema$PointInTimeRestoreContext {
2181
2211
  /**
@@ -2183,7 +2213,7 @@ export namespace sqladmin_v1beta4 {
2183
2213
  */
2184
2214
  allocatedIpRange?: string | null;
2185
2215
  /**
2186
- * The Google Cloud Backup and Disaster Recovery Datasource URI. Format: projects/{project\}/locations/{region\}/backupVaults/{backupvault\}/dataSources/{datasource\}.
2216
+ * The Backup and Disaster Recovery (DR) Service Datasource URI. Format: projects/{project\}/locations/{region\}/backupVaults/{backupvault\}/dataSources/{datasource\}.
2187
2217
  */
2188
2218
  datasource?: string | null;
2189
2219
  /**
@@ -2443,6 +2473,19 @@ export namespace sqladmin_v1beta4 {
2443
2473
  */
2444
2474
  project?: string | null;
2445
2475
  }
2476
+ /**
2477
+ * Instance rotate Entra ID certificate context.
2478
+ */
2479
+ export interface Schema$RotateEntraIdCertificateContext {
2480
+ /**
2481
+ * Optional. This is always `sql#rotateEntraIdCertificateContext`.
2482
+ */
2483
+ kind?: string | null;
2484
+ /**
2485
+ * Optional. The fingerprint of the next version to be rotated to. If left unspecified, will be rotated to the most recently added Entra ID certificate version.
2486
+ */
2487
+ nextVersion?: string | null;
2488
+ }
2446
2489
  /**
2447
2490
  * Instance rotate server CA context.
2448
2491
  */
@@ -2536,7 +2579,7 @@ export namespace sqladmin_v1beta4 {
2536
2579
  */
2537
2580
  crashSafeReplicationEnabled?: boolean | null;
2538
2581
  /**
2539
- * This parameter controls whether to allow using Data API to connect to the instance. Not allowed by default.
2582
+ * This parameter controls whether to allow using ExecuteSql API to connect to the instance. Not allowed by default.
2540
2583
  */
2541
2584
  dataApiAccess?: string | null;
2542
2585
  /**
@@ -2587,6 +2630,10 @@ export namespace sqladmin_v1beta4 {
2587
2630
  * Optional. When this parameter is set to true, Cloud SQL instances can connect to Vertex AI to pass requests for real-time predictions and insights to the AI. The default value is false. This applies only to Cloud SQL for MySQL and Cloud SQL for PostgreSQL instances.
2588
2631
  */
2589
2632
  enableGoogleMlIntegration?: boolean | null;
2633
+ /**
2634
+ * Optional. The Microsoft Entra ID configuration for the SQL Server instance.
2635
+ */
2636
+ entraidConfig?: Schema$SqlServerEntraIdConfig;
2590
2637
  /**
2591
2638
  * Optional. The final backup configuration for the instance.
2592
2639
  */
@@ -2719,6 +2766,10 @@ export namespace sqladmin_v1beta4 {
2719
2766
  */
2720
2767
  operationId?: string | null;
2721
2768
  }
2769
+ /**
2770
+ * Request for AddEntraIdCertificate RPC.
2771
+ */
2772
+ export interface Schema$SqlInstancesAddEntraIdCertificateRequest {}
2722
2773
  /**
2723
2774
  * Execute SQL statements response.
2724
2775
  */
@@ -2934,6 +2985,23 @@ export namespace sqladmin_v1beta4 {
2934
2985
  */
2935
2986
  recoveryModel?: string | null;
2936
2987
  }
2988
+ /**
2989
+ * SQL Server Entra ID configuration.
2990
+ */
2991
+ export interface Schema$SqlServerEntraIdConfig {
2992
+ /**
2993
+ * Optional. The application ID for the Entra ID configuration.
2994
+ */
2995
+ applicationId?: string | null;
2996
+ /**
2997
+ * Output only. This is always sql#sqlServerEntraIdConfig
2998
+ */
2999
+ kind?: string | null;
3000
+ /**
3001
+ * Optional. The tenant ID for the Entra ID configuration.
3002
+ */
3003
+ tenantId?: string | null;
3004
+ }
2937
3005
  /**
2938
3006
  * Represents a Sql Server user on the Cloud SQL instance.
2939
3007
  */
@@ -3164,6 +3232,10 @@ export namespace sqladmin_v1beta4 {
3164
3232
  * A Cloud SQL user resource.
3165
3233
  */
3166
3234
  export interface Schema$User {
3235
+ /**
3236
+ * Optional. Role memberships of the user
3237
+ */
3238
+ databaseRoles?: string[] | null;
3167
3239
  /**
3168
3240
  * Dual password status for the user.
3169
3241
  */
@@ -6685,6 +6757,175 @@ export namespace sqladmin_v1beta4 {
6685
6757
  }
6686
6758
  }
6687
6759
 
6760
+ /**
6761
+ * Adds a new Entra ID certificate for the specified instance. If an Entra ID certificate was previously added but never used in a certificate rotation, this operation replaces that version.
6762
+ * @example
6763
+ * ```js
6764
+ * // Before running the sample:
6765
+ * // - Enable the API at:
6766
+ * // https://console.developers.google.com/apis/api/sqladmin.googleapis.com
6767
+ * // - Login into gcloud by running:
6768
+ * // ```sh
6769
+ * // $ gcloud auth application-default login
6770
+ * // ```
6771
+ * // - Install the npm module by running:
6772
+ * // ```sh
6773
+ * // $ npm install googleapis
6774
+ * // ```
6775
+ *
6776
+ * const {google} = require('googleapis');
6777
+ * const sqladmin = google.sqladmin('v1beta4');
6778
+ *
6779
+ * async function main() {
6780
+ * const auth = new google.auth.GoogleAuth({
6781
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
6782
+ * scopes: [
6783
+ * 'https://www.googleapis.com/auth/cloud-platform',
6784
+ * 'https://www.googleapis.com/auth/sqlservice.admin',
6785
+ * ],
6786
+ * });
6787
+ *
6788
+ * // Acquire an auth client, and bind it to all future calls
6789
+ * const authClient = await auth.getClient();
6790
+ * google.options({auth: authClient});
6791
+ *
6792
+ * // Do the magic
6793
+ * const res = await sql.instances.addEntraIdCertificate({
6794
+ * // Required. Cloud SQL instance ID. This does not include the project ID.
6795
+ * instance: 'placeholder-value',
6796
+ * // Required. Project ID of the project that contains the instance.
6797
+ * project: 'placeholder-value',
6798
+ *
6799
+ * // Request body metadata
6800
+ * requestBody: {
6801
+ * // request body parameters
6802
+ * // {}
6803
+ * },
6804
+ * });
6805
+ * console.log(res.data);
6806
+ *
6807
+ * // Example response
6808
+ * // {
6809
+ * // "acquireSsrsLeaseContext": {},
6810
+ * // "apiWarning": {},
6811
+ * // "backupContext": {},
6812
+ * // "endTime": "my_endTime",
6813
+ * // "error": {},
6814
+ * // "exportContext": {},
6815
+ * // "importContext": {},
6816
+ * // "insertTime": "my_insertTime",
6817
+ * // "kind": "my_kind",
6818
+ * // "name": "my_name",
6819
+ * // "operationType": "my_operationType",
6820
+ * // "preCheckMajorVersionUpgradeContext": {},
6821
+ * // "selfLink": "my_selfLink",
6822
+ * // "startTime": "my_startTime",
6823
+ * // "status": "my_status",
6824
+ * // "subOperationType": {},
6825
+ * // "targetId": "my_targetId",
6826
+ * // "targetLink": "my_targetLink",
6827
+ * // "targetProject": "my_targetProject",
6828
+ * // "user": "my_user"
6829
+ * // }
6830
+ * }
6831
+ *
6832
+ * main().catch(e => {
6833
+ * console.error(e);
6834
+ * throw e;
6835
+ * });
6836
+ *
6837
+ * ```
6838
+ *
6839
+ * @param params - Parameters for request
6840
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
6841
+ * @param callback - Optional callback that handles the response.
6842
+ * @returns A promise if used with async/await, or void if used with a callback.
6843
+ */
6844
+ addEntraIdCertificate(
6845
+ params: Params$Resource$Instances$Addentraidcertificate,
6846
+ options: StreamMethodOptions
6847
+ ): Promise<GaxiosResponseWithHTTP2<Readable>>;
6848
+ addEntraIdCertificate(
6849
+ params?: Params$Resource$Instances$Addentraidcertificate,
6850
+ options?: MethodOptions
6851
+ ): Promise<GaxiosResponseWithHTTP2<Schema$Operation>>;
6852
+ addEntraIdCertificate(
6853
+ params: Params$Resource$Instances$Addentraidcertificate,
6854
+ options: StreamMethodOptions | BodyResponseCallback<Readable>,
6855
+ callback: BodyResponseCallback<Readable>
6856
+ ): void;
6857
+ addEntraIdCertificate(
6858
+ params: Params$Resource$Instances$Addentraidcertificate,
6859
+ options: MethodOptions | BodyResponseCallback<Schema$Operation>,
6860
+ callback: BodyResponseCallback<Schema$Operation>
6861
+ ): void;
6862
+ addEntraIdCertificate(
6863
+ params: Params$Resource$Instances$Addentraidcertificate,
6864
+ callback: BodyResponseCallback<Schema$Operation>
6865
+ ): void;
6866
+ addEntraIdCertificate(
6867
+ callback: BodyResponseCallback<Schema$Operation>
6868
+ ): void;
6869
+ addEntraIdCertificate(
6870
+ paramsOrCallback?:
6871
+ | Params$Resource$Instances$Addentraidcertificate
6872
+ | BodyResponseCallback<Schema$Operation>
6873
+ | BodyResponseCallback<Readable>,
6874
+ optionsOrCallback?:
6875
+ | MethodOptions
6876
+ | StreamMethodOptions
6877
+ | BodyResponseCallback<Schema$Operation>
6878
+ | BodyResponseCallback<Readable>,
6879
+ callback?:
6880
+ | BodyResponseCallback<Schema$Operation>
6881
+ | BodyResponseCallback<Readable>
6882
+ ):
6883
+ | void
6884
+ | Promise<GaxiosResponseWithHTTP2<Schema$Operation>>
6885
+ | Promise<GaxiosResponseWithHTTP2<Readable>> {
6886
+ let params = (paramsOrCallback ||
6887
+ {}) as Params$Resource$Instances$Addentraidcertificate;
6888
+ let options = (optionsOrCallback || {}) as MethodOptions;
6889
+
6890
+ if (typeof paramsOrCallback === 'function') {
6891
+ callback = paramsOrCallback;
6892
+ params = {} as Params$Resource$Instances$Addentraidcertificate;
6893
+ options = {};
6894
+ }
6895
+
6896
+ if (typeof optionsOrCallback === 'function') {
6897
+ callback = optionsOrCallback;
6898
+ options = {};
6899
+ }
6900
+
6901
+ const rootUrl = options.rootUrl || 'https://sqladmin.googleapis.com/';
6902
+ const parameters = {
6903
+ options: Object.assign(
6904
+ {
6905
+ url: (
6906
+ rootUrl +
6907
+ '/sql/v1beta4/projects/{project}/instances/{instance}/addEntraIdCertificate'
6908
+ ).replace(/([^:]\/)\/+/g, '$1'),
6909
+ method: 'POST',
6910
+ apiVersion: '',
6911
+ },
6912
+ options
6913
+ ),
6914
+ params,
6915
+ requiredParams: ['project', 'instance'],
6916
+ pathParams: ['instance', 'project'],
6917
+ context: this.context,
6918
+ };
6919
+ if (callback) {
6920
+ createAPIRequest<Schema$Operation>(
6921
+ parameters,
6922
+ callback as BodyResponseCallback<unknown>
6923
+ );
6924
+ } else {
6925
+ return createAPIRequest<Schema$Operation>(parameters);
6926
+ }
6927
+ }
6928
+
6688
6929
  /**
6689
6930
  * Add a new trusted Certificate Authority (CA) version for the specified instance. Required to prepare for a certificate rotation. If a CA version was previously added but never used in a certificate rotation, this operation replaces that version. There cannot be more than one CA version waiting to be rotated in. For instances that have enabled Certificate Authority Service (CAS) based server CA, use AddServerCertificate to add a new server certificate.
6690
6931
  * @example
@@ -8899,7 +9140,7 @@ export namespace sqladmin_v1beta4 {
8899
9140
  }
8900
9141
 
8901
9142
  /**
8902
- * Lists all of the trusted Certificate Authorities (CAs) for the specified instance. There can be up to three CAs listed: the CA that was used to sign the certificate that is currently in use, a CA that has been added but not yet used to sign a certificate, and a CA used to sign a certificate that has previously rotated out.
9143
+ * Lists all versions of EntraID certificates for the specified instance. There can be up to three sets of certificates listed: the certificate that is currently in use, a future that has been added but not yet used to sign a certificate, and a certificate that has been rotated out.
8903
9144
  * @example
8904
9145
  * ```js
8905
9146
  * // Before running the sample:
@@ -8931,10 +9172,10 @@ export namespace sqladmin_v1beta4 {
8931
9172
  * google.options({auth: authClient});
8932
9173
  *
8933
9174
  * // Do the magic
8934
- * const res = await sql.instances.listServerCas({
8935
- * // Cloud SQL instance ID. This does not include the project ID.
9175
+ * const res = await sql.instances.ListEntraIdCertificates({
9176
+ * // Required. Cloud SQL instance ID. This does not include the project ID.
8936
9177
  * instance: 'placeholder-value',
8937
- * // Project ID of the project that contains the instance.
9178
+ * // Required. Project ID of the project that contains the instance.
8938
9179
  * project: 'placeholder-value',
8939
9180
  * });
8940
9181
  * console.log(res.data);
@@ -8959,57 +9200,61 @@ export namespace sqladmin_v1beta4 {
8959
9200
  * @param callback - Optional callback that handles the response.
8960
9201
  * @returns A promise if used with async/await, or void if used with a callback.
8961
9202
  */
8962
- listServerCas(
8963
- params: Params$Resource$Instances$Listservercas,
9203
+ ListEntraIdCertificates(
9204
+ params: Params$Resource$Instances$Listentraidcertificates,
8964
9205
  options: StreamMethodOptions
8965
9206
  ): Promise<GaxiosResponseWithHTTP2<Readable>>;
8966
- listServerCas(
8967
- params?: Params$Resource$Instances$Listservercas,
9207
+ ListEntraIdCertificates(
9208
+ params?: Params$Resource$Instances$Listentraidcertificates,
8968
9209
  options?: MethodOptions
8969
- ): Promise<GaxiosResponseWithHTTP2<Schema$InstancesListServerCasResponse>>;
8970
- listServerCas(
8971
- params: Params$Resource$Instances$Listservercas,
9210
+ ): Promise<
9211
+ GaxiosResponseWithHTTP2<Schema$InstancesListEntraIdCertificatesResponse>
9212
+ >;
9213
+ ListEntraIdCertificates(
9214
+ params: Params$Resource$Instances$Listentraidcertificates,
8972
9215
  options: StreamMethodOptions | BodyResponseCallback<Readable>,
8973
9216
  callback: BodyResponseCallback<Readable>
8974
9217
  ): void;
8975
- listServerCas(
8976
- params: Params$Resource$Instances$Listservercas,
9218
+ ListEntraIdCertificates(
9219
+ params: Params$Resource$Instances$Listentraidcertificates,
8977
9220
  options:
8978
9221
  | MethodOptions
8979
- | BodyResponseCallback<Schema$InstancesListServerCasResponse>,
8980
- callback: BodyResponseCallback<Schema$InstancesListServerCasResponse>
9222
+ | BodyResponseCallback<Schema$InstancesListEntraIdCertificatesResponse>,
9223
+ callback: BodyResponseCallback<Schema$InstancesListEntraIdCertificatesResponse>
8981
9224
  ): void;
8982
- listServerCas(
8983
- params: Params$Resource$Instances$Listservercas,
8984
- callback: BodyResponseCallback<Schema$InstancesListServerCasResponse>
9225
+ ListEntraIdCertificates(
9226
+ params: Params$Resource$Instances$Listentraidcertificates,
9227
+ callback: BodyResponseCallback<Schema$InstancesListEntraIdCertificatesResponse>
8985
9228
  ): void;
8986
- listServerCas(
8987
- callback: BodyResponseCallback<Schema$InstancesListServerCasResponse>
9229
+ ListEntraIdCertificates(
9230
+ callback: BodyResponseCallback<Schema$InstancesListEntraIdCertificatesResponse>
8988
9231
  ): void;
8989
- listServerCas(
9232
+ ListEntraIdCertificates(
8990
9233
  paramsOrCallback?:
8991
- | Params$Resource$Instances$Listservercas
8992
- | BodyResponseCallback<Schema$InstancesListServerCasResponse>
9234
+ | Params$Resource$Instances$Listentraidcertificates
9235
+ | BodyResponseCallback<Schema$InstancesListEntraIdCertificatesResponse>
8993
9236
  | BodyResponseCallback<Readable>,
8994
9237
  optionsOrCallback?:
8995
9238
  | MethodOptions
8996
9239
  | StreamMethodOptions
8997
- | BodyResponseCallback<Schema$InstancesListServerCasResponse>
9240
+ | BodyResponseCallback<Schema$InstancesListEntraIdCertificatesResponse>
8998
9241
  | BodyResponseCallback<Readable>,
8999
9242
  callback?:
9000
- | BodyResponseCallback<Schema$InstancesListServerCasResponse>
9243
+ | BodyResponseCallback<Schema$InstancesListEntraIdCertificatesResponse>
9001
9244
  | BodyResponseCallback<Readable>
9002
9245
  ):
9003
9246
  | void
9004
- | Promise<GaxiosResponseWithHTTP2<Schema$InstancesListServerCasResponse>>
9247
+ | Promise<
9248
+ GaxiosResponseWithHTTP2<Schema$InstancesListEntraIdCertificatesResponse>
9249
+ >
9005
9250
  | Promise<GaxiosResponseWithHTTP2<Readable>> {
9006
9251
  let params = (paramsOrCallback ||
9007
- {}) as Params$Resource$Instances$Listservercas;
9252
+ {}) as Params$Resource$Instances$Listentraidcertificates;
9008
9253
  let options = (optionsOrCallback || {}) as MethodOptions;
9009
9254
 
9010
9255
  if (typeof paramsOrCallback === 'function') {
9011
9256
  callback = paramsOrCallback;
9012
- params = {} as Params$Resource$Instances$Listservercas;
9257
+ params = {} as Params$Resource$Instances$Listentraidcertificates;
9013
9258
  options = {};
9014
9259
  }
9015
9260
 
@@ -9024,7 +9269,7 @@ export namespace sqladmin_v1beta4 {
9024
9269
  {
9025
9270
  url: (
9026
9271
  rootUrl +
9027
- '/sql/v1beta4/projects/{project}/instances/{instance}/listServerCas'
9272
+ '/sql/v1beta4/projects/{project}/instances/{instance}/listEntraIdCertificates'
9028
9273
  ).replace(/([^:]\/)\/+/g, '$1'),
9029
9274
  method: 'GET',
9030
9275
  apiVersion: '',
@@ -9037,19 +9282,19 @@ export namespace sqladmin_v1beta4 {
9037
9282
  context: this.context,
9038
9283
  };
9039
9284
  if (callback) {
9040
- createAPIRequest<Schema$InstancesListServerCasResponse>(
9285
+ createAPIRequest<Schema$InstancesListEntraIdCertificatesResponse>(
9041
9286
  parameters,
9042
9287
  callback as BodyResponseCallback<unknown>
9043
9288
  );
9044
9289
  } else {
9045
- return createAPIRequest<Schema$InstancesListServerCasResponse>(
9290
+ return createAPIRequest<Schema$InstancesListEntraIdCertificatesResponse>(
9046
9291
  parameters
9047
9292
  );
9048
9293
  }
9049
9294
  }
9050
9295
 
9051
9296
  /**
9052
- * Lists all versions of server certificates and certificate authorities (CAs) for the specified instance. There can be up to three sets of certs listed: the certificate that is currently in use, a future that has been added but not yet used to sign a certificate, and a certificate that has been rotated out. For instances not using Certificate Authority Service (CAS) server CA, use ListServerCas instead.
9297
+ * Lists all of the trusted Certificate Authorities (CAs) for the specified instance. There can be up to three CAs listed: the CA that was used to sign the certificate that is currently in use, a CA that has been added but not yet used to sign a certificate, and a CA used to sign a certificate that has previously rotated out.
9053
9298
  * @example
9054
9299
  * ```js
9055
9300
  * // Before running the sample:
@@ -9081,10 +9326,10 @@ export namespace sqladmin_v1beta4 {
9081
9326
  * google.options({auth: authClient});
9082
9327
  *
9083
9328
  * // Do the magic
9084
- * const res = await sql.instances.ListServerCertificates({
9085
- * // Required. Cloud SQL instance ID. This does not include the project ID.
9329
+ * const res = await sql.instances.listServerCas({
9330
+ * // Cloud SQL instance ID. This does not include the project ID.
9086
9331
  * instance: 'placeholder-value',
9087
- * // Required. Project ID of the project that contains the instance.
9332
+ * // Project ID of the project that contains the instance.
9088
9333
  * project: 'placeholder-value',
9089
9334
  * });
9090
9335
  * console.log(res.data);
@@ -9092,9 +9337,8 @@ export namespace sqladmin_v1beta4 {
9092
9337
  * // Example response
9093
9338
  * // {
9094
9339
  * // "activeVersion": "my_activeVersion",
9095
- * // "caCerts": [],
9096
- * // "kind": "my_kind",
9097
- * // "serverCerts": []
9340
+ * // "certs": [],
9341
+ * // "kind": "my_kind"
9098
9342
  * // }
9099
9343
  * }
9100
9344
  *
@@ -9110,16 +9354,167 @@ export namespace sqladmin_v1beta4 {
9110
9354
  * @param callback - Optional callback that handles the response.
9111
9355
  * @returns A promise if used with async/await, or void if used with a callback.
9112
9356
  */
9113
- ListServerCertificates(
9114
- params: Params$Resource$Instances$Listservercertificates,
9357
+ listServerCas(
9358
+ params: Params$Resource$Instances$Listservercas,
9115
9359
  options: StreamMethodOptions
9116
9360
  ): Promise<GaxiosResponseWithHTTP2<Readable>>;
9117
- ListServerCertificates(
9118
- params?: Params$Resource$Instances$Listservercertificates,
9361
+ listServerCas(
9362
+ params?: Params$Resource$Instances$Listservercas,
9119
9363
  options?: MethodOptions
9120
- ): Promise<
9121
- GaxiosResponseWithHTTP2<Schema$InstancesListServerCertificatesResponse>
9122
- >;
9364
+ ): Promise<GaxiosResponseWithHTTP2<Schema$InstancesListServerCasResponse>>;
9365
+ listServerCas(
9366
+ params: Params$Resource$Instances$Listservercas,
9367
+ options: StreamMethodOptions | BodyResponseCallback<Readable>,
9368
+ callback: BodyResponseCallback<Readable>
9369
+ ): void;
9370
+ listServerCas(
9371
+ params: Params$Resource$Instances$Listservercas,
9372
+ options:
9373
+ | MethodOptions
9374
+ | BodyResponseCallback<Schema$InstancesListServerCasResponse>,
9375
+ callback: BodyResponseCallback<Schema$InstancesListServerCasResponse>
9376
+ ): void;
9377
+ listServerCas(
9378
+ params: Params$Resource$Instances$Listservercas,
9379
+ callback: BodyResponseCallback<Schema$InstancesListServerCasResponse>
9380
+ ): void;
9381
+ listServerCas(
9382
+ callback: BodyResponseCallback<Schema$InstancesListServerCasResponse>
9383
+ ): void;
9384
+ listServerCas(
9385
+ paramsOrCallback?:
9386
+ | Params$Resource$Instances$Listservercas
9387
+ | BodyResponseCallback<Schema$InstancesListServerCasResponse>
9388
+ | BodyResponseCallback<Readable>,
9389
+ optionsOrCallback?:
9390
+ | MethodOptions
9391
+ | StreamMethodOptions
9392
+ | BodyResponseCallback<Schema$InstancesListServerCasResponse>
9393
+ | BodyResponseCallback<Readable>,
9394
+ callback?:
9395
+ | BodyResponseCallback<Schema$InstancesListServerCasResponse>
9396
+ | BodyResponseCallback<Readable>
9397
+ ):
9398
+ | void
9399
+ | Promise<GaxiosResponseWithHTTP2<Schema$InstancesListServerCasResponse>>
9400
+ | Promise<GaxiosResponseWithHTTP2<Readable>> {
9401
+ let params = (paramsOrCallback ||
9402
+ {}) as Params$Resource$Instances$Listservercas;
9403
+ let options = (optionsOrCallback || {}) as MethodOptions;
9404
+
9405
+ if (typeof paramsOrCallback === 'function') {
9406
+ callback = paramsOrCallback;
9407
+ params = {} as Params$Resource$Instances$Listservercas;
9408
+ options = {};
9409
+ }
9410
+
9411
+ if (typeof optionsOrCallback === 'function') {
9412
+ callback = optionsOrCallback;
9413
+ options = {};
9414
+ }
9415
+
9416
+ const rootUrl = options.rootUrl || 'https://sqladmin.googleapis.com/';
9417
+ const parameters = {
9418
+ options: Object.assign(
9419
+ {
9420
+ url: (
9421
+ rootUrl +
9422
+ '/sql/v1beta4/projects/{project}/instances/{instance}/listServerCas'
9423
+ ).replace(/([^:]\/)\/+/g, '$1'),
9424
+ method: 'GET',
9425
+ apiVersion: '',
9426
+ },
9427
+ options
9428
+ ),
9429
+ params,
9430
+ requiredParams: ['project', 'instance'],
9431
+ pathParams: ['instance', 'project'],
9432
+ context: this.context,
9433
+ };
9434
+ if (callback) {
9435
+ createAPIRequest<Schema$InstancesListServerCasResponse>(
9436
+ parameters,
9437
+ callback as BodyResponseCallback<unknown>
9438
+ );
9439
+ } else {
9440
+ return createAPIRequest<Schema$InstancesListServerCasResponse>(
9441
+ parameters
9442
+ );
9443
+ }
9444
+ }
9445
+
9446
+ /**
9447
+ * Lists all versions of server certificates and certificate authorities (CAs) for the specified instance. There can be up to three sets of certs listed: the certificate that is currently in use, a future that has been added but not yet used to sign a certificate, and a certificate that has been rotated out. For instances not using Certificate Authority Service (CAS) server CA, use ListServerCas instead.
9448
+ * @example
9449
+ * ```js
9450
+ * // Before running the sample:
9451
+ * // - Enable the API at:
9452
+ * // https://console.developers.google.com/apis/api/sqladmin.googleapis.com
9453
+ * // - Login into gcloud by running:
9454
+ * // ```sh
9455
+ * // $ gcloud auth application-default login
9456
+ * // ```
9457
+ * // - Install the npm module by running:
9458
+ * // ```sh
9459
+ * // $ npm install googleapis
9460
+ * // ```
9461
+ *
9462
+ * const {google} = require('googleapis');
9463
+ * const sqladmin = google.sqladmin('v1beta4');
9464
+ *
9465
+ * async function main() {
9466
+ * const auth = new google.auth.GoogleAuth({
9467
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
9468
+ * scopes: [
9469
+ * 'https://www.googleapis.com/auth/cloud-platform',
9470
+ * 'https://www.googleapis.com/auth/sqlservice.admin',
9471
+ * ],
9472
+ * });
9473
+ *
9474
+ * // Acquire an auth client, and bind it to all future calls
9475
+ * const authClient = await auth.getClient();
9476
+ * google.options({auth: authClient});
9477
+ *
9478
+ * // Do the magic
9479
+ * const res = await sql.instances.ListServerCertificates({
9480
+ * // Required. Cloud SQL instance ID. This does not include the project ID.
9481
+ * instance: 'placeholder-value',
9482
+ * // Required. Project ID of the project that contains the instance.
9483
+ * project: 'placeholder-value',
9484
+ * });
9485
+ * console.log(res.data);
9486
+ *
9487
+ * // Example response
9488
+ * // {
9489
+ * // "activeVersion": "my_activeVersion",
9490
+ * // "caCerts": [],
9491
+ * // "kind": "my_kind",
9492
+ * // "serverCerts": []
9493
+ * // }
9494
+ * }
9495
+ *
9496
+ * main().catch(e => {
9497
+ * console.error(e);
9498
+ * throw e;
9499
+ * });
9500
+ *
9501
+ * ```
9502
+ *
9503
+ * @param params - Parameters for request
9504
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
9505
+ * @param callback - Optional callback that handles the response.
9506
+ * @returns A promise if used with async/await, or void if used with a callback.
9507
+ */
9508
+ ListServerCertificates(
9509
+ params: Params$Resource$Instances$Listservercertificates,
9510
+ options: StreamMethodOptions
9511
+ ): Promise<GaxiosResponseWithHTTP2<Readable>>;
9512
+ ListServerCertificates(
9513
+ params?: Params$Resource$Instances$Listservercertificates,
9514
+ options?: MethodOptions
9515
+ ): Promise<
9516
+ GaxiosResponseWithHTTP2<Schema$InstancesListServerCertificatesResponse>
9517
+ >;
9123
9518
  ListServerCertificates(
9124
9519
  params: Params$Resource$Instances$Listservercertificates,
9125
9520
  options: StreamMethodOptions | BodyResponseCallback<Readable>,
@@ -10744,6 +11139,177 @@ export namespace sqladmin_v1beta4 {
10744
11139
  }
10745
11140
  }
10746
11141
 
11142
+ /**
11143
+ * Rotates the Entra Id certificate version to one previously added with the addEntraIdCertificate method.
11144
+ * @example
11145
+ * ```js
11146
+ * // Before running the sample:
11147
+ * // - Enable the API at:
11148
+ * // https://console.developers.google.com/apis/api/sqladmin.googleapis.com
11149
+ * // - Login into gcloud by running:
11150
+ * // ```sh
11151
+ * // $ gcloud auth application-default login
11152
+ * // ```
11153
+ * // - Install the npm module by running:
11154
+ * // ```sh
11155
+ * // $ npm install googleapis
11156
+ * // ```
11157
+ *
11158
+ * const {google} = require('googleapis');
11159
+ * const sqladmin = google.sqladmin('v1beta4');
11160
+ *
11161
+ * async function main() {
11162
+ * const auth = new google.auth.GoogleAuth({
11163
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
11164
+ * scopes: [
11165
+ * 'https://www.googleapis.com/auth/cloud-platform',
11166
+ * 'https://www.googleapis.com/auth/sqlservice.admin',
11167
+ * ],
11168
+ * });
11169
+ *
11170
+ * // Acquire an auth client, and bind it to all future calls
11171
+ * const authClient = await auth.getClient();
11172
+ * google.options({auth: authClient});
11173
+ *
11174
+ * // Do the magic
11175
+ * const res = await sql.instances.RotateEntraIdCertificate({
11176
+ * // Required. Cloud SQL instance ID. This does not include the project ID.
11177
+ * instance: 'placeholder-value',
11178
+ * // Required. Project ID of the project that contains the instance.
11179
+ * project: 'placeholder-value',
11180
+ *
11181
+ * // Request body metadata
11182
+ * requestBody: {
11183
+ * // request body parameters
11184
+ * // {
11185
+ * // "rotateEntraIdCertificateContext": {}
11186
+ * // }
11187
+ * },
11188
+ * });
11189
+ * console.log(res.data);
11190
+ *
11191
+ * // Example response
11192
+ * // {
11193
+ * // "acquireSsrsLeaseContext": {},
11194
+ * // "apiWarning": {},
11195
+ * // "backupContext": {},
11196
+ * // "endTime": "my_endTime",
11197
+ * // "error": {},
11198
+ * // "exportContext": {},
11199
+ * // "importContext": {},
11200
+ * // "insertTime": "my_insertTime",
11201
+ * // "kind": "my_kind",
11202
+ * // "name": "my_name",
11203
+ * // "operationType": "my_operationType",
11204
+ * // "preCheckMajorVersionUpgradeContext": {},
11205
+ * // "selfLink": "my_selfLink",
11206
+ * // "startTime": "my_startTime",
11207
+ * // "status": "my_status",
11208
+ * // "subOperationType": {},
11209
+ * // "targetId": "my_targetId",
11210
+ * // "targetLink": "my_targetLink",
11211
+ * // "targetProject": "my_targetProject",
11212
+ * // "user": "my_user"
11213
+ * // }
11214
+ * }
11215
+ *
11216
+ * main().catch(e => {
11217
+ * console.error(e);
11218
+ * throw e;
11219
+ * });
11220
+ *
11221
+ * ```
11222
+ *
11223
+ * @param params - Parameters for request
11224
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
11225
+ * @param callback - Optional callback that handles the response.
11226
+ * @returns A promise if used with async/await, or void if used with a callback.
11227
+ */
11228
+ RotateEntraIdCertificate(
11229
+ params: Params$Resource$Instances$Rotateentraidcertificate,
11230
+ options: StreamMethodOptions
11231
+ ): Promise<GaxiosResponseWithHTTP2<Readable>>;
11232
+ RotateEntraIdCertificate(
11233
+ params?: Params$Resource$Instances$Rotateentraidcertificate,
11234
+ options?: MethodOptions
11235
+ ): Promise<GaxiosResponseWithHTTP2<Schema$Operation>>;
11236
+ RotateEntraIdCertificate(
11237
+ params: Params$Resource$Instances$Rotateentraidcertificate,
11238
+ options: StreamMethodOptions | BodyResponseCallback<Readable>,
11239
+ callback: BodyResponseCallback<Readable>
11240
+ ): void;
11241
+ RotateEntraIdCertificate(
11242
+ params: Params$Resource$Instances$Rotateentraidcertificate,
11243
+ options: MethodOptions | BodyResponseCallback<Schema$Operation>,
11244
+ callback: BodyResponseCallback<Schema$Operation>
11245
+ ): void;
11246
+ RotateEntraIdCertificate(
11247
+ params: Params$Resource$Instances$Rotateentraidcertificate,
11248
+ callback: BodyResponseCallback<Schema$Operation>
11249
+ ): void;
11250
+ RotateEntraIdCertificate(
11251
+ callback: BodyResponseCallback<Schema$Operation>
11252
+ ): void;
11253
+ RotateEntraIdCertificate(
11254
+ paramsOrCallback?:
11255
+ | Params$Resource$Instances$Rotateentraidcertificate
11256
+ | BodyResponseCallback<Schema$Operation>
11257
+ | BodyResponseCallback<Readable>,
11258
+ optionsOrCallback?:
11259
+ | MethodOptions
11260
+ | StreamMethodOptions
11261
+ | BodyResponseCallback<Schema$Operation>
11262
+ | BodyResponseCallback<Readable>,
11263
+ callback?:
11264
+ | BodyResponseCallback<Schema$Operation>
11265
+ | BodyResponseCallback<Readable>
11266
+ ):
11267
+ | void
11268
+ | Promise<GaxiosResponseWithHTTP2<Schema$Operation>>
11269
+ | Promise<GaxiosResponseWithHTTP2<Readable>> {
11270
+ let params = (paramsOrCallback ||
11271
+ {}) as Params$Resource$Instances$Rotateentraidcertificate;
11272
+ let options = (optionsOrCallback || {}) as MethodOptions;
11273
+
11274
+ if (typeof paramsOrCallback === 'function') {
11275
+ callback = paramsOrCallback;
11276
+ params = {} as Params$Resource$Instances$Rotateentraidcertificate;
11277
+ options = {};
11278
+ }
11279
+
11280
+ if (typeof optionsOrCallback === 'function') {
11281
+ callback = optionsOrCallback;
11282
+ options = {};
11283
+ }
11284
+
11285
+ const rootUrl = options.rootUrl || 'https://sqladmin.googleapis.com/';
11286
+ const parameters = {
11287
+ options: Object.assign(
11288
+ {
11289
+ url: (
11290
+ rootUrl +
11291
+ '/sql/v1beta4/projects/{project}/instances/{instance}/rotateEntraIdCertificate'
11292
+ ).replace(/([^:]\/)\/+/g, '$1'),
11293
+ method: 'POST',
11294
+ apiVersion: '',
11295
+ },
11296
+ options
11297
+ ),
11298
+ params,
11299
+ requiredParams: ['project', 'instance'],
11300
+ pathParams: ['instance', 'project'],
11301
+ context: this.context,
11302
+ };
11303
+ if (callback) {
11304
+ createAPIRequest<Schema$Operation>(
11305
+ parameters,
11306
+ callback as BodyResponseCallback<unknown>
11307
+ );
11308
+ } else {
11309
+ return createAPIRequest<Schema$Operation>(parameters);
11310
+ }
11311
+ }
11312
+
10747
11313
  /**
10748
11314
  * Rotates the server certificate to one signed by the Certificate Authority (CA) version previously added with the addServerCA method. For instances that have enabled Certificate Authority Service (CAS) based server CA, use RotateServerCertificate to rotate the server certificate.
10749
11315
  * @example
@@ -11972,6 +12538,22 @@ export namespace sqladmin_v1beta4 {
11972
12538
  */
11973
12539
  requestBody?: Schema$InstancesAcquireSsrsLeaseRequest;
11974
12540
  }
12541
+ export interface Params$Resource$Instances$Addentraidcertificate
12542
+ extends StandardParameters {
12543
+ /**
12544
+ * Required. Cloud SQL instance ID. This does not include the project ID.
12545
+ */
12546
+ instance?: string;
12547
+ /**
12548
+ * Required. Project ID of the project that contains the instance.
12549
+ */
12550
+ project?: string;
12551
+
12552
+ /**
12553
+ * Request body metadata
12554
+ */
12555
+ requestBody?: Schema$SqlInstancesAddEntraIdCertificateRequest;
12556
+ }
11975
12557
  export interface Params$Resource$Instances$Addserverca
11976
12558
  extends StandardParameters {
11977
12559
  /**
@@ -12167,6 +12749,17 @@ export namespace sqladmin_v1beta4 {
12167
12749
  */
12168
12750
  project?: string;
12169
12751
  }
12752
+ export interface Params$Resource$Instances$Listentraidcertificates
12753
+ extends StandardParameters {
12754
+ /**
12755
+ * Required. Cloud SQL instance ID. This does not include the project ID.
12756
+ */
12757
+ instance?: string;
12758
+ /**
12759
+ * Required. Project ID of the project that contains the instance.
12760
+ */
12761
+ project?: string;
12762
+ }
12170
12763
  export interface Params$Resource$Instances$Listservercas
12171
12764
  extends StandardParameters {
12172
12765
  /**
@@ -12316,6 +12909,22 @@ export namespace sqladmin_v1beta4 {
12316
12909
  */
12317
12910
  requestBody?: Schema$InstancesRestoreBackupRequest;
12318
12911
  }
12912
+ export interface Params$Resource$Instances$Rotateentraidcertificate
12913
+ extends StandardParameters {
12914
+ /**
12915
+ * Required. Cloud SQL instance ID. This does not include the project ID.
12916
+ */
12917
+ instance?: string;
12918
+ /**
12919
+ * Required. Project ID of the project that contains the instance.
12920
+ */
12921
+ project?: string;
12922
+
12923
+ /**
12924
+ * Request body metadata
12925
+ */
12926
+ requestBody?: Schema$InstancesRotateEntraIdCertificateRequest;
12927
+ }
12319
12928
  export interface Params$Resource$Instances$Rotateserverca
12320
12929
  extends StandardParameters {
12321
12930
  /**
@@ -15412,6 +16021,7 @@ export namespace sqladmin_v1beta4 {
15412
16021
  *
15413
16022
  * // Example response
15414
16023
  * // {
16024
+ * // "databaseRoles": [],
15415
16025
  * // "dualPasswordType": "my_dualPasswordType",
15416
16026
  * // "etag": "my_etag",
15417
16027
  * // "host": "my_host",
@@ -15565,6 +16175,7 @@ export namespace sqladmin_v1beta4 {
15565
16175
  * requestBody: {
15566
16176
  * // request body parameters
15567
16177
  * // {
16178
+ * // "databaseRoles": [],
15568
16179
  * // "dualPasswordType": "my_dualPasswordType",
15569
16180
  * // "etag": "my_etag",
15570
16181
  * // "host": "my_host",
@@ -15879,6 +16490,8 @@ export namespace sqladmin_v1beta4 {
15879
16490
  *
15880
16491
  * // Do the magic
15881
16492
  * const res = await sql.users.update({
16493
+ * // Optional. List of database roles to grant to the user. body.database_roles will be ignored for update request.
16494
+ * databaseRoles: 'placeholder-value',
15882
16495
  * // Optional. Host of the user in the instance.
15883
16496
  * host: 'placeholder-value',
15884
16497
  * // Database instance ID. This does not include the project ID.
@@ -15887,11 +16500,14 @@ export namespace sqladmin_v1beta4 {
15887
16500
  * name: 'placeholder-value',
15888
16501
  * // Project ID of the project that contains the instance.
15889
16502
  * project: 'placeholder-value',
16503
+ * // Optional. revoke the existing roles granted to the user.
16504
+ * revokeExistingRoles: 'placeholder-value',
15890
16505
  *
15891
16506
  * // Request body metadata
15892
16507
  * requestBody: {
15893
16508
  * // request body parameters
15894
16509
  * // {
16510
+ * // "databaseRoles": [],
15895
16511
  * // "dualPasswordType": "my_dualPasswordType",
15896
16512
  * // "etag": "my_etag",
15897
16513
  * // "host": "my_host",
@@ -16092,6 +16708,10 @@ export namespace sqladmin_v1beta4 {
16092
16708
  project?: string;
16093
16709
  }
16094
16710
  export interface Params$Resource$Users$Update extends StandardParameters {
16711
+ /**
16712
+ * Optional. List of database roles to grant to the user. body.database_roles will be ignored for update request.
16713
+ */
16714
+ databaseRoles?: string[];
16095
16715
  /**
16096
16716
  * Optional. Host of the user in the instance.
16097
16717
  */
@@ -16108,6 +16728,10 @@ export namespace sqladmin_v1beta4 {
16108
16728
  * Project ID of the project that contains the instance.
16109
16729
  */
16110
16730
  project?: string;
16731
+ /**
16732
+ * Optional. revoke the existing roles granted to the user.
16733
+ */
16734
+ revokeExistingRoles?: boolean;
16111
16735
 
16112
16736
  /**
16113
16737
  * Request body metadata