@azure/arm-devopsinfrastructure 1.0.0-alpha.20240531.3

package/review/arm-devopsinfrastructure.api.md

@@ -0,0 +1,828 @@
+## API Report File for "@azure/arm-devopsinfrastructure"
+
+> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
+
+```ts
+
+import * as coreAuth from '@azure/core-auth';
+import * as coreClient from '@azure/core-client';
+import { OperationState } from '@azure/core-lro';
+import { PagedAsyncIterableIterator } from '@azure/core-paging';
+import { SimplePollerLike } from '@azure/core-lro';
+
+// @public
+export type ActionType = string;
+
+// @public
+export interface AgentProfile {
+    kind: "Stateful" | "Stateless";
+    resourcePredictions?: Record<string, unknown>;
+    resourcePredictionsProfile?: ResourcePredictionsProfileUnion;
+}
+
+// @public (undocumented)
+export type AgentProfileUnion = AgentProfile | Stateful | StatelessAgentProfile;
+
+// @public
+export interface AgentProfileUpdate {
+    kind: "Stateful" | "Stateless";
+    resourcePredictions?: Record<string, unknown>;
+    resourcePredictionsProfile?: ResourcePredictionsProfileUpdateUnion;
+}
+
+// @public (undocumented)
+export type AgentProfileUpdateUnion = AgentProfileUpdate | StatefulUpdate | StatelessAgentProfileUpdate;
+
+// @public
+export interface AutomaticResourcePredictionsProfile extends ResourcePredictionsProfile {
+    kind: "Automatic";
+    predictionPreference?: PredictionPreference;
+}
+
+// @public
+export interface AutomaticResourcePredictionsProfileUpdate extends ResourcePredictionsProfileUpdate {
+    kind: "Automatic";
+    predictionPreference?: PredictionPreference;
+}
+
+// @public
+export interface AzureDevOpsOrganizationProfile extends OrganizationProfile {
+    kind: "AzureDevOps";
+    organizations: Organization[];
+    permissionProfile?: AzureDevOpsPermissionProfile;
+}
+
+// @public
+export interface AzureDevOpsPermissionProfile {
+    groups?: string[];
+    kind: AzureDevOpsPermissionType;
+    users?: string[];
+}
+
+// @public
+export type AzureDevOpsPermissionType = string;
+
+// @public
+export type CachingType = string;
+
+// @public
+export type CreatedByType = string;
+
+// @public
+export interface DataDisk {
+    caching?: CachingType;
+    diskSizeGiB?: number;
+    driveLetter?: string;
+    storageAccountType?: StorageAccountType;
+}
+
+// @public
+export interface DevOpsAzureSku {
+    name: string;
+}
+
+// @public
+export interface ErrorAdditionalInfo {
+    readonly info?: Record<string, unknown>;
+    readonly type?: string;
+}
+
+// @public
+export interface ErrorDetail {
+    readonly additionalInfo?: ErrorAdditionalInfo[];
+    readonly code?: string;
+    readonly details?: ErrorDetail[];
+    readonly message?: string;
+    readonly target?: string;
+}
+
+// @public
+export interface ErrorResponse {
+    error?: ErrorDetail;
+}
+
+// @public
+export interface FabricProfile {
+    kind: "Vmss";
+}
+
+// @public (undocumented)
+export type FabricProfileUnion = FabricProfile | VmssFabricProfile;
+
+// @public
+export function getContinuationToken(page: unknown): string | undefined;
+
+// @public
+export interface GitHubOrganization {
+    repositories?: string[];
+    url: string;
+}
+
+// @public
+export interface GitHubOrganizationProfile extends OrganizationProfile {
+    kind: "GitHub";
+    organizations: GitHubOrganization[];
+}
+
+// @public
+export interface ImageVersion extends ProxyResource {
+    properties?: ImageVersionProperties;
+}
+
+// @public
+export interface ImageVersionListResult {
+    nextLink?: string;
+    value: ImageVersion[];
+}
+
+// @public
+export interface ImageVersionProperties {
+    version: string;
+}
+
+// @public
+export interface ImageVersions {
+    listByImage(resourceGroupName: string, imageName: string, options?: ImageVersionsListByImageOptionalParams): PagedAsyncIterableIterator<ImageVersion>;
+}
+
+// @public
+export interface ImageVersionsListByImageNextOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type ImageVersionsListByImageNextResponse = ImageVersionListResult;
+
+// @public
+export interface ImageVersionsListByImageOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type ImageVersionsListByImageResponse = ImageVersionListResult;
+
+// @public
+export enum KnownActionType {
+    Internal = "Internal"
+}
+
+// @public
+export enum KnownAzureDevOpsPermissionType {
+    CreatorOnly = "CreatorOnly",
+    Inherit = "Inherit",
+    SpecificAccounts = "SpecificAccounts"
+}
+
+// @public
+export enum KnownCachingType {
+    None = "None",
+    ReadOnly = "ReadOnly",
+    ReadWrite = "ReadWrite"
+}
+
+// @public
+export enum KnownCreatedByType {
+    Application = "Application",
+    Key = "Key",
+    ManagedIdentity = "ManagedIdentity",
+    User = "User"
+}
+
+// @public
+export enum KnownLogonType {
+    Interactive = "Interactive",
+    Service = "Service"
+}
+
+// @public
+export enum KnownManagedServiceIdentityType {
+    None = "None",
+    SystemAssigned = "SystemAssigned",
+    SystemAssignedUserAssigned = "SystemAssigned,UserAssigned",
+    UserAssigned = "UserAssigned"
+}
+
+// @public
+export enum KnownOrigin {
+    System = "system",
+    User = "user",
+    UserSystem = "user,system"
+}
+
+// @public
+export enum KnownOsDiskStorageAccountType {
+    Premium = "Premium",
+    Standard = "Standard",
+    StandardSSD = "StandardSSD"
+}
+
+// @public
+export enum KnownPredictionPreference {
+    Balanced = "Balanced",
+    BestPerformance = "BestPerformance",
+    MoreCostEffective = "MoreCostEffective",
+    MorePerformance = "MorePerformance",
+    MostCostEffective = "MostCostEffective"
+}
+
+// @public
+export enum KnownProvisioningState {
+    Accepted = "Accepted",
+    Canceled = "Canceled",
+    Deleting = "Deleting",
+    Failed = "Failed",
+    Provisioning = "Provisioning",
+    Succeeded = "Succeeded",
+    Updating = "Updating"
+}
+
+// @public
+export enum KnownResourcePredictionsProfileType {
+    Automatic = "Automatic",
+    Manual = "Manual"
+}
+
+// @public
+export enum KnownResourceSkuRestrictionsReasonCode {
+    NotAvailableForSubscription = "NotAvailableForSubscription",
+    QuotaId = "QuotaId"
+}
+
+// @public
+export enum KnownResourceSkuRestrictionsType {
+    Location = "Location",
+    Zone = "Zone"
+}
+
+// @public
+export enum KnownResourceStatus {
+    Allocated = "Allocated",
+    Leased = "Leased",
+    NotReady = "NotReady",
+    PendingReimage = "PendingReimage",
+    PendingReturn = "PendingReturn",
+    Provisioning = "Provisioning",
+    Ready = "Ready",
+    Reimaging = "Reimaging",
+    Returned = "Returned",
+    Starting = "Starting",
+    Updating = "Updating"
+}
+
+// @public
+export enum KnownStorageAccountType {
+    PremiumLRS = "Premium_LRS",
+    PremiumZRS = "Premium_ZRS",
+    StandardLRS = "Standard_LRS",
+    StandardSsdlrs = "StandardSSD_LRS",
+    StandardSsdzrs = "StandardSSD_ZRS"
+}
+
+// @public
+export type LogonType = string;
+
+// @public (undocumented)
+export class ManagedDevOpsInfrastructure extends coreClient.ServiceClient {
+    // (undocumented)
+    $host: string;
+    constructor(credentials: coreAuth.TokenCredential, subscriptionId: string, options?: ManagedDevOpsInfrastructureOptionalParams);
+    // (undocumented)
+    apiVersion: string;
+    // (undocumented)
+    imageVersions: ImageVersions;
+    // (undocumented)
+    operations: Operations;
+    // (undocumented)
+    pools: Pools;
+    // (undocumented)
+    resourceDetails: ResourceDetails;
+    // (undocumented)
+    sku: Sku;
+    // (undocumented)
+    subscriptionId: string;
+    // (undocumented)
+    subscriptionUsages: SubscriptionUsages;
+}
+
+// @public
+export interface ManagedDevOpsInfrastructureOptionalParams extends coreClient.ServiceClientOptions {
+    $host?: string;
+    apiVersion?: string;
+    endpoint?: string;
+}
+
+// @public
+export interface ManagedServiceIdentity {
+    readonly principalId?: string;
+    readonly tenantId?: string;
+    type: ManagedServiceIdentityType;
+    userAssignedIdentities?: {
+        [propertyName: string]: UserAssignedIdentity | null;
+    };
+}
+
+// @public
+export type ManagedServiceIdentityType = string;
+
+// @public
+export interface ManualResourcePredictionsProfile extends ResourcePredictionsProfile {
+    kind: "Manual";
+}
+
+// @public
+export interface ManualResourcePredictionsProfileUpdate extends ResourcePredictionsProfileUpdate {
+    kind: "Manual";
+}
+
+// @public
+export interface NetworkProfile {
+    subnetId: string;
+}
+
+// @public
+export interface Operation {
+    readonly actionType?: ActionType;
+    display?: OperationDisplay;
+    readonly isDataAction?: boolean;
+    readonly name?: string;
+    readonly origin?: Origin;
+}
+
+// @public
+export interface OperationDisplay {
+    readonly description?: string;
+    readonly operation?: string;
+    readonly provider?: string;
+    readonly resource?: string;
+}
+
+// @public
+export interface OperationListResult {
+    readonly nextLink?: string;
+    readonly value?: Operation[];
+}
+
+// @public
+export interface Operations {
+    list(options?: OperationsListOptionalParams): PagedAsyncIterableIterator<Operation>;
+}
+
+// @public
+export interface OperationsListNextOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type OperationsListNextResponse = OperationListResult;
+
+// @public
+export interface OperationsListOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type OperationsListResponse = OperationListResult;
+
+// @public
+export interface Organization {
+    parallelism?: number;
+    projects?: string[];
+    url: string;
+}
+
+// @public
+export interface OrganizationProfile {
+    kind: "AzureDevOps" | "GitHub";
+}
+
+// @public (undocumented)
+export type OrganizationProfileUnion = OrganizationProfile | AzureDevOpsOrganizationProfile | GitHubOrganizationProfile;
+
+// @public
+export type Origin = string;
+
+// @public
+export type OsDiskStorageAccountType = string;
+
+// @public
+export interface OsProfile {
+    logonType?: LogonType;
+    secretsManagementSettings?: SecretsManagementSettings;
+}
+
+// @public
+export interface Pool extends TrackedResource {
+    identity?: ManagedServiceIdentity;
+    properties?: PoolProperties;
+}
+
+// @public
+export interface PoolImage {
+    aliases?: string[];
+    buffer?: string;
+    resourceId?: string;
+    wellKnownImageName?: string;
+}
+
+// @public
+export interface PoolListResult {
+    nextLink?: string;
+    value: Pool[];
+}
+
+// @public
+export interface PoolProperties {
+    agentProfile: AgentProfileUnion;
+    devCenterProjectResourceId: string;
+    fabricProfile: FabricProfileUnion;
+    maximumConcurrency: number;
+    organizationProfile: OrganizationProfileUnion;
+    provisioningState?: ProvisioningState;
+}
+
+// @public
+export interface Pools {
+    beginCreateOrUpdate(resourceGroupName: string, poolName: string, resource: Pool, options?: PoolsCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<PoolsCreateOrUpdateResponse>, PoolsCreateOrUpdateResponse>>;
+    beginCreateOrUpdateAndWait(resourceGroupName: string, poolName: string, resource: Pool, options?: PoolsCreateOrUpdateOptionalParams): Promise<PoolsCreateOrUpdateResponse>;
+    beginDelete(resourceGroupName: string, poolName: string, options?: PoolsDeleteOptionalParams): Promise<SimplePollerLike<OperationState<PoolsDeleteResponse>, PoolsDeleteResponse>>;
+    beginDeleteAndWait(resourceGroupName: string, poolName: string, options?: PoolsDeleteOptionalParams): Promise<PoolsDeleteResponse>;
+    beginUpdate(resourceGroupName: string, poolName: string, properties: PoolUpdate, options?: PoolsUpdateOptionalParams): Promise<SimplePollerLike<OperationState<PoolsUpdateResponse>, PoolsUpdateResponse>>;
+    beginUpdateAndWait(resourceGroupName: string, poolName: string, properties: PoolUpdate, options?: PoolsUpdateOptionalParams): Promise<PoolsUpdateResponse>;
+    get(resourceGroupName: string, poolName: string, options?: PoolsGetOptionalParams): Promise<PoolsGetResponse>;
+    listByResourceGroup(resourceGroupName: string, options?: PoolsListByResourceGroupOptionalParams): PagedAsyncIterableIterator<Pool>;
+    listBySubscription(options?: PoolsListBySubscriptionOptionalParams): PagedAsyncIterableIterator<Pool>;
+}
+
+// @public
+export interface PoolsCreateOrUpdateHeaders {
+    retryAfter?: number;
+}
+
+// @public
+export interface PoolsCreateOrUpdateOptionalParams extends coreClient.OperationOptions {
+    resumeFrom?: string;
+    updateIntervalInMs?: number;
+}
+
+// @public
+export type PoolsCreateOrUpdateResponse = Pool;
+
+// @public
+export interface PoolsDeleteHeaders {
+    location?: string;
+    retryAfter?: number;
+}
+
+// @public
+export interface PoolsDeleteOptionalParams extends coreClient.OperationOptions {
+    resumeFrom?: string;
+    updateIntervalInMs?: number;
+}
+
+// @public
+export type PoolsDeleteResponse = PoolsDeleteHeaders;
+
+// @public
+export interface PoolsGetOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type PoolsGetResponse = Pool;
+
+// @public
+export interface PoolsListByResourceGroupNextOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type PoolsListByResourceGroupNextResponse = PoolListResult;
+
+// @public
+export interface PoolsListByResourceGroupOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type PoolsListByResourceGroupResponse = PoolListResult;
+
+// @public
+export interface PoolsListBySubscriptionNextOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type PoolsListBySubscriptionNextResponse = PoolListResult;
+
+// @public
+export interface PoolsListBySubscriptionOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type PoolsListBySubscriptionResponse = PoolListResult;
+
+// @public
+export interface PoolsUpdateHeaders {
+    location?: string;
+    retryAfter?: number;
+}
+
+// @public
+export interface PoolsUpdateOptionalParams extends coreClient.OperationOptions {
+    resumeFrom?: string;
+    updateIntervalInMs?: number;
+}
+
+// @public
+export type PoolsUpdateResponse = Pool;
+
+// @public
+export interface PoolUpdate {
+    identity?: ManagedServiceIdentity;
+    properties?: PoolUpdateProperties;
+    tags?: {
+        [propertyName: string]: string;
+    };
+}
+
+// @public
+export interface PoolUpdateProperties {
+    agentProfile?: AgentProfileUpdateUnion;
+    devCenterProjectResourceId?: string;
+    fabricProfile?: FabricProfileUnion;
+    maximumConcurrency?: number;
+    organizationProfile?: OrganizationProfileUnion;
+    provisioningState?: ProvisioningState;
+}
+
+// @public
+export type PredictionPreference = string;
+
+// @public
+export type ProvisioningState = string;
+
+// @public
+export interface ProxyResource extends Resource {
+}
+
+// @public
+export interface Quota extends ProxyResource {
+    properties?: QuotaProperties;
+}
+
+// @public
+export interface QuotaListResult {
+    nextLink?: string;
+    value: Quota[];
+}
+
+// @public
+export interface QuotaName {
+    localizedValue?: string;
+    value?: string;
+}
+
+// @public
+export interface QuotaProperties {
+    currentValue: number;
+    limit: number;
+    name: QuotaName;
+    unit: string;
+}
+
+// @public
+export interface Resource {
+    readonly id?: string;
+    readonly name?: string;
+    readonly systemData?: SystemData;
+    readonly type?: string;
+}
+
+// @public
+export interface ResourceDetails {
+    listByPool(resourceGroupName: string, poolName: string, options?: ResourceDetailsListByPoolOptionalParams): PagedAsyncIterableIterator<ResourceDetailsObject>;
+}
+
+// @public
+export interface ResourceDetailsListByPoolNextOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type ResourceDetailsListByPoolNextResponse = ResourceDetailsObjectListResult;
+
+// @public
+export interface ResourceDetailsListByPoolOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type ResourceDetailsListByPoolResponse = ResourceDetailsObjectListResult;
+
+// @public
+export interface ResourceDetailsObject extends ProxyResource {
+    properties?: ResourceDetailsObjectProperties;
+}
+
+// @public
+export interface ResourceDetailsObjectListResult {
+    nextLink?: string;
+    value: ResourceDetailsObject[];
+}
+
+// @public
+export interface ResourceDetailsObjectProperties {
+    image: string;
+    imageVersion: string;
+    status: ResourceStatus;
+}
+
+// @public
+export interface ResourcePredictionsProfile {
+    kind: "Automatic" | "Manual";
+}
+
+// @public
+export type ResourcePredictionsProfileType = string;
+
+// @public (undocumented)
+export type ResourcePredictionsProfileUnion = ResourcePredictionsProfile | AutomaticResourcePredictionsProfile | ManualResourcePredictionsProfile;
+
+// @public
+export interface ResourcePredictionsProfileUpdate {
+    kind: "Automatic" | "Manual";
+}
+
+// @public (undocumented)
+export type ResourcePredictionsProfileUpdateUnion = ResourcePredictionsProfileUpdate | AutomaticResourcePredictionsProfileUpdate | ManualResourcePredictionsProfileUpdate;
+
+// @public
+export interface ResourceSku extends ProxyResource {
+    properties?: ResourceSkuProperties;
+}
+
+// @public
+export interface ResourceSkuCapabilities {
+    name: string;
+    value: string;
+}
+
+// @public
+export interface ResourceSkuListResult {
+    nextLink?: string;
+    value: ResourceSku[];
+}
+
+// @public
+export interface ResourceSkuLocationInfo {
+    location: string;
+    zoneDetails: ResourceSkuZoneDetails[];
+    zones: string[];
+}
+
+// @public
+export interface ResourceSkuProperties {
+    capabilities: ResourceSkuCapabilities[];
+    family: string;
+    locationInfo: ResourceSkuLocationInfo[];
+    locations: string[];
+    resourceType: string;
+    restrictions: ResourceSkuRestrictions[];
+    size: string;
+    tier: string;
+}
+
+// @public
+export interface ResourceSkuRestrictionInfo {
+    locations?: string[];
+    zones?: string[];
+}
+
+// @public
+export interface ResourceSkuRestrictions {
+    reasonCode?: ResourceSkuRestrictionsReasonCode;
+    restrictionInfo: ResourceSkuRestrictionInfo;
+    type?: ResourceSkuRestrictionsType;
+    values: string[];
+}
+
+// @public
+export type ResourceSkuRestrictionsReasonCode = string;
+
+// @public
+export type ResourceSkuRestrictionsType = string;
+
+// @public
+export interface ResourceSkuZoneDetails {
+    capabilities: ResourceSkuCapabilities[];
+    name: string[];
+}
+
+// @public
+export type ResourceStatus = string;
+
+// @public
+export interface SecretsManagementSettings {
+    certificateStoreLocation?: string;
+    keyExportable: boolean;
+    observedCertificates: string[];
+}
+
+// @public
+export interface Sku {
+    listByLocation(locationName: string, options?: SkuListByLocationOptionalParams): PagedAsyncIterableIterator<ResourceSku>;
+}
+
+// @public
+export interface SkuListByLocationNextOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type SkuListByLocationNextResponse = ResourceSkuListResult;
+
+// @public
+export interface SkuListByLocationOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type SkuListByLocationResponse = ResourceSkuListResult;
+
+// @public
+export interface Stateful extends AgentProfile {
+    gracePeriodTimeSpan?: string;
+    kind: "Stateful";
+    maxAgentLifetime?: string;
+}
+
+// @public
+export interface StatefulUpdate extends AgentProfileUpdate {
+    gracePeriodTimeSpan?: string;
+    kind: "Stateful";
+    maxAgentLifetime?: string;
+}
+
+// @public
+export interface StatelessAgentProfile extends AgentProfile {
+    kind: "Stateless";
+}
+
+// @public
+export interface StatelessAgentProfileUpdate extends AgentProfileUpdate {
+    kind: "Stateless";
+}
+
+// @public
+export type StorageAccountType = string;
+
+// @public
+export interface StorageProfile {
+    dataDisks?: DataDisk[];
+    osDiskStorageAccountType?: OsDiskStorageAccountType;
+}
+
+// @public
+export interface SubscriptionUsages {
+    listByLocation(locationName: string, options?: SubscriptionUsagesListByLocationOptionalParams): PagedAsyncIterableIterator<Quota>;
+}
+
+// @public
+export interface SubscriptionUsagesListByLocationNextOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type SubscriptionUsagesListByLocationNextResponse = QuotaListResult;
+
+// @public
+export interface SubscriptionUsagesListByLocationOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type SubscriptionUsagesListByLocationResponse = QuotaListResult;
+
+// @public
+export interface SystemData {
+    createdAt?: Date;
+    createdBy?: string;
+    createdByType?: CreatedByType;
+    lastModifiedAt?: Date;
+    lastModifiedBy?: string;
+    lastModifiedByType?: CreatedByType;
+}
+
+// @public
+export interface TrackedResource extends Resource {
+    location: string;
+    tags?: {
+        [propertyName: string]: string;
+    };
+}
+
+// @public
+export interface UserAssignedIdentity {
+    readonly clientId?: string;
+    readonly principalId?: string;
+}
+
+// @public
+export interface VmssFabricProfile extends FabricProfile {
+    images: PoolImage[];
+    kind: "Vmss";
+    networkProfile?: NetworkProfile;
+    osProfile?: OsProfile;
+    sku: DevOpsAzureSku;
+    storageProfile?: StorageProfile;
+}
+
+// (No @packageDocumentation comment for this package)
+
+```