@azure/arm-containerregistrytasks package

Classes

Interfaces

AgentPool	The agentpool that has the ARM resource and properties. The agentpool will have all information to create an agent pool.
AgentPoolProperties	The properties of agent pool.
AgentPoolPropertiesUpdateParameters	model interface AgentPoolPropertiesUpdateParameters
AgentPoolQueueStatus	The QueueStatus of Agent Pool
AgentPoolUpdateParameters	The parameters for updating an agent pool.
AgentPoolsCreateOptionalParams	Optional parameters.
AgentPoolsDeleteOptionalParams	Optional parameters.
AgentPoolsGetOptionalParams	Optional parameters.
AgentPoolsGetQueueStatusOptionalParams	Optional parameters.
AgentPoolsListOptionalParams	Optional parameters.
AgentPoolsOperations	Interface representing a AgentPools operations.
AgentPoolsUpdateOptionalParams	Optional parameters.
AgentProperties	The properties that determine the run agent configuration.
Argument	The properties of a run argument.
AuthInfo	The authorization properties for accessing the source code repository.
AuthInfoUpdateParameters	The authorization properties for accessing the source code repository.
BaseImageDependency	Properties that describe a base image dependency.
BaseImageTrigger	The trigger based on base image dependency.
BaseImageTriggerUpdateParameters	The properties for updating base image dependency trigger.
ContainerRegistryTasksManagementClientOptionalParams	Optional parameters for the client.
Credentials	The parameters that describes a set of credentials that will be used when a run is invoked.
CustomRegistryCredentials	Describes the credentials that will be used to access a custom registry during a run.
DockerBuildRequest	The parameters for a docker quick build.
DockerBuildStep	The Docker build step.
DockerBuildStepUpdateParameters	The properties for updating a docker build step.
EncodedTaskRunRequest	The parameters for a quick task run request.
EncodedTaskStep	The properties of a encoded task step.
EncodedTaskStepUpdateParameters	The properties for updating encoded task step.
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.
FileTaskRunRequest	The request parameters for a scheduling run against a task file.
FileTaskStep	The properties of a task step.
FileTaskStepUpdateParameters	The properties of updating a task step.
IdentityProperties	Managed identity for the resource.
ImageDescriptor	Properties for a registry image.
ImageUpdateTrigger	The image update trigger that caused a build.
OverrideTaskStepProperties	model interface OverrideTaskStepProperties
PageSettings	Options for the byPage method
PagedAsyncIterableIterator	An interface that allows async iterable iteration both to completion and by page.
PlatformProperties	The platform properties against which the run has to happen.
PlatformUpdateParameters	The properties for updating the platform configuration.
ProxyResource	The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location
RegistriesGetBuildSourceUploadUrlOptionalParams	Optional parameters.
RegistriesOperations	Interface representing a Registries operations.
RegistriesScheduleRunOptionalParams	Optional parameters.
Resource	Common fields that are returned in the response for all Azure Resource Manager resources
RestorePollerOptions
Run	Run resource properties
RunGetLogResult	The result of get log link operation.
RunProperties	The properties for a run.
RunRequest	The request parameters for scheduling a run.
RunUpdateParameters	The set of run properties that can be updated.
RunsCancelOptionalParams	Optional parameters.
RunsGetLogSasUrlOptionalParams	Optional parameters.
RunsGetOptionalParams	Optional parameters.
RunsListOptionalParams	Optional parameters.
RunsOperations	Interface representing a Runs operations.
RunsUpdateOptionalParams	Optional parameters.
SecretObject	Describes the properties of a secret object value.
SetValue	The properties of a overridable value that can be passed to a task template.
SourceProperties	The properties of the source code repository.
SourceRegistryCredentials	Describes the credential parameters for accessing the source registry.
SourceTrigger	The properties of a source based trigger.
SourceTriggerDescriptor	The source trigger that caused a run.
SourceTriggerUpdateParameters	The properties for updating a source based trigger.
SourceUpdateParameters	The properties for updating the source code repository.
SourceUploadDefinition	The properties of a response to source upload request.
SystemData	Metadata pertaining to creation and last modification of the resource.
Task	The task that has the ARM resource and task properties. The task will have all information to schedule a run against it.
TaskProperties	The properties of a task.
TaskPropertiesUpdateParameters	The properties for updating a task.
TaskRun	The task run that has the ARM resource and properties. The task run will have the information of request and result of a run.
TaskRunProperties	The properties of task run.
TaskRunPropertiesUpdateParameters	The properties of a task run update parameters.
TaskRunRequest	The parameters for a task run request.
TaskRunUpdateParameters	The parameters for updating a task run.
TaskRunsCreateOptionalParams	Optional parameters.
TaskRunsDeleteOptionalParams	Optional parameters.
TaskRunsGetDetailsOptionalParams	Optional parameters.
TaskRunsGetOptionalParams	Optional parameters.
TaskRunsListOptionalParams	Optional parameters.
TaskRunsOperations	Interface representing a TaskRuns operations.
TaskRunsUpdateOptionalParams	Optional parameters.
TaskStepProperties	Base properties for any task step.
TaskStepUpdateParameters	Base properties for updating any task step.
TaskUpdateParameters	The parameters for updating a task.
TasksCreateOptionalParams	Optional parameters.
TasksDeleteOptionalParams	Optional parameters.
TasksGetDetailsOptionalParams	Optional parameters.
TasksGetOptionalParams	Optional parameters.
TasksListOptionalParams	Optional parameters.
TasksOperations	Interface representing a Tasks operations.
TasksUpdateOptionalParams	Optional parameters.
TimerTrigger	The properties of a timer trigger.
TimerTriggerDescriptor	model interface TimerTriggerDescriptor
TimerTriggerUpdateParameters	The properties for updating a timer trigger.
TrackedResource	The resource model definition for an Azure Resource Manager tracked top level resource which has 'tags' and a 'location'
TriggerProperties	The properties of a trigger.
TriggerUpdateParameters	The properties for updating triggers.
UserIdentityProperties	model interface UserIdentityProperties

Type Aliases

Architecture	The OS architecture. KnownArchitecture can be used interchangeably with Architecture, this enum contains the known values that the service supports. Known values supported by the service amd64 x86 386 arm arm64
AzureSupportedClouds	The supported values for cloud setting as a string literal type
BaseImageDependencyType	The type of the base image dependency. KnownBaseImageDependencyType can be used interchangeably with BaseImageDependencyType, this enum contains the known values that the service supports. Known values supported by the service BuildTime RunTime
BaseImageTriggerType	The type of the auto trigger for base image dependency updates. KnownBaseImageTriggerType can be used interchangeably with BaseImageTriggerType, this enum contains the known values that the service supports. Known values supported by the service All Runtime
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.
OS	The OS of agent machine KnownOS can be used interchangeably with OS, this enum contains the known values that the service supports. Known values supported by the service Windows Linux
ProvisioningState	The provisioning state of this agent pool KnownProvisioningState can be used interchangeably with ProvisioningState, this enum contains the known values that the service supports. Known values supported by the service Creating Updating Deleting Succeeded Failed Canceled
ResourceIdentityType	The identity type.
RunRequestUnion	Alias for RunRequestUnion
RunStatus	The current status of the run. KnownRunStatus can be used interchangeably with RunStatus, this enum contains the known values that the service supports. Known values supported by the service Queued Started Running Succeeded Failed Canceled Error Timeout
RunType	The type of run. KnownRunType can be used interchangeably with RunType, this enum contains the known values that the service supports. Known values supported by the service QuickBuild QuickRun AutoBuild AutoRun
SecretObjectType	The type of the secret object which determines how the value of the secret object has to be interpreted. KnownSecretObjectType can be used interchangeably with SecretObjectType, this enum contains the known values that the service supports. Known values supported by the service Opaque Vaultsecret
SourceControlType	The type of source control service. KnownSourceControlType can be used interchangeably with SourceControlType, this enum contains the known values that the service supports. Known values supported by the service Github VisualStudioTeamService
SourceRegistryLoginMode	The authentication mode which determines the source registry login scope. The credentials for the source registry will be generated using the given scope. These credentials will be used to login to the source registry during the run. KnownSourceRegistryLoginMode can be used interchangeably with SourceRegistryLoginMode, this enum contains the known values that the service supports. Known values supported by the service None Default
SourceTriggerEvent	Type of SourceTriggerEvent
StepType	The type of the step. KnownStepType can be used interchangeably with StepType, this enum contains the known values that the service supports. Known values supported by the service Docker FileTask EncodedTask
TaskStatus	The current status of task. KnownTaskStatus can be used interchangeably with TaskStatus, this enum contains the known values that the service supports. Known values supported by the service Disabled Enabled
TaskStepPropertiesUnion	Alias for TaskStepPropertiesUnion
TaskStepUpdateParametersUnion	Alias for TaskStepUpdateParametersUnion
TokenType	The type of Auth token. KnownTokenType can be used interchangeably with TokenType, this enum contains the known values that the service supports. Known values supported by the service PAT OAuth
TriggerStatus	The current status of trigger. KnownTriggerStatus can be used interchangeably with TriggerStatus, this enum contains the known values that the service supports. Known values supported by the service Disabled Enabled
UpdateTriggerPayloadType	Type of Payload body for Base image update triggers. KnownUpdateTriggerPayloadType can be used interchangeably with UpdateTriggerPayloadType, this enum contains the known values that the service supports. Known values supported by the service Default Token
Variant	Variant of the CPU. KnownVariant can be used interchangeably with Variant, this enum contains the known values that the service supports. Known values supported by the service v6 v7 v8

Enums

AzureClouds	An enum to describe Azure Cloud environments.
KnownArchitecture	The OS architecture.
KnownBaseImageDependencyType	The type of the base image dependency.
KnownBaseImageTriggerType	The type of the auto trigger for base image dependency updates.
KnownCreatedByType	The kind of entity that created the resource.
KnownOS	The OS of agent machine
KnownProvisioningState	The provisioning state of this agent pool
KnownRunStatus	The current status of the run.
KnownRunType	The type of run.
KnownSecretObjectType	The type of the secret object which determines how the value of the secret object has to be interpreted.
KnownSourceControlType	The type of source control service.
KnownSourceRegistryLoginMode	The authentication mode which determines the source registry login scope. The credentials for the source registry will be generated using the given scope. These credentials will be used to login to the source registry during the run.
KnownSourceTriggerEvent	Known values of SourceTriggerEvent that the service accepts.
KnownStepType	The type of the step.
KnownTaskStatus	The current status of task.
KnownTokenType	The type of Auth token.
KnownTriggerStatus	The current status of trigger.
KnownUpdateTriggerPayloadType	Type of Payload body for Base image update triggers.
KnownVariant	Variant of the CPU.
KnownVersions	The available API versions.

Functions

restorePoller<TResponse, TResult>(ContainerRegistryTasksManagementClient, 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 Details

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

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

Parameters

client: ContainerRegistryTasksManagementClient

serializedState: string

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

options: RestorePollerOptions<TResult, PathUncheckedResponse>

Returns

PollerLike<OperationState<TResult>, TResult>

Feedback

Was this page helpful?

Share via

@azure/arm-containerregistrytasks package

Classes

Interfaces

Type Aliases

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Enums

Functions

Function Details

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

Parameters

Returns

Feedback