@azure/arm-devhub 1.0.0-beta.1

package/types/arm-devhub.d.ts

@@ -0,0 +1,609 @@
+import * as coreAuth from '@azure/core-auth';
+import * as coreClient from '@azure/core-client';
+import { PagedAsyncIterableIterator } from '@azure/core-paging';
+
+/** Information on the azure container registry */
+export declare interface Acr {
+    /** ACR subscription id */
+    acrSubscriptionId?: string;
+    /** ACR resource group */
+    acrResourceGroup?: string;
+    /** ACR registry */
+    acrRegistryName?: string;
+    /** ACR repository */
+    acrRepositoryName?: string;
+}
+
+/**
+ * Defines values for ActionType. \
+ * {@link KnownActionType} can be used interchangeably with ActionType,
+ *  this enum contains the known values that the service supports.
+ * ### Known values supported by the service
+ * **Internal**
+ */
+export declare type ActionType = string;
+
+/**
+ * Defines values for CreatedByType. \
+ * {@link KnownCreatedByType} can be used interchangeably with CreatedByType,
+ *  this enum contains the known values that the service supports.
+ * ### Known values supported by the service
+ * **User** \
+ * **Application** \
+ * **ManagedIdentity** \
+ * **Key**
+ */
+export declare type CreatedByType = string;
+
+/** delete response if content must be provided on delete operation */
+export declare interface DeleteWorkflowResponse {
+    /** delete status message */
+    status?: string;
+}
+
+export declare interface DeploymentProperties {
+    /** Determines the type of manifests within the repository. */
+    manifestType?: ManifestType;
+    kubeManifestLocations?: string[];
+    /** Helm chart directory path in repository. */
+    helmChartPath?: string;
+    /** Helm Values.yaml file location in repository. */
+    helmValues?: string;
+    /** Manifest override values. */
+    overrides?: {
+        [propertyName: string]: string;
+    };
+}
+
+export declare class DeveloperHubServiceClient extends coreClient.ServiceClient {
+    $host: string;
+    apiVersion: string;
+    subscriptionId: string;
+    /**
+     * Initializes a new instance of the DeveloperHubServiceClient class.
+     * @param credentials Subscription credentials which uniquely identify client subscription.
+     * @param subscriptionId The ID of the target subscription.
+     * @param options The parameter options
+     */
+    constructor(credentials: coreAuth.TokenCredential, subscriptionId: string, options?: DeveloperHubServiceClientOptionalParams);
+    /** A function that adds a policy that sets the api-version (or equivalent) to reflect the library version. */
+    private addCustomApiVersionPolicy;
+    /**
+     * Gets GitHubOAuth info used to authenticate users with the Developer Hub GitHub App.
+     * @param location The name of Azure region.
+     * @param options The options parameters.
+     */
+    gitHubOAuth(location: string, options?: GitHubOAuthOptionalParams): Promise<GitHubOAuthOperationResponse>;
+    /**
+     * Callback URL to hit once authenticated with GitHub App to have the service store the OAuth token.
+     * @param location The name of Azure region.
+     * @param code The code response from authenticating the GitHub App.
+     * @param state The state response from authenticating the GitHub App.
+     * @param options The options parameters.
+     */
+    gitHubOAuthCallback(location: string, code: string, state: string, options?: GitHubOAuthCallbackOptionalParams): Promise<GitHubOAuthCallbackResponse>;
+    /**
+     * Callback URL to hit once authenticated with GitHub App to have the service store the OAuth token.
+     * @param location The name of Azure region.
+     * @param options The options parameters.
+     */
+    listGitHubOAuth(location: string, options?: ListGitHubOAuthOptionalParams): Promise<ListGitHubOAuthResponse>;
+    operations: Operations;
+    workflowOperations: WorkflowOperations;
+}
+
+/** Optional parameters. */
+export declare interface DeveloperHubServiceClientOptionalParams extends coreClient.ServiceClientOptions {
+    /** server parameter */
+    $host?: string;
+    /** Api Version */
+    apiVersion?: string;
+    /** Overrides client endpoint. */
+    endpoint?: string;
+}
+
+/** The resource management error additional info. */
+export declare interface ErrorAdditionalInfo {
+    /**
+     * The additional info type.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly type?: string;
+    /**
+     * The additional info.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly info?: Record<string, unknown>;
+}
+
+/** The error detail. */
+export declare interface ErrorDetail {
+    /**
+     * The error code.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly code?: string;
+    /**
+     * The error message.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly message?: string;
+    /**
+     * The error target.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly target?: string;
+    /**
+     * The error details.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly details?: ErrorDetail[];
+    /**
+     * The error additional info.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly additionalInfo?: ErrorAdditionalInfo[];
+}
+
+/** Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.). */
+export declare interface ErrorResponse {
+    /** The error object. */
+    error?: ErrorDetail;
+}
+
+/** Optional parameters. */
+export declare interface GitHubOAuthCallbackOptionalParams extends coreClient.OperationOptions {
+}
+
+/** Contains response data for the gitHubOAuthCallback operation. */
+export declare type GitHubOAuthCallbackResponse = GitHubOAuthResponse;
+
+/** GitHubOAuth request object */
+export declare interface GitHubOAuthCallRequest {
+    /** The URL the client will redirect to on successful authentication. If empty, no redirect will occur. */
+    redirectUrl?: string;
+}
+
+/** URL used to authorize the Developer Hub GitHub App */
+export declare interface GitHubOAuthInfoResponse {
+    /** URL for authorizing the Developer Hub GitHub App */
+    authURL?: string;
+    /** OAuth token used to make calls to GitHub */
+    token?: string;
+}
+
+/** The response from List GitHubOAuth operation. */
+export declare interface GitHubOAuthListResponse {
+    /** Singleton list response containing one GitHubOAuthResponse response */
+    value?: GitHubOAuthResponse[];
+}
+
+/** Contains response data for the gitHubOAuth operation. */
+export declare type GitHubOAuthOperationResponse = GitHubOAuthInfoResponse;
+
+/** Optional parameters. */
+export declare interface GitHubOAuthOptionalParams extends coreClient.OperationOptions {
+    /** GitHubOAuth request object */
+    parameters?: GitHubOAuthCallRequest;
+}
+
+/** Singleton response of GitHubOAuth containing */
+export declare interface GitHubOAuthResponse extends ProxyResource {
+    /** user making request */
+    username?: string;
+}
+
+/** The fields needed for OIDC with GitHub. */
+export declare interface GitHubWorkflowProfileOidcCredentials {
+    /** Azure Application Client ID */
+    azureClientId?: string;
+    /** Azure Directory (tenant) ID */
+    azureTenantId?: string;
+}
+
+/** Known values of {@link ActionType} that the service accepts. */
+export declare enum KnownActionType {
+    /** Internal */
+    Internal = "Internal"
+}
+
+/** Known values of {@link CreatedByType} that the service accepts. */
+export declare enum KnownCreatedByType {
+    /** User */
+    User = "User",
+    /** Application */
+    Application = "Application",
+    /** ManagedIdentity */
+    ManagedIdentity = "ManagedIdentity",
+    /** Key */
+    Key = "Key"
+}
+
+/** Known values of {@link ManifestType} that the service accepts. */
+export declare enum KnownManifestType {
+    /** Repositories using helm */
+    Helm = "helm",
+    /** Repositories using kubernetes manifests */
+    Kube = "kube"
+}
+
+/** Known values of {@link Origin} that the service accepts. */
+export declare enum KnownOrigin {
+    /** User */
+    User = "user",
+    /** System */
+    System = "system",
+    /** UserSystem */
+    UserSystem = "user,system"
+}
+
+/** Known values of {@link PullRequestStatus} that the service accepts. */
+export declare enum KnownPullRequestStatus {
+    /** Pull Request state unknown. */
+    Unknown = "unknown",
+    /** Pull Request submitted to repository. */
+    Submitted = "submitted",
+    /** Pull Request merged into repository. */
+    Merged = "merged",
+    /** Workflow no longer found within repository. */
+    Removed = "removed"
+}
+
+/** Optional parameters. */
+export declare interface ListGitHubOAuthOptionalParams extends coreClient.OperationOptions {
+}
+
+/** Contains response data for the listGitHubOAuth operation. */
+export declare type ListGitHubOAuthResponse = GitHubOAuthListResponse;
+
+/**
+ * Defines values for ManifestType. \
+ * {@link KnownManifestType} can be used interchangeably with ManifestType,
+ *  this enum contains the known values that the service supports.
+ * ### Known values supported by the service
+ * **helm**: Repositories using helm \
+ * **kube**: Repositories using kubernetes manifests
+ */
+export declare type ManifestType = string;
+
+/** Details of a REST API operation, returned from the Resource Provider Operations API */
+export declare interface Operation {
+    /**
+     * The name of the operation, as per Resource-Based Access Control (RBAC). Examples: "Microsoft.Compute/virtualMachines/write", "Microsoft.Compute/virtualMachines/capture/action"
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly name?: string;
+    /**
+     * Whether the operation applies to data-plane. This is "true" for data-plane operations and "false" for ARM/control-plane operations.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly isDataAction?: boolean;
+    /** Localized display information for this particular operation. */
+    display?: OperationDisplay;
+    /**
+     * The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system"
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly origin?: Origin;
+    /**
+     * Enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly actionType?: ActionType;
+}
+
+/** Localized display information for this particular operation. */
+export declare interface OperationDisplay {
+    /**
+     * The localized friendly form of the resource provider name, e.g. "Microsoft Monitoring Insights" or "Microsoft Compute".
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly provider?: string;
+    /**
+     * The localized friendly name of the resource type related to this operation. E.g. "Virtual Machines" or "Job Schedule Collections".
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly resource?: string;
+    /**
+     * The concise, localized friendly name for the operation; suitable for dropdowns. E.g. "Create or Update Virtual Machine", "Restart Virtual Machine".
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly operation?: string;
+    /**
+     * The short, localized friendly description of the operation; suitable for tool tips and detailed views.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly description?: string;
+}
+
+/** A list of REST API operations supported by an Azure Resource Provider. It contains an URL link to get the next set of results. */
+export declare interface OperationListResult {
+    /**
+     * List of operations supported by the resource provider
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly value?: Operation[];
+    /**
+     * URL to get the next set of operation list results (if there are any).
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly nextLink?: string;
+}
+
+/** Interface representing a Operations. */
+export declare interface Operations {
+    /**
+     * Returns list of operations.
+     * @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;
+
+/**
+ * Defines values for Origin. \
+ * {@link KnownOrigin} can be used interchangeably with Origin,
+ *  this enum contains the known values that the service supports.
+ * ### Known values supported by the service
+ * **user** \
+ * **system** \
+ * **user,system**
+ */
+export declare type Origin = string;
+
+/** The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location */
+export declare interface ProxyResource extends Resource {
+}
+
+/**
+ * Defines values for PullRequestStatus. \
+ * {@link KnownPullRequestStatus} can be used interchangeably with PullRequestStatus,
+ *  this enum contains the known values that the service supports.
+ * ### Known values supported by the service
+ * **unknown**: Pull Request state unknown. \
+ * **submitted**: Pull Request submitted to repository. \
+ * **merged**: Pull Request merged into repository. \
+ * **removed**: Workflow no longer found within repository.
+ */
+export declare type PullRequestStatus = string;
+
+/** Common fields that are returned in the response for all Azure Resource Manager resources */
+export declare interface Resource {
+    /**
+     * Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly id?: string;
+    /**
+     * The name of the resource
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly name?: string;
+    /**
+     * The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly type?: string;
+    /**
+     * Azure Resource Manager metadata containing createdBy and modifiedBy information.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly systemData?: SystemData;
+}
+
+/** Metadata pertaining to creation and last modification of the resource. */
+export declare interface SystemData {
+    /** The identity that created the resource. */
+    createdBy?: string;
+    /** The type of identity that created the resource. */
+    createdByType?: CreatedByType;
+    /** The timestamp of resource creation (UTC). */
+    createdAt?: Date;
+    /** The identity that last modified the resource. */
+    lastModifiedBy?: string;
+    /** The type of identity that last modified the resource. */
+    lastModifiedByType?: CreatedByType;
+    /** The timestamp of resource last modification (UTC) */
+    lastModifiedAt?: Date;
+}
+
+/** Resource tags. */
+export declare interface TagsObject {
+    /** Dictionary of <string> */
+    tags?: {
+        [propertyName: string]: string;
+    };
+}
+
+/** The resource model definition for an Azure Resource Manager tracked top level resource which has 'tags' and a 'location' */
+export declare interface TrackedResource extends Resource {
+    /** Resource tags. */
+    tags?: {
+        [propertyName: string]: string;
+    };
+    /** The geo-location where the resource lives */
+    location: string;
+}
+
+/** Resource representation of a workflow */
+export declare interface Workflow extends TrackedResource {
+    /** Repository Owner */
+    repositoryOwner?: string;
+    /** Repository Name */
+    repositoryName?: string;
+    /** Repository Branch Name */
+    branchName?: string;
+    /** Path to the Dockerfile within the repository. */
+    dockerfile?: string;
+    /** Path to Dockerfile Build Context within the repository. */
+    dockerBuildContext?: string;
+    deploymentProperties?: DeploymentProperties;
+    /** Kubernetes namespace the application is deployed to. */
+    namespace?: string;
+    /** Information on the azure container registry */
+    acr?: Acr;
+    /** The fields needed for OIDC with GitHub. */
+    oidcCredentials?: GitHubWorkflowProfileOidcCredentials;
+    /** The Azure Kubernetes Cluster Resource the application will be deployed to. */
+    aksResourceId?: string;
+    /**
+     * The URL to the Pull Request submitted against the users repository.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly prURL?: string;
+    /**
+     * The number associated with the submitted pull request.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly pullNumber?: number;
+    /**
+     * The status of the Pull Request submitted against the users repository.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly prStatus?: PullRequestStatus;
+    lastWorkflowRun?: WorkflowRun;
+    /** Determines the type of manifests within the repository. */
+    authStatus?: ManifestType;
+}
+
+/** Optional parameters. */
+export declare interface WorkflowCreateOrUpdateOptionalParams extends coreClient.OperationOptions {
+}
+
+/** Contains response data for the createOrUpdate operation. */
+export declare type WorkflowCreateOrUpdateResponse = Workflow;
+
+/** Optional parameters. */
+export declare interface WorkflowDeleteOptionalParams extends coreClient.OperationOptions {
+}
+
+/** Contains response data for the delete operation. */
+export declare type WorkflowDeleteResponse = DeleteWorkflowResponse;
+
+/** Optional parameters. */
+export declare interface WorkflowGetOptionalParams extends coreClient.OperationOptions {
+}
+
+/** Contains response data for the get operation. */
+export declare type WorkflowGetResponse = Workflow;
+
+/** Optional parameters. */
+export declare interface WorkflowListByResourceGroupNextOptionalParams extends coreClient.OperationOptions {
+    /** The ManagedCluster resource associated with the workflows. */
+    managedClusterResource?: string;
+}
+
+/** Contains response data for the listByResourceGroupNext operation. */
+export declare type WorkflowListByResourceGroupNextResponse = WorkflowListResult;
+
+/** Optional parameters. */
+export declare interface WorkflowListByResourceGroupOptionalParams extends coreClient.OperationOptions {
+    /** The ManagedCluster resource associated with the workflows. */
+    managedClusterResource?: string;
+}
+
+/** Contains response data for the listByResourceGroup operation. */
+export declare type WorkflowListByResourceGroupResponse = WorkflowListResult;
+
+/** Optional parameters. */
+export declare interface WorkflowListNextOptionalParams extends coreClient.OperationOptions {
+}
+
+/** Contains response data for the listNext operation. */
+export declare type WorkflowListNextResponse = WorkflowListResult;
+
+/** Optional parameters. */
+export declare interface WorkflowListOptionalParams extends coreClient.OperationOptions {
+}
+
+/** Contains response data for the list operation. */
+export declare type WorkflowListResponse = WorkflowListResult;
+
+/** The response from List Workflows operation. */
+export declare interface WorkflowListResult {
+    /** The list of workflows. */
+    value?: Workflow[];
+    /**
+     * The URL to the next set of workflow results.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly nextLink?: string;
+}
+
+/** Interface representing a WorkflowOperations. */
+export declare interface WorkflowOperations {
+    /**
+     * Gets a list of workflows associated with the specified subscription.
+     * @param options The options parameters.
+     */
+    list(options?: WorkflowListOptionalParams): PagedAsyncIterableIterator<Workflow>;
+    /**
+     * Gets a list of workflows within a resource group.
+     * @param resourceGroupName The name of the resource group. The name is case insensitive.
+     * @param options The options parameters.
+     */
+    listByResourceGroup(resourceGroupName: string, options?: WorkflowListByResourceGroupOptionalParams): PagedAsyncIterableIterator<Workflow>;
+    /**
+     * Gets a workflow.
+     * @param resourceGroupName The name of the resource group. The name is case insensitive.
+     * @param workflowName The name of the workflow resource.
+     * @param options The options parameters.
+     */
+    get(resourceGroupName: string, workflowName: string, options?: WorkflowGetOptionalParams): Promise<WorkflowGetResponse>;
+    /**
+     * Creates or updates a workflow
+     * @param resourceGroupName The name of the resource group. The name is case insensitive.
+     * @param workflowName The name of the workflow resource.
+     * @param parameters Resource representation of a workflow
+     * @param options The options parameters.
+     */
+    createOrUpdate(resourceGroupName: string, workflowName: string, parameters: Workflow, options?: WorkflowCreateOrUpdateOptionalParams): Promise<WorkflowCreateOrUpdateResponse>;
+    /**
+     * Deletes a workflow
+     * @param resourceGroupName The name of the resource group. The name is case insensitive.
+     * @param workflowName The name of the workflow resource.
+     * @param options The options parameters.
+     */
+    delete(resourceGroupName: string, workflowName: string, options?: WorkflowDeleteOptionalParams): Promise<WorkflowDeleteResponse>;
+    /**
+     * Updates tags on a workflow.
+     * @param resourceGroupName The name of the resource group. The name is case insensitive.
+     * @param workflowName The name of the workflow resource.
+     * @param parameters Parameters supplied to the Update Workflow Tags operation.
+     * @param options The options parameters.
+     */
+    updateTags(resourceGroupName: string, workflowName: string, parameters: TagsObject, options?: WorkflowUpdateTagsOptionalParams): Promise<WorkflowUpdateTagsResponse>;
+}
+
+export declare interface WorkflowRun {
+    /**
+     * Describes if the workflow run succeeded.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly succeeded?: boolean;
+    /**
+     * URL to the run of the workflow.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly workflowRunURL?: string;
+    /**
+     * The timestamp of the last workflow run.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly lastRunAt?: Date;
+}
+
+/** Optional parameters. */
+export declare interface WorkflowUpdateTagsOptionalParams extends coreClient.OperationOptions {
+}
+
+/** Contains response data for the updateTags operation. */
+export declare type WorkflowUpdateTagsResponse = Workflow;
+
+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.32.0"
+    }
+  ]
+}