@azure/arm-platformvalidation package

Classes

PlatformValidationClient

Interfaces

CloudValidation	Cloud Validation Resource
CloudValidationProperties	Cloud Validation properties
CloudValidationUpdate	The type used for update operations of the CloudValidation.
CloudValidationUpdateProperties	The updatable properties of the CloudValidation.
CloudValidationsCreateOrUpdateOptionalParams	Optional parameters.
CloudValidationsDeleteOptionalParams	Optional parameters.
CloudValidationsGetOptionalParams	Optional parameters.
CloudValidationsListByResourceGroupOptionalParams	Optional parameters.
CloudValidationsListBySubscriptionOptionalParams	Optional parameters.
CloudValidationsOperations	Interface representing a CloudValidations operations.
CloudValidationsUpdateOptionalParams	Optional parameters.
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.
ExecutionPlanRun	The properties of the execution plan run.
ExecutionPlanRunProperties	The properties of the execution plan run.
ExecutionPlanRunsCreateOrUpdateOptionalParams	Optional parameters.
ExecutionPlanRunsDeleteOptionalParams	Optional parameters.
ExecutionPlanRunsGetOptionalParams	Optional parameters.
ExecutionPlanRunsListByExecutionPlanOptionalParams	Optional parameters.
ExecutionPlanRunsOperations	Interface representing a ExecutionPlanRuns operations.
ManagedOnBehalfOfConfiguration	Managed-On-Behalf-Of configuration properties. This configuration exists for the resources where a resource provider manages those resources on behalf of the resource owner.
MoboBrokerResource	Managed-On-Behalf-Of broker resource. This resource is created by the Resource Provider to manage some resources on behalf of the user.
Operation	Details of a REST API operation, returned from the Resource Provider Operations API
OperationDisplay	Localized display information for an operation.
OperationStatusGetOptionalParams	Optional parameters.
OperationStatusOperations	Interface representing a OperationStatus operations.
OperationStatusResult	The current status of an async 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.
PlatformValidationClientOptionalParams	Optional parameters for the client.
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.
TestRunSummary	Execution summary details for a validation test run collection.
TrackedResource	The resource model definition for an Azure Resource Manager tracked top level resource which has 'tags' and a 'location'
ValidationExecutionPlan	Validation Test Execution Plan
ValidationExecutionPlanProperties	Validation Test Execution Plan properties
ValidationExecutionPlanUpdate	The type used for update operations of the ValidationExecutionPlan.
ValidationExecutionPlanUpdateProperties	The updatable properties of the ValidationExecutionPlan.
ValidationExecutionPlansCreateOrUpdateOptionalParams	Optional parameters.
ValidationExecutionPlansDeleteOptionalParams	Optional parameters.
ValidationExecutionPlansGetOptionalParams	Optional parameters.
ValidationExecutionPlansListByResourceGroupOptionalParams	Optional parameters.
ValidationExecutionPlansOperations	Interface representing a ValidationExecutionPlans operations.
ValidationExecutionPlansUpdateOptionalParams	Optional parameters.
ValidationTest	Validation test catalog entry.
ValidationTestCategoriesGetOptionalParams	Optional parameters.
ValidationTestCategoriesListBySubscriptionOptionalParams	Optional parameters.
ValidationTestCategoriesOperations	Interface representing a ValidationTestCategories operations.
ValidationTestCategory	Validation test category catalog entry.
ValidationTestCategoryProperties	Validation test category properties.
ValidationTestFailureDetails	Detailed information about test failure.
ValidationTestInput	A named declared input parameter for a validation test contract.
ValidationTestInputDefinition	Declared contract for a validation test input parameter.
ValidationTestPassDetails	Detailed information about test pass.
ValidationTestProperties	Validation test catalog properties.
ValidationTestRun	Validation Test Run represents execution instance(s) of a Validation Test instance under execution plan.
ValidationTestRunProperties	Validation Test Run properties.
ValidationTestRunsGetOptionalParams	Optional parameters.
ValidationTestRunsListByExecutionPlanRunOptionalParams	Optional parameters.
ValidationTestRunsOperations	Interface representing a ValidationTestRuns operations.
ValidationTestVersion	Validation test version catalog entry.
ValidationTestVersionProperties	Validation test version catalog properties.
ValidationTestVersionsGetOptionalParams	Optional parameters.
ValidationTestVersionsListOptionalParams	Optional parameters.
ValidationTestVersionsOperations	Interface representing a ValidationTestVersions operations.
ValidationTestsGetOptionalParams	Optional parameters.
ValidationTestsListBySubscriptionOptionalParams	Optional parameters.
ValidationTestsOperations	Interface representing a ValidationTests operations.

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
CatalogAudience	Audience visibility of a published catalog item. KnownCatalogAudience can be used interchangeably with CatalogAudience, this enum contains the known values that the service supports. Known values supported by the service Public: Visible to all customers, including first-party and third-party callers. Internal: Visible only to authorized Microsoft-internal callers.
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.
ExecutionPlanRunProvisioningState	The provisioning state of the execution plan run. KnownExecutionPlanRunProvisioningState can be used interchangeably with ExecutionPlanRunProvisioningState, 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. Creating: The execution plan run is in progress. Running: The execution plan run is running. Waiting: The execution plan run is waiting. Processing: The execution plan run is partially executed.
ExecutionPlanRunStatus	The status of the execution plan run. KnownExecutionPlanRunStatus can be used interchangeably with ExecutionPlanRunStatus, this enum contains the known values that the service supports. Known values supported by the service Succeeded: The execution plan run is succeeded. Queued: The execution plan run has been queued. Running: The execution plan run is running. Completed: The execution plan run is completed. Failed: The execution plan run is failed. TimedOut: The execution plan run is timed out. Unknown: The execution plan run is unknown.
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.
ProvisioningState	The resource provisioning state. 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. Creating: The resource is being provisioned. Updating: The resource is updating. Disabling: The resource is being disabled. Deleting: The resource is being deleted Accepted: The resource create request has been accepted
ResourceProvisioningState	The provisioning state of a resource type. KnownResourceProvisioningState can be used interchangeably with ResourceProvisioningState, 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.
TestRunOverallResult	The overall result of a validation test run collection. KnownTestRunOverallResult can be used interchangeably with TestRunOverallResult, this enum contains the known values that the service supports. Known values supported by the service Passed: All tests passed. Failed: One or more tests failed. PartiallyPassed: Some tests passed and some failed.
ValidationExecutionPlanProvisioningState	The execution plan resource provisioning state. KnownValidationExecutionPlanProvisioningState can be used interchangeably with ValidationExecutionPlanProvisioningState, 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. Creating: The resource is being provisioned. Updating: The resource is updating.
ValidationTestInputDataType	Supported data types for a declared test input. KnownValidationTestInputDataType can be used interchangeably with ValidationTestInputDataType, this enum contains the known values that the service supports. Known values supported by the service String: String input value. Integer: Integer input value. Number: Numeric input value. Boolean: Boolean input value. Object: Object input value. Array: Array input value.
ValidationTestRunProvisioningState	The provisioning state of the validation test run. KnownValidationTestRunProvisioningState can be used interchangeably with ValidationTestRunProvisioningState, 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. Running: The validation test run is in progress.
ValidationTestRunStatus	The overall status of the test run. KnownValidationTestRunStatus can be used interchangeably with ValidationTestRunStatus, this enum contains the known values that the service supports. Known values supported by the service NotRunning: The test run is not running. Scheduled: The test run is scheduled. Ready: The test run is ready. Running: The test run is running. Completed: The test run is completed. Stopped: The test run is stopped. Error: The test run is errored out.

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.
KnownCatalogAudience	Audience visibility of a published catalog item.
KnownCreatedByType	The kind of entity that created the resource.
KnownExecutionPlanRunProvisioningState	The provisioning state of the execution plan run.
KnownExecutionPlanRunStatus	The status of the execution plan run.
KnownOrigin	The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system"
KnownProvisioningState	The resource provisioning state.
KnownResourceProvisioningState	The provisioning state of a resource type.
KnownTestRunOverallResult	The overall result of a validation test run collection.
KnownValidationExecutionPlanProvisioningState	The execution plan resource provisioning state.
KnownValidationTestInputDataType	Supported data types for a declared test input.
KnownValidationTestRunProvisioningState	The provisioning state of the validation test run.
KnownValidationTestRunStatus	The overall status of the test run.
KnownVersions	The available API versions.

Functions

isRestError(unknown)	Typeguard for RestError
restorePoller<TResponse, TResult>(PlatformValidationClient, 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 is RestError

Parameters

e

unknown

Something caught by a catch clause.

Returns

e is RestError

restorePoller<TResponse, TResult>(PlatformValidationClient, 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: PlatformValidationClient, serializedState: string, sourceOperation: (args: any[]) => PollerLike<OperationState<TResult>, TResult>, options?: RestorePollerOptions<TResult, PathUncheckedResponse>): PollerLike<OperationState<TResult>, TResult>

Parameters

client

PlatformValidationClient

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