123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701 |
- // Copyright 2022 Google LLC
- //
- // Licensed under the Apache License, Version 2.0 (the "License");
- // you may not use this file except in compliance with the License.
- // You may obtain a copy of the License at
- //
- // http://www.apache.org/licenses/LICENSE-2.0
- //
- // Unless required by applicable law or agreed to in writing, software
- // distributed under the License is distributed on an "AS IS" BASIS,
- // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- // See the License for the specific language governing permissions and
- // limitations under the License.
- syntax = "proto3";
- package google.cloud.gkemulticloud.v1;
- import "google/api/annotations.proto";
- import "google/api/client.proto";
- import "google/api/field_behavior.proto";
- import "google/api/resource.proto";
- import "google/cloud/gkemulticloud/v1/azure_resources.proto";
- import "google/longrunning/operations.proto";
- import "google/protobuf/field_mask.proto";
- import "google/protobuf/timestamp.proto";
- option csharp_namespace = "Google.Cloud.GkeMultiCloud.V1";
- option go_package = "google.golang.org/genproto/googleapis/cloud/gkemulticloud/v1;gkemulticloud";
- option java_multiple_files = true;
- option java_outer_classname = "AzureServiceProto";
- option java_package = "com.google.cloud.gkemulticloud.v1";
- option php_namespace = "Google\\Cloud\\GkeMultiCloud\\V1";
- option ruby_package = "Google::Cloud::GkeMultiCloud::V1";
- // The AzureClusters API provides a single centrally managed service
- // to create and manage Anthos clusters that run on Azure infrastructure.
- service AzureClusters {
- option (google.api.default_host) = "gkemulticloud.googleapis.com";
- option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/cloud-platform";
- // Creates a new [AzureClient][google.cloud.gkemulticloud.v1.AzureClient] resource on a given Google Cloud project
- // and region.
- //
- // `AzureClient` resources hold client authentication
- // information needed by the Anthos Multicloud API to manage Azure resources
- // on your Azure subscription on your behalf.
- //
- // If successful, the response contains a newly created
- // [Operation][google.longrunning.Operation] resource that can be
- // described to track the status of the operation.
- rpc CreateAzureClient(CreateAzureClientRequest) returns (google.longrunning.Operation) {
- option (google.api.http) = {
- post: "/v1/{parent=projects/*/locations/*}/azureClients"
- body: "azure_client"
- };
- option (google.api.method_signature) = "parent,azure_client,azure_client_id";
- option (google.longrunning.operation_info) = {
- response_type: "AzureClient"
- metadata_type: "OperationMetadata"
- };
- }
- // Describes a specific [AzureClient][google.cloud.gkemulticloud.v1.AzureClient] resource.
- rpc GetAzureClient(GetAzureClientRequest) returns (AzureClient) {
- option (google.api.http) = {
- get: "/v1/{name=projects/*/locations/*/azureClients/*}"
- };
- option (google.api.method_signature) = "name";
- }
- // Lists all [AzureClient][google.cloud.gkemulticloud.v1.AzureClient] resources on a given Google Cloud project and
- // region.
- rpc ListAzureClients(ListAzureClientsRequest) returns (ListAzureClientsResponse) {
- option (google.api.http) = {
- get: "/v1/{parent=projects/*/locations/*}/azureClients"
- };
- option (google.api.method_signature) = "parent";
- }
- // Deletes a specific [AzureClient][google.cloud.gkemulticloud.v1.AzureClient] resource.
- //
- // If the client is used by one or more clusters, deletion will
- // fail and a `FAILED_PRECONDITION` error will be returned.
- //
- // If successful, the response contains a newly created
- // [Operation][google.longrunning.Operation] resource that can be
- // described to track the status of the operation.
- rpc DeleteAzureClient(DeleteAzureClientRequest) returns (google.longrunning.Operation) {
- option (google.api.http) = {
- delete: "/v1/{name=projects/*/locations/*/azureClients/*}"
- };
- option (google.api.method_signature) = "name";
- option (google.longrunning.operation_info) = {
- response_type: "google.protobuf.Empty"
- metadata_type: "OperationMetadata"
- };
- }
- // Creates a new [AzureCluster][google.cloud.gkemulticloud.v1.AzureCluster] resource on a given GCP project and region.
- //
- // If successful, the response contains a newly created
- // [Operation][google.longrunning.Operation] resource that can be
- // described to track the status of the operation.
- rpc CreateAzureCluster(CreateAzureClusterRequest) returns (google.longrunning.Operation) {
- option (google.api.http) = {
- post: "/v1/{parent=projects/*/locations/*}/azureClusters"
- body: "azure_cluster"
- };
- option (google.api.method_signature) = "parent,azure_cluster,azure_cluster_id";
- option (google.longrunning.operation_info) = {
- response_type: "AzureCluster"
- metadata_type: "OperationMetadata"
- };
- }
- // Updates an [AzureCluster][google.cloud.gkemulticloud.v1.AzureCluster].
- rpc UpdateAzureCluster(UpdateAzureClusterRequest) returns (google.longrunning.Operation) {
- option (google.api.http) = {
- patch: "/v1/{azure_cluster.name=projects/*/locations/*/azureClusters/*}"
- body: "azure_cluster"
- };
- option (google.api.method_signature) = "azure_cluster,update_mask";
- option (google.longrunning.operation_info) = {
- response_type: "AzureCluster"
- metadata_type: "OperationMetadata"
- };
- }
- // Describes a specific [AzureCluster][google.cloud.gkemulticloud.v1.AzureCluster] resource.
- rpc GetAzureCluster(GetAzureClusterRequest) returns (AzureCluster) {
- option (google.api.http) = {
- get: "/v1/{name=projects/*/locations/*/azureClusters/*}"
- };
- option (google.api.method_signature) = "name";
- }
- // Lists all [AzureCluster][google.cloud.gkemulticloud.v1.AzureCluster] resources on a given Google Cloud project and
- // region.
- rpc ListAzureClusters(ListAzureClustersRequest) returns (ListAzureClustersResponse) {
- option (google.api.http) = {
- get: "/v1/{parent=projects/*/locations/*}/azureClusters"
- };
- option (google.api.method_signature) = "parent";
- }
- // Deletes a specific [AzureCluster][google.cloud.gkemulticloud.v1.AzureCluster] resource.
- //
- // Fails if the cluster has one or more associated [AzureNodePool][google.cloud.gkemulticloud.v1.AzureNodePool]
- // resources.
- //
- // If successful, the response contains a newly created
- // [Operation][google.longrunning.Operation] resource that can be
- // described to track the status of the operation.
- rpc DeleteAzureCluster(DeleteAzureClusterRequest) returns (google.longrunning.Operation) {
- option (google.api.http) = {
- delete: "/v1/{name=projects/*/locations/*/azureClusters/*}"
- };
- option (google.api.method_signature) = "name";
- option (google.longrunning.operation_info) = {
- response_type: "google.protobuf.Empty"
- metadata_type: "OperationMetadata"
- };
- }
- // Generates a short-lived access token to authenticate to a given
- // [AzureCluster][google.cloud.gkemulticloud.v1.AzureCluster] resource.
- rpc GenerateAzureAccessToken(GenerateAzureAccessTokenRequest) returns (GenerateAzureAccessTokenResponse) {
- option (google.api.http) = {
- get: "/v1/{azure_cluster=projects/*/locations/*/azureClusters/*}:generateAzureAccessToken"
- };
- }
- // Creates a new [AzureNodePool][google.cloud.gkemulticloud.v1.AzureNodePool], attached to a given [AzureCluster][google.cloud.gkemulticloud.v1.AzureCluster].
- //
- // If successful, the response contains a newly created
- // [Operation][google.longrunning.Operation] resource that can be
- // described to track the status of the operation.
- rpc CreateAzureNodePool(CreateAzureNodePoolRequest) returns (google.longrunning.Operation) {
- option (google.api.http) = {
- post: "/v1/{parent=projects/*/locations/*/azureClusters/*}/azureNodePools"
- body: "azure_node_pool"
- };
- option (google.api.method_signature) = "parent,azure_node_pool,azure_node_pool_id";
- option (google.longrunning.operation_info) = {
- response_type: "AzureNodePool"
- metadata_type: "OperationMetadata"
- };
- }
- // Updates an [AzureNodePool][google.cloud.gkemulticloud.v1.AzureNodePool].
- rpc UpdateAzureNodePool(UpdateAzureNodePoolRequest) returns (google.longrunning.Operation) {
- option (google.api.http) = {
- patch: "/v1/{azure_node_pool.name=projects/*/locations/*/azureClusters/*/azureNodePools/*}"
- body: "azure_node_pool"
- };
- option (google.api.method_signature) = "azure_node_pool,update_mask";
- option (google.longrunning.operation_info) = {
- response_type: "AzureNodePool"
- metadata_type: "OperationMetadata"
- };
- }
- // Describes a specific [AzureNodePool][google.cloud.gkemulticloud.v1.AzureNodePool] resource.
- rpc GetAzureNodePool(GetAzureNodePoolRequest) returns (AzureNodePool) {
- option (google.api.http) = {
- get: "/v1/{name=projects/*/locations/*/azureClusters/*/azureNodePools/*}"
- };
- option (google.api.method_signature) = "name";
- }
- // Lists all [AzureNodePool][google.cloud.gkemulticloud.v1.AzureNodePool] resources on a given [AzureCluster][google.cloud.gkemulticloud.v1.AzureCluster].
- rpc ListAzureNodePools(ListAzureNodePoolsRequest) returns (ListAzureNodePoolsResponse) {
- option (google.api.http) = {
- get: "/v1/{parent=projects/*/locations/*/azureClusters/*}/azureNodePools"
- };
- option (google.api.method_signature) = "parent";
- }
- // Deletes a specific [AzureNodePool][google.cloud.gkemulticloud.v1.AzureNodePool] resource.
- //
- // If successful, the response contains a newly created
- // [Operation][google.longrunning.Operation] resource that can be
- // described to track the status of the operation.
- rpc DeleteAzureNodePool(DeleteAzureNodePoolRequest) returns (google.longrunning.Operation) {
- option (google.api.http) = {
- delete: "/v1/{name=projects/*/locations/*/azureClusters/*/azureNodePools/*}"
- };
- option (google.api.method_signature) = "name";
- option (google.longrunning.operation_info) = {
- response_type: "google.protobuf.Empty"
- metadata_type: "OperationMetadata"
- };
- }
- // Returns information, such as supported Azure regions and Kubernetes
- // versions, on a given Google Cloud location.
- rpc GetAzureServerConfig(GetAzureServerConfigRequest) returns (AzureServerConfig) {
- option (google.api.http) = {
- get: "/v1/{name=projects/*/locations/*/azureServerConfig}"
- };
- option (google.api.method_signature) = "name";
- }
- }
- // Request message for `AzureClusters.CreateAzureCluster` method.
- message CreateAzureClusterRequest {
- // Required. The parent location where this [AzureCluster][google.cloud.gkemulticloud.v1.AzureCluster] resource
- // will be created.
- //
- // Location names are formatted as `projects/<project-id>/locations/<region>`.
- //
- // See [Resource Names](https://cloud.google.com/apis/design/resource_names)
- // for more details on Google Cloud resource names.
- string parent = 1 [
- (google.api.field_behavior) = REQUIRED,
- (google.api.resource_reference) = {
- child_type: "gkemulticloud.googleapis.com/AzureCluster"
- }
- ];
- // Required. The specification of the [AzureCluster][google.cloud.gkemulticloud.v1.AzureCluster] to create.
- AzureCluster azure_cluster = 2 [(google.api.field_behavior) = REQUIRED];
- // Required. A client provided ID the resource. Must be unique within the parent
- // resource.
- //
- // The provided ID will be part of the [AzureCluster][google.cloud.gkemulticloud.v1.AzureCluster]
- // resource name formatted as
- // `projects/<project-id>/locations/<region>/azureClusters/<cluster-id>`.
- //
- // Valid characters are `/[a-z][0-9]-/`. Cannot be longer than 40 characters.
- string azure_cluster_id = 3 [(google.api.field_behavior) = REQUIRED];
- // If set, only validate the request, but do not actually create the cluster.
- bool validate_only = 4;
- }
- // Request message for `AzureClusters.UpdateAzureCluster` method.
- message UpdateAzureClusterRequest {
- // Required. The [AzureCluster][google.cloud.gkemulticloud.v1.AzureCluster] resource to update.
- AzureCluster azure_cluster = 1 [(google.api.field_behavior) = REQUIRED];
- // If set, only validate the request, but do not actually update the cluster.
- bool validate_only = 2;
- // Required. Mask of fields to update. At least one path must be supplied in
- // this field. The elements of the repeated paths field can only include these
- // fields from [AzureCluster][google.cloud.gkemulticloud.v1.AzureCluster]:
- //
- // * `description`.
- // * `annotations`.
- // * `azureClient`.
- // * `control_plane.version`.
- // * `control_plane.vm_size`.
- // * `authorization.admin_users`.
- // * `control_plane.root_volume.size_gib`.
- // * `logging_config`
- google.protobuf.FieldMask update_mask = 4 [(google.api.field_behavior) = REQUIRED];
- }
- // Request message for `AzureClusters.GetAzureCluster` method.
- message GetAzureClusterRequest {
- // Required. The name of the [AzureCluster][google.cloud.gkemulticloud.v1.AzureCluster] resource to describe.
- //
- // `AzureCluster` names are formatted as
- // `projects/<project-id>/locations/<region>/azureClusters/<cluster-id>`.
- //
- // See [Resource Names](https://cloud.google.com/apis/design/resource_names)
- // for more details on GCP resource names.
- string name = 1 [
- (google.api.field_behavior) = REQUIRED,
- (google.api.resource_reference) = {
- type: "gkemulticloud.googleapis.com/AzureCluster"
- }
- ];
- }
- // Request message for `AzureClusters.ListAzureClusters` method.
- message ListAzureClustersRequest {
- // Required. The parent location which owns this collection of
- // [AzureCluster][google.cloud.gkemulticloud.v1.AzureCluster] resources.
- //
- // Location names are formatted as `projects/<project-id>/locations/<region>`.
- //
- // See [Resource Names](https://cloud.google.com/apis/design/resource_names)
- // for more details on GCP resource names.
- string parent = 1 [
- (google.api.field_behavior) = REQUIRED,
- (google.api.resource_reference) = {
- child_type: "gkemulticloud.googleapis.com/AzureCluster"
- }
- ];
- // The maximum number of items to return.
- //
- // If not specified, a default value of 50 will be used by the service.
- // Regardless of the pageSize value, the response can include a partial list
- // and a caller should only rely on response's
- // [nextPageToken][google.cloud.gkemulticloud.v1.ListAzureClustersResponse.next_page_token] to determine if
- // there are more instances left to be queried.
- int32 page_size = 2;
- // The `nextPageToken` value returned from a previous
- // [azureClusters.list][google.cloud.gkemulticloud.v1.AzureClusters.ListAzureClusters] request, if any.
- string page_token = 3;
- }
- // Response message for `AzureClusters.ListAzureClusters` method.
- message ListAzureClustersResponse {
- // A list of [AzureCluster][google.cloud.gkemulticloud.v1.AzureCluster] resources in the specified GCP
- // project and region region.
- repeated AzureCluster azure_clusters = 1;
- // Token to retrieve the next page of results, or empty if there are no more
- // results in the list.
- string next_page_token = 2;
- }
- // Request message for `Clusters.DeleteAzureCluster` method.
- message DeleteAzureClusterRequest {
- // Required. The resource name the [AzureCluster][google.cloud.gkemulticloud.v1.AzureCluster] to delete.
- //
- // `AzureCluster` names are formatted as
- // `projects/<project-id>/locations/<region>/azureClusters/<cluster-id>`.
- //
- // See [Resource Names](https://cloud.google.com/apis/design/resource_names)
- // for more details on GCP resource names.
- string name = 1 [
- (google.api.field_behavior) = REQUIRED,
- (google.api.resource_reference) = {
- type: "gkemulticloud.googleapis.com/AzureCluster"
- }
- ];
- // If set to true, and the [AzureCluster][google.cloud.gkemulticloud.v1.AzureCluster] resource is not found,
- // the request will succeed but no action will be taken on the server and a
- // completed [Operation][google.longrunning.Operation] will be returned.
- //
- // Useful for idempotent deletion.
- bool allow_missing = 2;
- // If set, only validate the request, but do not actually delete the resource.
- bool validate_only = 3;
- // The current etag of the [AzureCluster][google.cloud.gkemulticloud.v1.AzureCluster].
- //
- // Allows clients to perform deletions through optimistic concurrency control.
- //
- // If the provided etag does not match the current etag of the cluster,
- // the request will fail and an ABORTED error will be returned.
- string etag = 4;
- }
- // Response message for `AzureClusters.CreateAzureNodePool` method.
- message CreateAzureNodePoolRequest {
- // Required. The [AzureCluster][google.cloud.gkemulticloud.v1.AzureCluster] resource where this node pool will be created.
- //
- // Location names are formatted as `projects/<project-id>/locations/<region>`.
- //
- // See [Resource Names](https://cloud.google.com/apis/design/resource_names)
- // for more details on Google Cloud resource names.
- string parent = 1 [
- (google.api.field_behavior) = REQUIRED,
- (google.api.resource_reference) = {
- child_type: "gkemulticloud.googleapis.com/AzureNodePool"
- }
- ];
- // Required. The specification of the [AzureNodePool][google.cloud.gkemulticloud.v1.AzureNodePool] to create.
- AzureNodePool azure_node_pool = 2 [(google.api.field_behavior) = REQUIRED];
- // Required. A client provided ID the resource. Must be unique within the parent
- // resource.
- //
- // The provided ID will be part of the [AzureNodePool][google.cloud.gkemulticloud.v1.AzureNodePool]
- // resource name formatted as
- // `projects/<project-id>/locations/<region>/azureClusters/<cluster-id>/azureNodePools/<node-pool-id>`.
- //
- // Valid characters are `/[a-z][0-9]-/`. Cannot be longer than 40 characters.
- string azure_node_pool_id = 3 [(google.api.field_behavior) = REQUIRED];
- // If set, only validate the request, but do not actually create the node
- // pool.
- bool validate_only = 4;
- }
- // Request message for `AzureClusters.UpdateAzureNodePool` method.
- message UpdateAzureNodePoolRequest {
- // Required. The [AzureNodePool][google.cloud.gkemulticloud.v1.AzureNodePool] resource to update.
- AzureNodePool azure_node_pool = 1 [(google.api.field_behavior) = REQUIRED];
- // If set, only validate the request, but don't actually update the node pool.
- bool validate_only = 2;
- // Required. Mask of fields to update. At least one path must be supplied in
- // this field. The elements of the repeated paths field can only include these
- // fields from [AzureNodePool][google.cloud.gkemulticloud.v1.AzureNodePool]:
- //
- // *. `annotations`.
- // * `version`.
- // * `autoscaling.min_node_count`.
- // * `autoscaling.max_node_count`.
- // * `config.vm_size`.
- google.protobuf.FieldMask update_mask = 3 [(google.api.field_behavior) = REQUIRED];
- }
- // Request message for `AzureClusters.GetAzureNodePool` method.
- message GetAzureNodePoolRequest {
- // Required. The name of the [AzureNodePool][google.cloud.gkemulticloud.v1.AzureNodePool] resource to describe.
- //
- // `AzureNodePool` names are formatted as
- // `projects/<project-id>/locations/<region>/azureClusters/<cluster-id>/azureNodePools/<node-pool-id>`.
- //
- // See [Resource Names](https://cloud.google.com/apis/design/resource_names)
- // for more details on Google Cloud resource names.
- string name = 1 [
- (google.api.field_behavior) = REQUIRED,
- (google.api.resource_reference) = {
- type: "gkemulticloud.googleapis.com/AzureNodePool"
- }
- ];
- }
- // Request message for `AzureClusters.ListAzureNodePools` method.
- message ListAzureNodePoolsRequest {
- // Required. The parent `AzureCluster` which owns this collection of
- // [AzureNodePool][google.cloud.gkemulticloud.v1.AzureNodePool] resources.
- //
- // `AzureCluster` names are formatted as
- // `projects/<project-id>/locations/<region>/azureClusters/<cluster-id>`.
- //
- // See [Resource Names](https://cloud.google.com/apis/design/resource_names)
- // for more details on Google Cloud resource names.
- string parent = 1 [
- (google.api.field_behavior) = REQUIRED,
- (google.api.resource_reference) = {
- child_type: "gkemulticloud.googleapis.com/AzureNodePool"
- }
- ];
- // The maximum number of items to return.
- //
- // If not specified, a default value of 50 will be used by the service.
- // Regardless of the pageSize value, the response can include a partial list
- // and a caller should only rely on response's
- // [nextPageToken][google.cloud.gkemulticloud.v1.ListAzureNodePoolsResponse.next_page_token] to determine if
- // there are more instances left to be queried.
- int32 page_size = 2;
- // The `nextPageToken` value returned from a previous
- // [azureNodePools.list][google.cloud.gkemulticloud.v1.AzureClusters.ListAzureNodePools] request, if any.
- string page_token = 3;
- }
- // Response message for `AzureClusters.ListAzureNodePools` method.
- message ListAzureNodePoolsResponse {
- // A list of [AzureNodePool][google.cloud.gkemulticloud.v1.AzureNodePool] resources in the specified `AzureCluster`.
- repeated AzureNodePool azure_node_pools = 1;
- // Token to retrieve the next page of results, or empty if there are no more
- // results in the list.
- string next_page_token = 2;
- }
- // Delete message for `AzureClusters.DeleteNodePool` method.
- message DeleteAzureNodePoolRequest {
- // Required. The resource name the [AzureNodePool][google.cloud.gkemulticloud.v1.AzureNodePool] to delete.
- //
- // `AzureNodePool` names are formatted as
- // `projects/<project-id>/locations/<region>/azureClusters/<cluster-id>/azureNodePools/<node-pool-id>`.
- //
- // See [Resource Names](https://cloud.google.com/apis/design/resource_names)
- // for more details on Google Cloud resource names.
- string name = 1 [
- (google.api.field_behavior) = REQUIRED,
- (google.api.resource_reference) = {
- type: "gkemulticloud.googleapis.com/AzureNodePool"
- }
- ];
- // If set, only validate the request, but do not actually delete the node
- // pool.
- bool validate_only = 2;
- // If set to true, and the [AzureNodePool][google.cloud.gkemulticloud.v1.AzureNodePool] resource is not found,
- // the request will succeed but no action will be taken on the server and a
- // completed [Operation][google.longrunning.Operation] will be returned.
- //
- // Useful for idempotent deletion.
- bool allow_missing = 3;
- // The current ETag of the [AzureNodePool][google.cloud.gkemulticloud.v1.AzureNodePool].
- //
- // Allows clients to perform deletions through optimistic concurrency control.
- //
- // If the provided ETag does not match the current etag of the node pool,
- // the request will fail and an ABORTED error will be returned.
- string etag = 4;
- }
- // GetAzureServerConfigRequest gets the server config of GKE cluster on Azure.
- message GetAzureServerConfigRequest {
- // Required. The name of the [AzureServerConfig][google.cloud.gkemulticloud.v1.AzureServerConfig] resource to describe.
- //
- // `AzureServerConfig` names are formatted as
- // `projects/<project-id>/locations/<region>/azureServerConfig`.
- //
- // See [Resource Names](https://cloud.google.com/apis/design/resource_names)
- // for more details on Google Cloud resource names.
- string name = 1 [
- (google.api.field_behavior) = REQUIRED,
- (google.api.resource_reference) = {
- type: "gkemulticloud.googleapis.com/AzureServerConfig"
- }
- ];
- }
- // Request message for `AzureClusters.CreateAzureClient` method.
- message CreateAzureClientRequest {
- // Required. The parent location where this [AzureClient][google.cloud.gkemulticloud.v1.AzureClient] resource
- // will be created.
- //
- // Location names are formatted as `projects/<project-id>/locations/<region>`.
- //
- // See [Resource Names](https://cloud.google.com/apis/design/resource_names)
- // for more details on Google Cloud resource names.
- string parent = 1 [
- (google.api.field_behavior) = REQUIRED,
- (google.api.resource_reference) = {
- child_type: "gkemulticloud.googleapis.com/AzureClient"
- }
- ];
- // Required. The specification of the [AzureClient][google.cloud.gkemulticloud.v1.AzureClient] to create.
- AzureClient azure_client = 2 [(google.api.field_behavior) = REQUIRED];
- // Required. A client provided ID the resource. Must be unique within the parent
- // resource.
- //
- // The provided ID will be part of the [AzureClient][google.cloud.gkemulticloud.v1.AzureClient]
- // resource name formatted as
- // `projects/<project-id>/locations/<region>/azureClients/<client-id>`.
- //
- // Valid characters are `/[a-z][0-9]-/`. Cannot be longer than 40 characters.
- string azure_client_id = 4 [(google.api.field_behavior) = REQUIRED];
- // If set, only validate the request, but do not actually create the client.
- bool validate_only = 3;
- }
- // Request message for `AzureClusters.GetAzureClient` method.
- message GetAzureClientRequest {
- // Required. The name of the [AzureClient][google.cloud.gkemulticloud.v1.AzureClient] resource to describe.
- //
- // [AzureClient][google.cloud.gkemulticloud.v1.AzureClient] names are formatted as
- // `projects/<project-id>/locations/<region>/azureClients/<client-id>`.
- //
- // See [Resource Names](https://cloud.google.com/apis/design/resource_names)
- // for more details on Google Cloud resource names.
- string name = 1 [
- (google.api.field_behavior) = REQUIRED,
- (google.api.resource_reference) = {
- type: "gkemulticloud.googleapis.com/AzureClient"
- }
- ];
- }
- // Request message for `AzureClusters.ListAzureClients` method.
- message ListAzureClientsRequest {
- // Required. The parent location which owns this collection of
- // [AzureClient][google.cloud.gkemulticloud.v1.AzureClient] resources.
- //
- // Location names are formatted as `projects/<project-id>/locations/<region>`.
- //
- // See [Resource Names](https://cloud.google.com/apis/design/resource_names)
- // for more details on GCP resource names.
- string parent = 1 [
- (google.api.field_behavior) = REQUIRED,
- (google.api.resource_reference) = {
- child_type: "gkemulticloud.googleapis.com/AzureClient"
- }
- ];
- // The maximum number of items to return.
- //
- // If not specified, a default value of 50 will be used by the service.
- // Regardless of the pageSize value, the response can include a partial list
- // and a caller should only rely on response's
- // [nextPageToken][google.cloud.gkemulticloud.v1.ListAzureClientsResponse.next_page_token] to determine if
- // there are more instances left to be queried.
- int32 page_size = 2;
- // The `nextPageToken` value returned from a previous
- // [azureClients.list][google.cloud.gkemulticloud.v1.AzureClusters.ListAzureClients] request, if any.
- string page_token = 3;
- }
- // Response message for `AzureClusters.ListAzureClients` method.
- message ListAzureClientsResponse {
- // A list of [AzureClient][google.cloud.gkemulticloud.v1.AzureClient] resources in the specified Google Cloud
- // project and region region.
- repeated AzureClient azure_clients = 1;
- // Token to retrieve the next page of results, or empty if there are no more
- // results in the list.
- string next_page_token = 2;
- }
- // Request message for `AzureClusters.DeleteAzureClient` method.
- message DeleteAzureClientRequest {
- // Required. The resource name the [AzureClient][google.cloud.gkemulticloud.v1.AzureClient] to delete.
- //
- // [AzureClient][google.cloud.gkemulticloud.v1.AzureClient] names are formatted as
- // `projects/<project-id>/locations/<region>/azureClients/<client-id>`.
- //
- // See [Resource Names](https://cloud.google.com/apis/design/resource_names)
- // for more details on Google Cloud resource names.
- string name = 1 [
- (google.api.field_behavior) = REQUIRED,
- (google.api.resource_reference) = {
- type: "gkemulticloud.googleapis.com/AzureClient"
- }
- ];
- // If set to true, and the [AzureClient][google.cloud.gkemulticloud.v1.AzureClient] resource is not found,
- // the request will succeed but no action will be taken on the server and a
- // completed [Operation][google.longrunning.Operation] will be returned.
- //
- // Useful for idempotent deletion.
- bool allow_missing = 2;
- // If set, only validate the request, but do not actually delete the resource.
- bool validate_only = 3;
- }
- // Request message for `AzureClusters.GenerateAzureAccessToken` method.
- message GenerateAzureAccessTokenRequest {
- // Required. The name of the [AzureCluster][google.cloud.gkemulticloud.v1.AzureCluster] resource to authenticate to.
- //
- // `AzureCluster` names are formatted as
- // `projects/<project-id>/locations/<region>/AzureClusters/<cluster-id>`.
- //
- // See [Resource Names](https://cloud.google.com/apis/design/resource_names)
- // for more details on Google Cloud resource names.
- string azure_cluster = 1 [
- (google.api.field_behavior) = REQUIRED,
- (google.api.resource_reference) = {
- type: "gkemulticloud.googleapis.com/AzureCluster"
- }
- ];
- }
- // Response message for `AzureClusters.GenerateAzureAccessToken` method.
- message GenerateAzureAccessTokenResponse {
- // Output only. Access token to authenticate to k8s api-server.
- string access_token = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
- // Output only. Timestamp at which the token will expire.
- google.protobuf.Timestamp expiration_time = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
- }
|