azure_service.proto 29 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701
  1. // Copyright 2022 Google LLC
  2. //
  3. // Licensed under the Apache License, Version 2.0 (the "License");
  4. // you may not use this file except in compliance with the License.
  5. // You may obtain a copy of the License at
  6. //
  7. // http://www.apache.org/licenses/LICENSE-2.0
  8. //
  9. // Unless required by applicable law or agreed to in writing, software
  10. // distributed under the License is distributed on an "AS IS" BASIS,
  11. // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12. // See the License for the specific language governing permissions and
  13. // limitations under the License.
  14. syntax = "proto3";
  15. package google.cloud.gkemulticloud.v1;
  16. import "google/api/annotations.proto";
  17. import "google/api/client.proto";
  18. import "google/api/field_behavior.proto";
  19. import "google/api/resource.proto";
  20. import "google/cloud/gkemulticloud/v1/azure_resources.proto";
  21. import "google/longrunning/operations.proto";
  22. import "google/protobuf/field_mask.proto";
  23. import "google/protobuf/timestamp.proto";
  24. option csharp_namespace = "Google.Cloud.GkeMultiCloud.V1";
  25. option go_package = "google.golang.org/genproto/googleapis/cloud/gkemulticloud/v1;gkemulticloud";
  26. option java_multiple_files = true;
  27. option java_outer_classname = "AzureServiceProto";
  28. option java_package = "com.google.cloud.gkemulticloud.v1";
  29. option php_namespace = "Google\\Cloud\\GkeMultiCloud\\V1";
  30. option ruby_package = "Google::Cloud::GkeMultiCloud::V1";
  31. // The AzureClusters API provides a single centrally managed service
  32. // to create and manage Anthos clusters that run on Azure infrastructure.
  33. service AzureClusters {
  34. option (google.api.default_host) = "gkemulticloud.googleapis.com";
  35. option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/cloud-platform";
  36. // Creates a new [AzureClient][google.cloud.gkemulticloud.v1.AzureClient] resource on a given Google Cloud project
  37. // and region.
  38. //
  39. // `AzureClient` resources hold client authentication
  40. // information needed by the Anthos Multicloud API to manage Azure resources
  41. // on your Azure subscription on your behalf.
  42. //
  43. // If successful, the response contains a newly created
  44. // [Operation][google.longrunning.Operation] resource that can be
  45. // described to track the status of the operation.
  46. rpc CreateAzureClient(CreateAzureClientRequest) returns (google.longrunning.Operation) {
  47. option (google.api.http) = {
  48. post: "/v1/{parent=projects/*/locations/*}/azureClients"
  49. body: "azure_client"
  50. };
  51. option (google.api.method_signature) = "parent,azure_client,azure_client_id";
  52. option (google.longrunning.operation_info) = {
  53. response_type: "AzureClient"
  54. metadata_type: "OperationMetadata"
  55. };
  56. }
  57. // Describes a specific [AzureClient][google.cloud.gkemulticloud.v1.AzureClient] resource.
  58. rpc GetAzureClient(GetAzureClientRequest) returns (AzureClient) {
  59. option (google.api.http) = {
  60. get: "/v1/{name=projects/*/locations/*/azureClients/*}"
  61. };
  62. option (google.api.method_signature) = "name";
  63. }
  64. // Lists all [AzureClient][google.cloud.gkemulticloud.v1.AzureClient] resources on a given Google Cloud project and
  65. // region.
  66. rpc ListAzureClients(ListAzureClientsRequest) returns (ListAzureClientsResponse) {
  67. option (google.api.http) = {
  68. get: "/v1/{parent=projects/*/locations/*}/azureClients"
  69. };
  70. option (google.api.method_signature) = "parent";
  71. }
  72. // Deletes a specific [AzureClient][google.cloud.gkemulticloud.v1.AzureClient] resource.
  73. //
  74. // If the client is used by one or more clusters, deletion will
  75. // fail and a `FAILED_PRECONDITION` error will be returned.
  76. //
  77. // If successful, the response contains a newly created
  78. // [Operation][google.longrunning.Operation] resource that can be
  79. // described to track the status of the operation.
  80. rpc DeleteAzureClient(DeleteAzureClientRequest) returns (google.longrunning.Operation) {
  81. option (google.api.http) = {
  82. delete: "/v1/{name=projects/*/locations/*/azureClients/*}"
  83. };
  84. option (google.api.method_signature) = "name";
  85. option (google.longrunning.operation_info) = {
  86. response_type: "google.protobuf.Empty"
  87. metadata_type: "OperationMetadata"
  88. };
  89. }
  90. // Creates a new [AzureCluster][google.cloud.gkemulticloud.v1.AzureCluster] resource on a given GCP project and region.
  91. //
  92. // If successful, the response contains a newly created
  93. // [Operation][google.longrunning.Operation] resource that can be
  94. // described to track the status of the operation.
  95. rpc CreateAzureCluster(CreateAzureClusterRequest) returns (google.longrunning.Operation) {
  96. option (google.api.http) = {
  97. post: "/v1/{parent=projects/*/locations/*}/azureClusters"
  98. body: "azure_cluster"
  99. };
  100. option (google.api.method_signature) = "parent,azure_cluster,azure_cluster_id";
  101. option (google.longrunning.operation_info) = {
  102. response_type: "AzureCluster"
  103. metadata_type: "OperationMetadata"
  104. };
  105. }
  106. // Updates an [AzureCluster][google.cloud.gkemulticloud.v1.AzureCluster].
  107. rpc UpdateAzureCluster(UpdateAzureClusterRequest) returns (google.longrunning.Operation) {
  108. option (google.api.http) = {
  109. patch: "/v1/{azure_cluster.name=projects/*/locations/*/azureClusters/*}"
  110. body: "azure_cluster"
  111. };
  112. option (google.api.method_signature) = "azure_cluster,update_mask";
  113. option (google.longrunning.operation_info) = {
  114. response_type: "AzureCluster"
  115. metadata_type: "OperationMetadata"
  116. };
  117. }
  118. // Describes a specific [AzureCluster][google.cloud.gkemulticloud.v1.AzureCluster] resource.
  119. rpc GetAzureCluster(GetAzureClusterRequest) returns (AzureCluster) {
  120. option (google.api.http) = {
  121. get: "/v1/{name=projects/*/locations/*/azureClusters/*}"
  122. };
  123. option (google.api.method_signature) = "name";
  124. }
  125. // Lists all [AzureCluster][google.cloud.gkemulticloud.v1.AzureCluster] resources on a given Google Cloud project and
  126. // region.
  127. rpc ListAzureClusters(ListAzureClustersRequest) returns (ListAzureClustersResponse) {
  128. option (google.api.http) = {
  129. get: "/v1/{parent=projects/*/locations/*}/azureClusters"
  130. };
  131. option (google.api.method_signature) = "parent";
  132. }
  133. // Deletes a specific [AzureCluster][google.cloud.gkemulticloud.v1.AzureCluster] resource.
  134. //
  135. // Fails if the cluster has one or more associated [AzureNodePool][google.cloud.gkemulticloud.v1.AzureNodePool]
  136. // resources.
  137. //
  138. // If successful, the response contains a newly created
  139. // [Operation][google.longrunning.Operation] resource that can be
  140. // described to track the status of the operation.
  141. rpc DeleteAzureCluster(DeleteAzureClusterRequest) returns (google.longrunning.Operation) {
  142. option (google.api.http) = {
  143. delete: "/v1/{name=projects/*/locations/*/azureClusters/*}"
  144. };
  145. option (google.api.method_signature) = "name";
  146. option (google.longrunning.operation_info) = {
  147. response_type: "google.protobuf.Empty"
  148. metadata_type: "OperationMetadata"
  149. };
  150. }
  151. // Generates a short-lived access token to authenticate to a given
  152. // [AzureCluster][google.cloud.gkemulticloud.v1.AzureCluster] resource.
  153. rpc GenerateAzureAccessToken(GenerateAzureAccessTokenRequest) returns (GenerateAzureAccessTokenResponse) {
  154. option (google.api.http) = {
  155. get: "/v1/{azure_cluster=projects/*/locations/*/azureClusters/*}:generateAzureAccessToken"
  156. };
  157. }
  158. // Creates a new [AzureNodePool][google.cloud.gkemulticloud.v1.AzureNodePool], attached to a given [AzureCluster][google.cloud.gkemulticloud.v1.AzureCluster].
  159. //
  160. // If successful, the response contains a newly created
  161. // [Operation][google.longrunning.Operation] resource that can be
  162. // described to track the status of the operation.
  163. rpc CreateAzureNodePool(CreateAzureNodePoolRequest) returns (google.longrunning.Operation) {
  164. option (google.api.http) = {
  165. post: "/v1/{parent=projects/*/locations/*/azureClusters/*}/azureNodePools"
  166. body: "azure_node_pool"
  167. };
  168. option (google.api.method_signature) = "parent,azure_node_pool,azure_node_pool_id";
  169. option (google.longrunning.operation_info) = {
  170. response_type: "AzureNodePool"
  171. metadata_type: "OperationMetadata"
  172. };
  173. }
  174. // Updates an [AzureNodePool][google.cloud.gkemulticloud.v1.AzureNodePool].
  175. rpc UpdateAzureNodePool(UpdateAzureNodePoolRequest) returns (google.longrunning.Operation) {
  176. option (google.api.http) = {
  177. patch: "/v1/{azure_node_pool.name=projects/*/locations/*/azureClusters/*/azureNodePools/*}"
  178. body: "azure_node_pool"
  179. };
  180. option (google.api.method_signature) = "azure_node_pool,update_mask";
  181. option (google.longrunning.operation_info) = {
  182. response_type: "AzureNodePool"
  183. metadata_type: "OperationMetadata"
  184. };
  185. }
  186. // Describes a specific [AzureNodePool][google.cloud.gkemulticloud.v1.AzureNodePool] resource.
  187. rpc GetAzureNodePool(GetAzureNodePoolRequest) returns (AzureNodePool) {
  188. option (google.api.http) = {
  189. get: "/v1/{name=projects/*/locations/*/azureClusters/*/azureNodePools/*}"
  190. };
  191. option (google.api.method_signature) = "name";
  192. }
  193. // Lists all [AzureNodePool][google.cloud.gkemulticloud.v1.AzureNodePool] resources on a given [AzureCluster][google.cloud.gkemulticloud.v1.AzureCluster].
  194. rpc ListAzureNodePools(ListAzureNodePoolsRequest) returns (ListAzureNodePoolsResponse) {
  195. option (google.api.http) = {
  196. get: "/v1/{parent=projects/*/locations/*/azureClusters/*}/azureNodePools"
  197. };
  198. option (google.api.method_signature) = "parent";
  199. }
  200. // Deletes a specific [AzureNodePool][google.cloud.gkemulticloud.v1.AzureNodePool] resource.
  201. //
  202. // If successful, the response contains a newly created
  203. // [Operation][google.longrunning.Operation] resource that can be
  204. // described to track the status of the operation.
  205. rpc DeleteAzureNodePool(DeleteAzureNodePoolRequest) returns (google.longrunning.Operation) {
  206. option (google.api.http) = {
  207. delete: "/v1/{name=projects/*/locations/*/azureClusters/*/azureNodePools/*}"
  208. };
  209. option (google.api.method_signature) = "name";
  210. option (google.longrunning.operation_info) = {
  211. response_type: "google.protobuf.Empty"
  212. metadata_type: "OperationMetadata"
  213. };
  214. }
  215. // Returns information, such as supported Azure regions and Kubernetes
  216. // versions, on a given Google Cloud location.
  217. rpc GetAzureServerConfig(GetAzureServerConfigRequest) returns (AzureServerConfig) {
  218. option (google.api.http) = {
  219. get: "/v1/{name=projects/*/locations/*/azureServerConfig}"
  220. };
  221. option (google.api.method_signature) = "name";
  222. }
  223. }
  224. // Request message for `AzureClusters.CreateAzureCluster` method.
  225. message CreateAzureClusterRequest {
  226. // Required. The parent location where this [AzureCluster][google.cloud.gkemulticloud.v1.AzureCluster] resource
  227. // will be created.
  228. //
  229. // Location names are formatted as `projects/<project-id>/locations/<region>`.
  230. //
  231. // See [Resource Names](https://cloud.google.com/apis/design/resource_names)
  232. // for more details on Google Cloud resource names.
  233. string parent = 1 [
  234. (google.api.field_behavior) = REQUIRED,
  235. (google.api.resource_reference) = {
  236. child_type: "gkemulticloud.googleapis.com/AzureCluster"
  237. }
  238. ];
  239. // Required. The specification of the [AzureCluster][google.cloud.gkemulticloud.v1.AzureCluster] to create.
  240. AzureCluster azure_cluster = 2 [(google.api.field_behavior) = REQUIRED];
  241. // Required. A client provided ID the resource. Must be unique within the parent
  242. // resource.
  243. //
  244. // The provided ID will be part of the [AzureCluster][google.cloud.gkemulticloud.v1.AzureCluster]
  245. // resource name formatted as
  246. // `projects/<project-id>/locations/<region>/azureClusters/<cluster-id>`.
  247. //
  248. // Valid characters are `/[a-z][0-9]-/`. Cannot be longer than 40 characters.
  249. string azure_cluster_id = 3 [(google.api.field_behavior) = REQUIRED];
  250. // If set, only validate the request, but do not actually create the cluster.
  251. bool validate_only = 4;
  252. }
  253. // Request message for `AzureClusters.UpdateAzureCluster` method.
  254. message UpdateAzureClusterRequest {
  255. // Required. The [AzureCluster][google.cloud.gkemulticloud.v1.AzureCluster] resource to update.
  256. AzureCluster azure_cluster = 1 [(google.api.field_behavior) = REQUIRED];
  257. // If set, only validate the request, but do not actually update the cluster.
  258. bool validate_only = 2;
  259. // Required. Mask of fields to update. At least one path must be supplied in
  260. // this field. The elements of the repeated paths field can only include these
  261. // fields from [AzureCluster][google.cloud.gkemulticloud.v1.AzureCluster]:
  262. //
  263. // * `description`.
  264. // * `annotations`.
  265. // * `azureClient`.
  266. // * `control_plane.version`.
  267. // * `control_plane.vm_size`.
  268. // * `authorization.admin_users`.
  269. // * `control_plane.root_volume.size_gib`.
  270. // * `logging_config`
  271. google.protobuf.FieldMask update_mask = 4 [(google.api.field_behavior) = REQUIRED];
  272. }
  273. // Request message for `AzureClusters.GetAzureCluster` method.
  274. message GetAzureClusterRequest {
  275. // Required. The name of the [AzureCluster][google.cloud.gkemulticloud.v1.AzureCluster] resource to describe.
  276. //
  277. // `AzureCluster` names are formatted as
  278. // `projects/<project-id>/locations/<region>/azureClusters/<cluster-id>`.
  279. //
  280. // See [Resource Names](https://cloud.google.com/apis/design/resource_names)
  281. // for more details on GCP resource names.
  282. string name = 1 [
  283. (google.api.field_behavior) = REQUIRED,
  284. (google.api.resource_reference) = {
  285. type: "gkemulticloud.googleapis.com/AzureCluster"
  286. }
  287. ];
  288. }
  289. // Request message for `AzureClusters.ListAzureClusters` method.
  290. message ListAzureClustersRequest {
  291. // Required. The parent location which owns this collection of
  292. // [AzureCluster][google.cloud.gkemulticloud.v1.AzureCluster] resources.
  293. //
  294. // Location names are formatted as `projects/<project-id>/locations/<region>`.
  295. //
  296. // See [Resource Names](https://cloud.google.com/apis/design/resource_names)
  297. // for more details on GCP resource names.
  298. string parent = 1 [
  299. (google.api.field_behavior) = REQUIRED,
  300. (google.api.resource_reference) = {
  301. child_type: "gkemulticloud.googleapis.com/AzureCluster"
  302. }
  303. ];
  304. // The maximum number of items to return.
  305. //
  306. // If not specified, a default value of 50 will be used by the service.
  307. // Regardless of the pageSize value, the response can include a partial list
  308. // and a caller should only rely on response's
  309. // [nextPageToken][google.cloud.gkemulticloud.v1.ListAzureClustersResponse.next_page_token] to determine if
  310. // there are more instances left to be queried.
  311. int32 page_size = 2;
  312. // The `nextPageToken` value returned from a previous
  313. // [azureClusters.list][google.cloud.gkemulticloud.v1.AzureClusters.ListAzureClusters] request, if any.
  314. string page_token = 3;
  315. }
  316. // Response message for `AzureClusters.ListAzureClusters` method.
  317. message ListAzureClustersResponse {
  318. // A list of [AzureCluster][google.cloud.gkemulticloud.v1.AzureCluster] resources in the specified GCP
  319. // project and region region.
  320. repeated AzureCluster azure_clusters = 1;
  321. // Token to retrieve the next page of results, or empty if there are no more
  322. // results in the list.
  323. string next_page_token = 2;
  324. }
  325. // Request message for `Clusters.DeleteAzureCluster` method.
  326. message DeleteAzureClusterRequest {
  327. // Required. The resource name the [AzureCluster][google.cloud.gkemulticloud.v1.AzureCluster] to delete.
  328. //
  329. // `AzureCluster` names are formatted as
  330. // `projects/<project-id>/locations/<region>/azureClusters/<cluster-id>`.
  331. //
  332. // See [Resource Names](https://cloud.google.com/apis/design/resource_names)
  333. // for more details on GCP resource names.
  334. string name = 1 [
  335. (google.api.field_behavior) = REQUIRED,
  336. (google.api.resource_reference) = {
  337. type: "gkemulticloud.googleapis.com/AzureCluster"
  338. }
  339. ];
  340. // If set to true, and the [AzureCluster][google.cloud.gkemulticloud.v1.AzureCluster] resource is not found,
  341. // the request will succeed but no action will be taken on the server and a
  342. // completed [Operation][google.longrunning.Operation] will be returned.
  343. //
  344. // Useful for idempotent deletion.
  345. bool allow_missing = 2;
  346. // If set, only validate the request, but do not actually delete the resource.
  347. bool validate_only = 3;
  348. // The current etag of the [AzureCluster][google.cloud.gkemulticloud.v1.AzureCluster].
  349. //
  350. // Allows clients to perform deletions through optimistic concurrency control.
  351. //
  352. // If the provided etag does not match the current etag of the cluster,
  353. // the request will fail and an ABORTED error will be returned.
  354. string etag = 4;
  355. }
  356. // Response message for `AzureClusters.CreateAzureNodePool` method.
  357. message CreateAzureNodePoolRequest {
  358. // Required. The [AzureCluster][google.cloud.gkemulticloud.v1.AzureCluster] resource where this node pool will be created.
  359. //
  360. // Location names are formatted as `projects/<project-id>/locations/<region>`.
  361. //
  362. // See [Resource Names](https://cloud.google.com/apis/design/resource_names)
  363. // for more details on Google Cloud resource names.
  364. string parent = 1 [
  365. (google.api.field_behavior) = REQUIRED,
  366. (google.api.resource_reference) = {
  367. child_type: "gkemulticloud.googleapis.com/AzureNodePool"
  368. }
  369. ];
  370. // Required. The specification of the [AzureNodePool][google.cloud.gkemulticloud.v1.AzureNodePool] to create.
  371. AzureNodePool azure_node_pool = 2 [(google.api.field_behavior) = REQUIRED];
  372. // Required. A client provided ID the resource. Must be unique within the parent
  373. // resource.
  374. //
  375. // The provided ID will be part of the [AzureNodePool][google.cloud.gkemulticloud.v1.AzureNodePool]
  376. // resource name formatted as
  377. // `projects/<project-id>/locations/<region>/azureClusters/<cluster-id>/azureNodePools/<node-pool-id>`.
  378. //
  379. // Valid characters are `/[a-z][0-9]-/`. Cannot be longer than 40 characters.
  380. string azure_node_pool_id = 3 [(google.api.field_behavior) = REQUIRED];
  381. // If set, only validate the request, but do not actually create the node
  382. // pool.
  383. bool validate_only = 4;
  384. }
  385. // Request message for `AzureClusters.UpdateAzureNodePool` method.
  386. message UpdateAzureNodePoolRequest {
  387. // Required. The [AzureNodePool][google.cloud.gkemulticloud.v1.AzureNodePool] resource to update.
  388. AzureNodePool azure_node_pool = 1 [(google.api.field_behavior) = REQUIRED];
  389. // If set, only validate the request, but don't actually update the node pool.
  390. bool validate_only = 2;
  391. // Required. Mask of fields to update. At least one path must be supplied in
  392. // this field. The elements of the repeated paths field can only include these
  393. // fields from [AzureNodePool][google.cloud.gkemulticloud.v1.AzureNodePool]:
  394. //
  395. // *. `annotations`.
  396. // * `version`.
  397. // * `autoscaling.min_node_count`.
  398. // * `autoscaling.max_node_count`.
  399. // * `config.vm_size`.
  400. google.protobuf.FieldMask update_mask = 3 [(google.api.field_behavior) = REQUIRED];
  401. }
  402. // Request message for `AzureClusters.GetAzureNodePool` method.
  403. message GetAzureNodePoolRequest {
  404. // Required. The name of the [AzureNodePool][google.cloud.gkemulticloud.v1.AzureNodePool] resource to describe.
  405. //
  406. // `AzureNodePool` names are formatted as
  407. // `projects/<project-id>/locations/<region>/azureClusters/<cluster-id>/azureNodePools/<node-pool-id>`.
  408. //
  409. // See [Resource Names](https://cloud.google.com/apis/design/resource_names)
  410. // for more details on Google Cloud resource names.
  411. string name = 1 [
  412. (google.api.field_behavior) = REQUIRED,
  413. (google.api.resource_reference) = {
  414. type: "gkemulticloud.googleapis.com/AzureNodePool"
  415. }
  416. ];
  417. }
  418. // Request message for `AzureClusters.ListAzureNodePools` method.
  419. message ListAzureNodePoolsRequest {
  420. // Required. The parent `AzureCluster` which owns this collection of
  421. // [AzureNodePool][google.cloud.gkemulticloud.v1.AzureNodePool] resources.
  422. //
  423. // `AzureCluster` names are formatted as
  424. // `projects/<project-id>/locations/<region>/azureClusters/<cluster-id>`.
  425. //
  426. // See [Resource Names](https://cloud.google.com/apis/design/resource_names)
  427. // for more details on Google Cloud resource names.
  428. string parent = 1 [
  429. (google.api.field_behavior) = REQUIRED,
  430. (google.api.resource_reference) = {
  431. child_type: "gkemulticloud.googleapis.com/AzureNodePool"
  432. }
  433. ];
  434. // The maximum number of items to return.
  435. //
  436. // If not specified, a default value of 50 will be used by the service.
  437. // Regardless of the pageSize value, the response can include a partial list
  438. // and a caller should only rely on response's
  439. // [nextPageToken][google.cloud.gkemulticloud.v1.ListAzureNodePoolsResponse.next_page_token] to determine if
  440. // there are more instances left to be queried.
  441. int32 page_size = 2;
  442. // The `nextPageToken` value returned from a previous
  443. // [azureNodePools.list][google.cloud.gkemulticloud.v1.AzureClusters.ListAzureNodePools] request, if any.
  444. string page_token = 3;
  445. }
  446. // Response message for `AzureClusters.ListAzureNodePools` method.
  447. message ListAzureNodePoolsResponse {
  448. // A list of [AzureNodePool][google.cloud.gkemulticloud.v1.AzureNodePool] resources in the specified `AzureCluster`.
  449. repeated AzureNodePool azure_node_pools = 1;
  450. // Token to retrieve the next page of results, or empty if there are no more
  451. // results in the list.
  452. string next_page_token = 2;
  453. }
  454. // Delete message for `AzureClusters.DeleteNodePool` method.
  455. message DeleteAzureNodePoolRequest {
  456. // Required. The resource name the [AzureNodePool][google.cloud.gkemulticloud.v1.AzureNodePool] to delete.
  457. //
  458. // `AzureNodePool` names are formatted as
  459. // `projects/<project-id>/locations/<region>/azureClusters/<cluster-id>/azureNodePools/<node-pool-id>`.
  460. //
  461. // See [Resource Names](https://cloud.google.com/apis/design/resource_names)
  462. // for more details on Google Cloud resource names.
  463. string name = 1 [
  464. (google.api.field_behavior) = REQUIRED,
  465. (google.api.resource_reference) = {
  466. type: "gkemulticloud.googleapis.com/AzureNodePool"
  467. }
  468. ];
  469. // If set, only validate the request, but do not actually delete the node
  470. // pool.
  471. bool validate_only = 2;
  472. // If set to true, and the [AzureNodePool][google.cloud.gkemulticloud.v1.AzureNodePool] resource is not found,
  473. // the request will succeed but no action will be taken on the server and a
  474. // completed [Operation][google.longrunning.Operation] will be returned.
  475. //
  476. // Useful for idempotent deletion.
  477. bool allow_missing = 3;
  478. // The current ETag of the [AzureNodePool][google.cloud.gkemulticloud.v1.AzureNodePool].
  479. //
  480. // Allows clients to perform deletions through optimistic concurrency control.
  481. //
  482. // If the provided ETag does not match the current etag of the node pool,
  483. // the request will fail and an ABORTED error will be returned.
  484. string etag = 4;
  485. }
  486. // GetAzureServerConfigRequest gets the server config of GKE cluster on Azure.
  487. message GetAzureServerConfigRequest {
  488. // Required. The name of the [AzureServerConfig][google.cloud.gkemulticloud.v1.AzureServerConfig] resource to describe.
  489. //
  490. // `AzureServerConfig` names are formatted as
  491. // `projects/<project-id>/locations/<region>/azureServerConfig`.
  492. //
  493. // See [Resource Names](https://cloud.google.com/apis/design/resource_names)
  494. // for more details on Google Cloud resource names.
  495. string name = 1 [
  496. (google.api.field_behavior) = REQUIRED,
  497. (google.api.resource_reference) = {
  498. type: "gkemulticloud.googleapis.com/AzureServerConfig"
  499. }
  500. ];
  501. }
  502. // Request message for `AzureClusters.CreateAzureClient` method.
  503. message CreateAzureClientRequest {
  504. // Required. The parent location where this [AzureClient][google.cloud.gkemulticloud.v1.AzureClient] resource
  505. // will be created.
  506. //
  507. // Location names are formatted as `projects/<project-id>/locations/<region>`.
  508. //
  509. // See [Resource Names](https://cloud.google.com/apis/design/resource_names)
  510. // for more details on Google Cloud resource names.
  511. string parent = 1 [
  512. (google.api.field_behavior) = REQUIRED,
  513. (google.api.resource_reference) = {
  514. child_type: "gkemulticloud.googleapis.com/AzureClient"
  515. }
  516. ];
  517. // Required. The specification of the [AzureClient][google.cloud.gkemulticloud.v1.AzureClient] to create.
  518. AzureClient azure_client = 2 [(google.api.field_behavior) = REQUIRED];
  519. // Required. A client provided ID the resource. Must be unique within the parent
  520. // resource.
  521. //
  522. // The provided ID will be part of the [AzureClient][google.cloud.gkemulticloud.v1.AzureClient]
  523. // resource name formatted as
  524. // `projects/<project-id>/locations/<region>/azureClients/<client-id>`.
  525. //
  526. // Valid characters are `/[a-z][0-9]-/`. Cannot be longer than 40 characters.
  527. string azure_client_id = 4 [(google.api.field_behavior) = REQUIRED];
  528. // If set, only validate the request, but do not actually create the client.
  529. bool validate_only = 3;
  530. }
  531. // Request message for `AzureClusters.GetAzureClient` method.
  532. message GetAzureClientRequest {
  533. // Required. The name of the [AzureClient][google.cloud.gkemulticloud.v1.AzureClient] resource to describe.
  534. //
  535. // [AzureClient][google.cloud.gkemulticloud.v1.AzureClient] names are formatted as
  536. // `projects/<project-id>/locations/<region>/azureClients/<client-id>`.
  537. //
  538. // See [Resource Names](https://cloud.google.com/apis/design/resource_names)
  539. // for more details on Google Cloud resource names.
  540. string name = 1 [
  541. (google.api.field_behavior) = REQUIRED,
  542. (google.api.resource_reference) = {
  543. type: "gkemulticloud.googleapis.com/AzureClient"
  544. }
  545. ];
  546. }
  547. // Request message for `AzureClusters.ListAzureClients` method.
  548. message ListAzureClientsRequest {
  549. // Required. The parent location which owns this collection of
  550. // [AzureClient][google.cloud.gkemulticloud.v1.AzureClient] resources.
  551. //
  552. // Location names are formatted as `projects/<project-id>/locations/<region>`.
  553. //
  554. // See [Resource Names](https://cloud.google.com/apis/design/resource_names)
  555. // for more details on GCP resource names.
  556. string parent = 1 [
  557. (google.api.field_behavior) = REQUIRED,
  558. (google.api.resource_reference) = {
  559. child_type: "gkemulticloud.googleapis.com/AzureClient"
  560. }
  561. ];
  562. // The maximum number of items to return.
  563. //
  564. // If not specified, a default value of 50 will be used by the service.
  565. // Regardless of the pageSize value, the response can include a partial list
  566. // and a caller should only rely on response's
  567. // [nextPageToken][google.cloud.gkemulticloud.v1.ListAzureClientsResponse.next_page_token] to determine if
  568. // there are more instances left to be queried.
  569. int32 page_size = 2;
  570. // The `nextPageToken` value returned from a previous
  571. // [azureClients.list][google.cloud.gkemulticloud.v1.AzureClusters.ListAzureClients] request, if any.
  572. string page_token = 3;
  573. }
  574. // Response message for `AzureClusters.ListAzureClients` method.
  575. message ListAzureClientsResponse {
  576. // A list of [AzureClient][google.cloud.gkemulticloud.v1.AzureClient] resources in the specified Google Cloud
  577. // project and region region.
  578. repeated AzureClient azure_clients = 1;
  579. // Token to retrieve the next page of results, or empty if there are no more
  580. // results in the list.
  581. string next_page_token = 2;
  582. }
  583. // Request message for `AzureClusters.DeleteAzureClient` method.
  584. message DeleteAzureClientRequest {
  585. // Required. The resource name the [AzureClient][google.cloud.gkemulticloud.v1.AzureClient] to delete.
  586. //
  587. // [AzureClient][google.cloud.gkemulticloud.v1.AzureClient] names are formatted as
  588. // `projects/<project-id>/locations/<region>/azureClients/<client-id>`.
  589. //
  590. // See [Resource Names](https://cloud.google.com/apis/design/resource_names)
  591. // for more details on Google Cloud resource names.
  592. string name = 1 [
  593. (google.api.field_behavior) = REQUIRED,
  594. (google.api.resource_reference) = {
  595. type: "gkemulticloud.googleapis.com/AzureClient"
  596. }
  597. ];
  598. // If set to true, and the [AzureClient][google.cloud.gkemulticloud.v1.AzureClient] resource is not found,
  599. // the request will succeed but no action will be taken on the server and a
  600. // completed [Operation][google.longrunning.Operation] will be returned.
  601. //
  602. // Useful for idempotent deletion.
  603. bool allow_missing = 2;
  604. // If set, only validate the request, but do not actually delete the resource.
  605. bool validate_only = 3;
  606. }
  607. // Request message for `AzureClusters.GenerateAzureAccessToken` method.
  608. message GenerateAzureAccessTokenRequest {
  609. // Required. The name of the [AzureCluster][google.cloud.gkemulticloud.v1.AzureCluster] resource to authenticate to.
  610. //
  611. // `AzureCluster` names are formatted as
  612. // `projects/<project-id>/locations/<region>/AzureClusters/<cluster-id>`.
  613. //
  614. // See [Resource Names](https://cloud.google.com/apis/design/resource_names)
  615. // for more details on Google Cloud resource names.
  616. string azure_cluster = 1 [
  617. (google.api.field_behavior) = REQUIRED,
  618. (google.api.resource_reference) = {
  619. type: "gkemulticloud.googleapis.com/AzureCluster"
  620. }
  621. ];
  622. }
  623. // Response message for `AzureClusters.GenerateAzureAccessToken` method.
  624. message GenerateAzureAccessTokenResponse {
  625. // Output only. Access token to authenticate to k8s api-server.
  626. string access_token = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
  627. // Output only. Timestamp at which the token will expire.
  628. google.protobuf.Timestamp expiration_time = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
  629. }