RbacAuthorizationV1Api
All URIs are relative to http://localhost
Cluster Role
| Method | HTTP request | Description |
|---|---|---|
| createClusterRole | POST /apis/rbac.authorization.k8s.io/v1/clusterroles | create a ClusterRole |
| readClusterRole | GET /apis/rbac.authorization.k8s.io/v1/clusterroles/{name} | Generated API methods accept optional request options as a second argument. |
| listClusterRole | GET /apis/rbac.authorization.k8s.io/v1/clusterroles | Generated API methods accept optional request options as a second argument. |
| patchClusterRole | PATCH /apis/rbac.authorization.k8s.io/v1/clusterroles/{name} | partially update the specified ClusterRole |
| replaceClusterRole | PUT /apis/rbac.authorization.k8s.io/v1/clusterroles/{name} | replace the specified ClusterRole |
| deleteClusterRole | DELETE /apis/rbac.authorization.k8s.io/v1/clusterroles/{name} | Generated API methods accept optional request options as a second argument. |
| deleteCollectionClusterRole | DELETE /apis/rbac.authorization.k8s.io/v1/clusterroles | Generated API methods accept optional request options as a second argument. |
Cluster Role Binding
| Method | HTTP request | Description |
|---|---|---|
| createClusterRoleBinding | POST /apis/rbac.authorization.k8s.io/v1/clusterrolebindings | create a ClusterRoleBinding |
| readClusterRoleBinding | GET /apis/rbac.authorization.k8s.io/v1/clusterrolebindings/{name} | Generated API methods accept optional request options as a second argument. |
| listClusterRoleBinding | GET /apis/rbac.authorization.k8s.io/v1/clusterrolebindings | Generated API methods accept optional request options as a second argument. |
| patchClusterRoleBinding | PATCH /apis/rbac.authorization.k8s.io/v1/clusterrolebindings/{name} | partially update the specified ClusterRoleBinding |
| replaceClusterRoleBinding | PUT /apis/rbac.authorization.k8s.io/v1/clusterrolebindings/{name} | replace the specified ClusterRoleBinding |
| deleteClusterRoleBinding | DELETE /apis/rbac.authorization.k8s.io/v1/clusterrolebindings/{name} | Generated API methods accept optional request options as a second argument. |
| deleteCollectionClusterRoleBinding | DELETE /apis/rbac.authorization.k8s.io/v1/clusterrolebindings | Generated API methods accept optional request options as a second argument. |
Role
| Method | HTTP request | Description |
|---|---|---|
| createNamespacedRole | POST /apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/roles | create a Role |
| readNamespacedRole | GET /apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/roles/{name} | Generated API methods accept optional request options as a second argument. |
| listNamespacedRole | GET /apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/roles | Generated API methods accept optional request options as a second argument. |
| listRoleForAllNamespaces | GET /apis/rbac.authorization.k8s.io/v1/roles | Generated API methods accept optional request options as a second argument. |
| patchNamespacedRole | PATCH /apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/roles/{name} | partially update the specified Role |
| replaceNamespacedRole | PUT /apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/roles/{name} | replace the specified Role |
| deleteCollectionNamespacedRole | DELETE /apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/roles | Generated API methods accept optional request options as a second argument. |
| deleteNamespacedRole | DELETE /apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/roles/{name} | Generated API methods accept optional request options as a second argument. |
Role Binding
| Method | HTTP request | Description |
|---|---|---|
| createNamespacedRoleBinding | POST /apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/rolebindings | create a RoleBinding |
| readNamespacedRoleBinding | GET /apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/rolebindings/{name} | Generated API methods accept optional request options as a second argument. |
| listNamespacedRoleBinding | GET /apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/rolebindings | Generated API methods accept optional request options as a second argument. |
| listRoleBindingForAllNamespaces | GET /apis/rbac.authorization.k8s.io/v1/rolebindings | Generated API methods accept optional request options as a second argument. |
| patchNamespacedRoleBinding | PATCH /apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/rolebindings/{name} | partially update the specified RoleBinding |
| replaceNamespacedRoleBinding | PUT /apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/rolebindings/{name} | replace the specified RoleBinding |
| deleteCollectionNamespacedRoleBinding | DELETE /apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/rolebindings | Generated API methods accept optional request options as a second argument. |
| deleteNamespacedRoleBinding | DELETE /apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/rolebindings/{name} | Generated API methods accept optional request options as a second argument. |
APIResources
| Method | HTTP request | Description |
|---|---|---|
| getAPIResources | GET /apis/rbac.authorization.k8s.io/v1/ | Generated API methods accept optional request options as a second argument. |
Cluster Role
createClusterRole
V1ClusterRole createClusterRole(body)
create a ClusterRole
Example
import { createConfiguration, RbacAuthorizationV1Api } from '@kubernetes/client-node';
import type { RbacAuthorizationV1ApiCreateClusterRoleRequest } from '@kubernetes/client-node';
const configuration = createConfiguration();
const apiInstance = new RbacAuthorizationV1Api(configuration);
const request: RbacAuthorizationV1ApiCreateClusterRoleRequest = {
body: { /* See V1ClusterRole: /models/security#v1clusterrole */ },
// If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
pretty: "pretty_example",
// When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional)
dryRun: "dryRun_example",
// fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional)
fieldManager: "fieldManager_example",
// ...1 more optional parameter(s)
};
const data = await apiInstance.createClusterRole(request);
console.log('API called successfully. Returned data:', data);
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| body | V1ClusterRole | ||
| pretty | [string] | If 'true', then the output is pretty printed. More info | (optional) defaults to undefined |
| dryRun | [string] | When present, indicates that modifications should not be persisted. More info | (optional) defaults to undefined |
| fieldManager | [string] | fieldManager is a name associated with the actor or entity that is making these changes. More info | (optional) defaults to undefined |
| fieldValidation | [string] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. More info | (optional) defaults to undefined |
Return type
readClusterRole
V1ClusterRole readClusterRole()
Generated API methods accept optional request options as a second argument.
read the specified ClusterRole
Example
import { createConfiguration, RbacAuthorizationV1Api } from '@kubernetes/client-node';
import type { RbacAuthorizationV1ApiReadClusterRoleRequest } from '@kubernetes/client-node';
const configuration = createConfiguration();
const apiInstance = new RbacAuthorizationV1Api(configuration);
const request: RbacAuthorizationV1ApiReadClusterRoleRequest = {
// name of the ClusterRole
name: "name_example",
// If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
pretty: "pretty_example",
};
const data = await apiInstance.readClusterRole(request);
console.log('API called successfully. Returned data:', data);
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| name | [string] | name of the ClusterRole | defaults to undefined |
| pretty | [string] | If 'true', then the output is pretty printed. More info | (optional) defaults to undefined |
Return type
listClusterRole
V1ClusterRoleList listClusterRole()
Generated API methods accept optional request options as a second argument.
list or watch objects of kind ClusterRole
Example
import { createConfiguration, RbacAuthorizationV1Api } from '@kubernetes/client-node';
import type { RbacAuthorizationV1ApiListClusterRoleRequest } from '@kubernetes/client-node';
const configuration = createConfiguration();
const apiInstance = new RbacAuthorizationV1Api(configuration);
const request: RbacAuthorizationV1ApiListClusterRoleRequest = {
// If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
pretty: "pretty_example",
// allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional)
allowWatchBookmarks: true,
// The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional)
_continue: "continue_example",
// ...9 more optional parameter(s)
};
const data = await apiInstance.listClusterRole(request);
console.log('API called successfully. Returned data:', data);
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| pretty | [string] | If 'true', then the output is pretty printed. More info | (optional) defaults to undefined |
| allowWatchBookmarks | [boolean] | allowWatchBookmarks requests watch events with type "BOOKMARK". More info | (optional) defaults to undefined |
| _continue | [string] | The continue option should be set when retrieving more results from the server. More info | (optional) defaults to undefined |
| fieldSelector | [string] | A selector to restrict the list of returned objects by their fields. Defaults to everything. More info | (optional) defaults to undefined |
| labelSelector | [string] | A selector to restrict the list of returned objects by their labels. Defaults to everything. More info | (optional) defaults to undefined |
| limit | [number] | limit is a maximum number of responses to return for a list call. More info | (optional) defaults to undefined |
| resourceVersion | [string] | resourceVersion sets a constraint on what resource versions a request may be served from. More info | (optional) defaults to undefined |
| resourceVersionMatch | [string] | resourceVersionMatch determines how resourceVersion is applied to list calls. More info | (optional) defaults to undefined |
| sendInitialEvents | [boolean] | sendInitialEvents=true may be set together with watch=true. More info | (optional) defaults to undefined |
| shardSelector | [string] | shardSelector restricts the list of returned objects using a CEL-based shard selector expression. | (optional) defaults to undefined |
| timeoutSeconds | [number] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. More info | (optional) defaults to undefined |
| watch | [boolean] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. More info | (optional) defaults to undefined |
Return type
patchClusterRole
V1ClusterRole patchClusterRole(body)
partially update the specified ClusterRole
Example
import { createConfiguration, RbacAuthorizationV1Api } from '@kubernetes/client-node';
import type { RbacAuthorizationV1ApiPatchClusterRoleRequest } from '@kubernetes/client-node';
const configuration = createConfiguration();
const apiInstance = new RbacAuthorizationV1Api(configuration);
const request: RbacAuthorizationV1ApiPatchClusterRoleRequest = {
// name of the ClusterRole
name: "name_example",
body: { /* See type definition in parameter table */ },
// If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
pretty: "pretty_example",
// When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional)
dryRun: "dryRun_example",
// fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional)
fieldManager: "fieldManager_example",
// ...2 more optional parameter(s)
};
const data = await apiInstance.patchClusterRole(request);
console.log('API called successfully. Returned data:', data);
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| body | any | ||
| name | [string] | name of the ClusterRole | defaults to undefined |
| pretty | [string] | If 'true', then the output is pretty printed. More info | (optional) defaults to undefined |
| dryRun | [string] | When present, indicates that modifications should not be persisted. More info | (optional) defaults to undefined |
| fieldManager | [string] | fieldManager is a name associated with the actor or entity that is making these changes. More info | (optional) defaults to undefined |
| fieldValidation | [string] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. More info | (optional) defaults to undefined |
| force | [boolean] | Force is going to "force" Apply requests. More info | (optional) defaults to undefined |
Return type
replaceClusterRole
V1ClusterRole replaceClusterRole(body)
replace the specified ClusterRole
Example
import { createConfiguration, RbacAuthorizationV1Api } from '@kubernetes/client-node';
import type { RbacAuthorizationV1ApiReplaceClusterRoleRequest } from '@kubernetes/client-node';
const configuration = createConfiguration();
const apiInstance = new RbacAuthorizationV1Api(configuration);
const request: RbacAuthorizationV1ApiReplaceClusterRoleRequest = {
// name of the ClusterRole
name: "name_example",
body: { /* See V1ClusterRole: /models/security#v1clusterrole */ },
// If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
pretty: "pretty_example",
// When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional)
dryRun: "dryRun_example",
// fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional)
fieldManager: "fieldManager_example",
// ...1 more optional parameter(s)
};
const data = await apiInstance.replaceClusterRole(request);
console.log('API called successfully. Returned data:', data);
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| body | V1ClusterRole | ||
| name | [string] | name of the ClusterRole | defaults to undefined |
| pretty | [string] | If 'true', then the output is pretty printed. More info | (optional) defaults to undefined |
| dryRun | [string] | When present, indicates that modifications should not be persisted. More info | (optional) defaults to undefined |
| fieldManager | [string] | fieldManager is a name associated with the actor or entity that is making these changes. More info | (optional) defaults to undefined |
| fieldValidation | [string] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. More info | (optional) defaults to undefined |
Return type
deleteClusterRole
V1Status deleteClusterRole()
Generated API methods accept optional request options as a second argument.
delete a ClusterRole
Example
import { createConfiguration, RbacAuthorizationV1Api } from '@kubernetes/client-node';
import type { RbacAuthorizationV1ApiDeleteClusterRoleRequest } from '@kubernetes/client-node';
const configuration = createConfiguration();
const apiInstance = new RbacAuthorizationV1Api(configuration);
const request: RbacAuthorizationV1ApiDeleteClusterRoleRequest = {
// name of the ClusterRole
name: "name_example",
// If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
pretty: "pretty_example",
// When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional)
dryRun: "dryRun_example",
// The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional)
gracePeriodSeconds: 1,
body: { /* See V1DeleteOptions: /models/other#v1deleteoptions */ },
// ...3 more optional parameter(s)
};
const data = await apiInstance.deleteClusterRole(request);
console.log('API called successfully. Returned data:', data);
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| body | V1DeleteOptions | ||
| name | [string] | name of the ClusterRole | defaults to undefined |
| pretty | [string] | If 'true', then the output is pretty printed. More info | (optional) defaults to undefined |
| dryRun | [string] | When present, indicates that modifications should not be persisted. More info | (optional) defaults to undefined |
| gracePeriodSeconds | [number] | The duration in seconds before the object should be deleted. More info | (optional) defaults to undefined |
| ignoreStoreReadErrorWithClusterBreakingPotential | [boolean] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. More info | (optional) defaults to undefined |
| orphanDependents | [boolean] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. More info | (optional) defaults to undefined |
| propagationPolicy | [string] | Whether and how garbage collection will be performed. More info | (optional) defaults to undefined |
Return type
deleteCollectionClusterRole
V1Status deleteCollectionClusterRole()
Generated API methods accept optional request options as a second argument.
delete collection of ClusterRole
Example
import { createConfiguration, RbacAuthorizationV1Api } from '@kubernetes/client-node';
import type { RbacAuthorizationV1ApiDeleteCollectionClusterRoleRequest } from '@kubernetes/client-node';
const configuration = createConfiguration();
const apiInstance = new RbacAuthorizationV1Api(configuration);
const request: RbacAuthorizationV1ApiDeleteCollectionClusterRoleRequest = {
// If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
pretty: "pretty_example",
// The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional)
_continue: "continue_example",
// When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional)
dryRun: "dryRun_example",
body: { /* See V1DeleteOptions: /models/other#v1deleteoptions */ },
// ...12 more optional parameter(s)
};
const data = await apiInstance.deleteCollectionClusterRole(request);
console.log('API called successfully. Returned data:', data);
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| body | V1DeleteOptions | ||
| pretty | [string] | If 'true', then the output is pretty printed. More info | (optional) defaults to undefined |
| _continue | [string] | The continue option should be set when retrieving more results from the server. More info | (optional) defaults to undefined |
| dryRun | [string] | When present, indicates that modifications should not be persisted. More info | (optional) defaults to undefined |
| fieldSelector | [string] | A selector to restrict the list of returned objects by their fields. Defaults to everything. More info | (optional) defaults to undefined |
| gracePeriodSeconds | [number] | The duration in seconds before the object should be deleted. More info | (optional) defaults to undefined |
| ignoreStoreReadErrorWithClusterBreakingPotential | [boolean] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. More info | (optional) defaults to undefined |
| labelSelector | [string] | A selector to restrict the list of returned objects by their labels. Defaults to everything. More info | (optional) defaults to undefined |
| limit | [number] | limit is a maximum number of responses to return for a list call. More info | (optional) defaults to undefined |
| orphanDependents | [boolean] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. More info | (optional) defaults to undefined |
| propagationPolicy | [string] | Whether and how garbage collection will be performed. More info | (optional) defaults to undefined |
| resourceVersion | [string] | resourceVersion sets a constraint on what resource versions a request may be served from. More info | (optional) defaults to undefined |
| resourceVersionMatch | [string] | resourceVersionMatch determines how resourceVersion is applied to list calls. More info | (optional) defaults to undefined |
| sendInitialEvents | [boolean] | sendInitialEvents=true may be set together with watch=true. More info | (optional) defaults to undefined |
| shardSelector | [string] | shardSelector restricts the list of returned objects using a CEL-based shard selector expression. | (optional) defaults to undefined |
| timeoutSeconds | [number] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. More info | (optional) defaults to undefined |
Return type
Cluster Role Binding
createClusterRoleBinding
V1ClusterRoleBinding createClusterRoleBinding(body)
create a ClusterRoleBinding
Example
import { createConfiguration, RbacAuthorizationV1Api } from '@kubernetes/client-node';
import type { RbacAuthorizationV1ApiCreateClusterRoleBindingRequest } from '@kubernetes/client-node';
const configuration = createConfiguration();
const apiInstance = new RbacAuthorizationV1Api(configuration);
const request: RbacAuthorizationV1ApiCreateClusterRoleBindingRequest = {
body: { /* See V1ClusterRoleBinding: /models/security#v1clusterrolebinding */ },
// If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
pretty: "pretty_example",
// When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional)
dryRun: "dryRun_example",
// fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional)
fieldManager: "fieldManager_example",
// ...1 more optional parameter(s)
};
const data = await apiInstance.createClusterRoleBinding(request);
console.log('API called successfully. Returned data:', data);
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| body | V1ClusterRoleBinding | ||
| pretty | [string] | If 'true', then the output is pretty printed. More info | (optional) defaults to undefined |
| dryRun | [string] | When present, indicates that modifications should not be persisted. More info | (optional) defaults to undefined |
| fieldManager | [string] | fieldManager is a name associated with the actor or entity that is making these changes. More info | (optional) defaults to undefined |
| fieldValidation | [string] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. More info | (optional) defaults to undefined |
Return type
readClusterRoleBinding
V1ClusterRoleBinding readClusterRoleBinding()
Generated API methods accept optional request options as a second argument.
read the specified ClusterRoleBinding
Example
import { createConfiguration, RbacAuthorizationV1Api } from '@kubernetes/client-node';
import type { RbacAuthorizationV1ApiReadClusterRoleBindingRequest } from '@kubernetes/client-node';
const configuration = createConfiguration();
const apiInstance = new RbacAuthorizationV1Api(configuration);
const request: RbacAuthorizationV1ApiReadClusterRoleBindingRequest = {
// name of the ClusterRoleBinding
name: "name_example",
// If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
pretty: "pretty_example",
};
const data = await apiInstance.readClusterRoleBinding(request);
console.log('API called successfully. Returned data:', data);
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| name | [string] | name of the ClusterRoleBinding | defaults to undefined |
| pretty | [string] | If 'true', then the output is pretty printed. More info | (optional) defaults to undefined |
Return type
listClusterRoleBinding
V1ClusterRoleBindingList listClusterRoleBinding()
Generated API methods accept optional request options as a second argument.
list or watch objects of kind ClusterRoleBinding
Example
import { createConfiguration, RbacAuthorizationV1Api } from '@kubernetes/client-node';
import type { RbacAuthorizationV1ApiListClusterRoleBindingRequest } from '@kubernetes/client-node';
const configuration = createConfiguration();
const apiInstance = new RbacAuthorizationV1Api(configuration);
const request: RbacAuthorizationV1ApiListClusterRoleBindingRequest = {
// If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
pretty: "pretty_example",
// allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional)
allowWatchBookmarks: true,
// The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional)
_continue: "continue_example",
// ...9 more optional parameter(s)
};
const data = await apiInstance.listClusterRoleBinding(request);
console.log('API called successfully. Returned data:', data);
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| pretty | [string] | If 'true', then the output is pretty printed. More info | (optional) defaults to undefined |
| allowWatchBookmarks | [boolean] | allowWatchBookmarks requests watch events with type "BOOKMARK". More info | (optional) defaults to undefined |
| _continue | [string] | The continue option should be set when retrieving more results from the server. More info | (optional) defaults to undefined |
| fieldSelector | [string] | A selector to restrict the list of returned objects by their fields. Defaults to everything. More info | (optional) defaults to undefined |
| labelSelector | [string] | A selector to restrict the list of returned objects by their labels. Defaults to everything. More info | (optional) defaults to undefined |
| limit | [number] | limit is a maximum number of responses to return for a list call. More info | (optional) defaults to undefined |
| resourceVersion | [string] | resourceVersion sets a constraint on what resource versions a request may be served from. More info | (optional) defaults to undefined |
| resourceVersionMatch | [string] | resourceVersionMatch determines how resourceVersion is applied to list calls. More info | (optional) defaults to undefined |
| sendInitialEvents | [boolean] | sendInitialEvents=true may be set together with watch=true. More info | (optional) defaults to undefined |
| shardSelector | [string] | shardSelector restricts the list of returned objects using a CEL-based shard selector expression. | (optional) defaults to undefined |
| timeoutSeconds | [number] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. More info | (optional) defaults to undefined |
| watch | [boolean] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. More info | (optional) defaults to undefined |
Return type
patchClusterRoleBinding
V1ClusterRoleBinding patchClusterRoleBinding(body)
partially update the specified ClusterRoleBinding
Example
import { createConfiguration, RbacAuthorizationV1Api } from '@kubernetes/client-node';
import type { RbacAuthorizationV1ApiPatchClusterRoleBindingRequest } from '@kubernetes/client-node';
const configuration = createConfiguration();
const apiInstance = new RbacAuthorizationV1Api(configuration);
const request: RbacAuthorizationV1ApiPatchClusterRoleBindingRequest = {
// name of the ClusterRoleBinding
name: "name_example",
body: { /* See type definition in parameter table */ },
// If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
pretty: "pretty_example",
// When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional)
dryRun: "dryRun_example",
// fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional)
fieldManager: "fieldManager_example",
// ...2 more optional parameter(s)
};
const data = await apiInstance.patchClusterRoleBinding(request);
console.log('API called successfully. Returned data:', data);
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| body | any | ||
| name | [string] | name of the ClusterRoleBinding | defaults to undefined |
| pretty | [string] | If 'true', then the output is pretty printed. More info | (optional) defaults to undefined |
| dryRun | [string] | When present, indicates that modifications should not be persisted. More info | (optional) defaults to undefined |
| fieldManager | [string] | fieldManager is a name associated with the actor or entity that is making these changes. More info | (optional) defaults to undefined |
| fieldValidation | [string] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. More info | (optional) defaults to undefined |
| force | [boolean] | Force is going to "force" Apply requests. More info | (optional) defaults to undefined |
Return type
replaceClusterRoleBinding
V1ClusterRoleBinding replaceClusterRoleBinding(body)
replace the specified ClusterRoleBinding
Example
import { createConfiguration, RbacAuthorizationV1Api } from '@kubernetes/client-node';
import type { RbacAuthorizationV1ApiReplaceClusterRoleBindingRequest } from '@kubernetes/client-node';
const configuration = createConfiguration();
const apiInstance = new RbacAuthorizationV1Api(configuration);
const request: RbacAuthorizationV1ApiReplaceClusterRoleBindingRequest = {
// name of the ClusterRoleBinding
name: "name_example",
body: { /* See V1ClusterRoleBinding: /models/security#v1clusterrolebinding */ },
// If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
pretty: "pretty_example",
// When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional)
dryRun: "dryRun_example",
// fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional)
fieldManager: "fieldManager_example",
// ...1 more optional parameter(s)
};
const data = await apiInstance.replaceClusterRoleBinding(request);
console.log('API called successfully. Returned data:', data);
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| body | V1ClusterRoleBinding | ||
| name | [string] | name of the ClusterRoleBinding | defaults to undefined |
| pretty | [string] | If 'true', then the output is pretty printed. More info | (optional) defaults to undefined |
| dryRun | [string] | When present, indicates that modifications should not be persisted. More info | (optional) defaults to undefined |
| fieldManager | [string] | fieldManager is a name associated with the actor or entity that is making these changes. More info | (optional) defaults to undefined |
| fieldValidation | [string] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. More info | (optional) defaults to undefined |
Return type
deleteClusterRoleBinding
V1Status deleteClusterRoleBinding()
Generated API methods accept optional request options as a second argument.
delete a ClusterRoleBinding
Example
import { createConfiguration, RbacAuthorizationV1Api } from '@kubernetes/client-node';
import type { RbacAuthorizationV1ApiDeleteClusterRoleBindingRequest } from '@kubernetes/client-node';
const configuration = createConfiguration();
const apiInstance = new RbacAuthorizationV1Api(configuration);
const request: RbacAuthorizationV1ApiDeleteClusterRoleBindingRequest = {
// name of the ClusterRoleBinding
name: "name_example",
// If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
pretty: "pretty_example",
// When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional)
dryRun: "dryRun_example",
// The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional)
gracePeriodSeconds: 1,
body: { /* See V1DeleteOptions: /models/other#v1deleteoptions */ },
// ...3 more optional parameter(s)
};
const data = await apiInstance.deleteClusterRoleBinding(request);
console.log('API called successfully. Returned data:', data);
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| body | V1DeleteOptions | ||
| name | [string] | name of the ClusterRoleBinding | defaults to undefined |
| pretty | [string] | If 'true', then the output is pretty printed. More info | (optional) defaults to undefined |
| dryRun | [string] | When present, indicates that modifications should not be persisted. More info | (optional) defaults to undefined |
| gracePeriodSeconds | [number] | The duration in seconds before the object should be deleted. More info | (optional) defaults to undefined |
| ignoreStoreReadErrorWithClusterBreakingPotential | [boolean] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. More info | (optional) defaults to undefined |
| orphanDependents | [boolean] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. More info | (optional) defaults to undefined |
| propagationPolicy | [string] | Whether and how garbage collection will be performed. More info | (optional) defaults to undefined |
Return type
deleteCollectionClusterRoleBinding
V1Status deleteCollectionClusterRoleBinding()
Generated API methods accept optional request options as a second argument.
delete collection of ClusterRoleBinding
Example
import { createConfiguration, RbacAuthorizationV1Api } from '@kubernetes/client-node';
import type { RbacAuthorizationV1ApiDeleteCollectionClusterRoleBindingRequest } from '@kubernetes/client-node';
const configuration = createConfiguration();
const apiInstance = new RbacAuthorizationV1Api(configuration);
const request: RbacAuthorizationV1ApiDeleteCollectionClusterRoleBindingRequest = {
// If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
pretty: "pretty_example",
// The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional)
_continue: "continue_example",
// When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional)
dryRun: "dryRun_example",
body: { /* See V1DeleteOptions: /models/other#v1deleteoptions */ },
// ...12 more optional parameter(s)
};
const data = await apiInstance.deleteCollectionClusterRoleBinding(request);
console.log('API called successfully. Returned data:', data);
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| body | V1DeleteOptions | ||
| pretty | [string] | If 'true', then the output is pretty printed. More info | (optional) defaults to undefined |
| _continue | [string] | The continue option should be set when retrieving more results from the server. More info | (optional) defaults to undefined |
| dryRun | [string] | When present, indicates that modifications should not be persisted. More info | (optional) defaults to undefined |
| fieldSelector | [string] | A selector to restrict the list of returned objects by their fields. Defaults to everything. More info | (optional) defaults to undefined |
| gracePeriodSeconds | [number] | The duration in seconds before the object should be deleted. More info | (optional) defaults to undefined |
| ignoreStoreReadErrorWithClusterBreakingPotential | [boolean] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. More info | (optional) defaults to undefined |
| labelSelector | [string] | A selector to restrict the list of returned objects by their labels. Defaults to everything. More info | (optional) defaults to undefined |
| limit | [number] | limit is a maximum number of responses to return for a list call. More info | (optional) defaults to undefined |
| orphanDependents | [boolean] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. More info | (optional) defaults to undefined |
| propagationPolicy | [string] | Whether and how garbage collection will be performed. More info | (optional) defaults to undefined |
| resourceVersion | [string] | resourceVersion sets a constraint on what resource versions a request may be served from. More info | (optional) defaults to undefined |
| resourceVersionMatch | [string] | resourceVersionMatch determines how resourceVersion is applied to list calls. More info | (optional) defaults to undefined |
| sendInitialEvents | [boolean] | sendInitialEvents=true may be set together with watch=true. More info | (optional) defaults to undefined |
| shardSelector | [string] | shardSelector restricts the list of returned objects using a CEL-based shard selector expression. | (optional) defaults to undefined |
| timeoutSeconds | [number] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. More info | (optional) defaults to undefined |
Return type
Role
createNamespacedRole
V1Role createNamespacedRole(body)
create a Role
Example
import { createConfiguration, RbacAuthorizationV1Api } from '@kubernetes/client-node';
import type { RbacAuthorizationV1ApiCreateNamespacedRoleRequest } from '@kubernetes/client-node';
const configuration = createConfiguration();
const apiInstance = new RbacAuthorizationV1Api(configuration);
const request: RbacAuthorizationV1ApiCreateNamespacedRoleRequest = {
// object name and auth scope, such as for teams and projects
namespace: "namespace_example",
body: { /* See V1Role: /models/security#v1role */ },
// If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
pretty: "pretty_example",
// When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional)
dryRun: "dryRun_example",
// fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional)
fieldManager: "fieldManager_example",
// ...1 more optional parameter(s)
};
const data = await apiInstance.createNamespacedRole(request);
console.log('API called successfully. Returned data:', data);
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| body | V1Role | ||
| namespace | [string] | object name and auth scope, such as for teams and projects | defaults to undefined |
| pretty | [string] | If 'true', then the output is pretty printed. More info | (optional) defaults to undefined |
| dryRun | [string] | When present, indicates that modifications should not be persisted. More info | (optional) defaults to undefined |
| fieldManager | [string] | fieldManager is a name associated with the actor or entity that is making these changes. More info | (optional) defaults to undefined |
| fieldValidation | [string] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. More info | (optional) defaults to undefined |
Return type
readNamespacedRole
V1Role readNamespacedRole()
Generated API methods accept optional request options as a second argument.
read the specified Role
Example
import { createConfiguration, RbacAuthorizationV1Api } from '@kubernetes/client-node';
import type { RbacAuthorizationV1ApiReadNamespacedRoleRequest } from '@kubernetes/client-node';
const configuration = createConfiguration();
const apiInstance = new RbacAuthorizationV1Api(configuration);
const request: RbacAuthorizationV1ApiReadNamespacedRoleRequest = {
// name of the Role
name: "name_example",
// object name and auth scope, such as for teams and projects
namespace: "namespace_example",
// If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
pretty: "pretty_example",
};
const data = await apiInstance.readNamespacedRole(request);
console.log('API called successfully. Returned data:', data);
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| name | [string] | name of the Role | defaults to undefined |
| namespace | [string] | object name and auth scope, such as for teams and projects | defaults to undefined |
| pretty | [string] | If 'true', then the output is pretty printed. More info | (optional) defaults to undefined |
Return type
listNamespacedRole
V1RoleList listNamespacedRole()
Generated API methods accept optional request options as a second argument.
list or watch objects of kind Role
Example
import { createConfiguration, RbacAuthorizationV1Api } from '@kubernetes/client-node';
import type { RbacAuthorizationV1ApiListNamespacedRoleRequest } from '@kubernetes/client-node';
const configuration = createConfiguration();
const apiInstance = new RbacAuthorizationV1Api(configuration);
const request: RbacAuthorizationV1ApiListNamespacedRoleRequest = {
// object name and auth scope, such as for teams and projects
namespace: "namespace_example",
// If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
pretty: "pretty_example",
// allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional)
allowWatchBookmarks: true,
// The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional)
_continue: "continue_example",
// ...9 more optional parameter(s)
};
const data = await apiInstance.listNamespacedRole(request);
console.log('API called successfully. Returned data:', data);
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| namespace | [string] | object name and auth scope, such as for teams and projects | defaults to undefined |
| pretty | [string] | If 'true', then the output is pretty printed. More info | (optional) defaults to undefined |
| allowWatchBookmarks | [boolean] | allowWatchBookmarks requests watch events with type "BOOKMARK". More info | (optional) defaults to undefined |
| _continue | [string] | The continue option should be set when retrieving more results from the server. More info | (optional) defaults to undefined |
| fieldSelector | [string] | A selector to restrict the list of returned objects by their fields. Defaults to everything. More info | (optional) defaults to undefined |
| labelSelector | [string] | A selector to restrict the list of returned objects by their labels. Defaults to everything. More info | (optional) defaults to undefined |
| limit | [number] | limit is a maximum number of responses to return for a list call. More info | (optional) defaults to undefined |
| resourceVersion | [string] | resourceVersion sets a constraint on what resource versions a request may be served from. More info | (optional) defaults to undefined |
| resourceVersionMatch | [string] | resourceVersionMatch determines how resourceVersion is applied to list calls. More info | (optional) defaults to undefined |
| sendInitialEvents | [boolean] | sendInitialEvents=true may be set together with watch=true. More info | (optional) defaults to undefined |
| shardSelector | [string] | shardSelector restricts the list of returned objects using a CEL-based shard selector expression. | (optional) defaults to undefined |
| timeoutSeconds | [number] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. More info | (optional) defaults to undefined |
| watch | [boolean] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. More info | (optional) defaults to undefined |
Return type
listRoleForAllNamespaces
V1RoleList listRoleForAllNamespaces()
Generated API methods accept optional request options as a second argument.
list or watch objects of kind Role
Example
import { createConfiguration, RbacAuthorizationV1Api } from '@kubernetes/client-node';
import type { RbacAuthorizationV1ApiListRoleForAllNamespacesRequest } from '@kubernetes/client-node';
const configuration = createConfiguration();
const apiInstance = new RbacAuthorizationV1Api(configuration);
const request: RbacAuthorizationV1ApiListRoleForAllNamespacesRequest = {
// allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional)
allowWatchBookmarks: true,
// The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional)
_continue: "continue_example",
// A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional)
fieldSelector: "fieldSelector_example",
// ...9 more optional parameter(s)
};
const data = await apiInstance.listRoleForAllNamespaces(request);
console.log('API called successfully. Returned data:', data);
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| allowWatchBookmarks | [boolean] | allowWatchBookmarks requests watch events with type "BOOKMARK". More info | (optional) defaults to undefined |
| _continue | [string] | The continue option should be set when retrieving more results from the server. More info | (optional) defaults to undefined |
| fieldSelector | [string] | A selector to restrict the list of returned objects by their fields. Defaults to everything. More info | (optional) defaults to undefined |
| labelSelector | [string] | A selector to restrict the list of returned objects by their labels. Defaults to everything. More info | (optional) defaults to undefined |
| limit | [number] | limit is a maximum number of responses to return for a list call. More info | (optional) defaults to undefined |
| pretty | [string] | If 'true', then the output is pretty printed. More info | (optional) defaults to undefined |
| resourceVersion | [string] | resourceVersion sets a constraint on what resource versions a request may be served from. More info | (optional) defaults to undefined |
| resourceVersionMatch | [string] | resourceVersionMatch determines how resourceVersion is applied to list calls. More info | (optional) defaults to undefined |
| sendInitialEvents | [boolean] | sendInitialEvents=true may be set together with watch=true. More info | (optional) defaults to undefined |
| shardSelector | [string] | shardSelector restricts the list of returned objects using a CEL-based shard selector expression. | (optional) defaults to undefined |
| timeoutSeconds | [number] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. More info | (optional) defaults to undefined |
| watch | [boolean] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. More info | (optional) defaults to undefined |
Return type
patchNamespacedRole
V1Role patchNamespacedRole(body)
partially update the specified Role
Example
import { createConfiguration, RbacAuthorizationV1Api } from '@kubernetes/client-node';
import type { RbacAuthorizationV1ApiPatchNamespacedRoleRequest } from '@kubernetes/client-node';
const configuration = createConfiguration();
const apiInstance = new RbacAuthorizationV1Api(configuration);
const request: RbacAuthorizationV1ApiPatchNamespacedRoleRequest = {
// name of the Role
name: "name_example",
// object name and auth scope, such as for teams and projects
namespace: "namespace_example",
body: { /* See type definition in parameter table */ },
// If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
pretty: "pretty_example",
// When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional)
dryRun: "dryRun_example",
// fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional)
fieldManager: "fieldManager_example",
// ...2 more optional parameter(s)
};
const data = await apiInstance.patchNamespacedRole(request);
console.log('API called successfully. Returned data:', data);
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| body | any | ||
| name | [string] | name of the Role | defaults to undefined |
| namespace | [string] | object name and auth scope, such as for teams and projects | defaults to undefined |
| pretty | [string] | If 'true', then the output is pretty printed. More info | (optional) defaults to undefined |
| dryRun | [string] | When present, indicates that modifications should not be persisted. More info | (optional) defaults to undefined |
| fieldManager | [string] | fieldManager is a name associated with the actor or entity that is making these changes. More info | (optional) defaults to undefined |
| fieldValidation | [string] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. More info | (optional) defaults to undefined |
| force | [boolean] | Force is going to "force" Apply requests. More info | (optional) defaults to undefined |
Return type
replaceNamespacedRole
V1Role replaceNamespacedRole(body)
replace the specified Role
Example
import { createConfiguration, RbacAuthorizationV1Api } from '@kubernetes/client-node';
import type { RbacAuthorizationV1ApiReplaceNamespacedRoleRequest } from '@kubernetes/client-node';
const configuration = createConfiguration();
const apiInstance = new RbacAuthorizationV1Api(configuration);
const request: RbacAuthorizationV1ApiReplaceNamespacedRoleRequest = {
// name of the Role
name: "name_example",
// object name and auth scope, such as for teams and projects
namespace: "namespace_example",
body: { /* See V1Role: /models/security#v1role */ },
// If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
pretty: "pretty_example",
// When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional)
dryRun: "dryRun_example",
// fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional)
fieldManager: "fieldManager_example",
// ...1 more optional parameter(s)
};
const data = await apiInstance.replaceNamespacedRole(request);
console.log('API called successfully. Returned data:', data);
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| body | V1Role | ||
| name | [string] | name of the Role | defaults to undefined |
| namespace | [string] | object name and auth scope, such as for teams and projects | defaults to undefined |
| pretty | [string] | If 'true', then the output is pretty printed. More info | (optional) defaults to undefined |
| dryRun | [string] | When present, indicates that modifications should not be persisted. More info | (optional) defaults to undefined |
| fieldManager | [string] | fieldManager is a name associated with the actor or entity that is making these changes. More info | (optional) defaults to undefined |
| fieldValidation | [string] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. More info | (optional) defaults to undefined |
Return type
deleteCollectionNamespacedRole
V1Status deleteCollectionNamespacedRole()
Generated API methods accept optional request options as a second argument.
delete collection of Role
Example
import { createConfiguration, RbacAuthorizationV1Api } from '@kubernetes/client-node';
import type { RbacAuthorizationV1ApiDeleteCollectionNamespacedRoleRequest } from '@kubernetes/client-node';
const configuration = createConfiguration();
const apiInstance = new RbacAuthorizationV1Api(configuration);
const request: RbacAuthorizationV1ApiDeleteCollectionNamespacedRoleRequest = {
// object name and auth scope, such as for teams and projects
namespace: "namespace_example",
// If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
pretty: "pretty_example",
// The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional)
_continue: "continue_example",
// When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional)
dryRun: "dryRun_example",
body: { /* See V1DeleteOptions: /models/other#v1deleteoptions */ },
// ...12 more optional parameter(s)
};
const data = await apiInstance.deleteCollectionNamespacedRole(request);
console.log('API called successfully. Returned data:', data);
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| body | V1DeleteOptions | ||
| namespace | [string] | object name and auth scope, such as for teams and projects | defaults to undefined |
| pretty | [string] | If 'true', then the output is pretty printed. More info | (optional) defaults to undefined |
| _continue | [string] | The continue option should be set when retrieving more results from the server. More info | (optional) defaults to undefined |
| dryRun | [string] | When present, indicates that modifications should not be persisted. More info | (optional) defaults to undefined |
| fieldSelector | [string] | A selector to restrict the list of returned objects by their fields. Defaults to everything. More info | (optional) defaults to undefined |
| gracePeriodSeconds | [number] | The duration in seconds before the object should be deleted. More info | (optional) defaults to undefined |
| ignoreStoreReadErrorWithClusterBreakingPotential | [boolean] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. More info | (optional) defaults to undefined |
| labelSelector | [string] | A selector to restrict the list of returned objects by their labels. Defaults to everything. More info | (optional) defaults to undefined |
| limit | [number] | limit is a maximum number of responses to return for a list call. More info | (optional) defaults to undefined |
| orphanDependents | [boolean] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. More info | (optional) defaults to undefined |
| propagationPolicy | [string] | Whether and how garbage collection will be performed. More info | (optional) defaults to undefined |
| resourceVersion | [string] | resourceVersion sets a constraint on what resource versions a request may be served from. More info | (optional) defaults to undefined |
| resourceVersionMatch | [string] | resourceVersionMatch determines how resourceVersion is applied to list calls. More info | (optional) defaults to undefined |
| sendInitialEvents | [boolean] | sendInitialEvents=true may be set together with watch=true. More info | (optional) defaults to undefined |
| shardSelector | [string] | shardSelector restricts the list of returned objects using a CEL-based shard selector expression. | (optional) defaults to undefined |
| timeoutSeconds | [number] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. More info | (optional) defaults to undefined |
Return type
deleteNamespacedRole
V1Status deleteNamespacedRole()
Generated API methods accept optional request options as a second argument.
delete a Role
Example
import { createConfiguration, RbacAuthorizationV1Api } from '@kubernetes/client-node';
import type { RbacAuthorizationV1ApiDeleteNamespacedRoleRequest } from '@kubernetes/client-node';
const configuration = createConfiguration();
const apiInstance = new RbacAuthorizationV1Api(configuration);
const request: RbacAuthorizationV1ApiDeleteNamespacedRoleRequest = {
// name of the Role
name: "name_example",
// object name and auth scope, such as for teams and projects
namespace: "namespace_example",
// If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
pretty: "pretty_example",
// When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional)
dryRun: "dryRun_example",
// The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional)
gracePeriodSeconds: 1,
body: { /* See V1DeleteOptions: /models/other#v1deleteoptions */ },
// ...3 more optional parameter(s)
};
const data = await apiInstance.deleteNamespacedRole(request);
console.log('API called successfully. Returned data:', data);
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| body | V1DeleteOptions | ||
| name | [string] | name of the Role | defaults to undefined |
| namespace | [string] | object name and auth scope, such as for teams and projects | defaults to undefined |
| pretty | [string] | If 'true', then the output is pretty printed. More info | (optional) defaults to undefined |
| dryRun | [string] | When present, indicates that modifications should not be persisted. More info | (optional) defaults to undefined |
| gracePeriodSeconds | [number] | The duration in seconds before the object should be deleted. More info | (optional) defaults to undefined |
| ignoreStoreReadErrorWithClusterBreakingPotential | [boolean] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. More info | (optional) defaults to undefined |
| orphanDependents | [boolean] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. More info | (optional) defaults to undefined |
| propagationPolicy | [string] | Whether and how garbage collection will be performed. More info | (optional) defaults to undefined |
Return type
Role Binding
createNamespacedRoleBinding
V1RoleBinding createNamespacedRoleBinding(body)
create a RoleBinding
Example
import { createConfiguration, RbacAuthorizationV1Api } from '@kubernetes/client-node';
import type { RbacAuthorizationV1ApiCreateNamespacedRoleBindingRequest } from '@kubernetes/client-node';
const configuration = createConfiguration();
const apiInstance = new RbacAuthorizationV1Api(configuration);
const request: RbacAuthorizationV1ApiCreateNamespacedRoleBindingRequest = {
// object name and auth scope, such as for teams and projects
namespace: "namespace_example",
body: { /* See V1RoleBinding: /models/security#v1rolebinding */ },
// If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
pretty: "pretty_example",
// When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional)
dryRun: "dryRun_example",
// fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional)
fieldManager: "fieldManager_example",
// ...1 more optional parameter(s)
};
const data = await apiInstance.createNamespacedRoleBinding(request);
console.log('API called successfully. Returned data:', data);
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| body | V1RoleBinding | ||
| namespace | [string] | object name and auth scope, such as for teams and projects | defaults to undefined |
| pretty | [string] | If 'true', then the output is pretty printed. More info | (optional) defaults to undefined |
| dryRun | [string] | When present, indicates that modifications should not be persisted. More info | (optional) defaults to undefined |
| fieldManager | [string] | fieldManager is a name associated with the actor or entity that is making these changes. More info | (optional) defaults to undefined |
| fieldValidation | [string] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. More info | (optional) defaults to undefined |
Return type
readNamespacedRoleBinding
V1RoleBinding readNamespacedRoleBinding()
Generated API methods accept optional request options as a second argument.
read the specified RoleBinding
Example
import { createConfiguration, RbacAuthorizationV1Api } from '@kubernetes/client-node';
import type { RbacAuthorizationV1ApiReadNamespacedRoleBindingRequest } from '@kubernetes/client-node';
const configuration = createConfiguration();
const apiInstance = new RbacAuthorizationV1Api(configuration);
const request: RbacAuthorizationV1ApiReadNamespacedRoleBindingRequest = {
// name of the RoleBinding
name: "name_example",
// object name and auth scope, such as for teams and projects
namespace: "namespace_example",
// If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
pretty: "pretty_example",
};
const data = await apiInstance.readNamespacedRoleBinding(request);
console.log('API called successfully. Returned data:', data);
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| name | [string] | name of the RoleBinding | defaults to undefined |
| namespace | [string] | object name and auth scope, such as for teams and projects | defaults to undefined |
| pretty | [string] | If 'true', then the output is pretty printed. More info | (optional) defaults to undefined |
Return type
listNamespacedRoleBinding
V1RoleBindingList listNamespacedRoleBinding()
Generated API methods accept optional request options as a second argument.
list or watch objects of kind RoleBinding
Example
import { createConfiguration, RbacAuthorizationV1Api } from '@kubernetes/client-node';
import type { RbacAuthorizationV1ApiListNamespacedRoleBindingRequest } from '@kubernetes/client-node';
const configuration = createConfiguration();
const apiInstance = new RbacAuthorizationV1Api(configuration);
const request: RbacAuthorizationV1ApiListNamespacedRoleBindingRequest = {
// object name and auth scope, such as for teams and projects
namespace: "namespace_example",
// If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
pretty: "pretty_example",
// allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional)
allowWatchBookmarks: true,
// The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional)
_continue: "continue_example",
// ...9 more optional parameter(s)
};
const data = await apiInstance.listNamespacedRoleBinding(request);
console.log('API called successfully. Returned data:', data);
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| namespace | [string] | object name and auth scope, such as for teams and projects | defaults to undefined |
| pretty | [string] | If 'true', then the output is pretty printed. More info | (optional) defaults to undefined |
| allowWatchBookmarks | [boolean] | allowWatchBookmarks requests watch events with type "BOOKMARK". More info | (optional) defaults to undefined |
| _continue | [string] | The continue option should be set when retrieving more results from the server. More info | (optional) defaults to undefined |
| fieldSelector | [string] | A selector to restrict the list of returned objects by their fields. Defaults to everything. More info | (optional) defaults to undefined |
| labelSelector | [string] | A selector to restrict the list of returned objects by their labels. Defaults to everything. More info | (optional) defaults to undefined |
| limit | [number] | limit is a maximum number of responses to return for a list call. More info | (optional) defaults to undefined |
| resourceVersion | [string] | resourceVersion sets a constraint on what resource versions a request may be served from. More info | (optional) defaults to undefined |
| resourceVersionMatch | [string] | resourceVersionMatch determines how resourceVersion is applied to list calls. More info | (optional) defaults to undefined |
| sendInitialEvents | [boolean] | sendInitialEvents=true may be set together with watch=true. More info | (optional) defaults to undefined |
| shardSelector | [string] | shardSelector restricts the list of returned objects using a CEL-based shard selector expression. | (optional) defaults to undefined |
| timeoutSeconds | [number] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. More info | (optional) defaults to undefined |
| watch | [boolean] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. More info | (optional) defaults to undefined |
Return type
listRoleBindingForAllNamespaces
V1RoleBindingList listRoleBindingForAllNamespaces()
Generated API methods accept optional request options as a second argument.
list or watch objects of kind RoleBinding
Example
import { createConfiguration, RbacAuthorizationV1Api } from '@kubernetes/client-node';
import type { RbacAuthorizationV1ApiListRoleBindingForAllNamespacesRequest } from '@kubernetes/client-node';
const configuration = createConfiguration();
const apiInstance = new RbacAuthorizationV1Api(configuration);
const request: RbacAuthorizationV1ApiListRoleBindingForAllNamespacesRequest = {
// allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server\'s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. (optional)
allowWatchBookmarks: true,
// The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional)
_continue: "continue_example",
// A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional)
fieldSelector: "fieldSelector_example",
// ...9 more optional parameter(s)
};
const data = await apiInstance.listRoleBindingForAllNamespaces(request);
console.log('API called successfully. Returned data:', data);
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| allowWatchBookmarks | [boolean] | allowWatchBookmarks requests watch events with type "BOOKMARK". More info | (optional) defaults to undefined |
| _continue | [string] | The continue option should be set when retrieving more results from the server. More info | (optional) defaults to undefined |
| fieldSelector | [string] | A selector to restrict the list of returned objects by their fields. Defaults to everything. More info | (optional) defaults to undefined |
| labelSelector | [string] | A selector to restrict the list of returned objects by their labels. Defaults to everything. More info | (optional) defaults to undefined |
| limit | [number] | limit is a maximum number of responses to return for a list call. More info | (optional) defaults to undefined |
| pretty | [string] | If 'true', then the output is pretty printed. More info | (optional) defaults to undefined |
| resourceVersion | [string] | resourceVersion sets a constraint on what resource versions a request may be served from. More info | (optional) defaults to undefined |
| resourceVersionMatch | [string] | resourceVersionMatch determines how resourceVersion is applied to list calls. More info | (optional) defaults to undefined |
| sendInitialEvents | [boolean] | sendInitialEvents=true may be set together with watch=true. More info | (optional) defaults to undefined |
| shardSelector | [string] | shardSelector restricts the list of returned objects using a CEL-based shard selector expression. | (optional) defaults to undefined |
| timeoutSeconds | [number] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. More info | (optional) defaults to undefined |
| watch | [boolean] | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. More info | (optional) defaults to undefined |
Return type
patchNamespacedRoleBinding
V1RoleBinding patchNamespacedRoleBinding(body)
partially update the specified RoleBinding
Example
import { createConfiguration, RbacAuthorizationV1Api } from '@kubernetes/client-node';
import type { RbacAuthorizationV1ApiPatchNamespacedRoleBindingRequest } from '@kubernetes/client-node';
const configuration = createConfiguration();
const apiInstance = new RbacAuthorizationV1Api(configuration);
const request: RbacAuthorizationV1ApiPatchNamespacedRoleBindingRequest = {
// name of the RoleBinding
name: "name_example",
// object name and auth scope, such as for teams and projects
namespace: "namespace_example",
body: { /* See type definition in parameter table */ },
// If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
pretty: "pretty_example",
// When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional)
dryRun: "dryRun_example",
// fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). (optional)
fieldManager: "fieldManager_example",
// ...2 more optional parameter(s)
};
const data = await apiInstance.patchNamespacedRoleBinding(request);
console.log('API called successfully. Returned data:', data);
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| body | any | ||
| name | [string] | name of the RoleBinding | defaults to undefined |
| namespace | [string] | object name and auth scope, such as for teams and projects | defaults to undefined |
| pretty | [string] | If 'true', then the output is pretty printed. More info | (optional) defaults to undefined |
| dryRun | [string] | When present, indicates that modifications should not be persisted. More info | (optional) defaults to undefined |
| fieldManager | [string] | fieldManager is a name associated with the actor or entity that is making these changes. More info | (optional) defaults to undefined |
| fieldValidation | [string] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. More info | (optional) defaults to undefined |
| force | [boolean] | Force is going to "force" Apply requests. More info | (optional) defaults to undefined |
Return type
replaceNamespacedRoleBinding
V1RoleBinding replaceNamespacedRoleBinding(body)
replace the specified RoleBinding
Example
import { createConfiguration, RbacAuthorizationV1Api } from '@kubernetes/client-node';
import type { RbacAuthorizationV1ApiReplaceNamespacedRoleBindingRequest } from '@kubernetes/client-node';
const configuration = createConfiguration();
const apiInstance = new RbacAuthorizationV1Api(configuration);
const request: RbacAuthorizationV1ApiReplaceNamespacedRoleBindingRequest = {
// name of the RoleBinding
name: "name_example",
// object name and auth scope, such as for teams and projects
namespace: "namespace_example",
body: { /* See V1RoleBinding: /models/security#v1rolebinding */ },
// If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
pretty: "pretty_example",
// When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional)
dryRun: "dryRun_example",
// fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional)
fieldManager: "fieldManager_example",
// ...1 more optional parameter(s)
};
const data = await apiInstance.replaceNamespacedRoleBinding(request);
console.log('API called successfully. Returned data:', data);
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| body | V1RoleBinding | ||
| name | [string] | name of the RoleBinding | defaults to undefined |
| namespace | [string] | object name and auth scope, such as for teams and projects | defaults to undefined |
| pretty | [string] | If 'true', then the output is pretty printed. More info | (optional) defaults to undefined |
| dryRun | [string] | When present, indicates that modifications should not be persisted. More info | (optional) defaults to undefined |
| fieldManager | [string] | fieldManager is a name associated with the actor or entity that is making these changes. More info | (optional) defaults to undefined |
| fieldValidation | [string] | fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. More info | (optional) defaults to undefined |
Return type
deleteCollectionNamespacedRoleBinding
V1Status deleteCollectionNamespacedRoleBinding()
Generated API methods accept optional request options as a second argument.
delete collection of RoleBinding
Example
import { createConfiguration, RbacAuthorizationV1Api } from '@kubernetes/client-node';
import type { RbacAuthorizationV1ApiDeleteCollectionNamespacedRoleBindingRequest } from '@kubernetes/client-node';
const configuration = createConfiguration();
const apiInstance = new RbacAuthorizationV1Api(configuration);
const request: RbacAuthorizationV1ApiDeleteCollectionNamespacedRoleBindingRequest = {
// object name and auth scope, such as for teams and projects
namespace: "namespace_example",
// If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
pretty: "pretty_example",
// The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional)
_continue: "continue_example",
// When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional)
dryRun: "dryRun_example",
body: { /* See V1DeleteOptions: /models/other#v1deleteoptions */ },
// ...12 more optional parameter(s)
};
const data = await apiInstance.deleteCollectionNamespacedRoleBinding(request);
console.log('API called successfully. Returned data:', data);
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| body | V1DeleteOptions | ||
| namespace | [string] | object name and auth scope, such as for teams and projects | defaults to undefined |
| pretty | [string] | If 'true', then the output is pretty printed. More info | (optional) defaults to undefined |
| _continue | [string] | The continue option should be set when retrieving more results from the server. More info | (optional) defaults to undefined |
| dryRun | [string] | When present, indicates that modifications should not be persisted. More info | (optional) defaults to undefined |
| fieldSelector | [string] | A selector to restrict the list of returned objects by their fields. Defaults to everything. More info | (optional) defaults to undefined |
| gracePeriodSeconds | [number] | The duration in seconds before the object should be deleted. More info | (optional) defaults to undefined |
| ignoreStoreReadErrorWithClusterBreakingPotential | [boolean] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. More info | (optional) defaults to undefined |
| labelSelector | [string] | A selector to restrict the list of returned objects by their labels. Defaults to everything. More info | (optional) defaults to undefined |
| limit | [number] | limit is a maximum number of responses to return for a list call. More info | (optional) defaults to undefined |
| orphanDependents | [boolean] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. More info | (optional) defaults to undefined |
| propagationPolicy | [string] | Whether and how garbage collection will be performed. More info | (optional) defaults to undefined |
| resourceVersion | [string] | resourceVersion sets a constraint on what resource versions a request may be served from. More info | (optional) defaults to undefined |
| resourceVersionMatch | [string] | resourceVersionMatch determines how resourceVersion is applied to list calls. More info | (optional) defaults to undefined |
| sendInitialEvents | [boolean] | sendInitialEvents=true may be set together with watch=true. More info | (optional) defaults to undefined |
| shardSelector | [string] | shardSelector restricts the list of returned objects using a CEL-based shard selector expression. | (optional) defaults to undefined |
| timeoutSeconds | [number] | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. More info | (optional) defaults to undefined |
Return type
deleteNamespacedRoleBinding
V1Status deleteNamespacedRoleBinding()
Generated API methods accept optional request options as a second argument.
delete a RoleBinding
Example
import { createConfiguration, RbacAuthorizationV1Api } from '@kubernetes/client-node';
import type { RbacAuthorizationV1ApiDeleteNamespacedRoleBindingRequest } from '@kubernetes/client-node';
const configuration = createConfiguration();
const apiInstance = new RbacAuthorizationV1Api(configuration);
const request: RbacAuthorizationV1ApiDeleteNamespacedRoleBindingRequest = {
// name of the RoleBinding
name: "name_example",
// object name and auth scope, such as for teams and projects
namespace: "namespace_example",
// If \'true\', then the output is pretty printed. Defaults to \'false\' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget). (optional)
pretty: "pretty_example",
// When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional)
dryRun: "dryRun_example",
// The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional)
gracePeriodSeconds: 1,
body: { /* See V1DeleteOptions: /models/other#v1deleteoptions */ },
// ...3 more optional parameter(s)
};
const data = await apiInstance.deleteNamespacedRoleBinding(request);
console.log('API called successfully. Returned data:', data);
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| body | V1DeleteOptions | ||
| name | [string] | name of the RoleBinding | defaults to undefined |
| namespace | [string] | object name and auth scope, such as for teams and projects | defaults to undefined |
| pretty | [string] | If 'true', then the output is pretty printed. More info | (optional) defaults to undefined |
| dryRun | [string] | When present, indicates that modifications should not be persisted. More info | (optional) defaults to undefined |
| gracePeriodSeconds | [number] | The duration in seconds before the object should be deleted. More info | (optional) defaults to undefined |
| ignoreStoreReadErrorWithClusterBreakingPotential | [boolean] | if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. More info | (optional) defaults to undefined |
| orphanDependents | [boolean] | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. More info | (optional) defaults to undefined |
| propagationPolicy | [string] | Whether and how garbage collection will be performed. More info | (optional) defaults to undefined |
Return type
APIResources
getAPIResources
V1APIResourceList getAPIResources()
Generated API methods accept optional request options as a second argument.
get available resources
Example
import { createConfiguration, RbacAuthorizationV1Api } from '@kubernetes/client-node';
const configuration = createConfiguration();
const apiInstance = new RbacAuthorizationV1Api(configuration);
const request = {};
const data = await apiInstance.getAPIResources(request);
console.log('API called successfully. Returned data:', data);
Parameters
This endpoint does not need any parameter.