@azure/arm-devhub 1.0.0-beta.1

package/src/models/index.ts

@@ -0,0 +1,518 @@
+/*
+ * Copyright (c) Microsoft Corporation.
+ * Licensed under the MIT License.
+ *
+ * Code generated by Microsoft (R) AutoRest Code Generator.
+ * Changes may cause incorrect behavior and will be lost if the code is regenerated.
+ */
+
+import * as coreClient from "@azure/core-client";
+
+/** 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 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;
+}
+
+/** Details of a REST API operation, returned from the Resource Provider Operations API */
+export 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 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;
+}
+
+/** 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 interface ErrorResponse {
+  /** The error object. */
+  error?: ErrorDetail;
+}
+
+/** The error detail. */
+export 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[];
+}
+
+/** The resource management error additional info. */
+export 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>;
+}
+
+/** GitHubOAuth request object */
+export 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 interface GitHubOAuthInfoResponse {
+  /** URL for authorizing the Developer Hub GitHub App */
+  authURL?: string;
+  /** OAuth token used to make calls to GitHub */
+  token?: string;
+}
+
+/** Common fields that are returned in the response for all Azure Resource Manager resources */
+export 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 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;
+}
+
+/** The response from List GitHubOAuth operation. */
+export interface GitHubOAuthListResponse {
+  /** Singleton list response containing one GitHubOAuthResponse response */
+  value?: GitHubOAuthResponse[];
+}
+
+/** The response from List Workflows operation. */
+export 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;
+}
+
+export 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 };
+}
+
+/** Information on the azure container registry */
+export interface Acr {
+  /** ACR subscription id */
+  acrSubscriptionId?: string;
+  /** ACR resource group */
+  acrResourceGroup?: string;
+  /** ACR registry */
+  acrRegistryName?: string;
+  /** ACR repository */
+  acrRepositoryName?: string;
+}
+
+/** The fields needed for OIDC with GitHub. */
+export interface GitHubWorkflowProfileOidcCredentials {
+  /** Azure Application Client ID */
+  azureClientId?: string;
+  /** Azure Directory (tenant) ID */
+  azureTenantId?: string;
+}
+
+export 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;
+}
+
+/** delete response if content must be provided on delete operation */
+export interface DeleteWorkflowResponse {
+  /** delete status message */
+  status?: string;
+}
+
+/** Resource tags. */
+export interface TagsObject {
+  /** Dictionary of <string> */
+  tags?: { [propertyName: string]: string };
+}
+
+/** The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location */
+export interface ProxyResource extends Resource {}
+
+/** The resource model definition for an Azure Resource Manager tracked top level resource which has 'tags' and a 'location' */
+export interface TrackedResource extends Resource {
+  /** Resource tags. */
+  tags?: { [propertyName: string]: string };
+  /** The geo-location where the resource lives */
+  location: string;
+}
+
+/** Singleton response of GitHubOAuth containing */
+export interface GitHubOAuthResponse extends ProxyResource {
+  /** user making request */
+  username?: string;
+}
+
+/** Resource representation of a workflow */
+export 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;
+}
+
+/** Known values of {@link Origin} that the service accepts. */
+export enum KnownOrigin {
+  /** User */
+  User = "user",
+  /** System */
+  System = "system",
+  /** UserSystem */
+  UserSystem = "user,system"
+}
+
+/**
+ * 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 type Origin = string;
+
+/** Known values of {@link ActionType} that the service accepts. */
+export enum KnownActionType {
+  /** Internal */
+  Internal = "Internal"
+}
+
+/**
+ * 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 type ActionType = string;
+
+/** Known values of {@link CreatedByType} that the service accepts. */
+export enum KnownCreatedByType {
+  /** User */
+  User = "User",
+  /** Application */
+  Application = "Application",
+  /** ManagedIdentity */
+  ManagedIdentity = "ManagedIdentity",
+  /** Key */
+  Key = "Key"
+}
+
+/**
+ * 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 type CreatedByType = string;
+
+/** Known values of {@link ManifestType} that the service accepts. */
+export enum KnownManifestType {
+  /** Repositories using helm */
+  Helm = "helm",
+  /** Repositories using kubernetes manifests */
+  Kube = "kube"
+}
+
+/**
+ * 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 type ManifestType = string;
+
+/** Known values of {@link PullRequestStatus} that the service accepts. */
+export 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"
+}
+
+/**
+ * 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 type PullRequestStatus = string;
+
+/** Optional parameters. */
+export interface OperationsListOptionalParams
+  extends coreClient.OperationOptions {}
+
+/** Contains response data for the list operation. */
+export type OperationsListResponse = OperationListResult;
+
+/** Optional parameters. */
+export interface GitHubOAuthOptionalParams extends coreClient.OperationOptions {
+  /** GitHubOAuth request object */
+  parameters?: GitHubOAuthCallRequest;
+}
+
+/** Contains response data for the gitHubOAuth operation. */
+export type GitHubOAuthOperationResponse = GitHubOAuthInfoResponse;
+
+/** Optional parameters. */
+export interface GitHubOAuthCallbackOptionalParams
+  extends coreClient.OperationOptions {}
+
+/** Contains response data for the gitHubOAuthCallback operation. */
+export type GitHubOAuthCallbackResponse = GitHubOAuthResponse;
+
+/** Optional parameters. */
+export interface ListGitHubOAuthOptionalParams
+  extends coreClient.OperationOptions {}
+
+/** Contains response data for the listGitHubOAuth operation. */
+export type ListGitHubOAuthResponse = GitHubOAuthListResponse;
+
+/** Optional parameters. */
+export interface WorkflowListOptionalParams
+  extends coreClient.OperationOptions {}
+
+/** Contains response data for the list operation. */
+export type WorkflowListResponse = WorkflowListResult;
+
+/** Optional parameters. */
+export interface WorkflowListByResourceGroupOptionalParams
+  extends coreClient.OperationOptions {
+  /** The ManagedCluster resource associated with the workflows. */
+  managedClusterResource?: string;
+}
+
+/** Contains response data for the listByResourceGroup operation. */
+export type WorkflowListByResourceGroupResponse = WorkflowListResult;
+
+/** Optional parameters. */
+export interface WorkflowGetOptionalParams
+  extends coreClient.OperationOptions {}
+
+/** Contains response data for the get operation. */
+export type WorkflowGetResponse = Workflow;
+
+/** Optional parameters. */
+export interface WorkflowCreateOrUpdateOptionalParams
+  extends coreClient.OperationOptions {}
+
+/** Contains response data for the createOrUpdate operation. */
+export type WorkflowCreateOrUpdateResponse = Workflow;
+
+/** Optional parameters. */
+export interface WorkflowDeleteOptionalParams
+  extends coreClient.OperationOptions {}
+
+/** Contains response data for the delete operation. */
+export type WorkflowDeleteResponse = DeleteWorkflowResponse;
+
+/** Optional parameters. */
+export interface WorkflowUpdateTagsOptionalParams
+  extends coreClient.OperationOptions {}
+
+/** Contains response data for the updateTags operation. */
+export type WorkflowUpdateTagsResponse = Workflow;
+
+/** Optional parameters. */
+export interface WorkflowListNextOptionalParams
+  extends coreClient.OperationOptions {}
+
+/** Contains response data for the listNext operation. */
+export type WorkflowListNextResponse = WorkflowListResult;
+
+/** Optional parameters. */
+export interface WorkflowListByResourceGroupNextOptionalParams
+  extends coreClient.OperationOptions {
+  /** The ManagedCluster resource associated with the workflows. */
+  managedClusterResource?: string;
+}
+
+/** Contains response data for the listByResourceGroupNext operation. */
+export type WorkflowListByResourceGroupNextResponse = WorkflowListResult;
+
+/** Optional parameters. */
+export interface DeveloperHubServiceClientOptionalParams
+  extends coreClient.ServiceClientOptions {
+  /** server parameter */
+  $host?: string;
+  /** Api Version */
+  apiVersion?: string;
+  /** Overrides client endpoint. */
+  endpoint?: string;
+}