@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/v1beta4.d.ts
CHANGED
|
@@ -1084,7 +1084,7 @@ export declare namespace sqladmin_v1beta4 {
|
|
|
1084
1084
|
*/
|
|
1085
1085
|
database?: string | null;
|
|
1086
1086
|
/**
|
|
1087
|
-
* Optional. Controls how the API should respond when the SQL execution result
|
|
1087
|
+
* 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.
|
|
1088
1088
|
*/
|
|
1089
1089
|
partialResultMode?: string | null;
|
|
1090
1090
|
/**
|
|
@@ -1514,6 +1514,23 @@ export declare namespace sqladmin_v1beta4 {
|
|
|
1514
1514
|
*/
|
|
1515
1515
|
importContext?: Schema$ImportContext;
|
|
1516
1516
|
}
|
|
1517
|
+
/**
|
|
1518
|
+
* Instances ListEntraIdCertificates response.
|
|
1519
|
+
*/
|
|
1520
|
+
export interface Schema$InstancesListEntraIdCertificatesResponse {
|
|
1521
|
+
/**
|
|
1522
|
+
* The `sha1_fingerprint` of the active certificate from `certs`.
|
|
1523
|
+
*/
|
|
1524
|
+
activeVersion?: string | null;
|
|
1525
|
+
/**
|
|
1526
|
+
* List of Entra ID certificates for the instance.
|
|
1527
|
+
*/
|
|
1528
|
+
certs?: Schema$SslCert[];
|
|
1529
|
+
/**
|
|
1530
|
+
* This is always `sql#instancesListEntraIdCertificates`.
|
|
1531
|
+
*/
|
|
1532
|
+
kind?: string | null;
|
|
1533
|
+
}
|
|
1517
1534
|
/**
|
|
1518
1535
|
* Database instances list response.
|
|
1519
1536
|
*/
|
|
@@ -1613,6 +1630,15 @@ export declare namespace sqladmin_v1beta4 {
|
|
|
1613
1630
|
*/
|
|
1614
1631
|
restoreInstanceSettings?: Schema$DatabaseInstance;
|
|
1615
1632
|
}
|
|
1633
|
+
/**
|
|
1634
|
+
* Rotate Entra ID Certificate request.
|
|
1635
|
+
*/
|
|
1636
|
+
export interface Schema$InstancesRotateEntraIdCertificateRequest {
|
|
1637
|
+
/**
|
|
1638
|
+
* Optional. Contains details about the rotate Entra ID certificate operation.
|
|
1639
|
+
*/
|
|
1640
|
+
rotateEntraIdCertificateContext?: Schema$RotateEntraIdCertificateContext;
|
|
1641
|
+
}
|
|
1616
1642
|
/**
|
|
1617
1643
|
* Rotate Server CA request.
|
|
1618
1644
|
*/
|
|
@@ -1697,6 +1723,10 @@ export declare namespace sqladmin_v1beta4 {
|
|
|
1697
1723
|
* 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\}
|
|
1698
1724
|
*/
|
|
1699
1725
|
serverCaPool?: string | null;
|
|
1726
|
+
/**
|
|
1727
|
+
* 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.
|
|
1728
|
+
*/
|
|
1729
|
+
serverCertificateRotationMode?: string | null;
|
|
1700
1730
|
/**
|
|
1701
1731
|
* 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.
|
|
1702
1732
|
*/
|
|
@@ -2125,7 +2155,7 @@ export declare namespace sqladmin_v1beta4 {
|
|
|
2125
2155
|
targetSizeGb?: string | null;
|
|
2126
2156
|
}
|
|
2127
2157
|
/**
|
|
2128
|
-
* Context to perform a point-in-time restore of an instance managed by
|
|
2158
|
+
* Context to perform a point-in-time restore of an instance managed by Backup and Disaster Recovery (DR) Service.
|
|
2129
2159
|
*/
|
|
2130
2160
|
export interface Schema$PointInTimeRestoreContext {
|
|
2131
2161
|
/**
|
|
@@ -2133,7 +2163,7 @@ export declare namespace sqladmin_v1beta4 {
|
|
|
2133
2163
|
*/
|
|
2134
2164
|
allocatedIpRange?: string | null;
|
|
2135
2165
|
/**
|
|
2136
|
-
* The
|
|
2166
|
+
* The Backup and Disaster Recovery (DR) Service Datasource URI. Format: projects/{project\}/locations/{region\}/backupVaults/{backupvault\}/dataSources/{datasource\}.
|
|
2137
2167
|
*/
|
|
2138
2168
|
datasource?: string | null;
|
|
2139
2169
|
/**
|
|
@@ -2279,13 +2309,17 @@ export declare namespace sqladmin_v1beta4 {
|
|
|
2279
2309
|
*/
|
|
2280
2310
|
message?: string | null;
|
|
2281
2311
|
/**
|
|
2282
|
-
* Set to true if the SQL execution's result is truncated due to size limits.
|
|
2312
|
+
* Set to true if the SQL execution's result is truncated due to size limits or an error retrieving results.
|
|
2283
2313
|
*/
|
|
2284
2314
|
partialResult?: boolean | null;
|
|
2285
2315
|
/**
|
|
2286
2316
|
* Rows returned by the SQL statement.
|
|
2287
2317
|
*/
|
|
2288
2318
|
rows?: Schema$Row[];
|
|
2319
|
+
/**
|
|
2320
|
+
* If results were truncated due to an error, details of that error.
|
|
2321
|
+
*/
|
|
2322
|
+
status?: Schema$Status;
|
|
2289
2323
|
}
|
|
2290
2324
|
/**
|
|
2291
2325
|
* The read pool auto-scale configuration.
|
|
@@ -2389,6 +2423,19 @@ export declare namespace sqladmin_v1beta4 {
|
|
|
2389
2423
|
*/
|
|
2390
2424
|
project?: string | null;
|
|
2391
2425
|
}
|
|
2426
|
+
/**
|
|
2427
|
+
* Instance rotate Entra ID certificate context.
|
|
2428
|
+
*/
|
|
2429
|
+
export interface Schema$RotateEntraIdCertificateContext {
|
|
2430
|
+
/**
|
|
2431
|
+
* Optional. This is always `sql#rotateEntraIdCertificateContext`.
|
|
2432
|
+
*/
|
|
2433
|
+
kind?: string | null;
|
|
2434
|
+
/**
|
|
2435
|
+
* 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.
|
|
2436
|
+
*/
|
|
2437
|
+
nextVersion?: string | null;
|
|
2438
|
+
}
|
|
2392
2439
|
/**
|
|
2393
2440
|
* Instance rotate server CA context.
|
|
2394
2441
|
*/
|
|
@@ -2453,6 +2500,10 @@ export declare namespace sqladmin_v1beta4 {
|
|
|
2453
2500
|
* The App Engine app IDs that can access this instance. (Deprecated) Applied to First Generation instances only.
|
|
2454
2501
|
*/
|
|
2455
2502
|
authorizedGaeApplications?: string[] | null;
|
|
2503
|
+
/**
|
|
2504
|
+
* 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.
|
|
2505
|
+
*/
|
|
2506
|
+
autoUpgradeEnabled?: boolean | null;
|
|
2456
2507
|
/**
|
|
2457
2508
|
* 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).
|
|
2458
2509
|
*/
|
|
@@ -2477,6 +2528,10 @@ export declare namespace sqladmin_v1beta4 {
|
|
|
2477
2528
|
* 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.
|
|
2478
2529
|
*/
|
|
2479
2530
|
crashSafeReplicationEnabled?: boolean | null;
|
|
2531
|
+
/**
|
|
2532
|
+
* This parameter controls whether to allow using ExecuteSql API to connect to the instance. Not allowed by default.
|
|
2533
|
+
*/
|
|
2534
|
+
dataApiAccess?: string | null;
|
|
2480
2535
|
/**
|
|
2481
2536
|
* The database flags passed to the instance at startup.
|
|
2482
2537
|
*/
|
|
@@ -2525,6 +2580,10 @@ export declare namespace sqladmin_v1beta4 {
|
|
|
2525
2580
|
* 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.
|
|
2526
2581
|
*/
|
|
2527
2582
|
enableGoogleMlIntegration?: boolean | null;
|
|
2583
|
+
/**
|
|
2584
|
+
* Optional. The Microsoft Entra ID configuration for the SQL Server instance.
|
|
2585
|
+
*/
|
|
2586
|
+
entraidConfig?: Schema$SqlServerEntraIdConfig;
|
|
2528
2587
|
/**
|
|
2529
2588
|
* Optional. The final backup configuration for the instance.
|
|
2530
2589
|
*/
|
|
@@ -2659,6 +2718,11 @@ export declare namespace sqladmin_v1beta4 {
|
|
|
2659
2718
|
*/
|
|
2660
2719
|
operationId?: string | null;
|
|
2661
2720
|
}
|
|
2721
|
+
/**
|
|
2722
|
+
* Request for AddEntraIdCertificate RPC.
|
|
2723
|
+
*/
|
|
2724
|
+
export interface Schema$SqlInstancesAddEntraIdCertificateRequest {
|
|
2725
|
+
}
|
|
2662
2726
|
/**
|
|
2663
2727
|
* Execute SQL statements response.
|
|
2664
2728
|
*/
|
|
@@ -2675,6 +2739,10 @@ export declare namespace sqladmin_v1beta4 {
|
|
|
2675
2739
|
* The list of results after executing all the SQL statements.
|
|
2676
2740
|
*/
|
|
2677
2741
|
results?: Schema$QueryResult[];
|
|
2742
|
+
/**
|
|
2743
|
+
* Contains the error from the database if the SQL execution failed.
|
|
2744
|
+
*/
|
|
2745
|
+
status?: Schema$Status;
|
|
2678
2746
|
}
|
|
2679
2747
|
/**
|
|
2680
2748
|
* Instance get disk shrink config response.
|
|
@@ -2871,6 +2939,23 @@ export declare namespace sqladmin_v1beta4 {
|
|
|
2871
2939
|
*/
|
|
2872
2940
|
recoveryModel?: string | null;
|
|
2873
2941
|
}
|
|
2942
|
+
/**
|
|
2943
|
+
* SQL Server Entra ID configuration.
|
|
2944
|
+
*/
|
|
2945
|
+
export interface Schema$SqlServerEntraIdConfig {
|
|
2946
|
+
/**
|
|
2947
|
+
* Optional. The application ID for the Entra ID configuration.
|
|
2948
|
+
*/
|
|
2949
|
+
applicationId?: string | null;
|
|
2950
|
+
/**
|
|
2951
|
+
* Output only. This is always sql#sqlServerEntraIdConfig
|
|
2952
|
+
*/
|
|
2953
|
+
kind?: string | null;
|
|
2954
|
+
/**
|
|
2955
|
+
* Optional. The tenant ID for the Entra ID configuration.
|
|
2956
|
+
*/
|
|
2957
|
+
tenantId?: string | null;
|
|
2958
|
+
}
|
|
2874
2959
|
/**
|
|
2875
2960
|
* Represents a Sql Server user on the Cloud SQL instance.
|
|
2876
2961
|
*/
|
|
@@ -3003,6 +3088,25 @@ export declare namespace sqladmin_v1beta4 {
|
|
|
3003
3088
|
*/
|
|
3004
3089
|
kind?: string | null;
|
|
3005
3090
|
}
|
|
3091
|
+
/**
|
|
3092
|
+
* 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).
|
|
3093
|
+
*/
|
|
3094
|
+
export interface Schema$Status {
|
|
3095
|
+
/**
|
|
3096
|
+
* The status code, which should be an enum value of google.rpc.Code.
|
|
3097
|
+
*/
|
|
3098
|
+
code?: number | null;
|
|
3099
|
+
/**
|
|
3100
|
+
* A list of messages that carry the error details. There is a common set of message types for APIs to use.
|
|
3101
|
+
*/
|
|
3102
|
+
details?: Array<{
|
|
3103
|
+
[key: string]: any;
|
|
3104
|
+
}> | null;
|
|
3105
|
+
/**
|
|
3106
|
+
* 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.
|
|
3107
|
+
*/
|
|
3108
|
+
message?: string | null;
|
|
3109
|
+
}
|
|
3006
3110
|
/**
|
|
3007
3111
|
* Initial sync flags for certain Cloud SQL APIs. Currently used for the MySQL external server initial dump.
|
|
3008
3112
|
*/
|
|
@@ -3084,6 +3188,10 @@ export declare namespace sqladmin_v1beta4 {
|
|
|
3084
3188
|
* A Cloud SQL user resource.
|
|
3085
3189
|
*/
|
|
3086
3190
|
export interface Schema$User {
|
|
3191
|
+
/**
|
|
3192
|
+
* Optional. Role memberships of the user
|
|
3193
|
+
*/
|
|
3194
|
+
databaseRoles?: string[] | null;
|
|
3087
3195
|
/**
|
|
3088
3196
|
* Dual password status for the user.
|
|
3089
3197
|
*/
|
|
@@ -3096,6 +3204,10 @@ export declare namespace sqladmin_v1beta4 {
|
|
|
3096
3204
|
* 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.
|
|
3097
3205
|
*/
|
|
3098
3206
|
host?: string | null;
|
|
3207
|
+
/**
|
|
3208
|
+
* Optional. The full email for an IAM user. For normal database users, this will not be filled. Only applicable to MySQL database users.
|
|
3209
|
+
*/
|
|
3210
|
+
iamEmail?: string | null;
|
|
3099
3211
|
/**
|
|
3100
3212
|
* Indicates if a group is active or inactive for IAM database authentication.
|
|
3101
3213
|
*/
|
|
@@ -5090,6 +5202,96 @@ export declare namespace sqladmin_v1beta4 {
|
|
|
5090
5202
|
acquireSsrsLease(params: Params$Resource$Instances$Acquiressrslease, options: MethodOptions | BodyResponseCallback<Schema$SqlInstancesAcquireSsrsLeaseResponse>, callback: BodyResponseCallback<Schema$SqlInstancesAcquireSsrsLeaseResponse>): void;
|
|
5091
5203
|
acquireSsrsLease(params: Params$Resource$Instances$Acquiressrslease, callback: BodyResponseCallback<Schema$SqlInstancesAcquireSsrsLeaseResponse>): void;
|
|
5092
5204
|
acquireSsrsLease(callback: BodyResponseCallback<Schema$SqlInstancesAcquireSsrsLeaseResponse>): void;
|
|
5205
|
+
/**
|
|
5206
|
+
* 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.
|
|
5207
|
+
* @example
|
|
5208
|
+
* ```js
|
|
5209
|
+
* // Before running the sample:
|
|
5210
|
+
* // - Enable the API at:
|
|
5211
|
+
* // https://console.developers.google.com/apis/api/sqladmin.googleapis.com
|
|
5212
|
+
* // - Login into gcloud by running:
|
|
5213
|
+
* // ```sh
|
|
5214
|
+
* // $ gcloud auth application-default login
|
|
5215
|
+
* // ```
|
|
5216
|
+
* // - Install the npm module by running:
|
|
5217
|
+
* // ```sh
|
|
5218
|
+
* // $ npm install googleapis
|
|
5219
|
+
* // ```
|
|
5220
|
+
*
|
|
5221
|
+
* const {google} = require('googleapis');
|
|
5222
|
+
* const sqladmin = google.sqladmin('v1beta4');
|
|
5223
|
+
*
|
|
5224
|
+
* async function main() {
|
|
5225
|
+
* const auth = new google.auth.GoogleAuth({
|
|
5226
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
5227
|
+
* scopes: [
|
|
5228
|
+
* 'https://www.googleapis.com/auth/cloud-platform',
|
|
5229
|
+
* 'https://www.googleapis.com/auth/sqlservice.admin',
|
|
5230
|
+
* ],
|
|
5231
|
+
* });
|
|
5232
|
+
*
|
|
5233
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
5234
|
+
* const authClient = await auth.getClient();
|
|
5235
|
+
* google.options({auth: authClient});
|
|
5236
|
+
*
|
|
5237
|
+
* // Do the magic
|
|
5238
|
+
* const res = await sql.instances.addEntraIdCertificate({
|
|
5239
|
+
* // Required. Cloud SQL instance ID. This does not include the project ID.
|
|
5240
|
+
* instance: 'placeholder-value',
|
|
5241
|
+
* // Required. Project ID of the project that contains the instance.
|
|
5242
|
+
* project: 'placeholder-value',
|
|
5243
|
+
*
|
|
5244
|
+
* // Request body metadata
|
|
5245
|
+
* requestBody: {
|
|
5246
|
+
* // request body parameters
|
|
5247
|
+
* // {}
|
|
5248
|
+
* },
|
|
5249
|
+
* });
|
|
5250
|
+
* console.log(res.data);
|
|
5251
|
+
*
|
|
5252
|
+
* // Example response
|
|
5253
|
+
* // {
|
|
5254
|
+
* // "acquireSsrsLeaseContext": {},
|
|
5255
|
+
* // "apiWarning": {},
|
|
5256
|
+
* // "backupContext": {},
|
|
5257
|
+
* // "endTime": "my_endTime",
|
|
5258
|
+
* // "error": {},
|
|
5259
|
+
* // "exportContext": {},
|
|
5260
|
+
* // "importContext": {},
|
|
5261
|
+
* // "insertTime": "my_insertTime",
|
|
5262
|
+
* // "kind": "my_kind",
|
|
5263
|
+
* // "name": "my_name",
|
|
5264
|
+
* // "operationType": "my_operationType",
|
|
5265
|
+
* // "preCheckMajorVersionUpgradeContext": {},
|
|
5266
|
+
* // "selfLink": "my_selfLink",
|
|
5267
|
+
* // "startTime": "my_startTime",
|
|
5268
|
+
* // "status": "my_status",
|
|
5269
|
+
* // "subOperationType": {},
|
|
5270
|
+
* // "targetId": "my_targetId",
|
|
5271
|
+
* // "targetLink": "my_targetLink",
|
|
5272
|
+
* // "targetProject": "my_targetProject",
|
|
5273
|
+
* // "user": "my_user"
|
|
5274
|
+
* // }
|
|
5275
|
+
* }
|
|
5276
|
+
*
|
|
5277
|
+
* main().catch(e => {
|
|
5278
|
+
* console.error(e);
|
|
5279
|
+
* throw e;
|
|
5280
|
+
* });
|
|
5281
|
+
*
|
|
5282
|
+
* ```
|
|
5283
|
+
*
|
|
5284
|
+
* @param params - Parameters for request
|
|
5285
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
5286
|
+
* @param callback - Optional callback that handles the response.
|
|
5287
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
5288
|
+
*/
|
|
5289
|
+
addEntraIdCertificate(params: Params$Resource$Instances$Addentraidcertificate, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
5290
|
+
addEntraIdCertificate(params?: Params$Resource$Instances$Addentraidcertificate, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$Operation>>;
|
|
5291
|
+
addEntraIdCertificate(params: Params$Resource$Instances$Addentraidcertificate, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
5292
|
+
addEntraIdCertificate(params: Params$Resource$Instances$Addentraidcertificate, options: MethodOptions | BodyResponseCallback<Schema$Operation>, callback: BodyResponseCallback<Schema$Operation>): void;
|
|
5293
|
+
addEntraIdCertificate(params: Params$Resource$Instances$Addentraidcertificate, callback: BodyResponseCallback<Schema$Operation>): void;
|
|
5294
|
+
addEntraIdCertificate(callback: BodyResponseCallback<Schema$Operation>): void;
|
|
5093
5295
|
/**
|
|
5094
5296
|
* 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.
|
|
5095
5297
|
* @example
|
|
@@ -5684,7 +5886,8 @@ export declare namespace sqladmin_v1beta4 {
|
|
|
5684
5886
|
* // {
|
|
5685
5887
|
* // "messages": [],
|
|
5686
5888
|
* // "metadata": {},
|
|
5687
|
-
* // "results": []
|
|
5889
|
+
* // "results": [],
|
|
5890
|
+
* // "status": {}
|
|
5688
5891
|
* // }
|
|
5689
5892
|
* }
|
|
5690
5893
|
*
|
|
@@ -6303,6 +6506,73 @@ export declare namespace sqladmin_v1beta4 {
|
|
|
6303
6506
|
list(params: Params$Resource$Instances$List, options: MethodOptions | BodyResponseCallback<Schema$InstancesListResponse>, callback: BodyResponseCallback<Schema$InstancesListResponse>): void;
|
|
6304
6507
|
list(params: Params$Resource$Instances$List, callback: BodyResponseCallback<Schema$InstancesListResponse>): void;
|
|
6305
6508
|
list(callback: BodyResponseCallback<Schema$InstancesListResponse>): void;
|
|
6509
|
+
/**
|
|
6510
|
+
* 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.
|
|
6511
|
+
* @example
|
|
6512
|
+
* ```js
|
|
6513
|
+
* // Before running the sample:
|
|
6514
|
+
* // - Enable the API at:
|
|
6515
|
+
* // https://console.developers.google.com/apis/api/sqladmin.googleapis.com
|
|
6516
|
+
* // - Login into gcloud by running:
|
|
6517
|
+
* // ```sh
|
|
6518
|
+
* // $ gcloud auth application-default login
|
|
6519
|
+
* // ```
|
|
6520
|
+
* // - Install the npm module by running:
|
|
6521
|
+
* // ```sh
|
|
6522
|
+
* // $ npm install googleapis
|
|
6523
|
+
* // ```
|
|
6524
|
+
*
|
|
6525
|
+
* const {google} = require('googleapis');
|
|
6526
|
+
* const sqladmin = google.sqladmin('v1beta4');
|
|
6527
|
+
*
|
|
6528
|
+
* async function main() {
|
|
6529
|
+
* const auth = new google.auth.GoogleAuth({
|
|
6530
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
6531
|
+
* scopes: [
|
|
6532
|
+
* 'https://www.googleapis.com/auth/cloud-platform',
|
|
6533
|
+
* 'https://www.googleapis.com/auth/sqlservice.admin',
|
|
6534
|
+
* ],
|
|
6535
|
+
* });
|
|
6536
|
+
*
|
|
6537
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
6538
|
+
* const authClient = await auth.getClient();
|
|
6539
|
+
* google.options({auth: authClient});
|
|
6540
|
+
*
|
|
6541
|
+
* // Do the magic
|
|
6542
|
+
* const res = await sql.instances.ListEntraIdCertificates({
|
|
6543
|
+
* // Required. Cloud SQL instance ID. This does not include the project ID.
|
|
6544
|
+
* instance: 'placeholder-value',
|
|
6545
|
+
* // Required. Project ID of the project that contains the instance.
|
|
6546
|
+
* project: 'placeholder-value',
|
|
6547
|
+
* });
|
|
6548
|
+
* console.log(res.data);
|
|
6549
|
+
*
|
|
6550
|
+
* // Example response
|
|
6551
|
+
* // {
|
|
6552
|
+
* // "activeVersion": "my_activeVersion",
|
|
6553
|
+
* // "certs": [],
|
|
6554
|
+
* // "kind": "my_kind"
|
|
6555
|
+
* // }
|
|
6556
|
+
* }
|
|
6557
|
+
*
|
|
6558
|
+
* main().catch(e => {
|
|
6559
|
+
* console.error(e);
|
|
6560
|
+
* throw e;
|
|
6561
|
+
* });
|
|
6562
|
+
*
|
|
6563
|
+
* ```
|
|
6564
|
+
*
|
|
6565
|
+
* @param params - Parameters for request
|
|
6566
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
6567
|
+
* @param callback - Optional callback that handles the response.
|
|
6568
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
6569
|
+
*/
|
|
6570
|
+
ListEntraIdCertificates(params: Params$Resource$Instances$Listentraidcertificates, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
6571
|
+
ListEntraIdCertificates(params?: Params$Resource$Instances$Listentraidcertificates, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$InstancesListEntraIdCertificatesResponse>>;
|
|
6572
|
+
ListEntraIdCertificates(params: Params$Resource$Instances$Listentraidcertificates, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
6573
|
+
ListEntraIdCertificates(params: Params$Resource$Instances$Listentraidcertificates, options: MethodOptions | BodyResponseCallback<Schema$InstancesListEntraIdCertificatesResponse>, callback: BodyResponseCallback<Schema$InstancesListEntraIdCertificatesResponse>): void;
|
|
6574
|
+
ListEntraIdCertificates(params: Params$Resource$Instances$Listentraidcertificates, callback: BodyResponseCallback<Schema$InstancesListEntraIdCertificatesResponse>): void;
|
|
6575
|
+
ListEntraIdCertificates(callback: BodyResponseCallback<Schema$InstancesListEntraIdCertificatesResponse>): void;
|
|
6306
6576
|
/**
|
|
6307
6577
|
* 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.
|
|
6308
6578
|
* @example
|
|
@@ -7277,6 +7547,98 @@ export declare namespace sqladmin_v1beta4 {
|
|
|
7277
7547
|
restoreBackup(params: Params$Resource$Instances$Restorebackup, options: MethodOptions | BodyResponseCallback<Schema$Operation>, callback: BodyResponseCallback<Schema$Operation>): void;
|
|
7278
7548
|
restoreBackup(params: Params$Resource$Instances$Restorebackup, callback: BodyResponseCallback<Schema$Operation>): void;
|
|
7279
7549
|
restoreBackup(callback: BodyResponseCallback<Schema$Operation>): void;
|
|
7550
|
+
/**
|
|
7551
|
+
* Rotates the Entra Id certificate version to one previously added with the addEntraIdCertificate method.
|
|
7552
|
+
* @example
|
|
7553
|
+
* ```js
|
|
7554
|
+
* // Before running the sample:
|
|
7555
|
+
* // - Enable the API at:
|
|
7556
|
+
* // https://console.developers.google.com/apis/api/sqladmin.googleapis.com
|
|
7557
|
+
* // - Login into gcloud by running:
|
|
7558
|
+
* // ```sh
|
|
7559
|
+
* // $ gcloud auth application-default login
|
|
7560
|
+
* // ```
|
|
7561
|
+
* // - Install the npm module by running:
|
|
7562
|
+
* // ```sh
|
|
7563
|
+
* // $ npm install googleapis
|
|
7564
|
+
* // ```
|
|
7565
|
+
*
|
|
7566
|
+
* const {google} = require('googleapis');
|
|
7567
|
+
* const sqladmin = google.sqladmin('v1beta4');
|
|
7568
|
+
*
|
|
7569
|
+
* async function main() {
|
|
7570
|
+
* const auth = new google.auth.GoogleAuth({
|
|
7571
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
7572
|
+
* scopes: [
|
|
7573
|
+
* 'https://www.googleapis.com/auth/cloud-platform',
|
|
7574
|
+
* 'https://www.googleapis.com/auth/sqlservice.admin',
|
|
7575
|
+
* ],
|
|
7576
|
+
* });
|
|
7577
|
+
*
|
|
7578
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
7579
|
+
* const authClient = await auth.getClient();
|
|
7580
|
+
* google.options({auth: authClient});
|
|
7581
|
+
*
|
|
7582
|
+
* // Do the magic
|
|
7583
|
+
* const res = await sql.instances.RotateEntraIdCertificate({
|
|
7584
|
+
* // Required. Cloud SQL instance ID. This does not include the project ID.
|
|
7585
|
+
* instance: 'placeholder-value',
|
|
7586
|
+
* // Required. Project ID of the project that contains the instance.
|
|
7587
|
+
* project: 'placeholder-value',
|
|
7588
|
+
*
|
|
7589
|
+
* // Request body metadata
|
|
7590
|
+
* requestBody: {
|
|
7591
|
+
* // request body parameters
|
|
7592
|
+
* // {
|
|
7593
|
+
* // "rotateEntraIdCertificateContext": {}
|
|
7594
|
+
* // }
|
|
7595
|
+
* },
|
|
7596
|
+
* });
|
|
7597
|
+
* console.log(res.data);
|
|
7598
|
+
*
|
|
7599
|
+
* // Example response
|
|
7600
|
+
* // {
|
|
7601
|
+
* // "acquireSsrsLeaseContext": {},
|
|
7602
|
+
* // "apiWarning": {},
|
|
7603
|
+
* // "backupContext": {},
|
|
7604
|
+
* // "endTime": "my_endTime",
|
|
7605
|
+
* // "error": {},
|
|
7606
|
+
* // "exportContext": {},
|
|
7607
|
+
* // "importContext": {},
|
|
7608
|
+
* // "insertTime": "my_insertTime",
|
|
7609
|
+
* // "kind": "my_kind",
|
|
7610
|
+
* // "name": "my_name",
|
|
7611
|
+
* // "operationType": "my_operationType",
|
|
7612
|
+
* // "preCheckMajorVersionUpgradeContext": {},
|
|
7613
|
+
* // "selfLink": "my_selfLink",
|
|
7614
|
+
* // "startTime": "my_startTime",
|
|
7615
|
+
* // "status": "my_status",
|
|
7616
|
+
* // "subOperationType": {},
|
|
7617
|
+
* // "targetId": "my_targetId",
|
|
7618
|
+
* // "targetLink": "my_targetLink",
|
|
7619
|
+
* // "targetProject": "my_targetProject",
|
|
7620
|
+
* // "user": "my_user"
|
|
7621
|
+
* // }
|
|
7622
|
+
* }
|
|
7623
|
+
*
|
|
7624
|
+
* main().catch(e => {
|
|
7625
|
+
* console.error(e);
|
|
7626
|
+
* throw e;
|
|
7627
|
+
* });
|
|
7628
|
+
*
|
|
7629
|
+
* ```
|
|
7630
|
+
*
|
|
7631
|
+
* @param params - Parameters for request
|
|
7632
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
7633
|
+
* @param callback - Optional callback that handles the response.
|
|
7634
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
7635
|
+
*/
|
|
7636
|
+
RotateEntraIdCertificate(params: Params$Resource$Instances$Rotateentraidcertificate, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
7637
|
+
RotateEntraIdCertificate(params?: Params$Resource$Instances$Rotateentraidcertificate, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$Operation>>;
|
|
7638
|
+
RotateEntraIdCertificate(params: Params$Resource$Instances$Rotateentraidcertificate, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
7639
|
+
RotateEntraIdCertificate(params: Params$Resource$Instances$Rotateentraidcertificate, options: MethodOptions | BodyResponseCallback<Schema$Operation>, callback: BodyResponseCallback<Schema$Operation>): void;
|
|
7640
|
+
RotateEntraIdCertificate(params: Params$Resource$Instances$Rotateentraidcertificate, callback: BodyResponseCallback<Schema$Operation>): void;
|
|
7641
|
+
RotateEntraIdCertificate(callback: BodyResponseCallback<Schema$Operation>): void;
|
|
7280
7642
|
/**
|
|
7281
7643
|
* 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.
|
|
7282
7644
|
* @example
|
|
@@ -7964,6 +8326,20 @@ export declare namespace sqladmin_v1beta4 {
|
|
|
7964
8326
|
*/
|
|
7965
8327
|
requestBody?: Schema$InstancesAcquireSsrsLeaseRequest;
|
|
7966
8328
|
}
|
|
8329
|
+
export interface Params$Resource$Instances$Addentraidcertificate extends StandardParameters {
|
|
8330
|
+
/**
|
|
8331
|
+
* Required. Cloud SQL instance ID. This does not include the project ID.
|
|
8332
|
+
*/
|
|
8333
|
+
instance?: string;
|
|
8334
|
+
/**
|
|
8335
|
+
* Required. Project ID of the project that contains the instance.
|
|
8336
|
+
*/
|
|
8337
|
+
project?: string;
|
|
8338
|
+
/**
|
|
8339
|
+
* Request body metadata
|
|
8340
|
+
*/
|
|
8341
|
+
requestBody?: Schema$SqlInstancesAddEntraIdCertificateRequest;
|
|
8342
|
+
}
|
|
7967
8343
|
export interface Params$Resource$Instances$Addserverca extends StandardParameters {
|
|
7968
8344
|
/**
|
|
7969
8345
|
* Cloud SQL instance ID. This does not include the project ID.
|
|
@@ -8146,6 +8522,16 @@ export declare namespace sqladmin_v1beta4 {
|
|
|
8146
8522
|
*/
|
|
8147
8523
|
project?: string;
|
|
8148
8524
|
}
|
|
8525
|
+
export interface Params$Resource$Instances$Listentraidcertificates extends StandardParameters {
|
|
8526
|
+
/**
|
|
8527
|
+
* Required. Cloud SQL instance ID. This does not include the project ID.
|
|
8528
|
+
*/
|
|
8529
|
+
instance?: string;
|
|
8530
|
+
/**
|
|
8531
|
+
* Required. Project ID of the project that contains the instance.
|
|
8532
|
+
*/
|
|
8533
|
+
project?: string;
|
|
8534
|
+
}
|
|
8149
8535
|
export interface Params$Resource$Instances$Listservercas extends StandardParameters {
|
|
8150
8536
|
/**
|
|
8151
8537
|
* Cloud SQL instance ID. This does not include the project ID.
|
|
@@ -8280,6 +8666,20 @@ export declare namespace sqladmin_v1beta4 {
|
|
|
8280
8666
|
*/
|
|
8281
8667
|
requestBody?: Schema$InstancesRestoreBackupRequest;
|
|
8282
8668
|
}
|
|
8669
|
+
export interface Params$Resource$Instances$Rotateentraidcertificate extends StandardParameters {
|
|
8670
|
+
/**
|
|
8671
|
+
* Required. Cloud SQL instance ID. This does not include the project ID.
|
|
8672
|
+
*/
|
|
8673
|
+
instance?: string;
|
|
8674
|
+
/**
|
|
8675
|
+
* Required. Project ID of the project that contains the instance.
|
|
8676
|
+
*/
|
|
8677
|
+
project?: string;
|
|
8678
|
+
/**
|
|
8679
|
+
* Request body metadata
|
|
8680
|
+
*/
|
|
8681
|
+
requestBody?: Schema$InstancesRotateEntraIdCertificateRequest;
|
|
8682
|
+
}
|
|
8283
8683
|
export interface Params$Resource$Instances$Rotateserverca extends StandardParameters {
|
|
8284
8684
|
/**
|
|
8285
8685
|
* Cloud SQL instance ID. This does not include the project ID.
|
|
@@ -9988,9 +10388,11 @@ export declare namespace sqladmin_v1beta4 {
|
|
|
9988
10388
|
*
|
|
9989
10389
|
* // Example response
|
|
9990
10390
|
* // {
|
|
10391
|
+
* // "databaseRoles": [],
|
|
9991
10392
|
* // "dualPasswordType": "my_dualPasswordType",
|
|
9992
10393
|
* // "etag": "my_etag",
|
|
9993
10394
|
* // "host": "my_host",
|
|
10395
|
+
* // "iamEmail": "my_iamEmail",
|
|
9994
10396
|
* // "iamStatus": "my_iamStatus",
|
|
9995
10397
|
* // "instance": "my_instance",
|
|
9996
10398
|
* // "kind": "my_kind",
|
|
@@ -10064,9 +10466,11 @@ export declare namespace sqladmin_v1beta4 {
|
|
|
10064
10466
|
* requestBody: {
|
|
10065
10467
|
* // request body parameters
|
|
10066
10468
|
* // {
|
|
10469
|
+
* // "databaseRoles": [],
|
|
10067
10470
|
* // "dualPasswordType": "my_dualPasswordType",
|
|
10068
10471
|
* // "etag": "my_etag",
|
|
10069
10472
|
* // "host": "my_host",
|
|
10473
|
+
* // "iamEmail": "my_iamEmail",
|
|
10070
10474
|
* // "iamStatus": "my_iamStatus",
|
|
10071
10475
|
* // "instance": "my_instance",
|
|
10072
10476
|
* // "kind": "my_kind",
|
|
@@ -10225,6 +10629,8 @@ export declare namespace sqladmin_v1beta4 {
|
|
|
10225
10629
|
*
|
|
10226
10630
|
* // Do the magic
|
|
10227
10631
|
* const res = await sql.users.update({
|
|
10632
|
+
* // Optional. List of database roles to grant to the user. body.database_roles will be ignored for update request.
|
|
10633
|
+
* databaseRoles: 'placeholder-value',
|
|
10228
10634
|
* // Optional. Host of the user in the instance.
|
|
10229
10635
|
* host: 'placeholder-value',
|
|
10230
10636
|
* // Database instance ID. This does not include the project ID.
|
|
@@ -10233,14 +10639,18 @@ export declare namespace sqladmin_v1beta4 {
|
|
|
10233
10639
|
* name: 'placeholder-value',
|
|
10234
10640
|
* // Project ID of the project that contains the instance.
|
|
10235
10641
|
* project: 'placeholder-value',
|
|
10642
|
+
* // Optional. revoke the existing roles granted to the user.
|
|
10643
|
+
* revokeExistingRoles: 'placeholder-value',
|
|
10236
10644
|
*
|
|
10237
10645
|
* // Request body metadata
|
|
10238
10646
|
* requestBody: {
|
|
10239
10647
|
* // request body parameters
|
|
10240
10648
|
* // {
|
|
10649
|
+
* // "databaseRoles": [],
|
|
10241
10650
|
* // "dualPasswordType": "my_dualPasswordType",
|
|
10242
10651
|
* // "etag": "my_etag",
|
|
10243
10652
|
* // "host": "my_host",
|
|
10653
|
+
* // "iamEmail": "my_iamEmail",
|
|
10244
10654
|
* // "iamStatus": "my_iamStatus",
|
|
10245
10655
|
* // "instance": "my_instance",
|
|
10246
10656
|
* // "kind": "my_kind",
|
|
@@ -10360,6 +10770,10 @@ export declare namespace sqladmin_v1beta4 {
|
|
|
10360
10770
|
project?: string;
|
|
10361
10771
|
}
|
|
10362
10772
|
export interface Params$Resource$Users$Update extends StandardParameters {
|
|
10773
|
+
/**
|
|
10774
|
+
* Optional. List of database roles to grant to the user. body.database_roles will be ignored for update request.
|
|
10775
|
+
*/
|
|
10776
|
+
databaseRoles?: string[];
|
|
10363
10777
|
/**
|
|
10364
10778
|
* Optional. Host of the user in the instance.
|
|
10365
10779
|
*/
|
|
@@ -10376,6 +10790,10 @@ export declare namespace sqladmin_v1beta4 {
|
|
|
10376
10790
|
* Project ID of the project that contains the instance.
|
|
10377
10791
|
*/
|
|
10378
10792
|
project?: string;
|
|
10793
|
+
/**
|
|
10794
|
+
* Optional. revoke the existing roles granted to the user.
|
|
10795
|
+
*/
|
|
10796
|
+
revokeExistingRoles?: boolean;
|
|
10379
10797
|
/**
|
|
10380
10798
|
* Request body metadata
|
|
10381
10799
|
*/
|