swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector Artifacts API
schemes:
- https
tags:
- name: Artifacts
paths:
  /subscriptions/{subscriptionId}/providers/Microsoft.DevHub/locations/{location}/generatePreviewArtifacts:
    post:
      tags:
      - Artifacts
      operationId: microsoftAzureGeneratepreviewartifacts
      summary: Microsoft Azure Generate Preview Dockerfile And Manifests
      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/LocationParameter
      - name: parameters
        required: true
        in: body
        schema:
          $ref: '#/definitions/ArtifactGenerationProperties'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/GeneratePreviewArtifactsResponse'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
      x-ms-examples:
        Artifact Generation Properties:
          $ref: ./examples/GeneratePreviewArtifacts.json
      description: Needs a more full description created.
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/artifactsources/{artifactSourceName}/artifacts
  : get:
      tags:
      - Artifacts
      description: List artifacts in a given artifact source.
      operationId: microsoftAzureArtifactsList
      parameters:
      - $ref: '#/parameters/subscriptionId'
      - $ref: '#/parameters/resourceGroupName'
      - name: labName
        in: path
        description: The name of the lab.
        required: true
        type: string
      - name: artifactSourceName
        in: path
        description: The name of the artifact source.
        required: true
        type: string
      - name: $expand
        in: query
        description: 'Specify the $expand query. Example: ''properties($select=title)'''
        type: string
      - name: $filter
        in: query
        description: 'The filter to apply to the operation. Example: ''$filter=contains(name,''myName'')'
        type: string
      - name: $top
        in: query
        description: 'The maximum number of resources to return from the operation. Example: ''$top=10'''
        type: integer
        format: int32
      - name: $orderby
        in: query
        description: 'The ordering expression for the results, using OData notation. Example: ''$orderby=name desc'''
        type: string
      - $ref: '#/parameters/api-version'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/ArtifactList'
        default:
          description: BadRequest
          schema:
            $ref: '#/definitions/CloudError'
      x-ms-pageable:
        nextLinkName: nextLink
      x-ms-odata: '#/definitions/Artifact'
      x-ms-examples:
        Artifacts_List:
          $ref: ./examples/Artifacts_List.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Devtestlab Labs Labname Artifactsources Artifactsourcename Artifacts
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/artifactsources/{artifactSourceName}/artifacts/{name}
  : get:
      tags:
      - Artifacts
      description: Get artifact.
      operationId: microsoftAzureArtifactsGet
      parameters:
      - $ref: '#/parameters/subscriptionId'
      - $ref: '#/parameters/resourceGroupName'
      - name: labName
        in: path
        description: The name of the lab.
        required: true
        type: string
      - name: artifactSourceName
        in: path
        description: The name of the artifact source.
        required: true
        type: string
      - name: name
        in: path
        description: The name of the artifact.
        required: true
        type: string
      - name: $expand
        in: query
        description: 'Specify the $expand query. Example: ''properties($select=title)'''
        type: string
      - $ref: '#/parameters/api-version'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/Artifact'
        default:
          description: BadRequest
          schema:
            $ref: '#/definitions/CloudError'
      x-ms-examples:
        Artifacts_Get:
          $ref: ./examples/Artifacts_Get.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Devtestlab Labs Labname Artifactsources Artifactsourcename Artifacts Name
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/artifactsources/{artifactSourceName}/artifacts/{name}/generateArmTemplate
  : post:
      tags:
      - Artifacts
      description: Generates an ARM template for the given artifact, uploads the required files to a storage account, and validates the generated artifact.
      operationId: microsoftAzureArtifactsGeneratearmtemplate
      parameters:
      - $ref: '#/parameters/subscriptionId'
      - $ref: '#/parameters/resourceGroupName'
      - name: labName
        in: path
        description: The name of the lab.
        required: true
        type: string
      - name: artifactSourceName
        in: path
        description: The name of the artifact source.
        required: true
        type: string
      - name: name
        in: path
        description: The name of the artifact.
        required: true
        type: string
      - name: generateArmTemplateRequest
        in: body
        description: Parameters for generating an ARM template for deploying artifacts.
        required: true
        schema:
          $ref: '#/definitions/GenerateArmTemplateRequest'
      - $ref: '#/parameters/api-version'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/ArmTemplateInfo'
        default:
          description: BadRequest
          schema:
            $ref: '#/definitions/CloudError'
      x-ms-examples:
        Artifacts_GenerateArmTemplate:
          $ref: ./examples/Artifacts_GenerateArmTemplate.json
      summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Devtestlab Labs Labname Artifactsources Artifactsourcename Artifacts Name Generatearmtemplate
definitions:
  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.
  ParameterInfo:
    description: Information about an artifact's parameter.
    type: object
    properties:
      name:
        description: The name of the artifact parameter.
        type: string
      value:
        description: The value of the artifact parameter.
        type: string
  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.
  Resource:
    description: An Azure resource.
    type: object
    properties:
      id:
        description: The identifier of the resource.
        type: string
        readOnly: true
      name:
        description: The name of the resource.
        type: string
        readOnly: true
      type:
        description: The type of the resource.
        type: string
        readOnly: true
      location:
        description: The location of the resource.
        type: string
      tags:
        description: The tags of the resource.
        type: object
        additionalProperties:
          type: string
    x-ms-azure-resource: true
  ArtifactProperties:
    description: Properties of an artifact.
    type: object
    properties:
      title:
        description: The artifact's title.
        type: string
        readOnly: true
      description:
        description: The artifact's description.
        type: string
        readOnly: true
      publisher:
        description: The artifact's publisher.
        type: string
        readOnly: true
      filePath:
        description: The file path to the artifact.
        type: string
        readOnly: true
      icon:
        description: The URI to the artifact icon.
        type: string
        readOnly: true
      targetOsType:
        description: The artifact's target OS.
        type: string
        readOnly: true
      parameters:
        description: The artifact's parameters.
        type: object
        readOnly: true
      createdDate:
        format: date-time
        description: The artifact's creation date.
        type: string
        readOnly: true
  CloudError:
    description: Error from a REST request.
    type: object
    properties:
      error:
        $ref: '#/definitions/CloudErrorBody'
        description: The cloud error that occurred
    x-ms-external: true
  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.
  GeneratePreviewArtifactsResponse:
    type: object
    description: Dockerfile and manifest artifacts generated as a preview are returned as a map<path string,content string>
    additionalProperties:
      type: string
  ArmTemplateInfo:
    description: Information about a generated ARM template.
    type: object
    properties:
      template:
        description: The template's contents.
        type: object
      parameters:
        description: The parameters of the ARM template.
        type: object
  CloudErrorBody:
    description: Body of an error from a REST request.
    type: object
    properties:
      code:
        description: The error code.
        type: string
      message:
        description: The error message.
        type: string
      target:
        description: The error target.
        type: string
      details:
        description: Inner errors.
        type: array
        items:
          $ref: '#/definitions/CloudErrorBody'
    x-ms-external: true
  GenerateArmTemplateRequest:
    description: Parameters for generating an ARM template for deploying artifacts.
    type: object
    properties:
      virtualMachineName:
        description: The resource name of the virtual machine.
        type: string
      parameters:
        description: The parameters of the ARM template.
        type: array
        items:
          $ref: '#/definitions/ParameterInfo'
      location:
        description: The location of the virtual machine.
        type: string
      fileUploadOptions:
        description: Options for uploading the files for the artifact. UploadFilesAndGenerateSasTokens is the default value.
        enum:
        - UploadFilesAndGenerateSasTokens
        - None
        type: string
        x-ms-enum:
          name: FileUploadOptions
          modelAsString: true
  Artifact:
    description: An artifact.
    required:
    - properties
    type: object
    allOf:
    - $ref: '#/definitions/Resource'
    properties:
      properties:
        $ref: '#/definitions/ArtifactProperties'
        description: The properties of the resource.
        x-ms-client-flatten: true
  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.
  ArtifactList:
    description: The response of a list operation.
    type: object
    properties:
      value:
        description: Results of the list operation.
        type: array
        items:
          $ref: '#/definitions/Artifact'
      nextLink:
        description: Link for next set of results.
        type: string
parameters:
  resourceGroupName:
    name: resourceGroupName
    in: path
    description: The name of the resource group.
    required: true
    type: string
    x-ms-parameter-location: method
  subscriptionId:
    name: subscriptionId
    in: path
    description: The subscription ID.
    required: true
    type: string
  api-version:
    name: api-version
    in: query
    description: Client API version.
    required: true
    type: string
    default: '2018-09-15'
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'