Azure DevTest Labs Secrets API

openapi: 3.2.0
info:
  title: DevTestLabsClient Secrets API
  version: '2018-09-15'
  description: The DevTest Labs Client.
  x-typespec-generated:
  - emitter: '@azure-tools/typespec-autorest'
servers:
- url: https://management.azure.com
security:
- azure_auth:
  - user_impersonation
tags:
- name: Secrets
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/users/{userName}/secrets
  : get:
      operationId: Secrets_List
      tags:
      - Secrets
      description: List secrets in a given user profile.
      parameters:
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      - name: labName
        in: path
        description: The name of the lab.
        required: true
        schema:
          type: string
      - name: userName
        in: path
        description: The name of the user profile.
        required: true
        schema:
          type: string
      - name: $expand
        in: query
        description: 'Specify the $expand query. Example: ''properties($select=value)'''
        required: false
        schema:
          type: string
      - name: $filter
        in: query
        description: 'The filter to apply to the operation. Example: ''$filter=contains(name,''myName'')'
        required: false
        schema:
          type: string
      - name: $top
        in: query
        description: 'The maximum number of resources to return from the operation. Example: ''$top=10'''
        required: false
        schema:
          type: integer
          format: int32
      - name: $orderby
        in: query
        description: 'The ordering expression for the results, using OData notation. Example: ''$orderby=name desc'''
        required: false
        schema:
          type: string
      responses:
        '200':
          description: Azure operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SecretList'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Secrets list
      x-summary-source: derived
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/users/{userName}/secrets/{name}
  : get:
      operationId: Secrets_Get
      tags:
      - Secrets
      description: Get secret.
      parameters:
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      - name: labName
        in: path
        description: The name of the lab.
        required: true
        schema:
          type: string
      - name: userName
        in: path
        description: The name of the user profile.
        required: true
        schema:
          type: string
      - name: name
        in: path
        description: The name of the secret.
        required: true
        schema:
          type: string
      - name: $expand
        in: query
        description: 'Specify the $expand query. Example: ''properties($select=value)'''
        required: false
        schema:
          type: string
      responses:
        '200':
          description: Azure operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Secret'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      summary: Secrets get
      x-summary-source: derived
    put:
      operationId: Secrets_CreateOrUpdate
      tags:
      - Secrets
      description: Create or replace an existing secret. This operation can take a while to complete.
      parameters:
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      - name: labName
        in: path
        description: The name of the lab.
        required: true
        schema:
          type: string
      - name: userName
        in: path
        description: The name of the user profile.
        required: true
        schema:
          type: string
      - name: name
        in: path
        description: The name of the secret.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Resource 'Secret' update operation succeeded
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Secret'
        '201':
          description: Resource 'Secret' create operation succeeded
          headers:
            Location:
              description: The Location header contains the URL where the status of the long running operation can be checked.
              schema:
                type: string
            Retry-After:
              description: The Retry-After header can indicate how long the client should wait before polling the operation status.
              schema:
                type: integer
                format: int32
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Secret'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-ms-long-running-operation-options:
        final-state-via: location
      x-ms-long-running-operation: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Secret'
        description: A secret.
        required: true
      summary: Secrets create or update
      x-summary-source: derived
    patch:
      operationId: Secrets_Update
      tags:
      - Secrets
      description: Allows modifying tags of secrets. All other properties will be ignored.
      parameters:
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      - name: labName
        in: path
        description: The name of the lab.
        required: true
        schema:
          type: string
      - name: userName
        in: path
        description: The name of the user profile.
        required: true
        schema:
          type: string
      - name: name
        in: path
        description: The name of the secret.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Azure operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Secret'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SecretFragment'
        description: A secret.
        required: true
      summary: Secrets update
      x-summary-source: derived
    delete:
      operationId: Secrets_Delete
      tags:
      - Secrets
      description: Delete secret.
      parameters:
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      - name: labName
        in: path
        description: The name of the lab.
        required: true
        schema:
          type: string
      - name: userName
        in: path
        description: The name of the user profile.
        required: true
        schema:
          type: string
      - name: name
        in: path
        description: The name of the secret.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Resource deleted successfully.
        '204':
          description: Resource does not exist.
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      summary: Secrets delete
      x-summary-source: derived
components:
  parameters:
    SubscriptionIdParameter:
      name: subscriptionId
      in: path
      description: The ID of the target subscription.
      required: true
      schema:
        type: string
        minLength: 1
    ApiVersionParameter:
      name: api-version
      in: query
      description: The API version to use for this operation.
      required: true
      schema:
        type: string
        minLength: 1
    ResourceGroupNameParameter:
      name: resourceGroupName
      in: path
      description: The name of the resource group. The name is case insensitive.
      required: true
      x-ms-parameter-location: method
      schema:
        type: string
        maxLength: 90
        minLength: 1
  schemas:
    Resource:
      type: object
      title: Resource
      description: Common fields that are returned in the response for all Azure Resource Manager resources
      properties:
        id:
          type: string
          description: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
          readOnly: true
        name:
          type: string
          description: The name of the resource
          readOnly: true
        type:
          type: string
          description: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
          readOnly: true
        systemData:
          $ref: '#/components/schemas/systemData'
          type: object
          description: Azure Resource Manager metadata containing createdBy and modifiedBy information.
          readOnly: true
      x-ms-azure-resource: true
    ErrorResponse:
      type: object
      title: Error response
      description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).
      properties:
        error:
          $ref: '#/components/schemas/ErrorDetail'
          description: The error object.
    Secret:
      type: object
      description: A secret.
      properties:
        properties:
          $ref: '#/components/schemas/SecretProperties'
          description: The properties of the resource.
          x-ms-client-flatten: true
        tags:
          type: object
          description: Resource tags.
          additionalProperties:
            type: string
        location:
          type: string
          description: The geo-location where the resource lives
          x-ms-mutability:
          - read
          - create
      required:
      - properties
      allOf:
      - $ref: '#/components/schemas/ProxyResource'
    SecretFragment:
      type: object
      description: A secret.
      allOf:
      - $ref: '#/components/schemas/UpdateResource'
    UpdateResource:
      type: object
      description: Represents an update resource
      properties:
        tags:
          type: object
          description: The tags of the resource.
          additionalProperties:
            type: string
    SecretProperties:
      type: object
      description: Properties of a secret.
      properties:
        value:
          type: string
          description: The value of the secret for secret creation.
        provisioningState:
          type: string
          description: The provisioning status of the resource.
          readOnly: true
        uniqueIdentifier:
          type: string
          description: The unique immutable identifier of a resource (Guid).
          readOnly: true
    SecretList:
      type: object
      description: The response of a list operation.
      properties:
        value:
          type: array
          description: The Secret items on this page
          items:
            $ref: '#/components/schemas/Secret'
        nextLink:
          type: string
          format: uri
          description: The link to the next page of items
      required:
      - value
    ProxyResource:
      type: object
      title: Proxy Resource
      description: The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location
      allOf:
      - $ref: '#/components/schemas/Resource'
  securitySchemes:
    azure_auth:
      type: oauth2
      flows:
        implicit:
          scopes:
            user_impersonation: impersonate your user account
          authorizationUrl: https://login.microsoftonline.com/common/oauth2/authorize
      description: Azure Active Directory OAuth2 Flow.
x-provenance:
  method: harvested
  publisher: Azure DevTest Labs
  source: https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/DTL.json
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)