ProjectsLocationsBareMetalAdminClusters
class ProjectsLocationsBareMetalAdminClusters extends Resource (View source)
The "bareMetalAdminClusters" collection of methods.
Typical usage is:
$gkeonpremService = new Google\Service\GKEOnPrem(...);
$bareMetalAdminClusters = $gkeonpremService->projects_locations_bareMetalAdminClusters;Methods
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 (bareMetalAdminClusters.create)
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. (bareMetalAdminClusters.enroll)
Gets details of a single bare metal admin cluster.
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
Lists bare metal admin clusters in a given project and location.
Updates the parameters of a single bare metal admin cluster.
Queries the bare metal admin cluster version config.
Sets the access control policy on the specified resource. Replaces any
existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and
PERMISSION_DENIED errors. (bareMetalAdminClusters.setIamPolicy)
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.
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. (bareMetalAdminClusters.unenroll)
Details
Operation
create(string $parent, BareMetalAdminCluster $postBody, array $optParams = [])
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 (bareMetalAdminClusters.create)
Operation
enroll(string $parent, EnrollBareMetalAdminClusterRequest $postBody, array $optParams = [])
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. (bareMetalAdminClusters.enroll)
BareMetalAdminCluster
get(string $name, array $optParams = [])
Gets details of a single bare metal admin cluster.
(bareMetalAdminClusters.get)
Policy
getIamPolicy(string $resource, array $optParams = [])
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
(bareMetalAdminClusters.getIamPolicy)
ListBareMetalAdminClustersResponse
listProjectsLocationsBareMetalAdminClusters(string $parent, array $optParams = [])
Lists bare metal admin clusters in a given project and location.
(bareMetalAdminClusters.listProjectsLocationsBareMetalAdminClusters)
Operation
patch(string $name, BareMetalAdminCluster $postBody, array $optParams = [])
Updates the parameters of a single bare metal admin cluster.
(bareMetalAdminClusters.patch)
QueryBareMetalAdminVersionConfigResponse
queryVersionConfig(string $parent, array $optParams = [])
Queries the bare metal admin cluster version config.
(bareMetalAdminClusters.queryVersionConfig)
Policy
setIamPolicy(string $resource, SetIamPolicyRequest $postBody, array $optParams = [])
Sets the access control policy on the specified resource. Replaces any
existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and
PERMISSION_DENIED errors. (bareMetalAdminClusters.setIamPolicy)
TestIamPermissionsResponse
testIamPermissions(string $resource, TestIamPermissionsRequest $postBody, array $optParams = [])
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. (bareMetalAdminClusters.testIamPermissions)
Operation
unenroll(string $name, array $optParams = [])
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. (bareMetalAdminClusters.unenroll)