@azure/arm-devopsinfrastructure package

Classes

DevOpsInfrastructureClient

Interfaces

AgentProfile	The agent profile of the machines in the pool.
AutomaticResourcePredictionsProfile	The stand-by agent scheme is determined based on historical demand.
AzureDevOpsOrganizationProfile	Azure DevOps organization profile
AzureDevOpsPermissionProfile	Defines the type of Azure DevOps pool permission.
DataDisk	The data disk of the VMSS.
DevOpsAzureSku	The Azure SKU of the machines in the pool.
DevOpsInfrastructureClientOptionalParams	Optional parameters for the client.
FabricProfile	Defines the type of fabric the agent will run on.
GitHubOrganization	Defines a GitHub organization
GitHubOrganizationProfile	GitHub organization profile
ImageVersion	An image version object
ImageVersionProperties	Details of the ImageVersionProperties.
ImageVersionsListByImageOptionalParams	Optional parameters.
ImageVersionsOperations	Interface representing a ImageVersions operations.
ManagedServiceIdentity	Managed service identity (system assigned and/or user assigned identities)
ManualResourcePredictionsProfile	Customer provides the stand-by agent scheme.
NetworkProfile	The network profile of the machines in the pool.
Operation	Details of a REST API operation, returned from the Resource Provider Operations API
OperationDisplay	Localized display information for and operation.
OperationsListOptionalParams	Optional parameters.
OperationsOperations	Interface representing a Operations operations.
Organization	Defines an Azure DevOps organization.
OrganizationProfile	Defines the organization in which the pool will be used.
OsProfile	The OS profile of the machines in the pool.
PageSettings	Options for the byPage method
PagedAsyncIterableIterator	An interface that allows async iterable iteration both to completion and by page.
Pool	Concrete tracked resource types can be created by aliasing this type using a specific property type.
PoolImage	The VM image of the machines in the pool.
PoolProperties	Pool properties
PoolUpdate	The type used for update operations of the Pool.
PoolUpdateProperties	The updatable properties of the Pool.
PoolsCreateOrUpdateOptionalParams	Optional parameters.
PoolsDeleteOptionalParams	Optional parameters.
PoolsGetOptionalParams	Optional parameters.
PoolsListByResourceGroupOptionalParams	Optional parameters.
PoolsListBySubscriptionOptionalParams	Optional parameters.
PoolsOperations	Interface representing a Pools operations.
PoolsUpdateOptionalParams	Optional parameters.
ProxyResource	The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location
Quota	Describes Resource Quota
QuotaName	The Quota Names
Resource	Common fields that are returned in the response for all Azure Resource Manager resources
ResourceDetailsListByPoolOptionalParams	Optional parameters.
ResourceDetailsObject	A ResourceDetailsObject
ResourceDetailsObjectProperties	Details of the ResourceDetailsObject.
ResourceDetailsOperations	Interface representing a ResourceDetails operations.
ResourcePredictions	Defines pool buffer.
ResourcePredictionsProfile	Determines how the stand-by scheme should be provided.
ResourceSku	A ResourceSku
ResourceSkuCapabilities	Describes The SKU capabilities object.
ResourceSkuLocationInfo	Describes an available Compute SKU Location Information.
ResourceSkuProperties	Properties of a ResourceSku
ResourceSkuRestrictionInfo	Describes an available Compute SKU Restriction Information.
ResourceSkuRestrictions	The restrictions of the SKU.
ResourceSkuZoneDetails	Describes The zonal capabilities of a SKU.
RestorePollerOptions
SecretsManagementSettings	The secret management settings of the machines in the pool.
SkuListByLocationOptionalParams	Optional parameters.
SkuOperations	Interface representing a Sku operations.
Stateful	Stateful profile meaning that the machines will be returned to the pool after running a job.
StatelessAgentProfile	Stateless profile meaning that the machines will be cleaned up after running a job.
StorageProfile	The storage profile of the VMSS.
SubscriptionUsagesOperations	Interface representing a SubscriptionUsages operations.
SubscriptionUsagesUsagesOptionalParams	Optional parameters.
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'
UserAssignedIdentity	User assigned identity properties
VmssFabricProfile	The agents will run on Virtual Machine Scale Sets.

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.
AgentProfileUnion	Alias for AgentProfileUnion
AzureDevOpsPermissionType	Determines who has admin permissions to the Azure DevOps pool. KnownAzureDevOpsPermissionType can be used interchangeably with AzureDevOpsPermissionType, this enum contains the known values that the service supports. Known values supported by the service Inherit: Pool will inherit permissions from the project or organization. CreatorOnly: Only the pool creator will be an admin of the pool. SpecificAccounts: Only the specified accounts will be admins of the pool.
CachingType	The type of caching in a data disk. KnownCachingType can be used interchangeably with CachingType, this enum contains the known values that the service supports. Known values supported by the service None: Don't use host caching. ReadOnly: For workloads that only do read operations. ReadWrite: For workloads that do a balance of read and write operations.
ContinuablePage	An interface that describes a page of results.
CreatedByType	The kind of entity that created the resource. <xref: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.
FabricProfileUnion	Alias for FabricProfileUnion
LogonType	Determines how the service should be run. KnownLogonType can be used interchangeably with LogonType, this enum contains the known values that the service supports. Known values supported by the service Service: Run as a service. Interactive: Run in interactive mode.
ManagedServiceIdentityType	Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). KnownManagedServiceIdentityType can be used interchangeably with ManagedServiceIdentityType, this enum contains the known values that the service supports. Known values supported by the service None: No managed identity. SystemAssigned: System assigned managed identity. UserAssigned: User assigned managed identity. SystemAssigned,UserAssigned: System and user assigned managed identity.
OrganizationProfileUnion	Alias for OrganizationProfileUnion
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.
OsDiskStorageAccountType	The storage account type of the OS disk. KnownOsDiskStorageAccountType can be used interchangeably with OsDiskStorageAccountType, this enum contains the known values that the service supports. Known values supported by the service Standard: Standard OS disk type. Premium: Premium OS disk type. StandardSSD: Standard SSD OS disk type.
PredictionPreference	Determines the balance between cost and performance. KnownPredictionPreference can be used interchangeably with PredictionPreference, this enum contains the known values that the service supports. Known values supported by the service Balanced: Balance between cost and performance. MostCostEffective: Optimizes for cost over performance. MoreCostEffective: Halfway through cost and balanced. MorePerformance: Halfway through balanced and performance. BestPerformance: Optimizes for performance over cost.
ProvisioningState	The status of the current operation. KnownProvisioningState can be used interchangeably with ProvisioningState, this enum contains the known values that the service supports. Known values supported by the service Succeeded: Represents a succeeded operation. Failed: Represents a failed operation. Canceled: Represents a canceled operation. Provisioning: Represents a pending operation. Updating: Represents a pending operation. Deleting: Represents an operation under deletion. Accepted: Represents an accepted operation.
ResourcePredictionsProfileType	Determines how the stand-by scheme should be provided. KnownResourcePredictionsProfileType can be used interchangeably with ResourcePredictionsProfileType, this enum contains the known values that the service supports. Known values supported by the service Manual: Customer provides the stand-by agent scheme. Automatic: The stand-by agent scheme is determined based on historical demand.
ResourcePredictionsProfileUnion	Alias for ResourcePredictionsProfileUnion
ResourceSkuRestrictionsReasonCode	Describes the reason for SKU restriction. KnownResourceSkuRestrictionsReasonCode can be used interchangeably with ResourceSkuRestrictionsReasonCode, this enum contains the known values that the service supports. Known values supported by the service QuotaId: The restriction is due to exceeding a quota limitation. NotAvailableForSubscription: The restriction is not available for this subscription.
ResourceSkuRestrictionsType	Describes the kind of SKU restrictions that can exist KnownResourceSkuRestrictionsType can be used interchangeably with ResourceSkuRestrictionsType, this enum contains the known values that the service supports. Known values supported by the service Location: SKU restricted by location. Zone: SKU restricted by availability zone.
ResourceStatus	The status of the machine resource. KnownResourceStatus can be used interchangeably with ResourceStatus, this enum contains the known values that the service supports. Known values supported by the service Ready: Represents a machine resource that is ready. NotReady: Represents a machine resource that is not ready. Allocated: Represents a machine resource that is allocated. PendingReturn: Represents a machine resource that is pending return. Returned: Represents a machine resource that is returned. Leased: Represents a machine resource that is leased. Provisioning: Represents a machine resource that is provisioning. Updating: Represents a machine resource that is updating. Starting: Represents a machine resource that is starting. PendingReimage: Represents a machine resource that is pending reimage. Reimaging: Represents a machine resource that is reimaging.
StorageAccountType	StorageAccountType enums KnownStorageAccountType can be used interchangeably with StorageAccountType, this enum contains the known values that the service supports. Known values supported by the service Standard_LRS: The data disk should use standard locally redundant storage. Premium_LRS: The data disk should use premium locally redundant storage. StandardSSD_LRS: The data disk should use standard SSD locally redundant storage. Premium_ZRS: The data disk should use premium SSD zonal redundant storage. StandardSSD_ZRS: The data disk should use standard SSD zonal redundant storage.

Enums

KnownActionType	Extensible enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs.
KnownAzureDevOpsPermissionType	Determines who has admin permissions to the Azure DevOps pool.
KnownCachingType	The type of caching in a data disk.
KnownCreatedByType	The kind of entity that created the resource.
KnownLogonType	Determines how the service should be run.
KnownManagedServiceIdentityType	Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).
KnownOrigin	The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system"
KnownOsDiskStorageAccountType	The storage account type of the OS disk.
KnownPredictionPreference	Determines the balance between cost and performance.
KnownProvisioningState	The status of the current operation.
KnownResourcePredictionsProfileType	Determines how the stand-by scheme should be provided.
KnownResourceSkuRestrictionsReasonCode	Describes the reason for SKU restriction.
KnownResourceSkuRestrictionsType	Describes the kind of SKU restrictions that can exist
KnownResourceStatus	The status of the machine resource.
KnownStorageAccountType	StorageAccountType enums
KnownVersions	Api versions

Functions

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

Parameters

client

DevOpsInfrastructureClient

serializedState

string

sourceOperation

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

options

RestorePollerOptions<TResult, PathUncheckedResponse>

Returns

PollerLike<OperationState<TResult>, TResult>