@azure/arm-containerservicepreparedimgspec package

Classes

ContainerServiceClient

Interfaces

ContainerServiceClientOptionalParams	Optional parameters for the client.
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Common error response for all Azure Resource Manager APIs to return error details for failed operations.
Operation	Details of a REST API operation, returned from the Resource Provider Operations API
OperationDisplay	Localized display information for an operation.
OperationsListOptionalParams	Optional parameters.
OperationsOperations	Interface representing a Operations operations.
PageSettings	Options for the byPage method
PagedAsyncIterableIterator	An interface that allows async iterable iteration both to completion and by page.
PreparedImageSpecification	The Prepared Image Specification resource.
PreparedImageSpecificationManagedIdentityProfile	The managed identity profile used by the prepared image specification.
PreparedImageSpecificationPatch	Prepared image specification patch resource
PreparedImageSpecificationProperties	The properties of the Prepared Image Specification resource.
PreparedImageSpecificationScript	Prepared image specification script
PreparedImageSpecificationVersion	A version of the Prepared Image Specification resource.
PreparedImageSpecificationsCreateOrUpdateOptionalParams	Optional parameters.
PreparedImageSpecificationsDeleteOptionalParams	Optional parameters.
PreparedImageSpecificationsDeleteVersionOptionalParams	Optional parameters.
PreparedImageSpecificationsGetOptionalParams	Optional parameters.
PreparedImageSpecificationsGetVersionOptionalParams	Optional parameters.
PreparedImageSpecificationsListByResourceGroupOptionalParams	Optional parameters.
PreparedImageSpecificationsListBySubscriptionOptionalParams	Optional parameters.
PreparedImageSpecificationsListVersionsOptionalParams	Optional parameters.
PreparedImageSpecificationsOperations	Interface representing a PreparedImageSpecifications operations.
PreparedImageSpecificationsUpdateOptionalParams	Optional parameters.
ProxyResource	The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location
Resource	Common fields that are returned in the response for all Azure Resource Manager resources
RestorePollerOptions
SystemData	Metadata pertaining to creation and last modification of the resource.
TrackedResource	The resource model definition for an Azure Resource Manager tracked top level resource which has 'tags' and a 'location'

Type Aliases

ActionType	Extensible enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs. KnownActionType can be used interchangeably with ActionType, this enum contains the known values that the service supports. Known values supported by the service Internal: Actions are for internal-only APIs.
AzureSupportedClouds	The supported values for cloud setting as a string literal type
ContinuablePage	An interface that describes a page of results.
CreatedByType	The kind of entity that created the resource. KnownCreatedByType can be used interchangeably with CreatedByType, this enum contains the known values that the service supports. Known values supported by the service User: The entity was created by a user. Application: The entity was created by an application. ManagedIdentity: The entity was created by a managed identity. Key: The entity was created by a key.
ExecutionPoint	The execution point for the script. KnownExecutionPoint can be used interchangeably with ExecutionPoint, this enum contains the known values that the service supports. Known values supported by the service NodeImageBuildTime: Execute during node image build time. NodeProvisionTime: Execute during node provisioning time.
Origin	The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system" KnownOrigin can be used interchangeably with Origin, this enum contains the known values that the service supports. Known values supported by the service user: Indicates the operation is initiated by a user. system: Indicates the operation is initiated by a system. user,system: Indicates the operation is initiated by a user or system.
PostScriptAction	The action to take after the script finishes successfully. KnownPostScriptAction can be used interchangeably with PostScriptAction, this enum contains the known values that the service supports. Known values supported by the service None: No post-script action is taken. RebootAfter: Reboot the node after the script completes.
ProvisioningState	The provisioning state of the image customization. KnownProvisioningState can be used interchangeably with ProvisioningState, this enum contains the known values that the service supports. Known values supported by the service Succeeded: Resource has been created. Failed: Resource creation failed. Canceled: Resource creation was canceled. Provisioning: Provisioning the resource is in progress Updating: Resource is being updated Deleting: Resource is being deleted Accepted: The change request has been accepted
ScriptType	The script type. KnownScriptType can be used interchangeably with ScriptType, this enum contains the known values that the service supports. Known values supported by the service Bash: Bash script. PowerShell: PowerShell script.

Enums

AzureClouds	An enum to describe Azure Cloud environments.
KnownActionType	Extensible enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs.
KnownCreatedByType	The kind of entity that created the resource.
KnownExecutionPoint	The execution point for the script.
KnownOrigin	The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system"
KnownPostScriptAction	The action to take after the script finishes successfully.
KnownProvisioningState	The provisioning state of the image customization.
KnownScriptType	The script type.
KnownVersions	Azure Kubernetes Prepared Image Specification api versions.

Functions

isRestError(unknown)	Typeguard for RestError
restorePoller<TResponse, TResult>(ContainerServiceClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)	Creates a poller from the serialized state of another poller. This can be useful when you want to create pollers on a different host or a poller needs to be constructed after the original one is not in scope.

Variables

RestError

A custom error type for failed pipeline requests.

Function Details

isRestError(unknown)

Typeguard for RestError

function isRestError(e: unknown): e

Parameters

e

unknown

Something caught by a catch clause.

Returns

e

restorePoller<TResponse, TResult>(ContainerServiceClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)

Creates a poller from the serialized state of another poller. This can be useful when you want to create pollers on a different host or a poller needs to be constructed after the original one is not in scope.

function restorePoller<TResponse, TResult>(client: ContainerServiceClient, serializedState: string, sourceOperation: (args: any[]) => PollerLike<OperationState<TResult>, TResult>, options?: RestorePollerOptions<TResult, PathUncheckedResponse>): PollerLike<OperationState<TResult>, TResult>

Parameters

client

ContainerServiceClient

serializedState

string

sourceOperation

(args: any[]) => PollerLike<OperationState<TResult>, TResult>

options

RestorePollerOptions<TResult, PathUncheckedResponse>

Returns

PollerLike<OperationState<TResult>, TResult>

Variable Details

RestError

A custom error type for failed pipeline requests.

RestError: RestErrorConstructor

Type

RestErrorConstructor