AdmissionregistrationV1Api
All URIs are relative to http://localhost
Mutating Webhook Configuration
| Method | HTTP request | Description |
|---|---|---|
| createMutatingWebhookConfiguration | POST /apis/admissionregistration.k8s.io/v1/mutatingwebhookconfigurations | create a MutatingWebhookConfiguration |
| readMutatingWebhookConfiguration | GET /apis/admissionregistration.k8s.io/v1/mutatingwebhookconfigurations/{name} | read the specified MutatingWebhookConfiguration |
| listMutatingWebhookConfiguration | GET /apis/admissionregistration.k8s.io/v1/mutatingwebhookconfigurations | list or watch objects of kind MutatingWebhookConfiguration |
| patchMutatingWebhookConfiguration | PATCH /apis/admissionregistration.k8s.io/v1/mutatingwebhookconfigurations/{name} | partially update the specified MutatingWebhookConfiguration |
| replaceMutatingWebhookConfiguration | PUT /apis/admissionregistration.k8s.io/v1/mutatingwebhookconfigurations/{name} | replace the specified MutatingWebhookConfiguration |
| deleteCollectionMutatingWebhookConfiguration | DELETE /apis/admissionregistration.k8s.io/v1/mutatingwebhookconfigurations | delete collection of MutatingWebhookConfiguration |
| deleteMutatingWebhookConfiguration | DELETE /apis/admissionregistration.k8s.io/v1/mutatingwebhookconfigurations/{name} | delete a MutatingWebhookConfiguration |
Validating Admission Policy
| Method | HTTP request | Description |
|---|---|---|
| createValidatingAdmissionPolicy | POST /apis/admissionregistration.k8s.io/v1/validatingadmissionpolicies | create a ValidatingAdmissionPolicy |
| readValidatingAdmissionPolicy | GET /apis/admissionregistration.k8s.io/v1/validatingadmissionpolicies/{name} | read the specified ValidatingAdmissionPolicy |
| listValidatingAdmissionPolicy | GET /apis/admissionregistration.k8s.io/v1/validatingadmissionpolicies | list or watch objects of kind ValidatingAdmissionPolicy |
| readValidatingAdmissionPolicyStatus | GET /apis/admissionregistration.k8s.io/v1/validatingadmissionpolicies/{name}/status | read status of the specified ValidatingAdmissionPolicy |
| patchValidatingAdmissionPolicy | PATCH /apis/admissionregistration.k8s.io/v1/validatingadmissionpolicies/{name} | partially update the specified ValidatingAdmissionPolicy |
| patchValidatingAdmissionPolicyStatus | PATCH /apis/admissionregistration.k8s.io/v1/validatingadmissionpolicies/{name}/status | partially update status of the specified ValidatingAdmissionPolicy |
| replaceValidatingAdmissionPolicy | PUT /apis/admissionregistration.k8s.io/v1/validatingadmissionpolicies/{name} | replace the specified ValidatingAdmissionPolicy |
| deleteCollectionValidatingAdmissionPolicy | DELETE /apis/admissionregistration.k8s.io/v1/validatingadmissionpolicies | delete collection of ValidatingAdmissionPolicy |
| deleteValidatingAdmissionPolicy | DELETE /apis/admissionregistration.k8s.io/v1/validatingadmissionpolicies/{name} | delete a ValidatingAdmissionPolicy |
| replaceValidatingAdmissionPolicyStatus | PUT /apis/admissionregistration.k8s.io/v1/validatingadmissionpolicies/{name}/status | replace status of the specified ValidatingAdmissionPolicy |
Validating Admission Policy Binding
| Method | HTTP request | Description |
|---|---|---|
| createValidatingAdmissionPolicyBinding | POST /apis/admissionregistration.k8s.io/v1/validatingadmissionpolicybindings | create a ValidatingAdmissionPolicyBinding |
| readValidatingAdmissionPolicyBinding | GET /apis/admissionregistration.k8s.io/v1/validatingadmissionpolicybindings/{name} | read the specified ValidatingAdmissionPolicyBinding |
| listValidatingAdmissionPolicyBinding | GET /apis/admissionregistration.k8s.io/v1/validatingadmissionpolicybindings | list or watch objects of kind ValidatingAdmissionPolicyBinding |
| patchValidatingAdmissionPolicyBinding | PATCH /apis/admissionregistration.k8s.io/v1/validatingadmissionpolicybindings/{name} | partially update the specified ValidatingAdmissionPolicyBinding |
| replaceValidatingAdmissionPolicyBinding | PUT /apis/admissionregistration.k8s.io/v1/validatingadmissionpolicybindings/{name} | replace the specified ValidatingAdmissionPolicyBinding |
| deleteCollectionValidatingAdmissionPolicyBinding | DELETE /apis/admissionregistration.k8s.io/v1/validatingadmissionpolicybindings | delete collection of ValidatingAdmissionPolicyBinding |
| deleteValidatingAdmissionPolicyBinding | DELETE /apis/admissionregistration.k8s.io/v1/validatingadmissionpolicybindings/{name} | delete a ValidatingAdmissionPolicyBinding |
Validating Webhook Configuration
| Method | HTTP request | Description |
|---|---|---|
| createValidatingWebhookConfiguration | POST /apis/admissionregistration.k8s.io/v1/validatingwebhookconfigurations | create a ValidatingWebhookConfiguration |
| readValidatingWebhookConfiguration | GET /apis/admissionregistration.k8s.io/v1/validatingwebhookconfigurations/{name} | read the specified ValidatingWebhookConfiguration |
| listValidatingWebhookConfiguration | GET /apis/admissionregistration.k8s.io/v1/validatingwebhookconfigurations | list or watch objects of kind ValidatingWebhookConfiguration |
| patchValidatingWebhookConfiguration | PATCH /apis/admissionregistration.k8s.io/v1/validatingwebhookconfigurations/{name} | partially update the specified ValidatingWebhookConfiguration |
| replaceValidatingWebhookConfiguration | PUT /apis/admissionregistration.k8s.io/v1/validatingwebhookconfigurations/{name} | replace the specified ValidatingWebhookConfiguration |
| deleteCollectionValidatingWebhookConfiguration | DELETE /apis/admissionregistration.k8s.io/v1/validatingwebhookconfigurations | delete collection of ValidatingWebhookConfiguration |
| deleteValidatingWebhookConfiguration | DELETE /apis/admissionregistration.k8s.io/v1/validatingwebhookconfigurations/{name} | delete a ValidatingWebhookConfiguration |
APIResources
| Method | HTTP request | Description |
|---|---|---|
| getAPIResources | GET /apis/admissionregistration.k8s.io/v1/ | get available resources |
Mutating Webhook Configuration
createMutatingWebhookConfiguration
V1MutatingWebhookConfiguration createMutatingWebhookConfiguration(body)
create a MutatingWebhookConfiguration
Example
import { createConfiguration, AdmissionregistrationV1Api } from '@kubernetes/client-node';
import type { AdmissionregistrationV1ApiCreateMutatingWebhookConfigurationRequest } from '@kubernetes/client-node';
const configuration = createConfiguration();
const apiInstance = new AdmissionregistrationV1Api(configuration);
const request: AdmissionregistrationV1ApiCreateMutatingWebhookConfigurationRequest = {
body: { /* See V1MutatingWebhookConfiguration: /models/cluster#v1mutatingwebhookconfiguration */ },
// 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.createMutatingWebhookConfiguration(request);
console.log('API called successfully. Returned data:', data);
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| body | V1MutatingWebhookConfiguration | ||
| 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
V1MutatingWebhookConfiguration
readMutatingWebhookConfiguration
V1MutatingWebhookConfiguration readMutatingWebhookConfiguration()
read the specified MutatingWebhookConfiguration
Example
import { createConfiguration, AdmissionregistrationV1Api } from '@kubernetes/client-node';
import type { AdmissionregistrationV1ApiReadMutatingWebhookConfigurationRequest } from '@kubernetes/client-node';
const configuration = createConfiguration();
const apiInstance = new AdmissionregistrationV1Api(configuration);
const request: AdmissionregistrationV1ApiReadMutatingWebhookConfigurationRequest = {
// name of the MutatingWebhookConfiguration
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.readMutatingWebhookConfiguration(request);
console.log('API called successfully. Returned data:', data);
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| name | [string] | name of the MutatingWebhookConfiguration | defaults to undefined |
| pretty | [string] | If 'true', then the output is pretty printed. More info | (optional) defaults to undefined |
Return type
V1MutatingWebhookConfiguration
listMutatingWebhookConfiguration
V1MutatingWebhookConfigurationList listMutatingWebhookConfiguration()
list or watch objects of kind MutatingWebhookConfiguration
Example
import { createConfiguration, AdmissionregistrationV1Api } from '@kubernetes/client-node';
import type { AdmissionregistrationV1ApiListMutatingWebhookConfigurationRequest } from '@kubernetes/client-node';
const configuration = createConfiguration();
const apiInstance = new AdmissionregistrationV1Api(configuration);
const request: AdmissionregistrationV1ApiListMutatingWebhookConfigurationRequest = {
// 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",
// ...8 more optional parameter(s)
};
const data = await apiInstance.listMutatingWebhookConfiguration(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 |
| 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
V1MutatingWebhookConfigurationList
patchMutatingWebhookConfiguration
V1MutatingWebhookConfiguration patchMutatingWebhookConfiguration(body)
partially update the specified MutatingWebhookConfiguration
Example
import { createConfiguration, AdmissionregistrationV1Api } from '@kubernetes/client-node';
import type { AdmissionregistrationV1ApiPatchMutatingWebhookConfigurationRequest } from '@kubernetes/client-node';
const configuration = createConfiguration();
const apiInstance = new AdmissionregistrationV1Api(configuration);
const request: AdmissionregistrationV1ApiPatchMutatingWebhookConfigurationRequest = {
// name of the MutatingWebhookConfiguration
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.patchMutatingWebhookConfiguration(request);
console.log('API called successfully. Returned data:', data);
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| body | any | ||
| name | [string] | name of the MutatingWebhookConfiguration | 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
V1MutatingWebhookConfiguration
replaceMutatingWebhookConfiguration
V1MutatingWebhookConfiguration replaceMutatingWebhookConfiguration(body)
replace the specified MutatingWebhookConfiguration
Example
import { createConfiguration, AdmissionregistrationV1Api } from '@kubernetes/client-node';
import type { AdmissionregistrationV1ApiReplaceMutatingWebhookConfigurationRequest } from '@kubernetes/client-node';
const configuration = createConfiguration();
const apiInstance = new AdmissionregistrationV1Api(configuration);
const request: AdmissionregistrationV1ApiReplaceMutatingWebhookConfigurationRequest = {
// name of the MutatingWebhookConfiguration
name: "name_example",
body: { /* See V1MutatingWebhookConfiguration: /models/cluster#v1mutatingwebhookconfiguration */ },
// 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.replaceMutatingWebhookConfiguration(request);
console.log('API called successfully. Returned data:', data);
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| body | V1MutatingWebhookConfiguration | ||
| name | [string] | name of the MutatingWebhookConfiguration | 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
V1MutatingWebhookConfiguration
deleteCollectionMutatingWebhookConfiguration
V1Status deleteCollectionMutatingWebhookConfiguration()
delete collection of MutatingWebhookConfiguration
Example
import { createConfiguration, AdmissionregistrationV1Api } from '@kubernetes/client-node';
import type { AdmissionregistrationV1ApiDeleteCollectionMutatingWebhookConfigurationRequest } from '@kubernetes/client-node';
const configuration = createConfiguration();
const apiInstance = new AdmissionregistrationV1Api(configuration);
const request: AdmissionregistrationV1ApiDeleteCollectionMutatingWebhookConfigurationRequest = {
// 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 */ },
// ...11 more optional parameter(s)
};
const data = await apiInstance.deleteCollectionMutatingWebhookConfiguration(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 |
| 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
deleteMutatingWebhookConfiguration
V1Status deleteMutatingWebhookConfiguration()
delete a MutatingWebhookConfiguration
Example
import { createConfiguration, AdmissionregistrationV1Api } from '@kubernetes/client-node';
import type { AdmissionregistrationV1ApiDeleteMutatingWebhookConfigurationRequest } from '@kubernetes/client-node';
const configuration = createConfiguration();
const apiInstance = new AdmissionregistrationV1Api(configuration);
const request: AdmissionregistrationV1ApiDeleteMutatingWebhookConfigurationRequest = {
// name of the MutatingWebhookConfiguration
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.deleteMutatingWebhookConfiguration(request);
console.log('API called successfully. Returned data:', data);
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| body | V1DeleteOptions | ||
| name | [string] | name of the MutatingWebhookConfiguration | 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
Validating Admission Policy
createValidatingAdmissionPolicy
V1ValidatingAdmissionPolicy createValidatingAdmissionPolicy(body)
create a ValidatingAdmissionPolicy
Example
import { createConfiguration, AdmissionregistrationV1Api } from '@kubernetes/client-node';
import type { AdmissionregistrationV1ApiCreateValidatingAdmissionPolicyRequest } from '@kubernetes/client-node';
const configuration = createConfiguration();
const apiInstance = new AdmissionregistrationV1Api(configuration);
const request: AdmissionregistrationV1ApiCreateValidatingAdmissionPolicyRequest = {
body: { /* See V1ValidatingAdmissionPolicy: /models/cluster#v1validatingadmissionpolicy */ },
// 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.createValidatingAdmissionPolicy(request);
console.log('API called successfully. Returned data:', data);
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| body | V1ValidatingAdmissionPolicy | ||
| 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
readValidatingAdmissionPolicy
V1ValidatingAdmissionPolicy readValidatingAdmissionPolicy()
read the specified ValidatingAdmissionPolicy
Example
import { createConfiguration, AdmissionregistrationV1Api } from '@kubernetes/client-node';
import type { AdmissionregistrationV1ApiReadValidatingAdmissionPolicyRequest } from '@kubernetes/client-node';
const configuration = createConfiguration();
const apiInstance = new AdmissionregistrationV1Api(configuration);
const request: AdmissionregistrationV1ApiReadValidatingAdmissionPolicyRequest = {
// name of the ValidatingAdmissionPolicy
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.readValidatingAdmissionPolicy(request);
console.log('API called successfully. Returned data:', data);
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| name | [string] | name of the ValidatingAdmissionPolicy | defaults to undefined |
| pretty | [string] | If 'true', then the output is pretty printed. More info | (optional) defaults to undefined |
Return type
listValidatingAdmissionPolicy
V1ValidatingAdmissionPolicyList listValidatingAdmissionPolicy()
list or watch objects of kind ValidatingAdmissionPolicy
Example
import { createConfiguration, AdmissionregistrationV1Api } from '@kubernetes/client-node';
import type { AdmissionregistrationV1ApiListValidatingAdmissionPolicyRequest } from '@kubernetes/client-node';
const configuration = createConfiguration();
const apiInstance = new AdmissionregistrationV1Api(configuration);
const request: AdmissionregistrationV1ApiListValidatingAdmissionPolicyRequest = {
// 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",
// ...8 more optional parameter(s)
};
const data = await apiInstance.listValidatingAdmissionPolicy(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 |
| 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
V1ValidatingAdmissionPolicyList
readValidatingAdmissionPolicyStatus
V1ValidatingAdmissionPolicy readValidatingAdmissionPolicyStatus()
read status of the specified ValidatingAdmissionPolicy
Example
import { createConfiguration, AdmissionregistrationV1Api } from '@kubernetes/client-node';
import type { AdmissionregistrationV1ApiReadValidatingAdmissionPolicyStatusRequest } from '@kubernetes/client-node';
const configuration = createConfiguration();
const apiInstance = new AdmissionregistrationV1Api(configuration);
const request: AdmissionregistrationV1ApiReadValidatingAdmissionPolicyStatusRequest = {
// name of the ValidatingAdmissionPolicy
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.readValidatingAdmissionPolicyStatus(request);
console.log('API called successfully. Returned data:', data);
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| name | [string] | name of the ValidatingAdmissionPolicy | defaults to undefined |
| pretty | [string] | If 'true', then the output is pretty printed. More info | (optional) defaults to undefined |
Return type
patchValidatingAdmissionPolicy
V1ValidatingAdmissionPolicy patchValidatingAdmissionPolicy(body)
partially update the specified ValidatingAdmissionPolicy
Example
import { createConfiguration, AdmissionregistrationV1Api } from '@kubernetes/client-node';
import type { AdmissionregistrationV1ApiPatchValidatingAdmissionPolicyRequest } from '@kubernetes/client-node';
const configuration = createConfiguration();
const apiInstance = new AdmissionregistrationV1Api(configuration);
const request: AdmissionregistrationV1ApiPatchValidatingAdmissionPolicyRequest = {
// name of the ValidatingAdmissionPolicy
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.patchValidatingAdmissionPolicy(request);
console.log('API called successfully. Returned data:', data);
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| body | any | ||
| name | [string] | name of the ValidatingAdmissionPolicy | 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
patchValidatingAdmissionPolicyStatus
V1ValidatingAdmissionPolicy patchValidatingAdmissionPolicyStatus(body)
partially update status of the specified ValidatingAdmissionPolicy
Example
import { createConfiguration, AdmissionregistrationV1Api } from '@kubernetes/client-node';
import type { AdmissionregistrationV1ApiPatchValidatingAdmissionPolicyStatusRequest } from '@kubernetes/client-node';
const configuration = createConfiguration();
const apiInstance = new AdmissionregistrationV1Api(configuration);
const request: AdmissionregistrationV1ApiPatchValidatingAdmissionPolicyStatusRequest = {
// name of the ValidatingAdmissionPolicy
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.patchValidatingAdmissionPolicyStatus(request);
console.log('API called successfully. Returned data:', data);
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| body | any | ||
| name | [string] | name of the ValidatingAdmissionPolicy | 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
replaceValidatingAdmissionPolicy
V1ValidatingAdmissionPolicy replaceValidatingAdmissionPolicy(body)
replace the specified ValidatingAdmissionPolicy
Example
import { createConfiguration, AdmissionregistrationV1Api } from '@kubernetes/client-node';
import type { AdmissionregistrationV1ApiReplaceValidatingAdmissionPolicyRequest } from '@kubernetes/client-node';
const configuration = createConfiguration();
const apiInstance = new AdmissionregistrationV1Api(configuration);
const request: AdmissionregistrationV1ApiReplaceValidatingAdmissionPolicyRequest = {
// name of the ValidatingAdmissionPolicy
name: "name_example",
body: { /* See V1ValidatingAdmissionPolicy: /models/cluster#v1validatingadmissionpolicy */ },
// 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.replaceValidatingAdmissionPolicy(request);
console.log('API called successfully. Returned data:', data);
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| body | V1ValidatingAdmissionPolicy | ||
| name | [string] | name of the ValidatingAdmissionPolicy | 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
deleteCollectionValidatingAdmissionPolicy
V1Status deleteCollectionValidatingAdmissionPolicy()
delete collection of ValidatingAdmissionPolicy
Example
import { createConfiguration, AdmissionregistrationV1Api } from '@kubernetes/client-node';
import type { AdmissionregistrationV1ApiDeleteCollectionValidatingAdmissionPolicyRequest } from '@kubernetes/client-node';
const configuration = createConfiguration();
const apiInstance = new AdmissionregistrationV1Api(configuration);
const request: AdmissionregistrationV1ApiDeleteCollectionValidatingAdmissionPolicyRequest = {
// 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 */ },
// ...11 more optional parameter(s)
};
const data = await apiInstance.deleteCollectionValidatingAdmissionPolicy(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 |
| 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
deleteValidatingAdmissionPolicy
V1Status deleteValidatingAdmissionPolicy()
delete a ValidatingAdmissionPolicy
Example
import { createConfiguration, AdmissionregistrationV1Api } from '@kubernetes/client-node';
import type { AdmissionregistrationV1ApiDeleteValidatingAdmissionPolicyRequest } from '@kubernetes/client-node';
const configuration = createConfiguration();
const apiInstance = new AdmissionregistrationV1Api(configuration);
const request: AdmissionregistrationV1ApiDeleteValidatingAdmissionPolicyRequest = {
// name of the ValidatingAdmissionPolicy
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.deleteValidatingAdmissionPolicy(request);
console.log('API called successfully. Returned data:', data);
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| body | V1DeleteOptions | ||
| name | [string] | name of the ValidatingAdmissionPolicy | 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
replaceValidatingAdmissionPolicyStatus
V1ValidatingAdmissionPolicy replaceValidatingAdmissionPolicyStatus(body)
replace status of the specified ValidatingAdmissionPolicy
Example
import { createConfiguration, AdmissionregistrationV1Api } from '@kubernetes/client-node';
import type { AdmissionregistrationV1ApiReplaceValidatingAdmissionPolicyStatusRequest } from '@kubernetes/client-node';
const configuration = createConfiguration();
const apiInstance = new AdmissionregistrationV1Api(configuration);
const request: AdmissionregistrationV1ApiReplaceValidatingAdmissionPolicyStatusRequest = {
// name of the ValidatingAdmissionPolicy
name: "name_example",
body: { /* See V1ValidatingAdmissionPolicy: /models/cluster#v1validatingadmissionpolicy */ },
// 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.replaceValidatingAdmissionPolicyStatus(request);
console.log('API called successfully. Returned data:', data);
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| body | V1ValidatingAdmissionPolicy | ||
| name | [string] | name of the ValidatingAdmissionPolicy | 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
Validating Admission Policy Binding
createValidatingAdmissionPolicyBinding
V1ValidatingAdmissionPolicyBinding createValidatingAdmissionPolicyBinding(body)
create a ValidatingAdmissionPolicyBinding
Example
import { createConfiguration, AdmissionregistrationV1Api } from '@kubernetes/client-node';
import type { AdmissionregistrationV1ApiCreateValidatingAdmissionPolicyBindingRequest } from '@kubernetes/client-node';
const configuration = createConfiguration();
const apiInstance = new AdmissionregistrationV1Api(configuration);
const request: AdmissionregistrationV1ApiCreateValidatingAdmissionPolicyBindingRequest = {
body: { /* See V1ValidatingAdmissionPolicyBinding: /models/cluster#v1validatingadmissionpolicybinding */ },
// 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.createValidatingAdmissionPolicyBinding(request);
console.log('API called successfully. Returned data:', data);
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| body | V1ValidatingAdmissionPolicyBinding | ||
| 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
V1ValidatingAdmissionPolicyBinding
readValidatingAdmissionPolicyBinding
V1ValidatingAdmissionPolicyBinding readValidatingAdmissionPolicyBinding()
read the specified ValidatingAdmissionPolicyBinding
Example
import { createConfiguration, AdmissionregistrationV1Api } from '@kubernetes/client-node';
import type { AdmissionregistrationV1ApiReadValidatingAdmissionPolicyBindingRequest } from '@kubernetes/client-node';
const configuration = createConfiguration();
const apiInstance = new AdmissionregistrationV1Api(configuration);
const request: AdmissionregistrationV1ApiReadValidatingAdmissionPolicyBindingRequest = {
// name of the ValidatingAdmissionPolicyBinding
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.readValidatingAdmissionPolicyBinding(request);
console.log('API called successfully. Returned data:', data);
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| name | [string] | name of the ValidatingAdmissionPolicyBinding | defaults to undefined |
| pretty | [string] | If 'true', then the output is pretty printed. More info | (optional) defaults to undefined |
Return type
V1ValidatingAdmissionPolicyBinding
listValidatingAdmissionPolicyBinding
V1ValidatingAdmissionPolicyBindingList listValidatingAdmissionPolicyBinding()
list or watch objects of kind ValidatingAdmissionPolicyBinding
Example
import { createConfiguration, AdmissionregistrationV1Api } from '@kubernetes/client-node';
import type { AdmissionregistrationV1ApiListValidatingAdmissionPolicyBindingRequest } from '@kubernetes/client-node';
const configuration = createConfiguration();
const apiInstance = new AdmissionregistrationV1Api(configuration);
const request: AdmissionregistrationV1ApiListValidatingAdmissionPolicyBindingRequest = {
// 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",
// ...8 more optional parameter(s)
};
const data = await apiInstance.listValidatingAdmissionPolicyBinding(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 |
| 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
V1ValidatingAdmissionPolicyBindingList
patchValidatingAdmissionPolicyBinding
V1ValidatingAdmissionPolicyBinding patchValidatingAdmissionPolicyBinding(body)
partially update the specified ValidatingAdmissionPolicyBinding
Example
import { createConfiguration, AdmissionregistrationV1Api } from '@kubernetes/client-node';
import type { AdmissionregistrationV1ApiPatchValidatingAdmissionPolicyBindingRequest } from '@kubernetes/client-node';
const configuration = createConfiguration();
const apiInstance = new AdmissionregistrationV1Api(configuration);
const request: AdmissionregistrationV1ApiPatchValidatingAdmissionPolicyBindingRequest = {
// name of the ValidatingAdmissionPolicyBinding
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.patchValidatingAdmissionPolicyBinding(request);
console.log('API called successfully. Returned data:', data);
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| body | any | ||
| name | [string] | name of the ValidatingAdmissionPolicyBinding | 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
V1ValidatingAdmissionPolicyBinding
replaceValidatingAdmissionPolicyBinding
V1ValidatingAdmissionPolicyBinding replaceValidatingAdmissionPolicyBinding(body)
replace the specified ValidatingAdmissionPolicyBinding
Example
import { createConfiguration, AdmissionregistrationV1Api } from '@kubernetes/client-node';
import type { AdmissionregistrationV1ApiReplaceValidatingAdmissionPolicyBindingRequest } from '@kubernetes/client-node';
const configuration = createConfiguration();
const apiInstance = new AdmissionregistrationV1Api(configuration);
const request: AdmissionregistrationV1ApiReplaceValidatingAdmissionPolicyBindingRequest = {
// name of the ValidatingAdmissionPolicyBinding
name: "name_example",
body: { /* See V1ValidatingAdmissionPolicyBinding: /models/cluster#v1validatingadmissionpolicybinding */ },
// 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.replaceValidatingAdmissionPolicyBinding(request);
console.log('API called successfully. Returned data:', data);
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| body | V1ValidatingAdmissionPolicyBinding | ||
| name | [string] | name of the ValidatingAdmissionPolicyBinding | 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
V1ValidatingAdmissionPolicyBinding
deleteCollectionValidatingAdmissionPolicyBinding
V1Status deleteCollectionValidatingAdmissionPolicyBinding()
delete collection of ValidatingAdmissionPolicyBinding
Example
import { createConfiguration, AdmissionregistrationV1Api } from '@kubernetes/client-node';
import type { AdmissionregistrationV1ApiDeleteCollectionValidatingAdmissionPolicyBindingRequest } from '@kubernetes/client-node';
const configuration = createConfiguration();
const apiInstance = new AdmissionregistrationV1Api(configuration);
const request: AdmissionregistrationV1ApiDeleteCollectionValidatingAdmissionPolicyBindingRequest = {
// 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 */ },
// ...11 more optional parameter(s)
};
const data = await apiInstance.deleteCollectionValidatingAdmissionPolicyBinding(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 |
| 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
deleteValidatingAdmissionPolicyBinding
V1Status deleteValidatingAdmissionPolicyBinding()
delete a ValidatingAdmissionPolicyBinding
Example
import { createConfiguration, AdmissionregistrationV1Api } from '@kubernetes/client-node';
import type { AdmissionregistrationV1ApiDeleteValidatingAdmissionPolicyBindingRequest } from '@kubernetes/client-node';
const configuration = createConfiguration();
const apiInstance = new AdmissionregistrationV1Api(configuration);
const request: AdmissionregistrationV1ApiDeleteValidatingAdmissionPolicyBindingRequest = {
// name of the ValidatingAdmissionPolicyBinding
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.deleteValidatingAdmissionPolicyBinding(request);
console.log('API called successfully. Returned data:', data);
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| body | V1DeleteOptions | ||
| name | [string] | name of the ValidatingAdmissionPolicyBinding | 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
Validating Webhook Configuration
createValidatingWebhookConfiguration
V1ValidatingWebhookConfiguration createValidatingWebhookConfiguration(body)
create a ValidatingWebhookConfiguration
Example
import { createConfiguration, AdmissionregistrationV1Api } from '@kubernetes/client-node';
import type { AdmissionregistrationV1ApiCreateValidatingWebhookConfigurationRequest } from '@kubernetes/client-node';
const configuration = createConfiguration();
const apiInstance = new AdmissionregistrationV1Api(configuration);
const request: AdmissionregistrationV1ApiCreateValidatingWebhookConfigurationRequest = {
body: { /* See V1ValidatingWebhookConfiguration: /models/cluster#v1validatingwebhookconfiguration */ },
// 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.createValidatingWebhookConfiguration(request);
console.log('API called successfully. Returned data:', data);
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| body | V1ValidatingWebhookConfiguration | ||
| 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
V1ValidatingWebhookConfiguration
readValidatingWebhookConfiguration
V1ValidatingWebhookConfiguration readValidatingWebhookConfiguration()
read the specified ValidatingWebhookConfiguration
Example
import { createConfiguration, AdmissionregistrationV1Api } from '@kubernetes/client-node';
import type { AdmissionregistrationV1ApiReadValidatingWebhookConfigurationRequest } from '@kubernetes/client-node';
const configuration = createConfiguration();
const apiInstance = new AdmissionregistrationV1Api(configuration);
const request: AdmissionregistrationV1ApiReadValidatingWebhookConfigurationRequest = {
// name of the ValidatingWebhookConfiguration
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.readValidatingWebhookConfiguration(request);
console.log('API called successfully. Returned data:', data);
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| name | [string] | name of the ValidatingWebhookConfiguration | defaults to undefined |
| pretty | [string] | If 'true', then the output is pretty printed. More info | (optional) defaults to undefined |
Return type
V1ValidatingWebhookConfiguration
listValidatingWebhookConfiguration
V1ValidatingWebhookConfigurationList listValidatingWebhookConfiguration()
list or watch objects of kind ValidatingWebhookConfiguration
Example
import { createConfiguration, AdmissionregistrationV1Api } from '@kubernetes/client-node';
import type { AdmissionregistrationV1ApiListValidatingWebhookConfigurationRequest } from '@kubernetes/client-node';
const configuration = createConfiguration();
const apiInstance = new AdmissionregistrationV1Api(configuration);
const request: AdmissionregistrationV1ApiListValidatingWebhookConfigurationRequest = {
// 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",
// ...8 more optional parameter(s)
};
const data = await apiInstance.listValidatingWebhookConfiguration(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 |
| 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
V1ValidatingWebhookConfigurationList
patchValidatingWebhookConfiguration
V1ValidatingWebhookConfiguration patchValidatingWebhookConfiguration(body)
partially update the specified ValidatingWebhookConfiguration
Example
import { createConfiguration, AdmissionregistrationV1Api } from '@kubernetes/client-node';
import type { AdmissionregistrationV1ApiPatchValidatingWebhookConfigurationRequest } from '@kubernetes/client-node';
const configuration = createConfiguration();
const apiInstance = new AdmissionregistrationV1Api(configuration);
const request: AdmissionregistrationV1ApiPatchValidatingWebhookConfigurationRequest = {
// name of the ValidatingWebhookConfiguration
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.patchValidatingWebhookConfiguration(request);
console.log('API called successfully. Returned data:', data);
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| body | any | ||
| name | [string] | name of the ValidatingWebhookConfiguration | 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
V1ValidatingWebhookConfiguration
replaceValidatingWebhookConfiguration
V1ValidatingWebhookConfiguration replaceValidatingWebhookConfiguration(body)
replace the specified ValidatingWebhookConfiguration
Example
import { createConfiguration, AdmissionregistrationV1Api } from '@kubernetes/client-node';
import type { AdmissionregistrationV1ApiReplaceValidatingWebhookConfigurationRequest } from '@kubernetes/client-node';
const configuration = createConfiguration();
const apiInstance = new AdmissionregistrationV1Api(configuration);
const request: AdmissionregistrationV1ApiReplaceValidatingWebhookConfigurationRequest = {
// name of the ValidatingWebhookConfiguration
name: "name_example",
body: { /* See V1ValidatingWebhookConfiguration: /models/cluster#v1validatingwebhookconfiguration */ },
// 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.replaceValidatingWebhookConfiguration(request);
console.log('API called successfully. Returned data:', data);
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| body | V1ValidatingWebhookConfiguration | ||
| name | [string] | name of the ValidatingWebhookConfiguration | 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
V1ValidatingWebhookConfiguration
deleteCollectionValidatingWebhookConfiguration
V1Status deleteCollectionValidatingWebhookConfiguration()
delete collection of ValidatingWebhookConfiguration
Example
import { createConfiguration, AdmissionregistrationV1Api } from '@kubernetes/client-node';
import type { AdmissionregistrationV1ApiDeleteCollectionValidatingWebhookConfigurationRequest } from '@kubernetes/client-node';
const configuration = createConfiguration();
const apiInstance = new AdmissionregistrationV1Api(configuration);
const request: AdmissionregistrationV1ApiDeleteCollectionValidatingWebhookConfigurationRequest = {
// 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 */ },
// ...11 more optional parameter(s)
};
const data = await apiInstance.deleteCollectionValidatingWebhookConfiguration(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 |
| 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
deleteValidatingWebhookConfiguration
V1Status deleteValidatingWebhookConfiguration()
delete a ValidatingWebhookConfiguration
Example
import { createConfiguration, AdmissionregistrationV1Api } from '@kubernetes/client-node';
import type { AdmissionregistrationV1ApiDeleteValidatingWebhookConfigurationRequest } from '@kubernetes/client-node';
const configuration = createConfiguration();
const apiInstance = new AdmissionregistrationV1Api(configuration);
const request: AdmissionregistrationV1ApiDeleteValidatingWebhookConfigurationRequest = {
// name of the ValidatingWebhookConfiguration
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.deleteValidatingWebhookConfiguration(request);
console.log('API called successfully. Returned data:', data);
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| body | V1DeleteOptions | ||
| name | [string] | name of the ValidatingWebhookConfiguration | 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()
get available resources
Example
import { createConfiguration, AdmissionregistrationV1Api } from '@kubernetes/client-node';
const configuration = createConfiguration();
const apiInstance = new AdmissionregistrationV1Api(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.