Anthos Multi-Cloud v1 API - Class AzureClusters.AzureClustersBase (2.4.0)

[BindServiceMethod(typeof(AzureClusters), "BindService")]
public abstract class AzureClusters.AzureClustersBase

Reference documentation and code samples for the Anthos Multi-Cloud v1 API class AzureClusters.AzureClustersBase.

Base class for server-side implementations of AzureClusters

Inheritance

object > AzureClusters.AzureClustersBase

Namespace

Google.Cloud.GkeMultiCloud.V1

Assembly

Google.Cloud.GkeMultiCloud.V1.dll

Methods

CreateAzureClient(CreateAzureClientRequest, ServerCallContext)

public virtual Task<Operation> CreateAzureClient(CreateAzureClientRequest request, ServerCallContext context)

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.

Parameters
NameDescription
requestCreateAzureClientRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
TaskOperation

The response to send back to the client (wrapped by a task).

CreateAzureCluster(CreateAzureClusterRequest, ServerCallContext)

public virtual Task<Operation> CreateAzureCluster(CreateAzureClusterRequest request, ServerCallContext context)

Creates a new [AzureCluster][google.cloud.gkemulticloud.v1.AzureCluster] resource on a given Google Cloud Platform 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.

Parameters
NameDescription
requestCreateAzureClusterRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
TaskOperation

The response to send back to the client (wrapped by a task).

CreateAzureNodePool(CreateAzureNodePoolRequest, ServerCallContext)

public virtual Task<Operation> CreateAzureNodePool(CreateAzureNodePoolRequest request, ServerCallContext context)

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.

Parameters
NameDescription
requestCreateAzureNodePoolRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
TaskOperation

The response to send back to the client (wrapped by a task).

DeleteAzureClient(DeleteAzureClientRequest, ServerCallContext)

public virtual Task<Operation> DeleteAzureClient(DeleteAzureClientRequest request, ServerCallContext context)

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.

Parameters
NameDescription
requestDeleteAzureClientRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
TaskOperation

The response to send back to the client (wrapped by a task).

DeleteAzureCluster(DeleteAzureClusterRequest, ServerCallContext)

public virtual Task<Operation> DeleteAzureCluster(DeleteAzureClusterRequest request, ServerCallContext context)

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.

Parameters
NameDescription
requestDeleteAzureClusterRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
TaskOperation

The response to send back to the client (wrapped by a task).

DeleteAzureNodePool(DeleteAzureNodePoolRequest, ServerCallContext)

public virtual Task<Operation> DeleteAzureNodePool(DeleteAzureNodePoolRequest request, ServerCallContext context)

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.

Parameters
NameDescription
requestDeleteAzureNodePoolRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
TaskOperation

The response to send back to the client (wrapped by a task).

GenerateAzureAccessToken(GenerateAzureAccessTokenRequest, ServerCallContext)

public virtual Task<GenerateAzureAccessTokenResponse> GenerateAzureAccessToken(GenerateAzureAccessTokenRequest request, ServerCallContext context)

Generates a short-lived access token to authenticate to a given [AzureCluster][google.cloud.gkemulticloud.v1.AzureCluster] resource.

Parameters
NameDescription
requestGenerateAzureAccessTokenRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
TaskGenerateAzureAccessTokenResponse

The response to send back to the client (wrapped by a task).

GenerateAzureClusterAgentToken(GenerateAzureClusterAgentTokenRequest, ServerCallContext)

public virtual Task<GenerateAzureClusterAgentTokenResponse> GenerateAzureClusterAgentToken(GenerateAzureClusterAgentTokenRequest request, ServerCallContext context)

Generates an access token for a cluster agent.

Parameters
NameDescription
requestGenerateAzureClusterAgentTokenRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
TaskGenerateAzureClusterAgentTokenResponse

The response to send back to the client (wrapped by a task).

GetAzureClient(GetAzureClientRequest, ServerCallContext)

public virtual Task<AzureClient> GetAzureClient(GetAzureClientRequest request, ServerCallContext context)

Describes a specific [AzureClient][google.cloud.gkemulticloud.v1.AzureClient] resource.

Parameters
NameDescription
requestGetAzureClientRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
TaskAzureClient

The response to send back to the client (wrapped by a task).

GetAzureCluster(GetAzureClusterRequest, ServerCallContext)

public virtual Task<AzureCluster> GetAzureCluster(GetAzureClusterRequest request, ServerCallContext context)

Describes a specific [AzureCluster][google.cloud.gkemulticloud.v1.AzureCluster] resource.

Parameters
NameDescription
requestGetAzureClusterRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
TaskAzureCluster

The response to send back to the client (wrapped by a task).

GetAzureJsonWebKeys(GetAzureJsonWebKeysRequest, ServerCallContext)

public virtual Task<AzureJsonWebKeys> GetAzureJsonWebKeys(GetAzureJsonWebKeysRequest request, ServerCallContext context)

Gets the public component of the cluster signing keys in JSON Web Key format.

Parameters
NameDescription
requestGetAzureJsonWebKeysRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
TaskAzureJsonWebKeys

The response to send back to the client (wrapped by a task).

GetAzureNodePool(GetAzureNodePoolRequest, ServerCallContext)

public virtual Task<AzureNodePool> GetAzureNodePool(GetAzureNodePoolRequest request, ServerCallContext context)

Describes a specific [AzureNodePool][google.cloud.gkemulticloud.v1.AzureNodePool] resource.

Parameters
NameDescription
requestGetAzureNodePoolRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
TaskAzureNodePool

The response to send back to the client (wrapped by a task).

GetAzureOpenIdConfig(GetAzureOpenIdConfigRequest, ServerCallContext)

public virtual Task<AzureOpenIdConfig> GetAzureOpenIdConfig(GetAzureOpenIdConfigRequest request, ServerCallContext context)

Gets the OIDC discovery document for the cluster. See the OpenID Connect Discovery 1.0 specification for details.

Parameters
NameDescription
requestGetAzureOpenIdConfigRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
TaskAzureOpenIdConfig

The response to send back to the client (wrapped by a task).

GetAzureServerConfig(GetAzureServerConfigRequest, ServerCallContext)

public virtual Task<AzureServerConfig> GetAzureServerConfig(GetAzureServerConfigRequest request, ServerCallContext context)

Returns information, such as supported Azure regions and Kubernetes versions, on a given Google Cloud location.

Parameters
NameDescription
requestGetAzureServerConfigRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
TaskAzureServerConfig

The response to send back to the client (wrapped by a task).

ListAzureClients(ListAzureClientsRequest, ServerCallContext)

public virtual Task<ListAzureClientsResponse> ListAzureClients(ListAzureClientsRequest request, ServerCallContext context)

Lists all [AzureClient][google.cloud.gkemulticloud.v1.AzureClient] resources on a given Google Cloud project and region.

Parameters
NameDescription
requestListAzureClientsRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
TaskListAzureClientsResponse

The response to send back to the client (wrapped by a task).

ListAzureClusters(ListAzureClustersRequest, ServerCallContext)

public virtual Task<ListAzureClustersResponse> ListAzureClusters(ListAzureClustersRequest request, ServerCallContext context)

Lists all [AzureCluster][google.cloud.gkemulticloud.v1.AzureCluster] resources on a given Google Cloud project and region.

Parameters
NameDescription
requestListAzureClustersRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
TaskListAzureClustersResponse

The response to send back to the client (wrapped by a task).

ListAzureNodePools(ListAzureNodePoolsRequest, ServerCallContext)

public virtual Task<ListAzureNodePoolsResponse> ListAzureNodePools(ListAzureNodePoolsRequest request, ServerCallContext context)

Lists all [AzureNodePool][google.cloud.gkemulticloud.v1.AzureNodePool] resources on a given [AzureCluster][google.cloud.gkemulticloud.v1.AzureCluster].

Parameters
NameDescription
requestListAzureNodePoolsRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
TaskListAzureNodePoolsResponse

The response to send back to the client (wrapped by a task).

UpdateAzureCluster(UpdateAzureClusterRequest, ServerCallContext)

public virtual Task<Operation> UpdateAzureCluster(UpdateAzureClusterRequest request, ServerCallContext context)

Updates an [AzureCluster][google.cloud.gkemulticloud.v1.AzureCluster].

Parameters
NameDescription
requestUpdateAzureClusterRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
TaskOperation

The response to send back to the client (wrapped by a task).

UpdateAzureNodePool(UpdateAzureNodePoolRequest, ServerCallContext)

public virtual Task<Operation> UpdateAzureNodePool(UpdateAzureNodePoolRequest request, ServerCallContext context)

Updates an [AzureNodePool][google.cloud.gkemulticloud.v1.AzureNodePool].

Parameters
NameDescription
requestUpdateAzureNodePoolRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
TaskOperation

The response to send back to the client (wrapped by a task).