swagger: '2.0' info: version: 2020-08-01-preview title: Microsoft Azure AccessControlClient AccessConnector Workflow API description: Workflow controller. schemes: - https tags: - name: Workflow description: Workflow controller. paths: ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/modernizeProjects/{modernizeProjectName}/jobs/{workflowName} : get: tags: - Workflow summary: Microsoft Azure Gets The Workflow description: Gets the details of the job. operationId: microsoftAzureWorkflowGet produces: - application/json parameters: - $ref: '#/parameters/subscriptionId' - $ref: '#/parameters/resourceGroupName' - in: path name: modernizeProjectName pattern: ^[a-z][a-z0-9]*$ description: ModernizeProject name. required: true type: string - in: path name: workflowName pattern: ^[a-z][a-z0-9]*$ description: Workflow name. required: true type: string - $ref: '#/parameters/api-version' responses: '200': description: Success schema: $ref: '#/definitions/WorkflowModel' default: description: Error schema: $ref: '#/definitions/ArmError' x-ms-examples: Workflow_Get_MaximumSet_Gen: $ref: ./examples/Workflow_Get_MaximumSet_Gen.json Workflow_Get_MinimumSet_Gen: $ref: ./examples/Workflow_Get_MinimumSet_Gen.json ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/modernizeProjects/{modernizeProjectName}/jobs : get: tags: - Workflow summary: Microsoft Azure Lists The Workflows description: Gets the list of jobs in the given modernizeProject. operationId: microsoftAzureWorkflowList produces: - application/json parameters: - $ref: '#/parameters/subscriptionId' - $ref: '#/parameters/resourceGroupName' - in: path name: modernizeProjectName pattern: ^[a-z][a-z0-9]*$ description: ModernizeProject name. required: true type: string - in: query name: $filter description: Filter string. type: string - in: query name: continuationToken description: Continuation token. type: string - $ref: '#/parameters/api-version' responses: '200': description: Success schema: $ref: '#/definitions/WorkflowModelCollection' default: description: Error schema: $ref: '#/definitions/ArmError' x-ms-pageable: nextLinkName: nextLink x-ms-examples: Workflow_List_MaximumSet_Gen: $ref: ./examples/Workflow_List_MaximumSet_Gen.json Workflow_List_MinimumSet_Gen: $ref: ./examples/Workflow_List_MinimumSet_Gen.json ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/modernizeProjects/{modernizeProjectName}/jobs/{workflowName}/operations/{operationId} : get: tags: - Workflow summary: Microsoft Azure Gets The Workflow Operation Status description: Tracks the results of an asynchronous operation on the job. operationId: microsoftAzureWorkflowoperationstatusGet produces: - application/json parameters: - $ref: '#/parameters/subscriptionId' - $ref: '#/parameters/resourceGroupName' - in: path name: modernizeProjectName pattern: ^[a-z][a-z0-9]*$ description: ModernizeProject name. required: true type: string - in: path name: workflowName pattern: ^[a-z][a-z0-9]*$ description: Workflow name. required: true type: string - in: path name: operationId description: Operation Id. required: true type: string - $ref: '#/parameters/api-version' responses: '200': description: Success schema: $ref: '#/definitions/OperationStatus' default: description: Error schema: $ref: '#/definitions/ArmError' x-ms-examples: WorkflowOperationStatus_Get_MaximumSet_Gen: $ref: ./examples/WorkflowOperationStatus_Get_MaximumSet_Gen.json WorkflowOperationStatus_Get_MinimumSet_Gen: $ref: ./examples/WorkflowOperationStatus_Get_MinimumSet_Gen.json ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataReplication/replicationVaults/{vaultName}/jobs/{jobName} : get: tags: - Workflow summary: Microsoft Azure Gets The Job Workflow description: Gets the details of the job. operationId: microsoftAzureWorkflowGet produces: - application/json parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/VaultNameParameter' - $ref: '#/parameters/JobNameParameter' - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter responses: '200': description: Returns Workflow Model on success. schema: $ref: '#/definitions/WorkflowModel_2' default: description: Error schema: $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-examples: Workflow_Get: $ref: ./examples/Workflow_Get.json ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataReplication/replicationVaults/{vaultName}/jobs : get: tags: - Workflow summary: Microsoft Azure Lists The Jobs Workflows description: Gets the list of jobs in the given vault. operationId: microsoftAzureWorkflowList produces: - application/json parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/VaultNameParameter' - in: query name: $filter description: Filter string. type: string - in: query name: continuationToken description: Continuation token. type: string - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter responses: '200': description: Returns Workflow Model Collection on success. schema: $ref: '#/definitions/WorkflowModelCollection_2' default: description: Error schema: $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-pageable: nextLinkName: nextLink x-ms-examples: Workflow_List: $ref: ./examples/Workflow_List.json ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataReplication/replicationVaults/{vaultName}/jobs/{jobName}/operations/{operationId} : get: tags: - Workflow summary: Microsoft Azure Gets The Job Workflow Operation Status description: Tracks the results of an asynchronous operation on the job. operationId: microsoftAzureWorkflowoperationstatusGet produces: - application/json parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/VaultNameParameter' - $ref: '#/parameters/JobNameParameter' - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/OperationIdParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter responses: '200': description: Success schema: $ref: '#/definitions/OperationStatus_2' default: description: Error schema: $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-examples: WorkflowOperationStatus_Get: $ref: ./examples/WorkflowOperationStatus_Get.json /subscriptions/{subscriptionId}/providers/Microsoft.DevHub/workflows: get: tags: - Workflow operationId: microsoftAzureWorkflowList summary: Microsoft Azure Gets A List Of Workflows Associated With The Specified Subscription parameters: - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter responses: '200': description: Describe the result of a successful operation. schema: $ref: '#/definitions/WorkflowListResult' default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse x-ms-pageable: nextLinkName: nextLink x-ms-examples: List Workflows: $ref: ./examples/Workflow_List.json description: Needs a more full description created. /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevHub/workflows: get: tags: - Workflow operationId: microsoftAzureWorkflowListbyresourcegroup summary: Microsoft Azure Gets A List Of Workflows Within A Resource Group parameters: - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/ManagedClusterParameter' responses: '200': description: Describe the result of a successful operation. schema: $ref: '#/definitions/WorkflowListResult' default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse x-ms-pageable: nextLinkName: nextLink x-ms-examples: List Workflows: $ref: ./examples/Workflow_ListByResourceGroup.json description: Needs a more full description created. /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevHub/workflows/{workflowName}: get: tags: - Workflow operationId: microsoftAzureWorkflowGet summary: Microsoft Azure Gets A Workflow parameters: - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/WorkflowNameParameter' responses: '200': description: OK schema: $ref: '#/definitions/Workflow' default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse x-ms-examples: Get Workflow: $ref: ./examples/Workflow_Get.json description: Needs a more full description created. put: tags: - Workflow operationId: microsoftAzureWorkflowCreateorupdate summary: Microsoft Azure Creates Or Updates A Workflow parameters: - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/WorkflowNameParameter' - name: parameters in: body required: true schema: $ref: '#/definitions/Workflow' responses: '200': description: OK schema: $ref: '#/definitions/Workflow' '201': description: Created schema: $ref: '#/definitions/Workflow' default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse x-ms-examples: Create Workflow: $ref: ./examples/Workflow_CreateOrUpdate.json Create Workflow With Artifact Generation: $ref: ./examples/Workflow_CreateOrUpdate_WithArtifactGen.json description: Needs a more full description created. delete: tags: - Workflow operationId: microsoftAzureWorkflowDelete summary: Microsoft Azure Deletes A Workflow parameters: - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/WorkflowNameParameter' responses: '200': description: successful delete with response schema: $ref: '#/definitions/DeleteWorkflowResponse' '204': description: Successfully deleted the resource default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse x-ms-examples: Delete Workflow: $ref: ./examples/Workflow_Delete.json description: Needs a more full description created. patch: tags: - Workflow operationId: microsoftAzureWorkflowUpdatetags summary: Microsoft Azure Updates Tags On A Workflow parameters: - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/WorkflowNameParameter' - name: parameters in: body required: true schema: $ref: '#/definitions/TagsObject' description: Parameters supplied to the Update Workflow Tags operation. responses: '200': description: OK schema: $ref: '#/definitions/Workflow' default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse x-ms-examples: Update Managed Cluster Tags: $ref: ./examples/Workflow_UpdateTags.json description: Needs a more full description created. definitions: ArtifactGenerationProperties: description: Properties used for generating artifacts such as Dockerfiles and manifests. title: Artifact Generation Properties type: object properties: generationLanguage: $ref: '#/definitions/GenerationLanguage' languageVersion: type: string description: The version of the language image used for execution in the generated dockerfile. builderVersion: type: string description: The version of the language image used for building the code in the generated dockerfile. port: type: string description: The port the application is exposed on. appName: type: string description: The name of the app. dockerfileOutputDirectory: type: string description: The directory to output the generated Dockerfile to. manifestOutputDirectory: type: string description: The directory to output the generated manifests to. dockerfileGenerationMode: $ref: '#/definitions/DockerfileGenerationMode' manifestGenerationMode: $ref: '#/definitions/ManifestGenerationMode' manifestType: $ref: '#/definitions/GenerationManifestType' imageName: type: string description: The name of the image to be generated. namespace: type: string description: The namespace to deploy the application to. imageTag: type: string description: The tag to apply to the generated image. GenerationLanguage: type: string enum: - clojure - csharp - erlang - go - gomodule - gradle - java - javascript - php - python - ruby - rust - swift x-ms-enum: name: GenerationLanguage modelAsString: true values: - value: clojure description: clojure language - value: csharp description: csharp language - value: erlang description: erlang language - value: go description: go language - value: gomodule description: gomodule language - value: gradle description: gradle language - value: java description: java language - value: javascript description: javascript language - value: php description: php language - value: python description: python language - value: ruby description: ruby language - value: rust description: rust language - value: swift description: swift language description: The programming language used. AuthorizationStatus: type: string enum: - Authorized - NotFound - Error readOnly: true x-ms-enum: name: AuthorizationStatus modelAsString: true values: - value: Authorized description: Requests authorized successfully - value: NotFound description: Requests returned NotFound response - value: Error description: Requests returned other error response description: Determines the authorization status of requests. TagsObject: type: object properties: tags: type: object additionalProperties: type: string x-ms-mutability: - read - create - update description: Resource tags. ErrorModel: description: Error model. type: object properties: id: description: Gets the ID. type: string readOnly: true code: description: Gets or sets the error code. type: string readOnly: true type: description: Gets or sets the error type. type: string readOnly: true severity: description: Gets or sets the error severity. type: string readOnly: true creationTime: format: date-time description: Gets or sets the creation time of error. type: string readOnly: true message: description: Gets or sets the error message. type: string readOnly: true causes: description: Gets or sets the possible causes of error. type: string readOnly: true recommendation: description: Gets or sets the recommended action to resolve error. type: string readOnly: true WorkflowModel_2: description: Workflow model. required: - properties type: object properties: properties: $ref: '#/definitions/WorkflowModelProperties_2' id: description: Gets or sets the Id of the resource. type: string readOnly: true name: description: Gets or sets the name of the resource. type: string readOnly: true type: description: Gets or sets the type of the resource. type: string readOnly: true systemData: allOf: - $ref: '#/definitions/SystemDataModel' readOnly: true x-ms-azure-resource: true ArmError: description: ARM error. type: object properties: error: $ref: '#/definitions/ArmErrorInfo' WorkflowModel: description: Workflow model. type: object properties: properties: $ref: '#/definitions/WorkflowModelProperties' id: description: Gets or sets the Id of the resource. type: string readOnly: true name: description: Gets or sets the name of the resource. type: string readOnly: true type: description: Gets or sets the type of the resource. type: string readOnly: true systemData: allOf: - $ref: '#/definitions/SystemDataModel' readOnly: true tags: description: Gets or sets the resource tags. type: object additionalProperties: type: string x-ms-azure-resource: true DockerfileGenerationMode: type: string enum: - enabled - disabled x-ms-enum: name: DockerfileGenerationMode modelAsString: true values: - value: enabled description: Dockerfiles will be generated - value: disabled description: Dockerfiles will not be generated description: The mode of generation to be used for generating Dockerfiles. PullRequestStatus: type: string readOnly: true enum: - unknown - submitted - merged - removed x-ms-enum: name: PullRequestStatus modelAsString: true values: - value: unknown description: Pull Request state unknown. - value: submitted description: Pull Request submitted to repository. - value: merged description: Pull Request merged into repository. - value: removed description: Workflow no longer found within repository. description: The status of the Pull Request submitted against the users repository. OperationStatus: description: Defines the operation status. type: object properties: id: description: Gets the Id. type: string readOnly: true name: description: Gets the operation name. type: string readOnly: true status: description: "Gets the status of the operation. ARM expects the terminal status to be one of\r\nSucceeded/ Failed/ Canceled. All other values imply that the operation is still running." type: string readOnly: true startTime: description: Gets the start time. type: string readOnly: true endTime: description: Gets the end time. type: string readOnly: true TaskModel_2: description: Task model. type: object properties: taskName: description: Gets or sets the task name. type: string readOnly: true state: description: Gets or sets the task state. enum: - Pending - Started - Succeeded - Failed - Cancelled - Skipped type: string readOnly: true x-ms-enum: name: TaskState modelAsString: true startTime: format: date-time description: Gets or sets the start time. type: string readOnly: true endTime: format: date-time description: Gets or sets the end time. type: string readOnly: true customProperties: $ref: '#/definitions/TaskModelCustomProperties_2' childrenWorkflows: description: Gets or sets the list of children workflow models. type: array items: $ref: '#/definitions/WorkflowModel_2' x-ms-identifiers: [] SystemDataModel: description: System data required to be defined for Azure resources. type: object properties: createdBy: description: Gets or sets identity that created the resource. type: string createdByType: description: "Gets or sets the type of identity that created the resource: user, application,\r\nmanagedIdentity." type: string createdAt: format: date-time description: Gets or sets the timestamp of resource creation (UTC). type: string lastModifiedBy: description: Gets or sets the identity that last modified the resource. type: string lastModifiedByType: description: "Gets or sets the type of identity that last modified the resource: user, application,\r\nmanagedIdentity." type: string lastModifiedAt: format: date-time description: Gets or sets the timestamp of resource last modification (UTC). type: string DeleteWorkflowResponse: type: object properties: status: type: string description: delete status message description: delete response if content must be provided on delete operation GenerationManifestType: type: string enum: - helm - kube x-ms-enum: name: GenerationManifestType modelAsString: true values: - value: helm description: Helm manifests - value: kube description: Kubernetes manifests description: Determines the type of manifests to be generated. WorkflowModelProperties: description: Workflow model properties. type: object properties: displayName: description: Gets or sets the friendly display name. type: string readOnly: true state: description: Gets or sets the workflow state. enum: - Pending - Started - Cancelling - Succeeded - Failed - Cancelled - CompletedWithInformation - CompletedWithWarnings - CompletedWithErrors type: string readOnly: true x-ms-enum: name: WorkflowState modelAsString: true startTime: format: date-time description: Gets or sets the start time. type: string readOnly: true endTime: format: date-time description: Gets or sets the end time. type: string readOnly: true objectId: description: Gets or sets the affected object Id. type: string readOnly: true objectName: description: Gets or sets the affected object name. type: string readOnly: true objectInternalId: description: Gets or sets the affected object internal Id. type: string readOnly: true objectInternalName: description: Gets or sets the affected object internal name. type: string readOnly: true objectType: description: Gets or sets the object type. enum: - ModernizeProject - MigrateAgent - WorkloadInstance - WorkloadDeployment - ReplicationPostAction type: string readOnly: true x-ms-enum: name: WorkflowObjectType modelAsString: true workloadInstanceProviderId: description: Gets or sets the workload instance provider. type: string readOnly: true workloadDeploymentProviderId: description: Gets or sets the workload deployment provider. type: string readOnly: true allowedActions: description: Gets or sets the list of allowed actions on the workflow. type: array items: type: string readOnly: true activityId: description: Gets or sets the workflow activity id. type: string readOnly: true tasks: description: Gets or sets the list of tasks. type: array items: $ref: '#/definitions/TaskModel' readOnly: true errors: description: Gets or sets the list of errors. type: array items: $ref: '#/definitions/ErrorModel' readOnly: true customProperties: $ref: '#/definitions/WorkflowModelCustomProperties' TaskModelCustomProperties: description: Task model custom properties. type: object properties: instanceType: description: Gets or sets the instance type. type: string WorkflowModelCollection: description: Workflow model collection. type: object properties: value: description: Gets or sets the list of workflows. type: array items: $ref: '#/definitions/WorkflowModel' nextLink: description: Gets or sets the value of next link. type: string ManifestType: type: string enum: - helm - kube - kustomize x-ms-enum: name: ManifestType modelAsString: true values: - value: helm description: Repositories using helm - value: kube description: Repositories using kubernetes manifests description: Determines the type of manifests within the repository. ErrorModel_2: description: Error model. type: object properties: code: description: Gets or sets the error code. type: string readOnly: true type: description: Gets or sets the error type. type: string readOnly: true severity: description: Gets or sets the error severity. type: string readOnly: true creationTime: format: date-time description: Gets or sets the creation time of error. type: string readOnly: true message: description: Gets or sets the error message. type: string readOnly: true causes: description: Gets or sets the possible causes of error. type: string readOnly: true recommendation: description: Gets or sets the recommended action to resolve error. type: string readOnly: true TaskModelCustomProperties_2: description: Task model custom properties. required: - instanceType type: object properties: instanceType: description: Gets or sets the instance type. minLength: 1 type: string WorkflowModelCustomProperties_2: description: Workflow model custom properties. required: - instanceType type: object properties: instanceType: description: Gets or sets the instance type. minLength: 1 type: string affectedObjectDetails: description: Gets or sets any custom properties of the affected object. type: object additionalProperties: type: string readOnly: true discriminator: instanceType TaskModel: description: Task model. type: object properties: id: description: Gets the ID. type: string readOnly: true taskName: description: Gets or sets the task name. type: string readOnly: true state: description: Gets or sets the task state. enum: - Pending - Started - Succeeded - Failed - Cancelled - Skipped type: string readOnly: true x-ms-enum: name: TaskState modelAsString: true startTime: format: date-time description: Gets or sets the start time. type: string readOnly: true endTime: format: date-time description: Gets or sets the end time. type: string readOnly: true customProperties: $ref: '#/definitions/TaskModelCustomProperties' WorkflowListResult: type: object properties: value: type: array items: $ref: '#/definitions/Workflow' description: The list of workflows. nextLink: type: string description: The URL to the next set of workflow results. readOnly: true description: The response from List Workflows operation. GitHubWorkflowProfile: type: object description: GitHub Workflow Profile properties: repositoryOwner: type: string title: The owner of the repository the workflow is associated with. description: Repository Owner repositoryName: type: string title: The name of the repository the workflow is associated with. description: Repository Name branchName: type: string title: The name of the branch the workflow is associated with. description: Repository Branch Name dockerfile: type: string title: Path to Dockerfile within the repository. description: Path to the Dockerfile within the repository. dockerBuildContext: type: string title: Path to Dockerfile Build Context within the repository. description: Path to Dockerfile Build Context within the repository. deploymentProperties: $ref: '#/definitions/DeploymentProperties' namespace: type: string description: Kubernetes namespace the application is deployed to. title: The Kubernetes namespace the application is deployed to acr: $ref: '#/definitions/ACR' oidcCredentials: type: object description: The fields needed for OIDC with GitHub. properties: azureClientId: type: string description: Azure Application Client ID azureTenantId: type: string description: Azure Directory (tenant) ID aksResourceId: type: string description: The Azure Kubernetes Cluster Resource the application will be deployed to. title: The Azure Kubernetes Managed Cluster resource. prURL: type: string description: The URL to the Pull Request submitted against the users repository. readOnly: true pullNumber: type: integer format: int32 readOnly: true description: The number associated with the submitted pull request. prStatus: $ref: '#/definitions/PullRequestStatus' lastWorkflowRun: $ref: '#/definitions/WorkflowRun' authStatus: $ref: '#/definitions/AuthorizationStatus' DeploymentProperties: type: object properties: manifestType: $ref: '#/definitions/ManifestType' kubeManifestLocations: type: array items: type: string helmChartPath: type: string description: Helm chart directory path in repository. helmValues: type: string description: Helm Values.yaml file location in repository. overrides: type: object additionalProperties: type: string title: Manifest override values. description: Manifest override values. WorkflowModelCollection_2: description: Workflow model collection. type: object properties: value: description: Gets or sets the list of workflows. type: array items: $ref: '#/definitions/WorkflowModel_2' x-ms-identifiers: [] nextLink: description: Gets or sets the value of next link. type: string WorkflowRunStatus: type: string enum: - queued - inprogress - completed x-ms-enum: name: WorkflowRunStatus modelAsString: true values: - value: queued description: Workflow run is queued - value: inprogress description: Workflow run is inprogress - value: completed description: Workflow run is completed description: Describes the status of the workflow run WorkflowModelProperties_2: description: Workflow model properties. required: - customProperties type: object properties: displayName: description: Gets or sets the friendly display name. type: string readOnly: true state: description: Gets or sets the workflow state. enum: - Pending - Started - Cancelling - Succeeded - Failed - Cancelled - CompletedWithInformation - CompletedWithWarnings - CompletedWithErrors type: string readOnly: true x-ms-enum: name: WorkflowState modelAsString: true startTime: format: date-time description: Gets or sets the start time. type: string readOnly: true endTime: format: date-time description: Gets or sets the end time. type: string readOnly: true objectId: description: Gets or sets the affected object Id. type: string readOnly: true objectName: description: Gets or sets the affected object name. type: string readOnly: true objectInternalId: description: Gets or sets the affected object internal Id. type: string readOnly: true objectInternalName: description: Gets or sets the affected object internal name. type: string readOnly: true objectType: description: Gets or sets the object type. enum: - AvsDiskPool - Dra - Fabric - Policy - ProtectedItem - RecoveryPlan - ReplicationExtension - Vault type: string readOnly: true x-ms-enum: name: WorkflowObjectType modelAsString: true replicationProviderId: description: Gets or sets the replication provider. type: string readOnly: true sourceFabricProviderId: description: Gets or sets the source fabric provider. type: string readOnly: true targetFabricProviderId: description: Gets or sets the target fabric provider. type: string readOnly: true allowedActions: description: Gets or sets the list of allowed actions on the workflow. type: array items: type: string readOnly: true activityId: description: Gets or sets the workflow activity id. type: string readOnly: true tasks: description: Gets or sets the list of tasks. type: array items: $ref: '#/definitions/TaskModel_2' readOnly: true x-ms-identifiers: [] errors: description: Gets or sets the list of errors. type: array items: $ref: '#/definitions/ErrorModel_2' readOnly: true x-ms-identifiers: [] customProperties: $ref: '#/definitions/WorkflowModelCustomProperties_2' OperationStatus_2: description: Defines the operation status. type: object properties: id: description: Gets or sets the Id. type: string name: description: Gets or sets the operation name. type: string status: description: "Gets or sets the status of the operation. ARM expects the terminal status to be one of\r\nSucceeded/ Failed/ Canceled. All other values imply that the operation is still running." type: string startTime: description: Gets or sets the start time. type: string endTime: description: Gets or sets the end time. type: string ACR: type: object description: Information on the azure container registry properties: acrSubscriptionId: type: string description: ACR subscription id acrResourceGroup: type: string description: ACR resource group acrRegistryName: type: string description: ACR registry acrRepositoryName: type: string description: ACR repository WorkflowProperties: type: object description: Workflow properties properties: githubWorkflowProfile: description: Profile of a github workflow. $ref: '#/definitions/GitHubWorkflowProfile' x-ms-client-flatten: true artifactGenerationProperties: description: Properties for generating artifacts like dockerfile and manifests. $ref: '#/definitions/ArtifactGenerationProperties' x-ms-client-flatten: true WorkflowRun: type: object properties: succeeded: type: boolean readOnly: true description: Describes if the workflow run succeeded. workflowRunURL: type: string readOnly: true description: URL to the run of the workflow. lastRunAt: type: string readOnly: true format: date-time description: The timestamp of the last workflow run. workflowRunStatus: $ref: '#/definitions/WorkflowRunStatus' Workflow: title: Workflow description: Resource representation of a workflow type: object allOf: - $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/TrackedResource properties: properties: description: Properties of a workflow. $ref: '#/definitions/WorkflowProperties' x-ms-client-flatten: true ArmErrorInfo: description: Arm error information. type: object properties: code: description: Gets or sets the error code returned by the service. type: string message: description: Gets or sets error Message returned by the service. type: string ManifestGenerationMode: type: string enum: - enabled - disabled x-ms-enum: name: ManifestGenerationMode modelAsString: true values: - value: enabled description: Manifests will be generated - value: disabled description: Manifests will not be generated description: The mode of generation to be used for generating Manifest. WorkflowModelCustomProperties: description: Workflow model custom properties. required: - instanceType type: object properties: instanceType: description: Gets or sets the instance type. enum: - SampleWorkflow - EnableReplicationWorkflow - StopReplicationWorkflow - BuildContainerImageWorkflow - MigrateWorkflow - TestMigrateWorkflow - TestMigrateCleanupWorkflow - CompleteMigrationWorkflow - DisableReplicationWorkflow type: string x-ms-enum: name: WorkflowType modelAsString: true affectedObjectDetails: description: Gets or sets any custom properties of the affected object. type: object additionalProperties: type: string readOnly: true x-ms-discriminator-value: SampleWorkflow discriminator: instanceType parameters: VaultNameParameter: in: path name: vaultName description: The vault name. required: true type: string pattern: ^[a-zA-Z0-9]*$ x-ms-parameter-location: method resourceGroupName: in: path name: resourceGroupName description: Name of the Azure Resource Group that project is part of. required: true type: string x-ms-parameter-location: method api-version: in: query name: api-version description: Client Api Version. required: true type: string x-ms-parameter-location: method subscriptionId: in: path name: subscriptionId description: Azure Subscription Id in which project was created. required: true type: string x-ms-parameter-location: method JobNameParameter: in: path name: jobName description: The job (workflow) name. required: true type: string pattern: ^[a-zA-Z0-9]*$ x-ms-parameter-location: method ManagedClusterParameter: name: managedClusterResource in: query required: false type: string description: The ManagedCluster resource associated with the workflows. x-ms-parameter-location: method WorkflowNameParameter: name: workflowName in: path required: true type: string minLength: 1 maxLength: 63 pattern: ^[a-zA-Z0-9]$|^[a-zA-Z0-9][-_a-zA-Z0-9]{0,61}[a-zA-Z0-9]$ description: The name of the workflow resource. x-ms-parameter-location: method x-ms-parameterized-host: hostTemplate: '{endpoint}' useSchemePrefix: false parameters: - $ref: '#/parameters/Endpoint'