Anthos Multi-Cloud V1 API - Class Google::Cloud::GkeMultiCloud::V1::AzureClusters::Client (v0.1.0)

Reference documentation and code samples for the Anthos Multi-Cloud V1 API class Google::Cloud::GkeMultiCloud::V1::AzureClusters::Client.

Client for the AzureClusters service.

The AzureClusters API provides a single centrally managed service to create and manage Anthos clusters that run on Azure infrastructure.

Inherits

  • Object

Includes

Methods

.configure

def self.configure() { |config| ... } -> Client::Configuration

Configure the AzureClusters Client class.

See Configuration for a description of the configuration fields.

Yields
  • (config) — Configure the Client client.
Yield Parameter
Returns
Example 
# Modify the configuration for all AzureClusters clients
::Google::Cloud::GkeMultiCloud::V1::AzureClusters::Client.configure do |config|
  config.timeout = 10.0
end

#configure

def configure() { |config| ... } -> Client::Configuration

Configure the AzureClusters Client instance.

The configuration is set to the derived mode, meaning that values can be changed, but structural changes (adding new fields, etc.) are not allowed. Structural changes should be made on Client.configure.

See Configuration for a description of the configuration fields.

Yields
  • (config) — Configure the Client client.
Yield Parameter
Returns

#create_azure_client

def create_azure_client(request, options = nil) -> ::Gapic::Operation
def create_azure_client(parent: nil, azure_client: nil, azure_client_id: nil, validate_only: nil) -> ::Gapic::Operation

Creates a new 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 resource that can be described to track the status of the operation.

Overloads 
def create_azure_client(request, options = nil) -> ::Gapic::Operation
Pass arguments to create_azure_client via a request object, either of type CreateAzureClientRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::GkeMultiCloud::V1::CreateAzureClientRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def create_azure_client(parent: nil, azure_client: nil, azure_client_id: nil, validate_only: nil) -> ::Gapic::Operation
Pass arguments to create_azure_client via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • parent (::String) — Required. The parent location where this AzureClient resource will be created.

    Location names are formatted as projects/<project-id>/locations/<region>.

    See Resource Names for more details on Google Cloud resource names.

  • azure_client (::Google::Cloud::GkeMultiCloud::V1::AzureClient, ::Hash) — Required. The specification of the AzureClient to create.
  • azure_client_id (::String) — Required. A client provided ID the resource. Must be unique within the parent resource.

    The provided ID will be part of the 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.

  • validate_only (::Boolean) — If set, only validate the request, but do not actually create the client.
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
  • response (::Gapic::Operation)
  • operation (::GRPC::ActiveCall::Operation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/gke_multi_cloud/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::GkeMultiCloud::V1::AzureClusters::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::GkeMultiCloud::V1::CreateAzureClientRequest.new

# Call the create_azure_client method.
result = client.create_azure_client request

# The returned object is of type Gapic::Operation. You can use this
# object to check the status of an operation, cancel it, or wait
# for results. Here is how to block until completion:
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "Error!"
end

#create_azure_cluster

def create_azure_cluster(request, options = nil) -> ::Gapic::Operation
def create_azure_cluster(parent: nil, azure_cluster: nil, azure_cluster_id: nil, validate_only: nil) -> ::Gapic::Operation

Creates a new AzureCluster resource on a given GCP project and region.

If successful, the response contains a newly created Operation resource that can be described to track the status of the operation.

Overloads 
def create_azure_cluster(request, options = nil) -> ::Gapic::Operation
Pass arguments to create_azure_cluster via a request object, either of type CreateAzureClusterRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::GkeMultiCloud::V1::CreateAzureClusterRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def create_azure_cluster(parent: nil, azure_cluster: nil, azure_cluster_id: nil, validate_only: nil) -> ::Gapic::Operation
Pass arguments to create_azure_cluster via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • parent (::String) — Required. The parent location where this AzureCluster resource will be created.

    Location names are formatted as projects/<project-id>/locations/<region>.

    See Resource Names for more details on Google Cloud resource names.

  • azure_cluster (::Google::Cloud::GkeMultiCloud::V1::AzureCluster, ::Hash) — Required. The specification of the AzureCluster to create.
  • azure_cluster_id (::String) — Required. A client provided ID the resource. Must be unique within the parent resource.

    The provided ID will be part of the 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.

  • validate_only (::Boolean) — If set, only validate the request, but do not actually create the cluster.
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
  • response (::Gapic::Operation)
  • operation (::GRPC::ActiveCall::Operation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/gke_multi_cloud/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::GkeMultiCloud::V1::AzureClusters::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::GkeMultiCloud::V1::CreateAzureClusterRequest.new

# Call the create_azure_cluster method.
result = client.create_azure_cluster request

# The returned object is of type Gapic::Operation. You can use this
# object to check the status of an operation, cancel it, or wait
# for results. Here is how to block until completion:
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "Error!"
end

#create_azure_node_pool

def create_azure_node_pool(request, options = nil) -> ::Gapic::Operation
def create_azure_node_pool(parent: nil, azure_node_pool: nil, azure_node_pool_id: nil, validate_only: nil) -> ::Gapic::Operation

Creates a new AzureNodePool, attached to a given AzureCluster.

If successful, the response contains a newly created Operation resource that can be described to track the status of the operation.

Overloads 
def create_azure_node_pool(request, options = nil) -> ::Gapic::Operation
Pass arguments to create_azure_node_pool via a request object, either of type CreateAzureNodePoolRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::GkeMultiCloud::V1::CreateAzureNodePoolRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def create_azure_node_pool(parent: nil, azure_node_pool: nil, azure_node_pool_id: nil, validate_only: nil) -> ::Gapic::Operation
Pass arguments to create_azure_node_pool via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • parent (::String) — Required. The AzureCluster resource where this node pool will be created.

    Location names are formatted as projects/<project-id>/locations/<region>.

    See Resource Names for more details on Google Cloud resource names.

  • azure_node_pool (::Google::Cloud::GkeMultiCloud::V1::AzureNodePool, ::Hash) — Required. The specification of the AzureNodePool to create.
  • azure_node_pool_id (::String) — Required. A client provided ID the resource. Must be unique within the parent resource.

    The provided ID will be part of the 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.

  • validate_only (::Boolean) — If set, only validate the request, but do not actually create the node pool.
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
  • response (::Gapic::Operation)
  • operation (::GRPC::ActiveCall::Operation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/gke_multi_cloud/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::GkeMultiCloud::V1::AzureClusters::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::GkeMultiCloud::V1::CreateAzureNodePoolRequest.new

# Call the create_azure_node_pool method.
result = client.create_azure_node_pool request

# The returned object is of type Gapic::Operation. You can use this
# object to check the status of an operation, cancel it, or wait
# for results. Here is how to block until completion:
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "Error!"
end

#delete_azure_client

def delete_azure_client(request, options = nil) -> ::Gapic::Operation
def delete_azure_client(name: nil, allow_missing: nil, validate_only: nil) -> ::Gapic::Operation

Deletes a specific 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 resource that can be described to track the status of the operation.

Overloads 
def delete_azure_client(request, options = nil) -> ::Gapic::Operation
Pass arguments to delete_azure_client via a request object, either of type DeleteAzureClientRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::GkeMultiCloud::V1::DeleteAzureClientRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def delete_azure_client(name: nil, allow_missing: nil, validate_only: nil) -> ::Gapic::Operation
Pass arguments to delete_azure_client via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • name (::String) — Required. The resource name the AzureClient to delete.

    AzureClient names are formatted as projects/<project-id>/locations/<region>/azureClients/<client-id>.

    See Resource Names for more details on Google Cloud resource names.

  • allow_missing (::Boolean) — If set to true, and the AzureClient resource is not found, the request will succeed but no action will be taken on the server and a completed Operation will be returned.

    Useful for idempotent deletion.

  • validate_only (::Boolean) — If set, only validate the request, but do not actually delete the resource.
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
  • response (::Gapic::Operation)
  • operation (::GRPC::ActiveCall::Operation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/gke_multi_cloud/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::GkeMultiCloud::V1::AzureClusters::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::GkeMultiCloud::V1::DeleteAzureClientRequest.new

# Call the delete_azure_client method.
result = client.delete_azure_client request

# The returned object is of type Gapic::Operation. You can use this
# object to check the status of an operation, cancel it, or wait
# for results. Here is how to block until completion:
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "Error!"
end

#delete_azure_cluster

def delete_azure_cluster(request, options = nil) -> ::Gapic::Operation
def delete_azure_cluster(name: nil, allow_missing: nil, validate_only: nil, etag: nil) -> ::Gapic::Operation

Deletes a specific AzureCluster resource.

Fails if the cluster has one or more associated AzureNodePool resources.

If successful, the response contains a newly created Operation resource that can be described to track the status of the operation.

Overloads 
def delete_azure_cluster(request, options = nil) -> ::Gapic::Operation
Pass arguments to delete_azure_cluster via a request object, either of type DeleteAzureClusterRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::GkeMultiCloud::V1::DeleteAzureClusterRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def delete_azure_cluster(name: nil, allow_missing: nil, validate_only: nil, etag: nil) -> ::Gapic::Operation
Pass arguments to delete_azure_cluster via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • name (::String) — Required. The resource name the AzureCluster to delete.

    AzureCluster names are formatted as projects/<project-id>/locations/<region>/azureClusters/<cluster-id>.

    See Resource Names for more details on GCP resource names.

  • allow_missing (::Boolean) — If set to true, and the AzureCluster resource is not found, the request will succeed but no action will be taken on the server and a completed Operation will be returned.

    Useful for idempotent deletion.

  • validate_only (::Boolean) — If set, only validate the request, but do not actually delete the resource.
  • etag (::String) — The current etag of the 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.

Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
  • response (::Gapic::Operation)
  • operation (::GRPC::ActiveCall::Operation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/gke_multi_cloud/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::GkeMultiCloud::V1::AzureClusters::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::GkeMultiCloud::V1::DeleteAzureClusterRequest.new

# Call the delete_azure_cluster method.
result = client.delete_azure_cluster request

# The returned object is of type Gapic::Operation. You can use this
# object to check the status of an operation, cancel it, or wait
# for results. Here is how to block until completion:
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "Error!"
end

#delete_azure_node_pool

def delete_azure_node_pool(request, options = nil) -> ::Gapic::Operation
def delete_azure_node_pool(name: nil, validate_only: nil, allow_missing: nil, etag: nil) -> ::Gapic::Operation

Deletes a specific AzureNodePool resource.

If successful, the response contains a newly created Operation resource that can be described to track the status of the operation.

Overloads 
def delete_azure_node_pool(request, options = nil) -> ::Gapic::Operation
Pass arguments to delete_azure_node_pool via a request object, either of type DeleteAzureNodePoolRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::GkeMultiCloud::V1::DeleteAzureNodePoolRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def delete_azure_node_pool(name: nil, validate_only: nil, allow_missing: nil, etag: nil) -> ::Gapic::Operation
Pass arguments to delete_azure_node_pool via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • name (::String) — Required. The resource name the AzureNodePool to delete.

    AzureNodePool names are formatted as projects/<project-id>/locations/<region>/azureClusters/<cluster-id>/azureNodePools/<node-pool-id>.

    See Resource Names for more details on Google Cloud resource names.

  • validate_only (::Boolean) — If set, only validate the request, but do not actually delete the node pool.
  • allow_missing (::Boolean) — If set to true, and the AzureNodePool resource is not found, the request will succeed but no action will be taken on the server and a completed Operation will be returned.

    Useful for idempotent deletion.

  • etag (::String) — The current ETag of the 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.

Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
  • response (::Gapic::Operation)
  • operation (::GRPC::ActiveCall::Operation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/gke_multi_cloud/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::GkeMultiCloud::V1::AzureClusters::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::GkeMultiCloud::V1::DeleteAzureNodePoolRequest.new

# Call the delete_azure_node_pool method.
result = client.delete_azure_node_pool request

# The returned object is of type Gapic::Operation. You can use this
# object to check the status of an operation, cancel it, or wait
# for results. Here is how to block until completion:
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "Error!"
end

#generate_azure_access_token

def generate_azure_access_token(request, options = nil) -> ::Google::Cloud::GkeMultiCloud::V1::GenerateAzureAccessTokenResponse
def generate_azure_access_token(azure_cluster: nil) -> ::Google::Cloud::GkeMultiCloud::V1::GenerateAzureAccessTokenResponse

Generates a short-lived access token to authenticate to a given AzureCluster resource.

Overloads 
def generate_azure_access_token(request, options = nil) -> ::Google::Cloud::GkeMultiCloud::V1::GenerateAzureAccessTokenResponse
Pass arguments to generate_azure_access_token via a request object, either of type GenerateAzureAccessTokenRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::GkeMultiCloud::V1::GenerateAzureAccessTokenRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def generate_azure_access_token(azure_cluster: nil) -> ::Google::Cloud::GkeMultiCloud::V1::GenerateAzureAccessTokenResponse
Pass arguments to generate_azure_access_token via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameter
  • azure_cluster (::String) — Required. The name of the AzureCluster resource to authenticate to.

    AzureCluster names are formatted as projects/<project-id>/locations/<region>/AzureClusters/<cluster-id>.

    See Resource Names for more details on Google Cloud resource names.

Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/gke_multi_cloud/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::GkeMultiCloud::V1::AzureClusters::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::GkeMultiCloud::V1::GenerateAzureAccessTokenRequest.new

# Call the generate_azure_access_token method.
result = client.generate_azure_access_token request

# The returned object is of type Google::Cloud::GkeMultiCloud::V1::GenerateAzureAccessTokenResponse.
p result

#get_azure_client

def get_azure_client(request, options = nil) -> ::Google::Cloud::GkeMultiCloud::V1::AzureClient
def get_azure_client(name: nil) -> ::Google::Cloud::GkeMultiCloud::V1::AzureClient

Describes a specific AzureClient resource.

Overloads 
def get_azure_client(request, options = nil) -> ::Google::Cloud::GkeMultiCloud::V1::AzureClient
Pass arguments to get_azure_client via a request object, either of type GetAzureClientRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::GkeMultiCloud::V1::GetAzureClientRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def get_azure_client(name: nil) -> ::Google::Cloud::GkeMultiCloud::V1::AzureClient
Pass arguments to get_azure_client via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameter
  • name (::String) — Required. The name of the AzureClient resource to describe.

    AzureClient names are formatted as projects/<project-id>/locations/<region>/azureClients/<client-id>.

    See Resource Names for more details on Google Cloud resource names.

Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/gke_multi_cloud/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::GkeMultiCloud::V1::AzureClusters::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::GkeMultiCloud::V1::GetAzureClientRequest.new

# Call the get_azure_client method.
result = client.get_azure_client request

# The returned object is of type Google::Cloud::GkeMultiCloud::V1::AzureClient.
p result

#get_azure_cluster

def get_azure_cluster(request, options = nil) -> ::Google::Cloud::GkeMultiCloud::V1::AzureCluster
def get_azure_cluster(name: nil) -> ::Google::Cloud::GkeMultiCloud::V1::AzureCluster

Describes a specific AzureCluster resource.

Overloads 
def get_azure_cluster(request, options = nil) -> ::Google::Cloud::GkeMultiCloud::V1::AzureCluster
Pass arguments to get_azure_cluster via a request object, either of type GetAzureClusterRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::GkeMultiCloud::V1::GetAzureClusterRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def get_azure_cluster(name: nil) -> ::Google::Cloud::GkeMultiCloud::V1::AzureCluster
Pass arguments to get_azure_cluster via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameter
  • name (::String) — Required. The name of the AzureCluster resource to describe.

    AzureCluster names are formatted as projects/<project-id>/locations/<region>/azureClusters/<cluster-id>.

    See Resource Names for more details on GCP resource names.

Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/gke_multi_cloud/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::GkeMultiCloud::V1::AzureClusters::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::GkeMultiCloud::V1::GetAzureClusterRequest.new

# Call the get_azure_cluster method.
result = client.get_azure_cluster request

# The returned object is of type Google::Cloud::GkeMultiCloud::V1::AzureCluster.
p result

#get_azure_node_pool

def get_azure_node_pool(request, options = nil) -> ::Google::Cloud::GkeMultiCloud::V1::AzureNodePool
def get_azure_node_pool(name: nil) -> ::Google::Cloud::GkeMultiCloud::V1::AzureNodePool

Describes a specific AzureNodePool resource.

Overloads 
def get_azure_node_pool(request, options = nil) -> ::Google::Cloud::GkeMultiCloud::V1::AzureNodePool
Pass arguments to get_azure_node_pool via a request object, either of type GetAzureNodePoolRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::GkeMultiCloud::V1::GetAzureNodePoolRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def get_azure_node_pool(name: nil) -> ::Google::Cloud::GkeMultiCloud::V1::AzureNodePool
Pass arguments to get_azure_node_pool via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameter
  • name (::String) — Required. The name of the AzureNodePool resource to describe.

    AzureNodePool names are formatted as projects/<project-id>/locations/<region>/azureClusters/<cluster-id>/azureNodePools/<node-pool-id>.

    See Resource Names for more details on Google Cloud resource names.

Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/gke_multi_cloud/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::GkeMultiCloud::V1::AzureClusters::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::GkeMultiCloud::V1::GetAzureNodePoolRequest.new

# Call the get_azure_node_pool method.
result = client.get_azure_node_pool request

# The returned object is of type Google::Cloud::GkeMultiCloud::V1::AzureNodePool.
p result

#get_azure_server_config

def get_azure_server_config(request, options = nil) -> ::Google::Cloud::GkeMultiCloud::V1::AzureServerConfig
def get_azure_server_config(name: nil) -> ::Google::Cloud::GkeMultiCloud::V1::AzureServerConfig

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

Overloads 
def get_azure_server_config(request, options = nil) -> ::Google::Cloud::GkeMultiCloud::V1::AzureServerConfig
Pass arguments to get_azure_server_config via a request object, either of type GetAzureServerConfigRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::GkeMultiCloud::V1::GetAzureServerConfigRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def get_azure_server_config(name: nil) -> ::Google::Cloud::GkeMultiCloud::V1::AzureServerConfig
Pass arguments to get_azure_server_config via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameter
  • name (::String) — Required. The name of the AzureServerConfig resource to describe.

    AzureServerConfig names are formatted as projects/<project-id>/locations/<region>/azureServerConfig.

    See Resource Names for more details on Google Cloud resource names.

Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/gke_multi_cloud/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::GkeMultiCloud::V1::AzureClusters::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::GkeMultiCloud::V1::GetAzureServerConfigRequest.new

# Call the get_azure_server_config method.
result = client.get_azure_server_config request

# The returned object is of type Google::Cloud::GkeMultiCloud::V1::AzureServerConfig.
p result

#initialize

def initialize() { |config| ... } -> Client

Create a new AzureClusters client object.

Yields
  • (config) — Configure the AzureClusters client.
Yield Parameter
Returns
  • (Client) — a new instance of Client
Example 
# Create a client using the default configuration
client = ::Google::Cloud::GkeMultiCloud::V1::AzureClusters::Client.new

# Create a client using a custom configuration
client = ::Google::Cloud::GkeMultiCloud::V1::AzureClusters::Client.new do |config|
  config.timeout = 10.0
end

#list_azure_clients

def list_azure_clients(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::GkeMultiCloud::V1::AzureClient>
def list_azure_clients(parent: nil, page_size: nil, page_token: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::GkeMultiCloud::V1::AzureClient>

Lists all AzureClient resources on a given Google Cloud project and region.

Overloads 
def list_azure_clients(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::GkeMultiCloud::V1::AzureClient>
Pass arguments to list_azure_clients via a request object, either of type ListAzureClientsRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::GkeMultiCloud::V1::ListAzureClientsRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def list_azure_clients(parent: nil, page_size: nil, page_token: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::GkeMultiCloud::V1::AzureClient>
Pass arguments to list_azure_clients via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • parent (::String) — Required. The parent location which owns this collection of AzureClient resources.

    Location names are formatted as projects/<project-id>/locations/<region>.

    See Resource Names for more details on GCP resource names.

  • page_size (::Integer) — 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 to determine if there are more instances left to be queried.

  • page_token (::String) — The nextPageToken value returned from a previous azureClients.list request, if any.
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/gke_multi_cloud/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::GkeMultiCloud::V1::AzureClusters::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::GkeMultiCloud::V1::ListAzureClientsRequest.new

# Call the list_azure_clients method.
result = client.list_azure_clients request

# The returned object is of type Gapic::PagedEnumerable. You can
# iterate over all elements by calling #each, and the enumerable
# will lazily make API calls to fetch subsequent pages. Other
# methods are also available for managing paging directly.
result.each do |response|
  # Each element is of type ::Google::Cloud::GkeMultiCloud::V1::AzureClient.
  p response
end

#list_azure_clusters

def list_azure_clusters(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::GkeMultiCloud::V1::AzureCluster>
def list_azure_clusters(parent: nil, page_size: nil, page_token: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::GkeMultiCloud::V1::AzureCluster>

Lists all AzureCluster resources on a given Google Cloud project and region.

Overloads 
def list_azure_clusters(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::GkeMultiCloud::V1::AzureCluster>
Pass arguments to list_azure_clusters via a request object, either of type ListAzureClustersRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::GkeMultiCloud::V1::ListAzureClustersRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def list_azure_clusters(parent: nil, page_size: nil, page_token: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::GkeMultiCloud::V1::AzureCluster>
Pass arguments to list_azure_clusters via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • parent (::String) — Required. The parent location which owns this collection of AzureCluster resources.

    Location names are formatted as projects/<project-id>/locations/<region>.

    See Resource Names for more details on GCP resource names.

  • page_size (::Integer) — 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 to determine if there are more instances left to be queried.

  • page_token (::String) — The nextPageToken value returned from a previous azureClusters.list request, if any.
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/gke_multi_cloud/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::GkeMultiCloud::V1::AzureClusters::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::GkeMultiCloud::V1::ListAzureClustersRequest.new

# Call the list_azure_clusters method.
result = client.list_azure_clusters request

# The returned object is of type Gapic::PagedEnumerable. You can
# iterate over all elements by calling #each, and the enumerable
# will lazily make API calls to fetch subsequent pages. Other
# methods are also available for managing paging directly.
result.each do |response|
  # Each element is of type ::Google::Cloud::GkeMultiCloud::V1::AzureCluster.
  p response
end

#list_azure_node_pools

def list_azure_node_pools(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::GkeMultiCloud::V1::AzureNodePool>
def list_azure_node_pools(parent: nil, page_size: nil, page_token: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::GkeMultiCloud::V1::AzureNodePool>

Lists all AzureNodePool resources on a given AzureCluster.

Overloads 
def list_azure_node_pools(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::GkeMultiCloud::V1::AzureNodePool>
Pass arguments to list_azure_node_pools via a request object, either of type ListAzureNodePoolsRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::GkeMultiCloud::V1::ListAzureNodePoolsRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def list_azure_node_pools(parent: nil, page_size: nil, page_token: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::GkeMultiCloud::V1::AzureNodePool>
Pass arguments to list_azure_node_pools via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • parent (::String) — Required. The parent AzureCluster which owns this collection of AzureNodePool resources.

    AzureCluster names are formatted as projects/<project-id>/locations/<region>/azureClusters/<cluster-id>.

    See Resource Names for more details on Google Cloud resource names.

  • page_size (::Integer) — 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 to determine if there are more instances left to be queried.

  • page_token (::String) — The nextPageToken value returned from a previous azureNodePools.list request, if any.
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/gke_multi_cloud/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::GkeMultiCloud::V1::AzureClusters::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::GkeMultiCloud::V1::ListAzureNodePoolsRequest.new

# Call the list_azure_node_pools method.
result = client.list_azure_node_pools request

# The returned object is of type Gapic::PagedEnumerable. You can
# iterate over all elements by calling #each, and the enumerable
# will lazily make API calls to fetch subsequent pages. Other
# methods are also available for managing paging directly.
result.each do |response|
  # Each element is of type ::Google::Cloud::GkeMultiCloud::V1::AzureNodePool.
  p response
end

#operations_client

def operations_client() -> ::Google::Cloud::GkeMultiCloud::V1::AzureClusters::Operations

Get the associated client for long-running operations.

Returns

#update_azure_cluster

def update_azure_cluster(request, options = nil) -> ::Gapic::Operation
def update_azure_cluster(azure_cluster: nil, validate_only: nil, update_mask: nil) -> ::Gapic::Operation

Updates an AzureCluster.

Overloads 
def update_azure_cluster(request, options = nil) -> ::Gapic::Operation
Pass arguments to update_azure_cluster via a request object, either of type UpdateAzureClusterRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::GkeMultiCloud::V1::UpdateAzureClusterRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def update_azure_cluster(azure_cluster: nil, validate_only: nil, update_mask: nil) -> ::Gapic::Operation
Pass arguments to update_azure_cluster via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • azure_cluster (::Google::Cloud::GkeMultiCloud::V1::AzureCluster, ::Hash) — Required. The AzureCluster resource to update.
  • validate_only (::Boolean) — If set, only validate the request, but do not actually update the cluster.
  • update_mask (::Google::Protobuf::FieldMask, ::Hash) —

    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:

    • description.
    • annotations.
    • azureClient.
    • control_plane.version.
    • control_plane.vm_size.
    • authorization.admin_users.
    • control_plane.root_volume.size_gib.
    • logging_config
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
  • response (::Gapic::Operation)
  • operation (::GRPC::ActiveCall::Operation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/gke_multi_cloud/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::GkeMultiCloud::V1::AzureClusters::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::GkeMultiCloud::V1::UpdateAzureClusterRequest.new

# Call the update_azure_cluster method.
result = client.update_azure_cluster request

# The returned object is of type Gapic::Operation. You can use this
# object to check the status of an operation, cancel it, or wait
# for results. Here is how to block until completion:
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "Error!"
end

#update_azure_node_pool

def update_azure_node_pool(request, options = nil) -> ::Gapic::Operation
def update_azure_node_pool(azure_node_pool: nil, validate_only: nil, update_mask: nil) -> ::Gapic::Operation

Updates an AzureNodePool.

Overloads 
def update_azure_node_pool(request, options = nil) -> ::Gapic::Operation
Pass arguments to update_azure_node_pool via a request object, either of type UpdateAzureNodePoolRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::GkeMultiCloud::V1::UpdateAzureNodePoolRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def update_azure_node_pool(azure_node_pool: nil, validate_only: nil, update_mask: nil) -> ::Gapic::Operation
Pass arguments to update_azure_node_pool via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • azure_node_pool (::Google::Cloud::GkeMultiCloud::V1::AzureNodePool, ::Hash) — Required. The AzureNodePool resource to update.
  • validate_only (::Boolean) — If set, only validate the request, but don't actually update the node pool.
  • update_mask (::Google::Protobuf::FieldMask, ::Hash) —

    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:

    *. annotations.

    • version.
    • autoscaling.min_node_count.
    • autoscaling.max_node_count.
    • config.vm_size.
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
  • response (::Gapic::Operation)
  • operation (::GRPC::ActiveCall::Operation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/gke_multi_cloud/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::GkeMultiCloud::V1::AzureClusters::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::GkeMultiCloud::V1::UpdateAzureNodePoolRequest.new

# Call the update_azure_node_pool method.
result = client.update_azure_node_pool request

# The returned object is of type Gapic::Operation. You can use this
# object to check the status of an operation, cancel it, or wait
# for results. Here is how to block until completion:
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "Error!"
end