@azure/arm-visualstudio 2.2.0 → 4.0.0-beta.1

package/types/arm-visualstudio.d.ts

@@ -0,0 +1,493 @@
+import * as coreAuth from '@azure/core-auth';
+import * as coreClient from '@azure/core-client';
+import { PollerLike } from '@azure/core-lro';
+import { PollOperationState } from '@azure/core-lro';
+
+/** The response to an account resource GET request. */
+export declare type AccountResource = Resource & {
+    /** Resource properties. */
+    properties?: {
+        [propertyName: string]: string;
+    };
+};
+
+/** The response to an account resource list GET request. */
+export declare interface AccountResourceListResult {
+    /** Array of resource details. */
+    value?: AccountResource[];
+}
+
+/** The body of a PUT request to modify a Visual Studio account resource. */
+export declare interface AccountResourceRequest {
+    /** The account name. */
+    accountName?: string;
+    /** The Azure instance location. */
+    location?: string;
+    /** The type of the operation. */
+    operationType?: AccountResourceRequestOperationType;
+    /** The custom properties of the resource. */
+    properties?: {
+        [propertyName: string]: string;
+    };
+    /** The custom tags of the resource. */
+    tags?: {
+        [propertyName: string]: string;
+    };
+}
+
+/** Defines values for AccountResourceRequestOperationType. */
+export declare type AccountResourceRequestOperationType = "unknown" | "create" | "update" | "link";
+
+/** Interface representing a Accounts. */
+export declare interface Accounts {
+    /**
+     * Checks if the specified Visual Studio Team Services account name is available. Resource name can be
+     * either an account name or an account name and PUID.
+     * @param body Parameters describing the name to check availability for.
+     * @param options The options parameters.
+     */
+    checkNameAvailability(body: CheckNameAvailabilityParameter, options?: AccountsCheckNameAvailabilityOptionalParams): Promise<AccountsCheckNameAvailabilityResponse>;
+    /**
+     * Gets all Visual Studio Team Services account resources under the resource group linked to the
+     * specified Azure subscription.
+     * @param resourceGroupName Name of the resource group within the Azure subscription.
+     * @param options The options parameters.
+     */
+    listByResourceGroup(resourceGroupName: string, options?: AccountsListByResourceGroupOptionalParams): Promise<AccountsListByResourceGroupResponse>;
+    /**
+     * Creates or updates a Visual Studio Team Services account resource.
+     * @param resourceGroupName Name of the resource group within the Azure subscription.
+     * @param resourceName Name of the resource.
+     * @param body The request data.
+     * @param options The options parameters.
+     */
+    createOrUpdate(resourceGroupName: string, resourceName: string, body: AccountResourceRequest, options?: AccountsCreateOrUpdateOptionalParams): Promise<AccountsCreateOrUpdateResponse>;
+    /**
+     * Deletes a Visual Studio Team Services account resource.
+     * @param resourceGroupName Name of the resource group within the Azure subscription.
+     * @param resourceName Name of the resource.
+     * @param options The options parameters.
+     */
+    delete(resourceGroupName: string, resourceName: string, options?: AccountsDeleteOptionalParams): Promise<void>;
+    /**
+     * Gets the Visual Studio Team Services account resource details.
+     * @param resourceGroupName Name of the resource group within the Azure subscription.
+     * @param resourceName Name of the resource.
+     * @param options The options parameters.
+     */
+    get(resourceGroupName: string, resourceName: string, options?: AccountsGetOptionalParams): Promise<AccountsGetResponse>;
+    /**
+     * Updates tags for Visual Studio Team Services account resource.
+     * @param resourceGroupName Name of the resource group within the Azure subscription.
+     * @param resourceName Name of the resource.
+     * @param body The request data.
+     * @param options The options parameters.
+     */
+    update(resourceGroupName: string, resourceName: string, body: AccountTagRequest, options?: AccountsUpdateOptionalParams): Promise<AccountsUpdateResponse>;
+}
+
+/** Optional parameters. */
+export declare interface AccountsCheckNameAvailabilityOptionalParams extends coreClient.OperationOptions {
+}
+
+/** Contains response data for the checkNameAvailability operation. */
+export declare type AccountsCheckNameAvailabilityResponse = CheckNameAvailabilityResult;
+
+/** Optional parameters. */
+export declare interface AccountsCreateOrUpdateOptionalParams extends coreClient.OperationOptions {
+}
+
+/** Contains response data for the createOrUpdate operation. */
+export declare type AccountsCreateOrUpdateResponse = AccountResource;
+
+/** Optional parameters. */
+export declare interface AccountsDeleteOptionalParams extends coreClient.OperationOptions {
+}
+
+/** Optional parameters. */
+export declare interface AccountsGetOptionalParams extends coreClient.OperationOptions {
+}
+
+/** Contains response data for the get operation. */
+export declare type AccountsGetResponse = AccountResource;
+
+/** Optional parameters. */
+export declare interface AccountsListByResourceGroupOptionalParams extends coreClient.OperationOptions {
+}
+
+/** Contains response data for the listByResourceGroup operation. */
+export declare type AccountsListByResourceGroupResponse = AccountResourceListResult;
+
+/** Optional parameters. */
+export declare interface AccountsUpdateOptionalParams extends coreClient.OperationOptions {
+}
+
+/** Contains response data for the update operation. */
+export declare type AccountsUpdateResponse = AccountResource;
+
+/** The body of a Patch request to add tags to a Visual Studio account resource. */
+export declare interface AccountTagRequest {
+    /** The custom tags of the resource. */
+    tags?: {
+        [propertyName: string]: string;
+    };
+}
+
+/** The body of a POST request to check name availability. */
+export declare interface CheckNameAvailabilityParameter {
+    /** The name of the resource to check availability for. */
+    resourceName?: string;
+    /** The type of resource to check availability for. */
+    resourceType?: string;
+}
+
+/** The response to a name availability request. */
+export declare interface CheckNameAvailabilityResult {
+    /** The message describing the detailed reason. */
+    message?: string;
+    /** The value which indicates whether the provided name is available. */
+    nameAvailable?: boolean;
+}
+
+/** The response to an extension resource GET request. */
+export declare type ExtensionResource = Resource & {
+    /** The extension plan that was purchased. */
+    plan?: ExtensionResourcePlan;
+    /** Resource properties. */
+    properties?: {
+        [propertyName: string]: string;
+    };
+};
+
+/** The response to an extension resource list GET request. */
+export declare interface ExtensionResourceListResult {
+    /** Array of extension resource details. */
+    value?: ExtensionResource[];
+}
+
+/** Plan data for an extension resource. */
+export declare interface ExtensionResourcePlan {
+    /** Name of the plan. */
+    name?: string;
+    /** Product name. */
+    product?: string;
+    /** Optional: the promotion code associated with the plan. */
+    promotionCode?: string;
+    /** Name of the extension publisher. */
+    publisher?: string;
+    /** A string that uniquely identifies the plan version. */
+    version?: string;
+}
+
+/** The body of an extension resource PUT request. */
+export declare interface ExtensionResourceRequest {
+    /** The Azure region of the Visual Studio account associated with this request (i.e 'southcentralus'.) */
+    location?: string;
+    /** Extended information about the plan being purchased for this extension resource. */
+    plan?: ExtensionResourcePlan;
+    /** A dictionary of extended properties. This property is currently unused. */
+    properties?: {
+        [propertyName: string]: string;
+    };
+    /** A dictionary of user-defined tags to be stored with the extension resource. */
+    tags?: {
+        [propertyName: string]: string;
+    };
+}
+
+/** Interface representing a Extensions. */
+export declare interface Extensions {
+    /**
+     * Gets the details of the extension resources created within the resource group.
+     * @param resourceGroupName Name of the resource group within the Azure subscription.
+     * @param accountResourceName The name of the Visual Studio Team Services account resource.
+     * @param options The options parameters.
+     */
+    listByAccount(resourceGroupName: string, accountResourceName: string, options?: ExtensionsListByAccountOptionalParams): Promise<ExtensionsListByAccountResponse>;
+    /**
+     * Registers the extension with a Visual Studio Team Services account.
+     * @param resourceGroupName Name of the resource group within the Azure subscription.
+     * @param accountResourceName The name of the Visual Studio Team Services account resource.
+     * @param extensionResourceName The name of the extension.
+     * @param body An object containing additional information related to the extension request.
+     * @param options The options parameters.
+     */
+    create(resourceGroupName: string, accountResourceName: string, extensionResourceName: string, body: ExtensionResourceRequest, options?: ExtensionsCreateOptionalParams): Promise<ExtensionsCreateResponse>;
+    /**
+     * Removes an extension resource registration for a Visual Studio Team Services account.
+     * @param resourceGroupName Name of the resource group within the Azure subscription.
+     * @param accountResourceName The name of the Visual Studio Team Services account resource.
+     * @param extensionResourceName The name of the extension.
+     * @param options The options parameters.
+     */
+    delete(resourceGroupName: string, accountResourceName: string, extensionResourceName: string, options?: ExtensionsDeleteOptionalParams): Promise<void>;
+    /**
+     * Gets the details of an extension associated with a Visual Studio Team Services account resource.
+     * @param resourceGroupName Name of the resource group within the Azure subscription.
+     * @param accountResourceName The name of the Visual Studio Team Services account resource.
+     * @param extensionResourceName The name of the extension.
+     * @param options The options parameters.
+     */
+    get(resourceGroupName: string, accountResourceName: string, extensionResourceName: string, options?: ExtensionsGetOptionalParams): Promise<ExtensionsGetResponse>;
+    /**
+     * Updates an existing extension registration for the Visual Studio Team Services account.
+     * @param resourceGroupName Name of the resource group within the Azure subscription.
+     * @param accountResourceName The name of the Visual Studio Team Services account resource.
+     * @param extensionResourceName The name of the extension.
+     * @param body An object containing additional information related to the extension request.
+     * @param options The options parameters.
+     */
+    update(resourceGroupName: string, accountResourceName: string, extensionResourceName: string, body: ExtensionResourceRequest, options?: ExtensionsUpdateOptionalParams): Promise<ExtensionsUpdateResponse>;
+}
+
+/** Optional parameters. */
+export declare interface ExtensionsCreateOptionalParams extends coreClient.OperationOptions {
+}
+
+/** Contains response data for the create operation. */
+export declare type ExtensionsCreateResponse = ExtensionResource;
+
+/** Optional parameters. */
+export declare interface ExtensionsDeleteOptionalParams extends coreClient.OperationOptions {
+}
+
+/** Optional parameters. */
+export declare interface ExtensionsGetOptionalParams extends coreClient.OperationOptions {
+}
+
+/** Contains response data for the get operation. */
+export declare type ExtensionsGetResponse = ExtensionResource;
+
+/** Optional parameters. */
+export declare interface ExtensionsListByAccountOptionalParams extends coreClient.OperationOptions {
+}
+
+/** Contains response data for the listByAccount operation. */
+export declare type ExtensionsListByAccountResponse = ExtensionResourceListResult;
+
+/** Optional parameters. */
+export declare interface ExtensionsUpdateOptionalParams extends coreClient.OperationOptions {
+}
+
+/** Contains response data for the update operation. */
+export declare type ExtensionsUpdateResponse = ExtensionResource;
+
+/** Properties of an operation supported by the resource provider. */
+export declare interface Operation {
+    /** The properties of the resource operation. */
+    display?: OperationProperties;
+    /** The name of the resource operation. */
+    name?: string;
+}
+
+/** Container for a list of operations supported by a resource provider. */
+export declare interface OperationListResult {
+    /** A list of operations supported by a resource provider. */
+    value?: Operation[];
+}
+
+/** Properties of an operation supported by the resource provider. */
+export declare interface OperationProperties {
+    /** The description of the resource operation. */
+    description?: string;
+    /** The operation name. */
+    operation?: string;
+    /** The provider name. */
+    provider?: string;
+    /** The resource name. */
+    resource?: string;
+}
+
+/** Interface representing a Operations. */
+export declare interface Operations {
+    /**
+     * Gets the details of all operations possible on the Microsoft.VisualStudio resource provider.
+     * @param options The options parameters.
+     */
+    list(options?: OperationsListOptionalParams): Promise<OperationsListResponse>;
+}
+
+/** Optional parameters. */
+export declare interface OperationsListOptionalParams extends coreClient.OperationOptions {
+}
+
+/** Contains response data for the list operation. */
+export declare type OperationsListResponse = OperationListResult;
+
+/** A Visual Studio Team Services project resource. */
+export declare type ProjectResource = Resource & {
+    /** Key/value pair of resource properties. */
+    properties?: {
+        [propertyName: string]: string;
+    };
+};
+
+/** The response to a request to list Team Services project resources in a resource group/account. */
+export declare interface ProjectResourceListResult {
+    /** List of project resource details. */
+    value?: ProjectResource[];
+}
+
+/** Interface representing a Projects. */
+export declare interface Projects {
+    /**
+     * Gets all Visual Studio Team Services project resources created in the specified Team Services
+     * account.
+     * @param resourceGroupName Name of the resource group within the Azure subscription.
+     * @param rootResourceName Name of the Team Services account.
+     * @param options The options parameters.
+     */
+    listByResourceGroup(resourceGroupName: string, rootResourceName: string, options?: ProjectsListByResourceGroupOptionalParams): Promise<ProjectsListByResourceGroupResponse>;
+    /**
+     * Creates a Team Services project in the collection with the specified name. 'VersionControlOption'
+     * and 'ProcessTemplateId' must be specified in the resource properties. Valid values for
+     * VersionControlOption: Git, Tfvc. Valid values for ProcessTemplateId:
+     * 6B724908-EF14-45CF-84F8-768B5384DA45, ADCC42AB-9882-485E-A3ED-7678F01F66BC,
+     * 27450541-8E31-4150-9947-DC59F998FC01 (these IDs correspond to Scrum, Agile, and CMMI process
+     * templates).
+     * @param resourceGroupName Name of the resource group within the Azure subscription.
+     * @param rootResourceName Name of the Team Services account.
+     * @param resourceName Name of the Team Services project.
+     * @param body The request data.
+     * @param options The options parameters.
+     */
+    beginCreate(resourceGroupName: string, rootResourceName: string, resourceName: string, body: ProjectResource, options?: ProjectsCreateOptionalParams): Promise<PollerLike<PollOperationState<ProjectsCreateResponse>, ProjectsCreateResponse>>;
+    /**
+     * Creates a Team Services project in the collection with the specified name. 'VersionControlOption'
+     * and 'ProcessTemplateId' must be specified in the resource properties. Valid values for
+     * VersionControlOption: Git, Tfvc. Valid values for ProcessTemplateId:
+     * 6B724908-EF14-45CF-84F8-768B5384DA45, ADCC42AB-9882-485E-A3ED-7678F01F66BC,
+     * 27450541-8E31-4150-9947-DC59F998FC01 (these IDs correspond to Scrum, Agile, and CMMI process
+     * templates).
+     * @param resourceGroupName Name of the resource group within the Azure subscription.
+     * @param rootResourceName Name of the Team Services account.
+     * @param resourceName Name of the Team Services project.
+     * @param body The request data.
+     * @param options The options parameters.
+     */
+    beginCreateAndWait(resourceGroupName: string, rootResourceName: string, resourceName: string, body: ProjectResource, options?: ProjectsCreateOptionalParams): Promise<ProjectsCreateResponse>;
+    /**
+     * Gets the details of a Team Services project resource.
+     * @param resourceGroupName Name of the resource group within the Azure subscription.
+     * @param rootResourceName Name of the Team Services account.
+     * @param resourceName Name of the Team Services project.
+     * @param options The options parameters.
+     */
+    get(resourceGroupName: string, rootResourceName: string, resourceName: string, options?: ProjectsGetOptionalParams): Promise<ProjectsGetResponse>;
+    /**
+     * Updates the tags of the specified Team Services project.
+     * @param resourceGroupName Name of the resource group within the Azure subscription.
+     * @param rootResourceName Name of the Team Services account.
+     * @param resourceName Name of the Team Services project.
+     * @param body The request data.
+     * @param options The options parameters.
+     */
+    update(resourceGroupName: string, rootResourceName: string, resourceName: string, body: ProjectResource, options?: ProjectsUpdateOptionalParams): Promise<ProjectsUpdateResponse>;
+    /**
+     * Gets the status of the project resource creation job.
+     * @param resourceGroupName Name of the resource group within the Azure subscription.
+     * @param rootResourceName Name of the Team Services account.
+     * @param resourceName Name of the Team Services project.
+     * @param subContainerName This parameter should be set to the resourceName.
+     * @param operation The operation type. The only supported value is 'put'.
+     * @param options The options parameters.
+     */
+    getJobStatus(resourceGroupName: string, rootResourceName: string, resourceName: string, subContainerName: string, operation: string, options?: ProjectsGetJobStatusOptionalParams): Promise<ProjectsGetJobStatusResponse>;
+}
+
+/** Optional parameters. */
+export declare interface ProjectsCreateOptionalParams extends coreClient.OperationOptions {
+    /** This parameter is ignored and should be set to an empty string. */
+    validating?: string;
+    /** Delay to wait until next poll, in milliseconds. */
+    updateIntervalInMs?: number;
+    /** A serialized poller which can be used to resume an existing paused Long-Running-Operation. */
+    resumeFrom?: string;
+}
+
+/** Contains response data for the create operation. */
+export declare type ProjectsCreateResponse = ProjectResource;
+
+/** Optional parameters. */
+export declare interface ProjectsGetJobStatusOptionalParams extends coreClient.OperationOptions {
+    /** The job identifier. */
+    jobId?: string;
+}
+
+/** Contains response data for the getJobStatus operation. */
+export declare type ProjectsGetJobStatusResponse = ProjectResource;
+
+/** Optional parameters. */
+export declare interface ProjectsGetOptionalParams extends coreClient.OperationOptions {
+}
+
+/** Contains response data for the get operation. */
+export declare type ProjectsGetResponse = ProjectResource;
+
+/** Optional parameters. */
+export declare interface ProjectsListByResourceGroupOptionalParams extends coreClient.OperationOptions {
+}
+
+/** Contains response data for the listByResourceGroup operation. */
+export declare type ProjectsListByResourceGroupResponse = ProjectResourceListResult;
+
+/** Optional parameters. */
+export declare interface ProjectsUpdateOptionalParams extends coreClient.OperationOptions {
+}
+
+/** Contains response data for the update operation. */
+export declare type ProjectsUpdateResponse = ProjectResource;
+
+/** A generic Azure Resource Manager resource. */
+export declare interface Resource {
+    /**
+     * Unique identifier of the resource.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly id?: string;
+    /** Resource location. */
+    location?: string;
+    /**
+     * Resource name.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly name?: string;
+    /** Resource tags. */
+    tags?: {
+        [propertyName: string]: string;
+    };
+    /**
+     * Resource type.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly type?: string;
+}
+
+export declare class VisualStudioResourceProviderClient extends coreClient.ServiceClient {
+    $host: string;
+    subscriptionId: string;
+    apiVersion: string;
+    /**
+     * Initializes a new instance of the VisualStudioResourceProviderClient class.
+     * @param credentials Subscription credentials which uniquely identify client subscription.
+     * @param subscriptionId The Azure subscription identifier.
+     * @param options The parameter options
+     */
+    constructor(credentials: coreAuth.TokenCredential, subscriptionId: string, options?: VisualStudioResourceProviderClientOptionalParams);
+    operations: Operations;
+    accounts: Accounts;
+    extensions: Extensions;
+    projects: Projects;
+}
+
+/** Optional parameters. */
+export declare interface VisualStudioResourceProviderClientOptionalParams extends coreClient.ServiceClientOptions {
+    /** server parameter */
+    $host?: string;
+    /** Api Version */
+    apiVersion?: string;
+    /** Overrides client endpoint. */
+    endpoint?: string;
+}
+
+export { }

package/types/tsdoc-metadata.json

@@ -0,0 +1,11 @@
+// This file is read by tools that parse documentation comments conforming to the TSDoc standard.
+// It should be published with your NPM package.  It should not be tracked by Git.
+{
+  "tsdocVersion": "0.12",
+  "toolPackages": [
+    {
+      "packageName": "@microsoft/api-extractor",
+      "packageVersion": "7.19.4"
+    }
+  ]
+}