@googleapis/sqladmin 33.0.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/CHANGELOG.md +28 -0
- package/build/tsconfig.tsbuildinfo +1 -1
- package/build/v1.d.ts +322 -19
- package/build/v1.js +66 -0
- package/build/v1.js.map +1 -1
- package/build/v1beta4.d.ts +423 -5
- package/build/v1beta4.js +99 -0
- package/build/v1beta4.js.map +1 -1
- package/package.json +1 -1
- package/v1.ts +489 -19
- package/v1beta4.ts +704 -39
package/build/v1.d.ts
CHANGED
|
@@ -486,7 +486,7 @@ export declare namespace sqladmin_v1 {
|
|
|
486
486
|
*/
|
|
487
487
|
databaseNames?: string[] | null;
|
|
488
488
|
/**
|
|
489
|
-
* Name of the Cloud SQL instance to be created as a clone.
|
|
489
|
+
* Required. Name of the Cloud SQL instance to be created as a clone.
|
|
490
490
|
*/
|
|
491
491
|
destinationInstanceName?: string | null;
|
|
492
492
|
/**
|
|
@@ -1081,7 +1081,7 @@ export declare namespace sqladmin_v1 {
|
|
|
1081
1081
|
*/
|
|
1082
1082
|
database?: string | null;
|
|
1083
1083
|
/**
|
|
1084
|
-
* Optional. Controls how the API should respond when the SQL execution result
|
|
1084
|
+
* Optional. Controls how the API should respond when the SQL execution result is incomplete due to the size limit or another error. The default mode is to throw an error.
|
|
1085
1085
|
*/
|
|
1086
1086
|
partialResultMode?: string | null;
|
|
1087
1087
|
/**
|
|
@@ -1462,7 +1462,7 @@ export declare namespace sqladmin_v1 {
|
|
|
1462
1462
|
*/
|
|
1463
1463
|
export interface Schema$InstancesCloneRequest {
|
|
1464
1464
|
/**
|
|
1465
|
-
* Contains details about the clone operation.
|
|
1465
|
+
* Required. Contains details about the clone operation.
|
|
1466
1466
|
*/
|
|
1467
1467
|
cloneContext?: Schema$CloneContext;
|
|
1468
1468
|
}
|
|
@@ -1511,6 +1511,23 @@ export declare namespace sqladmin_v1 {
|
|
|
1511
1511
|
*/
|
|
1512
1512
|
importContext?: Schema$ImportContext;
|
|
1513
1513
|
}
|
|
1514
|
+
/**
|
|
1515
|
+
* Instances ListEntraIdCertificates response.
|
|
1516
|
+
*/
|
|
1517
|
+
export interface Schema$InstancesListEntraIdCertificatesResponse {
|
|
1518
|
+
/**
|
|
1519
|
+
* The `sha1_fingerprint` of the active certificate from `certs`.
|
|
1520
|
+
*/
|
|
1521
|
+
activeVersion?: string | null;
|
|
1522
|
+
/**
|
|
1523
|
+
* List of Entra ID certificates for the instance.
|
|
1524
|
+
*/
|
|
1525
|
+
certs?: Schema$SslCert[];
|
|
1526
|
+
/**
|
|
1527
|
+
* This is always `sql#instancesListEntraIdCertificates`.
|
|
1528
|
+
*/
|
|
1529
|
+
kind?: string | null;
|
|
1530
|
+
}
|
|
1514
1531
|
/**
|
|
1515
1532
|
* Database instances list response.
|
|
1516
1533
|
*/
|
|
@@ -1610,6 +1627,15 @@ export declare namespace sqladmin_v1 {
|
|
|
1610
1627
|
*/
|
|
1611
1628
|
restoreInstanceSettings?: Schema$DatabaseInstance;
|
|
1612
1629
|
}
|
|
1630
|
+
/**
|
|
1631
|
+
* Rotate Entra ID certificate request.
|
|
1632
|
+
*/
|
|
1633
|
+
export interface Schema$InstancesRotateEntraIdCertificateRequest {
|
|
1634
|
+
/**
|
|
1635
|
+
* Optional. Contains details about the rotate server certificate operation.
|
|
1636
|
+
*/
|
|
1637
|
+
rotateEntraIdCertificateContext?: Schema$RotateEntraIdCertificateContext;
|
|
1638
|
+
}
|
|
1613
1639
|
/**
|
|
1614
1640
|
* Rotate server CA request.
|
|
1615
1641
|
*/
|
|
@@ -1694,6 +1720,10 @@ export declare namespace sqladmin_v1 {
|
|
|
1694
1720
|
* 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\}
|
|
1695
1721
|
*/
|
|
1696
1722
|
serverCaPool?: string | null;
|
|
1723
|
+
/**
|
|
1724
|
+
* 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.
|
|
1725
|
+
*/
|
|
1726
|
+
serverCertificateRotationMode?: string | null;
|
|
1697
1727
|
/**
|
|
1698
1728
|
* 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.
|
|
1699
1729
|
*/
|
|
@@ -2122,7 +2152,7 @@ export declare namespace sqladmin_v1 {
|
|
|
2122
2152
|
targetSizeGb?: string | null;
|
|
2123
2153
|
}
|
|
2124
2154
|
/**
|
|
2125
|
-
* The context to perform a point-in-time recovery of an instance managed by
|
|
2155
|
+
* The context to perform a point-in-time recovery of an instance managed by Backup and Disaster Recovery (DR) Service.
|
|
2126
2156
|
*/
|
|
2127
2157
|
export interface Schema$PointInTimeRestoreContext {
|
|
2128
2158
|
/**
|
|
@@ -2130,7 +2160,7 @@ export declare namespace sqladmin_v1 {
|
|
|
2130
2160
|
*/
|
|
2131
2161
|
allocatedIpRange?: string | null;
|
|
2132
2162
|
/**
|
|
2133
|
-
* The
|
|
2163
|
+
* The Backup and Disaster Recovery (DR) Service Datasource URI. Format: projects/{project\}/locations/{region\}/backupVaults/{backupvault\}/dataSources/{datasource\}.
|
|
2134
2164
|
*/
|
|
2135
2165
|
datasource?: string | null;
|
|
2136
2166
|
/**
|
|
@@ -2276,13 +2306,17 @@ export declare namespace sqladmin_v1 {
|
|
|
2276
2306
|
*/
|
|
2277
2307
|
message?: string | null;
|
|
2278
2308
|
/**
|
|
2279
|
-
* Set to true if the SQL execution's result is truncated due to size limits.
|
|
2309
|
+
* Set to true if the SQL execution's result is truncated due to size limits or an error retrieving results.
|
|
2280
2310
|
*/
|
|
2281
2311
|
partialResult?: boolean | null;
|
|
2282
2312
|
/**
|
|
2283
2313
|
* Rows returned by the SQL statement.
|
|
2284
2314
|
*/
|
|
2285
2315
|
rows?: Schema$Row[];
|
|
2316
|
+
/**
|
|
2317
|
+
* If results were truncated due to an error, details of that error.
|
|
2318
|
+
*/
|
|
2319
|
+
status?: Schema$Status;
|
|
2286
2320
|
}
|
|
2287
2321
|
/**
|
|
2288
2322
|
* The read pool auto-scale configuration.
|
|
@@ -2386,6 +2420,19 @@ export declare namespace sqladmin_v1 {
|
|
|
2386
2420
|
*/
|
|
2387
2421
|
project?: string | null;
|
|
2388
2422
|
}
|
|
2423
|
+
/**
|
|
2424
|
+
* Instance rotate Entra ID certificate context.
|
|
2425
|
+
*/
|
|
2426
|
+
export interface Schema$RotateEntraIdCertificateContext {
|
|
2427
|
+
/**
|
|
2428
|
+
* Optional. This is always `sql#rotateEntraIdCertificateContext`.
|
|
2429
|
+
*/
|
|
2430
|
+
kind?: string | null;
|
|
2431
|
+
/**
|
|
2432
|
+
* Optional. The fingerprint of the next version to be rotated to. If left unspecified, will be rotated to the most recently added server certificate version.
|
|
2433
|
+
*/
|
|
2434
|
+
nextVersion?: string | null;
|
|
2435
|
+
}
|
|
2389
2436
|
/**
|
|
2390
2437
|
* Instance rotate server CA context.
|
|
2391
2438
|
*/
|
|
@@ -2450,6 +2497,10 @@ export declare namespace sqladmin_v1 {
|
|
|
2450
2497
|
* The App Engine app IDs that can access this instance. (Deprecated) Applied to First Generation instances only.
|
|
2451
2498
|
*/
|
|
2452
2499
|
authorizedGaeApplications?: string[] | null;
|
|
2500
|
+
/**
|
|
2501
|
+
* Optional. Cloud SQL for MySQL auto-upgrade configuration. When this parameter is set to true, auto-upgrade is enabled for MySQL 8.0 minor versions. The MySQL version must be 8.0.35 or higher.
|
|
2502
|
+
*/
|
|
2503
|
+
autoUpgradeEnabled?: boolean | null;
|
|
2453
2504
|
/**
|
|
2454
2505
|
* Availability type. Potential values: * `ZONAL`: The instance serves data from only one zone. Outages in that zone affect data accessibility. * `REGIONAL`: The instance can serve data from more than one zone in a region (it is highly available)./ For more information, see [Overview of the High Availability Configuration](https://cloud.google.com/sql/docs/mysql/high-availability).
|
|
2455
2506
|
*/
|
|
@@ -2474,6 +2525,10 @@ export declare namespace sqladmin_v1 {
|
|
|
2474
2525
|
* Configuration specific to read replica instances. Indicates whether database flags for crash-safe replication are enabled. This property was only applicable to First Generation instances.
|
|
2475
2526
|
*/
|
|
2476
2527
|
crashSafeReplicationEnabled?: boolean | null;
|
|
2528
|
+
/**
|
|
2529
|
+
* This parameter controls whether to allow using ExecuteSql API to connect to the instance. Not allowed by default.
|
|
2530
|
+
*/
|
|
2531
|
+
dataApiAccess?: string | null;
|
|
2477
2532
|
/**
|
|
2478
2533
|
* The database flags passed to the instance at startup.
|
|
2479
2534
|
*/
|
|
@@ -2522,6 +2577,10 @@ export declare namespace sqladmin_v1 {
|
|
|
2522
2577
|
* 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.
|
|
2523
2578
|
*/
|
|
2524
2579
|
enableGoogleMlIntegration?: boolean | null;
|
|
2580
|
+
/**
|
|
2581
|
+
* Optional. The Microsoft Entra ID configuration for the SQL Server instance.
|
|
2582
|
+
*/
|
|
2583
|
+
entraidConfig?: Schema$SqlServerEntraIdConfig;
|
|
2525
2584
|
/**
|
|
2526
2585
|
* Optional. The final backup configuration for the instance.
|
|
2527
2586
|
*/
|
|
@@ -2672,6 +2731,10 @@ export declare namespace sqladmin_v1 {
|
|
|
2672
2731
|
* The list of results after executing all the SQL statements.
|
|
2673
2732
|
*/
|
|
2674
2733
|
results?: Schema$QueryResult[];
|
|
2734
|
+
/**
|
|
2735
|
+
* Contains the error from the database if the SQL execution failed.
|
|
2736
|
+
*/
|
|
2737
|
+
status?: Schema$Status;
|
|
2675
2738
|
}
|
|
2676
2739
|
/**
|
|
2677
2740
|
* Instance get disk shrink config response.
|
|
@@ -2874,6 +2937,23 @@ export declare namespace sqladmin_v1 {
|
|
|
2874
2937
|
*/
|
|
2875
2938
|
recoveryModel?: string | null;
|
|
2876
2939
|
}
|
|
2940
|
+
/**
|
|
2941
|
+
* SQL Server Entra ID configuration.
|
|
2942
|
+
*/
|
|
2943
|
+
export interface Schema$SqlServerEntraIdConfig {
|
|
2944
|
+
/**
|
|
2945
|
+
* Optional. The application ID for the Entra ID configuration.
|
|
2946
|
+
*/
|
|
2947
|
+
applicationId?: string | null;
|
|
2948
|
+
/**
|
|
2949
|
+
* Output only. This is always sql#sqlServerEntraIdConfig
|
|
2950
|
+
*/
|
|
2951
|
+
kind?: string | null;
|
|
2952
|
+
/**
|
|
2953
|
+
* Optional. The tenant ID for the Entra ID configuration.
|
|
2954
|
+
*/
|
|
2955
|
+
tenantId?: string | null;
|
|
2956
|
+
}
|
|
2877
2957
|
/**
|
|
2878
2958
|
* Represents a Sql Server user on the Cloud SQL instance.
|
|
2879
2959
|
*/
|
|
@@ -3006,6 +3086,25 @@ export declare namespace sqladmin_v1 {
|
|
|
3006
3086
|
*/
|
|
3007
3087
|
kind?: string | null;
|
|
3008
3088
|
}
|
|
3089
|
+
/**
|
|
3090
|
+
* The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).
|
|
3091
|
+
*/
|
|
3092
|
+
export interface Schema$Status {
|
|
3093
|
+
/**
|
|
3094
|
+
* The status code, which should be an enum value of google.rpc.Code.
|
|
3095
|
+
*/
|
|
3096
|
+
code?: number | null;
|
|
3097
|
+
/**
|
|
3098
|
+
* A list of messages that carry the error details. There is a common set of message types for APIs to use.
|
|
3099
|
+
*/
|
|
3100
|
+
details?: Array<{
|
|
3101
|
+
[key: string]: any;
|
|
3102
|
+
}> | null;
|
|
3103
|
+
/**
|
|
3104
|
+
* A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
|
|
3105
|
+
*/
|
|
3106
|
+
message?: string | null;
|
|
3107
|
+
}
|
|
3009
3108
|
/**
|
|
3010
3109
|
* Initial sync flags for certain Cloud SQL APIs. Currently used for the MySQL external server initial dump.
|
|
3011
3110
|
*/
|
|
@@ -3087,6 +3186,10 @@ export declare namespace sqladmin_v1 {
|
|
|
3087
3186
|
* A Cloud SQL user resource.
|
|
3088
3187
|
*/
|
|
3089
3188
|
export interface Schema$User {
|
|
3189
|
+
/**
|
|
3190
|
+
* Optional. Role memberships of the user
|
|
3191
|
+
*/
|
|
3192
|
+
databaseRoles?: string[] | null;
|
|
3090
3193
|
/**
|
|
3091
3194
|
* Dual password status for the user.
|
|
3092
3195
|
*/
|
|
@@ -3099,6 +3202,10 @@ export declare namespace sqladmin_v1 {
|
|
|
3099
3202
|
* Optional. The host from which the user can connect. For `insert` operations, host defaults to an empty string. For `update` operations, host is specified as part of the request URL. The host name cannot be updated after insertion. For a MySQL instance, it's required; for a PostgreSQL or SQL Server instance, it's optional.
|
|
3100
3203
|
*/
|
|
3101
3204
|
host?: string | null;
|
|
3205
|
+
/**
|
|
3206
|
+
* Optional. The full email for an IAM user. For normal database users, this will not be filled. Only applicable to MySQL database users.
|
|
3207
|
+
*/
|
|
3208
|
+
iamEmail?: string | null;
|
|
3102
3209
|
/**
|
|
3103
3210
|
* Indicates if a group is active or inactive for IAM database authentication.
|
|
3104
3211
|
*/
|
|
@@ -5295,9 +5402,9 @@ export declare namespace sqladmin_v1 {
|
|
|
5295
5402
|
*
|
|
5296
5403
|
* // Do the magic
|
|
5297
5404
|
* const res = await sql.instances.clone({
|
|
5298
|
-
* // The ID of the Cloud SQL instance to be cloned (source). This does not include the project ID.
|
|
5405
|
+
* // Required. The ID of the Cloud SQL instance to be cloned (source). This does not include the project ID.
|
|
5299
5406
|
* instance: 'placeholder-value',
|
|
5300
|
-
* // Project ID of the source as well as the clone Cloud SQL instance.
|
|
5407
|
+
* // Required. Project ID of the source as well as the clone Cloud SQL instance.
|
|
5301
5408
|
* project: 'placeholder-value',
|
|
5302
5409
|
*
|
|
5303
5410
|
* // Request body metadata
|
|
@@ -5687,7 +5794,8 @@ export declare namespace sqladmin_v1 {
|
|
|
5687
5794
|
* // {
|
|
5688
5795
|
* // "messages": [],
|
|
5689
5796
|
* // "metadata": {},
|
|
5690
|
-
* // "results": []
|
|
5797
|
+
* // "results": [],
|
|
5798
|
+
* // "status": {}
|
|
5691
5799
|
* // }
|
|
5692
5800
|
* }
|
|
5693
5801
|
*
|
|
@@ -5924,9 +6032,9 @@ export declare namespace sqladmin_v1 {
|
|
|
5924
6032
|
*
|
|
5925
6033
|
* // Do the magic
|
|
5926
6034
|
* const res = await sql.instances.get({
|
|
5927
|
-
* // Database instance ID. This does not include the project ID.
|
|
6035
|
+
* // Required. Database instance ID. This does not include the project ID.
|
|
5928
6036
|
* instance: 'placeholder-value',
|
|
5929
|
-
* // Project ID of the project that contains the instance.
|
|
6037
|
+
* // Required. Project ID of the project that contains the instance.
|
|
5930
6038
|
* project: 'placeholder-value',
|
|
5931
6039
|
* });
|
|
5932
6040
|
* console.log(res.data);
|
|
@@ -6306,6 +6414,73 @@ export declare namespace sqladmin_v1 {
|
|
|
6306
6414
|
list(params: Params$Resource$Instances$List, options: MethodOptions | BodyResponseCallback<Schema$InstancesListResponse>, callback: BodyResponseCallback<Schema$InstancesListResponse>): void;
|
|
6307
6415
|
list(params: Params$Resource$Instances$List, callback: BodyResponseCallback<Schema$InstancesListResponse>): void;
|
|
6308
6416
|
list(callback: BodyResponseCallback<Schema$InstancesListResponse>): void;
|
|
6417
|
+
/**
|
|
6418
|
+
* 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.
|
|
6419
|
+
* @example
|
|
6420
|
+
* ```js
|
|
6421
|
+
* // Before running the sample:
|
|
6422
|
+
* // - Enable the API at:
|
|
6423
|
+
* // https://console.developers.google.com/apis/api/sqladmin.googleapis.com
|
|
6424
|
+
* // - Login into gcloud by running:
|
|
6425
|
+
* // ```sh
|
|
6426
|
+
* // $ gcloud auth application-default login
|
|
6427
|
+
* // ```
|
|
6428
|
+
* // - Install the npm module by running:
|
|
6429
|
+
* // ```sh
|
|
6430
|
+
* // $ npm install googleapis
|
|
6431
|
+
* // ```
|
|
6432
|
+
*
|
|
6433
|
+
* const {google} = require('googleapis');
|
|
6434
|
+
* const sqladmin = google.sqladmin('v1');
|
|
6435
|
+
*
|
|
6436
|
+
* async function main() {
|
|
6437
|
+
* const auth = new google.auth.GoogleAuth({
|
|
6438
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
6439
|
+
* scopes: [
|
|
6440
|
+
* 'https://www.googleapis.com/auth/cloud-platform',
|
|
6441
|
+
* 'https://www.googleapis.com/auth/sqlservice.admin',
|
|
6442
|
+
* ],
|
|
6443
|
+
* });
|
|
6444
|
+
*
|
|
6445
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
6446
|
+
* const authClient = await auth.getClient();
|
|
6447
|
+
* google.options({auth: authClient});
|
|
6448
|
+
*
|
|
6449
|
+
* // Do the magic
|
|
6450
|
+
* const res = await sql.instances.ListEntraIdCertificates({
|
|
6451
|
+
* // Required. Cloud SQL instance ID. This does not include the project ID.
|
|
6452
|
+
* instance: 'placeholder-value',
|
|
6453
|
+
* // Required. Project ID of the project that contains the instance.
|
|
6454
|
+
* project: 'placeholder-value',
|
|
6455
|
+
* });
|
|
6456
|
+
* console.log(res.data);
|
|
6457
|
+
*
|
|
6458
|
+
* // Example response
|
|
6459
|
+
* // {
|
|
6460
|
+
* // "activeVersion": "my_activeVersion",
|
|
6461
|
+
* // "certs": [],
|
|
6462
|
+
* // "kind": "my_kind"
|
|
6463
|
+
* // }
|
|
6464
|
+
* }
|
|
6465
|
+
*
|
|
6466
|
+
* main().catch(e => {
|
|
6467
|
+
* console.error(e);
|
|
6468
|
+
* throw e;
|
|
6469
|
+
* });
|
|
6470
|
+
*
|
|
6471
|
+
* ```
|
|
6472
|
+
*
|
|
6473
|
+
* @param params - Parameters for request
|
|
6474
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
6475
|
+
* @param callback - Optional callback that handles the response.
|
|
6476
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
6477
|
+
*/
|
|
6478
|
+
ListEntraIdCertificates(params: Params$Resource$Instances$Listentraidcertificates, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
6479
|
+
ListEntraIdCertificates(params?: Params$Resource$Instances$Listentraidcertificates, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$InstancesListEntraIdCertificatesResponse>>;
|
|
6480
|
+
ListEntraIdCertificates(params: Params$Resource$Instances$Listentraidcertificates, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
6481
|
+
ListEntraIdCertificates(params: Params$Resource$Instances$Listentraidcertificates, options: MethodOptions | BodyResponseCallback<Schema$InstancesListEntraIdCertificatesResponse>, callback: BodyResponseCallback<Schema$InstancesListEntraIdCertificatesResponse>): void;
|
|
6482
|
+
ListEntraIdCertificates(params: Params$Resource$Instances$Listentraidcertificates, callback: BodyResponseCallback<Schema$InstancesListEntraIdCertificatesResponse>): void;
|
|
6483
|
+
ListEntraIdCertificates(callback: BodyResponseCallback<Schema$InstancesListEntraIdCertificatesResponse>): void;
|
|
6309
6484
|
/**
|
|
6310
6485
|
* 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.
|
|
6311
6486
|
* @example
|
|
@@ -7280,6 +7455,98 @@ export declare namespace sqladmin_v1 {
|
|
|
7280
7455
|
restoreBackup(params: Params$Resource$Instances$Restorebackup, options: MethodOptions | BodyResponseCallback<Schema$Operation>, callback: BodyResponseCallback<Schema$Operation>): void;
|
|
7281
7456
|
restoreBackup(params: Params$Resource$Instances$Restorebackup, callback: BodyResponseCallback<Schema$Operation>): void;
|
|
7282
7457
|
restoreBackup(callback: BodyResponseCallback<Schema$Operation>): void;
|
|
7458
|
+
/**
|
|
7459
|
+
* Rotates the server certificate version to one previously added with the addEntraIdCertificate method.
|
|
7460
|
+
* @example
|
|
7461
|
+
* ```js
|
|
7462
|
+
* // Before running the sample:
|
|
7463
|
+
* // - Enable the API at:
|
|
7464
|
+
* // https://console.developers.google.com/apis/api/sqladmin.googleapis.com
|
|
7465
|
+
* // - Login into gcloud by running:
|
|
7466
|
+
* // ```sh
|
|
7467
|
+
* // $ gcloud auth application-default login
|
|
7468
|
+
* // ```
|
|
7469
|
+
* // - Install the npm module by running:
|
|
7470
|
+
* // ```sh
|
|
7471
|
+
* // $ npm install googleapis
|
|
7472
|
+
* // ```
|
|
7473
|
+
*
|
|
7474
|
+
* const {google} = require('googleapis');
|
|
7475
|
+
* const sqladmin = google.sqladmin('v1');
|
|
7476
|
+
*
|
|
7477
|
+
* async function main() {
|
|
7478
|
+
* const auth = new google.auth.GoogleAuth({
|
|
7479
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
7480
|
+
* scopes: [
|
|
7481
|
+
* 'https://www.googleapis.com/auth/cloud-platform',
|
|
7482
|
+
* 'https://www.googleapis.com/auth/sqlservice.admin',
|
|
7483
|
+
* ],
|
|
7484
|
+
* });
|
|
7485
|
+
*
|
|
7486
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
7487
|
+
* const authClient = await auth.getClient();
|
|
7488
|
+
* google.options({auth: authClient});
|
|
7489
|
+
*
|
|
7490
|
+
* // Do the magic
|
|
7491
|
+
* const res = await sql.instances.RotateEntraIdCertificate({
|
|
7492
|
+
* // Required. Cloud SQL instance ID. This does not include the project ID.
|
|
7493
|
+
* instance: 'placeholder-value',
|
|
7494
|
+
* // Required. Project ID of the project that contains the instance.
|
|
7495
|
+
* project: 'placeholder-value',
|
|
7496
|
+
*
|
|
7497
|
+
* // Request body metadata
|
|
7498
|
+
* requestBody: {
|
|
7499
|
+
* // request body parameters
|
|
7500
|
+
* // {
|
|
7501
|
+
* // "rotateEntraIdCertificateContext": {}
|
|
7502
|
+
* // }
|
|
7503
|
+
* },
|
|
7504
|
+
* });
|
|
7505
|
+
* console.log(res.data);
|
|
7506
|
+
*
|
|
7507
|
+
* // Example response
|
|
7508
|
+
* // {
|
|
7509
|
+
* // "acquireSsrsLeaseContext": {},
|
|
7510
|
+
* // "apiWarning": {},
|
|
7511
|
+
* // "backupContext": {},
|
|
7512
|
+
* // "endTime": "my_endTime",
|
|
7513
|
+
* // "error": {},
|
|
7514
|
+
* // "exportContext": {},
|
|
7515
|
+
* // "importContext": {},
|
|
7516
|
+
* // "insertTime": "my_insertTime",
|
|
7517
|
+
* // "kind": "my_kind",
|
|
7518
|
+
* // "name": "my_name",
|
|
7519
|
+
* // "operationType": "my_operationType",
|
|
7520
|
+
* // "preCheckMajorVersionUpgradeContext": {},
|
|
7521
|
+
* // "selfLink": "my_selfLink",
|
|
7522
|
+
* // "startTime": "my_startTime",
|
|
7523
|
+
* // "status": "my_status",
|
|
7524
|
+
* // "subOperationType": {},
|
|
7525
|
+
* // "targetId": "my_targetId",
|
|
7526
|
+
* // "targetLink": "my_targetLink",
|
|
7527
|
+
* // "targetProject": "my_targetProject",
|
|
7528
|
+
* // "user": "my_user"
|
|
7529
|
+
* // }
|
|
7530
|
+
* }
|
|
7531
|
+
*
|
|
7532
|
+
* main().catch(e => {
|
|
7533
|
+
* console.error(e);
|
|
7534
|
+
* throw e;
|
|
7535
|
+
* });
|
|
7536
|
+
*
|
|
7537
|
+
* ```
|
|
7538
|
+
*
|
|
7539
|
+
* @param params - Parameters for request
|
|
7540
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
7541
|
+
* @param callback - Optional callback that handles the response.
|
|
7542
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
7543
|
+
*/
|
|
7544
|
+
RotateEntraIdCertificate(params: Params$Resource$Instances$Rotateentraidcertificate, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
7545
|
+
RotateEntraIdCertificate(params?: Params$Resource$Instances$Rotateentraidcertificate, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$Operation>>;
|
|
7546
|
+
RotateEntraIdCertificate(params: Params$Resource$Instances$Rotateentraidcertificate, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
7547
|
+
RotateEntraIdCertificate(params: Params$Resource$Instances$Rotateentraidcertificate, options: MethodOptions | BodyResponseCallback<Schema$Operation>, callback: BodyResponseCallback<Schema$Operation>): void;
|
|
7548
|
+
RotateEntraIdCertificate(params: Params$Resource$Instances$Rotateentraidcertificate, callback: BodyResponseCallback<Schema$Operation>): void;
|
|
7549
|
+
RotateEntraIdCertificate(callback: BodyResponseCallback<Schema$Operation>): void;
|
|
7283
7550
|
/**
|
|
7284
7551
|
* 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.
|
|
7285
7552
|
* @example
|
|
@@ -7989,11 +8256,11 @@ export declare namespace sqladmin_v1 {
|
|
|
7989
8256
|
}
|
|
7990
8257
|
export interface Params$Resource$Instances$Clone extends StandardParameters {
|
|
7991
8258
|
/**
|
|
7992
|
-
* The ID of the Cloud SQL instance to be cloned (source). This does not include the project ID.
|
|
8259
|
+
* Required. The ID of the Cloud SQL instance to be cloned (source). This does not include the project ID.
|
|
7993
8260
|
*/
|
|
7994
8261
|
instance?: string;
|
|
7995
8262
|
/**
|
|
7996
|
-
* Project ID of the source as well as the clone Cloud SQL instance.
|
|
8263
|
+
* Required. Project ID of the source as well as the clone Cloud SQL instance.
|
|
7997
8264
|
*/
|
|
7998
8265
|
project?: string;
|
|
7999
8266
|
/**
|
|
@@ -8099,11 +8366,11 @@ export declare namespace sqladmin_v1 {
|
|
|
8099
8366
|
}
|
|
8100
8367
|
export interface Params$Resource$Instances$Get extends StandardParameters {
|
|
8101
8368
|
/**
|
|
8102
|
-
* Database instance ID. This does not include the project ID.
|
|
8369
|
+
* Required. Database instance ID. This does not include the project ID.
|
|
8103
8370
|
*/
|
|
8104
8371
|
instance?: string;
|
|
8105
8372
|
/**
|
|
8106
|
-
* Project ID of the project that contains the instance.
|
|
8373
|
+
* Required. Project ID of the project that contains the instance.
|
|
8107
8374
|
*/
|
|
8108
8375
|
project?: string;
|
|
8109
8376
|
}
|
|
@@ -8149,6 +8416,16 @@ export declare namespace sqladmin_v1 {
|
|
|
8149
8416
|
*/
|
|
8150
8417
|
project?: string;
|
|
8151
8418
|
}
|
|
8419
|
+
export interface Params$Resource$Instances$Listentraidcertificates extends StandardParameters {
|
|
8420
|
+
/**
|
|
8421
|
+
* Required. Cloud SQL instance ID. This does not include the project ID.
|
|
8422
|
+
*/
|
|
8423
|
+
instance?: string;
|
|
8424
|
+
/**
|
|
8425
|
+
* Required. Project ID of the project that contains the instance.
|
|
8426
|
+
*/
|
|
8427
|
+
project?: string;
|
|
8428
|
+
}
|
|
8152
8429
|
export interface Params$Resource$Instances$Listservercas extends StandardParameters {
|
|
8153
8430
|
/**
|
|
8154
8431
|
* Cloud SQL instance ID. This does not include the project ID.
|
|
@@ -8283,6 +8560,20 @@ export declare namespace sqladmin_v1 {
|
|
|
8283
8560
|
*/
|
|
8284
8561
|
requestBody?: Schema$InstancesRestoreBackupRequest;
|
|
8285
8562
|
}
|
|
8563
|
+
export interface Params$Resource$Instances$Rotateentraidcertificate extends StandardParameters {
|
|
8564
|
+
/**
|
|
8565
|
+
* Required. Cloud SQL instance ID. This does not include the project ID.
|
|
8566
|
+
*/
|
|
8567
|
+
instance?: string;
|
|
8568
|
+
/**
|
|
8569
|
+
* Required. Project ID of the project that contains the instance.
|
|
8570
|
+
*/
|
|
8571
|
+
project?: string;
|
|
8572
|
+
/**
|
|
8573
|
+
* Request body metadata
|
|
8574
|
+
*/
|
|
8575
|
+
requestBody?: Schema$InstancesRotateEntraIdCertificateRequest;
|
|
8576
|
+
}
|
|
8286
8577
|
export interface Params$Resource$Instances$Rotateserverca extends StandardParameters {
|
|
8287
8578
|
/**
|
|
8288
8579
|
* Cloud SQL instance ID. This does not include the project ID.
|
|
@@ -8473,9 +8764,9 @@ export declare namespace sqladmin_v1 {
|
|
|
8473
8764
|
*
|
|
8474
8765
|
* // Do the magic
|
|
8475
8766
|
* const res = await sql.operations.get({
|
|
8476
|
-
* // Instance operation ID.
|
|
8767
|
+
* // Required. Instance operation ID.
|
|
8477
8768
|
* operation: 'placeholder-value',
|
|
8478
|
-
* // Project ID of the project that contains the instance.
|
|
8769
|
+
* // Required. Project ID of the project that contains the instance.
|
|
8479
8770
|
* project: 'placeholder-value',
|
|
8480
8771
|
* });
|
|
8481
8772
|
* console.log(res.data);
|
|
@@ -8607,11 +8898,11 @@ export declare namespace sqladmin_v1 {
|
|
|
8607
8898
|
}
|
|
8608
8899
|
export interface Params$Resource$Operations$Get extends StandardParameters {
|
|
8609
8900
|
/**
|
|
8610
|
-
* Instance operation ID.
|
|
8901
|
+
* Required. Instance operation ID.
|
|
8611
8902
|
*/
|
|
8612
8903
|
operation?: string;
|
|
8613
8904
|
/**
|
|
8614
|
-
* Project ID of the project that contains the instance.
|
|
8905
|
+
* Required. Project ID of the project that contains the instance.
|
|
8615
8906
|
*/
|
|
8616
8907
|
project?: string;
|
|
8617
8908
|
}
|
|
@@ -9991,9 +10282,11 @@ export declare namespace sqladmin_v1 {
|
|
|
9991
10282
|
*
|
|
9992
10283
|
* // Example response
|
|
9993
10284
|
* // {
|
|
10285
|
+
* // "databaseRoles": [],
|
|
9994
10286
|
* // "dualPasswordType": "my_dualPasswordType",
|
|
9995
10287
|
* // "etag": "my_etag",
|
|
9996
10288
|
* // "host": "my_host",
|
|
10289
|
+
* // "iamEmail": "my_iamEmail",
|
|
9997
10290
|
* // "iamStatus": "my_iamStatus",
|
|
9998
10291
|
* // "instance": "my_instance",
|
|
9999
10292
|
* // "kind": "my_kind",
|
|
@@ -10067,9 +10360,11 @@ export declare namespace sqladmin_v1 {
|
|
|
10067
10360
|
* requestBody: {
|
|
10068
10361
|
* // request body parameters
|
|
10069
10362
|
* // {
|
|
10363
|
+
* // "databaseRoles": [],
|
|
10070
10364
|
* // "dualPasswordType": "my_dualPasswordType",
|
|
10071
10365
|
* // "etag": "my_etag",
|
|
10072
10366
|
* // "host": "my_host",
|
|
10367
|
+
* // "iamEmail": "my_iamEmail",
|
|
10073
10368
|
* // "iamStatus": "my_iamStatus",
|
|
10074
10369
|
* // "instance": "my_instance",
|
|
10075
10370
|
* // "kind": "my_kind",
|
|
@@ -10228,6 +10523,8 @@ export declare namespace sqladmin_v1 {
|
|
|
10228
10523
|
*
|
|
10229
10524
|
* // Do the magic
|
|
10230
10525
|
* const res = await sql.users.update({
|
|
10526
|
+
* // Optional. List of database roles to grant to the user. body.database_roles will be ignored for update request.
|
|
10527
|
+
* databaseRoles: 'placeholder-value',
|
|
10231
10528
|
* // Optional. Host of the user in the instance.
|
|
10232
10529
|
* host: 'placeholder-value',
|
|
10233
10530
|
* // Database instance ID. This does not include the project ID.
|
|
@@ -10241,9 +10538,11 @@ export declare namespace sqladmin_v1 {
|
|
|
10241
10538
|
* requestBody: {
|
|
10242
10539
|
* // request body parameters
|
|
10243
10540
|
* // {
|
|
10541
|
+
* // "databaseRoles": [],
|
|
10244
10542
|
* // "dualPasswordType": "my_dualPasswordType",
|
|
10245
10543
|
* // "etag": "my_etag",
|
|
10246
10544
|
* // "host": "my_host",
|
|
10545
|
+
* // "iamEmail": "my_iamEmail",
|
|
10247
10546
|
* // "iamStatus": "my_iamStatus",
|
|
10248
10547
|
* // "instance": "my_instance",
|
|
10249
10548
|
* // "kind": "my_kind",
|
|
@@ -10363,6 +10662,10 @@ export declare namespace sqladmin_v1 {
|
|
|
10363
10662
|
project?: string;
|
|
10364
10663
|
}
|
|
10365
10664
|
export interface Params$Resource$Users$Update extends StandardParameters {
|
|
10665
|
+
/**
|
|
10666
|
+
* Optional. List of database roles to grant to the user. body.database_roles will be ignored for update request.
|
|
10667
|
+
*/
|
|
10668
|
+
databaseRoles?: string[];
|
|
10366
10669
|
/**
|
|
10367
10670
|
* Optional. Host of the user in the instance.
|
|
10368
10671
|
*/
|
package/build/v1.js
CHANGED
|
@@ -1122,6 +1122,39 @@ var sqladmin_v1;
|
|
|
1122
1122
|
return (0, googleapis_common_1.createAPIRequest)(parameters);
|
|
1123
1123
|
}
|
|
1124
1124
|
}
|
|
1125
|
+
ListEntraIdCertificates(paramsOrCallback, optionsOrCallback, callback) {
|
|
1126
|
+
let params = (paramsOrCallback ||
|
|
1127
|
+
{});
|
|
1128
|
+
let options = (optionsOrCallback || {});
|
|
1129
|
+
if (typeof paramsOrCallback === 'function') {
|
|
1130
|
+
callback = paramsOrCallback;
|
|
1131
|
+
params = {};
|
|
1132
|
+
options = {};
|
|
1133
|
+
}
|
|
1134
|
+
if (typeof optionsOrCallback === 'function') {
|
|
1135
|
+
callback = optionsOrCallback;
|
|
1136
|
+
options = {};
|
|
1137
|
+
}
|
|
1138
|
+
const rootUrl = options.rootUrl || 'https://sqladmin.googleapis.com/';
|
|
1139
|
+
const parameters = {
|
|
1140
|
+
options: Object.assign({
|
|
1141
|
+
url: (rootUrl +
|
|
1142
|
+
'/v1/projects/{project}/instances/{instance}/listEntraIdCertificates').replace(/([^:]\/)\/+/g, '$1'),
|
|
1143
|
+
method: 'GET',
|
|
1144
|
+
apiVersion: '',
|
|
1145
|
+
}, options),
|
|
1146
|
+
params,
|
|
1147
|
+
requiredParams: ['project', 'instance'],
|
|
1148
|
+
pathParams: ['instance', 'project'],
|
|
1149
|
+
context: this.context,
|
|
1150
|
+
};
|
|
1151
|
+
if (callback) {
|
|
1152
|
+
(0, googleapis_common_1.createAPIRequest)(parameters, callback);
|
|
1153
|
+
}
|
|
1154
|
+
else {
|
|
1155
|
+
return (0, googleapis_common_1.createAPIRequest)(parameters);
|
|
1156
|
+
}
|
|
1157
|
+
}
|
|
1125
1158
|
listServerCas(paramsOrCallback, optionsOrCallback, callback) {
|
|
1126
1159
|
let params = (paramsOrCallback ||
|
|
1127
1160
|
{});
|
|
@@ -1480,6 +1513,39 @@ var sqladmin_v1;
|
|
|
1480
1513
|
return (0, googleapis_common_1.createAPIRequest)(parameters);
|
|
1481
1514
|
}
|
|
1482
1515
|
}
|
|
1516
|
+
RotateEntraIdCertificate(paramsOrCallback, optionsOrCallback, callback) {
|
|
1517
|
+
let params = (paramsOrCallback ||
|
|
1518
|
+
{});
|
|
1519
|
+
let options = (optionsOrCallback || {});
|
|
1520
|
+
if (typeof paramsOrCallback === 'function') {
|
|
1521
|
+
callback = paramsOrCallback;
|
|
1522
|
+
params = {};
|
|
1523
|
+
options = {};
|
|
1524
|
+
}
|
|
1525
|
+
if (typeof optionsOrCallback === 'function') {
|
|
1526
|
+
callback = optionsOrCallback;
|
|
1527
|
+
options = {};
|
|
1528
|
+
}
|
|
1529
|
+
const rootUrl = options.rootUrl || 'https://sqladmin.googleapis.com/';
|
|
1530
|
+
const parameters = {
|
|
1531
|
+
options: Object.assign({
|
|
1532
|
+
url: (rootUrl +
|
|
1533
|
+
'/v1/projects/{project}/instances/{instance}/rotateEntraIdCertificate').replace(/([^:]\/)\/+/g, '$1'),
|
|
1534
|
+
method: 'POST',
|
|
1535
|
+
apiVersion: '',
|
|
1536
|
+
}, options),
|
|
1537
|
+
params,
|
|
1538
|
+
requiredParams: ['project', 'instance'],
|
|
1539
|
+
pathParams: ['instance', 'project'],
|
|
1540
|
+
context: this.context,
|
|
1541
|
+
};
|
|
1542
|
+
if (callback) {
|
|
1543
|
+
(0, googleapis_common_1.createAPIRequest)(parameters, callback);
|
|
1544
|
+
}
|
|
1545
|
+
else {
|
|
1546
|
+
return (0, googleapis_common_1.createAPIRequest)(parameters);
|
|
1547
|
+
}
|
|
1548
|
+
}
|
|
1483
1549
|
rotateServerCa(paramsOrCallback, optionsOrCallback, callback) {
|
|
1484
1550
|
let params = (paramsOrCallback ||
|
|
1485
1551
|
{});
|