Class ProjectsResource.LocationsResource.BareMetalAdminClustersResource

The "bareMetalAdminClusters" collection of methods.

Inheritance

object

ProjectsResource.LocationsResource.BareMetalAdminClustersResource

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Google.Apis.GKEOnPrem.v1

Assembly: Google.Apis.GKEOnPrem.v1.dll

Syntax

public class ProjectsResource.LocationsResource.BareMetalAdminClustersResource

Constructors

BareMetalAdminClustersResource(IClientService)

Constructs a new resource.

Declaration

public BareMetalAdminClustersResource(IClientService service)

Parameters

Type	Name	Description
IClientService	service

Properties

Operations

Gets the Operations resource.

Declaration

public virtual ProjectsResource.LocationsResource.BareMetalAdminClustersResource.OperationsResource Operations { get; }

Property Value

Type	Description
ProjectsResource.LocationsResource.BareMetalAdminClustersResource.OperationsResource

Methods

Create(BareMetalAdminCluster, string)

Creates a new bare metal admin cluster in a given project and location. The API needs to be combined with creating a bootstrap cluster to work. See: https://cloud.google.com/anthos/clusters/docs/bare-metal/latest/installing/creating-clusters/create-admin-cluster-api#prepare_bootstrap_environment

Declaration

public virtual ProjectsResource.LocationsResource.BareMetalAdminClustersResource.CreateRequest Create(BareMetalAdminCluster body, string parent)

Parameters

Type	Name	Description
BareMetalAdminCluster	body	The body of the request.
string	parent	Required. The parent of the project and location where the cluster is created in. Format: "projects/{project}/locations/{location}"

Returns

Type	Description
ProjectsResource.LocationsResource.BareMetalAdminClustersResource.CreateRequest

Enroll(EnrollBareMetalAdminClusterRequest, string)

Enrolls an existing bare metal admin cluster to the Anthos On-Prem API within a given project and location. Through enrollment, an existing admin cluster will become Anthos On-Prem API managed. The corresponding GCP resources will be created and all future modifications to the cluster will be expected to be performed through the API.

Declaration

public virtual ProjectsResource.LocationsResource.BareMetalAdminClustersResource.EnrollRequest Enroll(EnrollBareMetalAdminClusterRequest body, string parent)

Parameters

Type	Name	Description
EnrollBareMetalAdminClusterRequest	body	The body of the request.
string	parent	Required. The parent of the project and location where the cluster is enrolled in. Format: "projects/{project}/locations/{location}"

Returns

Type	Description
ProjectsResource.LocationsResource.BareMetalAdminClustersResource.EnrollRequest

Get(string)

Gets details of a single bare metal admin cluster.

Declaration

public virtual ProjectsResource.LocationsResource.BareMetalAdminClustersResource.GetRequest Get(string name)

Parameters

Type	Name	Description
string	name	Required. Name of the bare metal admin cluster to get. Format: "projects/{project}/locations/{location}/bareMetalAdminClusters/{bare_metal_admin_cluster}"

Returns

Type	Description
ProjectsResource.LocationsResource.BareMetalAdminClustersResource.GetRequest

GetIamPolicy(string)

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

Declaration

public virtual ProjectsResource.LocationsResource.BareMetalAdminClustersResource.GetIamPolicyRequest GetIamPolicy(string resource)

Parameters

Type	Name	Description
string	resource	REQUIRED: The resource for which the policy is being requested. See Resource names for the appropriate value for this field.

Returns

Type	Description
ProjectsResource.LocationsResource.BareMetalAdminClustersResource.GetIamPolicyRequest

List(string)

Lists bare metal admin clusters in a given project and location.

Declaration

public virtual ProjectsResource.LocationsResource.BareMetalAdminClustersResource.ListRequest List(string parent)

Parameters

Type	Name	Description
string	parent	Required. The parent of the project and location where the clusters are listed in. Format: "projects/{project}/locations/{location}"

Returns

Type	Description
ProjectsResource.LocationsResource.BareMetalAdminClustersResource.ListRequest

Patch(BareMetalAdminCluster, string)

Updates the parameters of a single bare metal admin cluster.

Declaration

public virtual ProjectsResource.LocationsResource.BareMetalAdminClustersResource.PatchRequest Patch(BareMetalAdminCluster body, string name)

Parameters

Type	Name	Description
BareMetalAdminCluster	body	The body of the request.
string	name	Immutable. The bare metal admin cluster resource name.

Returns

Type	Description
ProjectsResource.LocationsResource.BareMetalAdminClustersResource.PatchRequest

QueryVersionConfig(string)

Queries the bare metal admin cluster version config.

Declaration

public virtual ProjectsResource.LocationsResource.BareMetalAdminClustersResource.QueryVersionConfigRequest QueryVersionConfig(string parent)

Parameters

Type	Name	Description
string	parent	Required. The parent of the project and location to query for version config. Format: "projects/{project}/locations/{location}"

Returns

Type	Description
ProjectsResource.LocationsResource.BareMetalAdminClustersResource.QueryVersionConfigRequest

SetIamPolicy(SetIamPolicyRequest, string)

Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.

Declaration

public virtual ProjectsResource.LocationsResource.BareMetalAdminClustersResource.SetIamPolicyRequest SetIamPolicy(SetIamPolicyRequest body, string resource)

Parameters

Type	Name	Description
SetIamPolicyRequest	body	The body of the request.
string	resource	REQUIRED: The resource for which the policy is being specified. See Resource names for the appropriate value for this field.

Returns

Type	Description
ProjectsResource.LocationsResource.BareMetalAdminClustersResource.SetIamPolicyRequest

TestIamPermissions(TestIamPermissionsRequest, string)

Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

Declaration

public virtual ProjectsResource.LocationsResource.BareMetalAdminClustersResource.TestIamPermissionsRequest TestIamPermissions(TestIamPermissionsRequest body, string resource)

Parameters

Type	Name	Description
TestIamPermissionsRequest	body	The body of the request.
string	resource	REQUIRED: The resource for which the policy detail is being requested. See Resource names for the appropriate value for this field.

Returns

Type	Description
ProjectsResource.LocationsResource.BareMetalAdminClustersResource.TestIamPermissionsRequest

Unenroll(string)

Unenrolls an existing bare metal admin cluster from the Anthos On-Prem API within a given project and location. Unenrollment removes the Cloud reference to the cluster without modifying the underlying OnPrem Resources. Clusters will continue to run; however, they will no longer be accessible through the Anthos On-Prem API or its clients.

Declaration

public virtual ProjectsResource.LocationsResource.BareMetalAdminClustersResource.UnenrollRequest Unenroll(string name)

Parameters

Type	Name	Description
string	name	Required. Name of the bare metal admin cluster to be unenrolled. Format: "projects/{project}/locations/{location}/bareMetalAdminClusters/{cluster}"

Returns

Type	Description
ProjectsResource.LocationsResource.BareMetalAdminClustersResource.UnenrollRequest