swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector Labels API
schemes:
- https
tags:
- name: Labels
paths:
  /labels:
    get:
      tags:
      - Labels
      summary: Microsoft Azure Gets A List Of Labels
      operationId: microsoftAzureGetlabels
      consumes: []
      produces:
      - application/vnd.microsoft.appconfig.labelset+json
      - application/problem+json
      parameters:
      - name: name
        in: query
        description: A filter for the name of the returned labels.
        type: string
      - $ref: '#/parameters/SyncTokens'
      - $ref: '#/parameters/ApiVersion'
      - name: After
        in: query
        description: Instructs the server to return elements that appear after the element referred to by the specified token.
        type: string
      - name: Accept-Datetime
        in: header
        description: Requests the server to respond with the state of the resource at the specified time.
        type: string
      - $ref: '#/parameters/LabelFields'
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/LabelListResult'
          headers:
            Sync-Token:
              description: Enables real-time consistency between requests by providing the returned value in the next request made to the server.
              type: string
        default:
          description: Error response describing why the operation failed
          schema:
            $ref: '#/definitions/Error'
      x-ms-examples:
        GetLabels:
          $ref: ./examples/GetLabels.json
      x-ms-pageable:
        itemName: items
        nextLinkName: '@nextLink'
      description: Needs a more full description created.
    head:
      tags:
      - Labels
      summary: Microsoft Azure Requests The Headers And Status Of The Given Resource
      operationId: microsoftAzureChecklabels
      consumes: []
      produces: []
      parameters:
      - name: name
        in: query
        description: A filter for the name of the returned labels.
        type: string
      - $ref: '#/parameters/SyncTokens'
      - $ref: '#/parameters/ApiVersion'
      - name: After
        in: query
        description: Instructs the server to return elements that appear after the element referred to by the specified token.
        type: string
      - name: Accept-Datetime
        in: header
        description: Requests the server to respond with the state of the resource at the specified time.
        type: string
      - $ref: '#/parameters/LabelFields'
      responses:
        '200':
          description: Success
          headers:
            Sync-Token:
              description: Enables real-time consistency between requests by providing the returned value in the next request made to the server.
              type: string
        default:
          description: Error response.
      x-ms-examples:
        CheckLabels:
          $ref: ./examples/CheckLabels.json
      description: Needs a more full description created.
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Easm/workspaces/{workspaceName}/labels
  : get:
      tags:
      - Labels
      description: Returns a list of labels in the given workspace.
      operationId: microsoftAzureLabelsListbyworkspace
      parameters:
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
      - $ref: '#/parameters/WorkspaceNameParameter'
      responses:
        '200':
          description: Lists of labels.
          schema:
            $ref: '#/definitions/LabelResourceList'
        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:
        Labels:
          $ref: ./examples/Labels_ListByWorkspace.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Easm Workspaces Workspacename Labels
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Easm/workspaces/{workspaceName}/labels/{labelName}
  : get:
      tags:
      - Labels
      description: Returns a label in the given workspace.
      operationId: microsoftAzureLabelsGetbyworkspace
      parameters:
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
      - $ref: '#/parameters/WorkspaceNameParameter'
      - $ref: '#/parameters/LabelNameParameter'
      responses:
        '200':
          description: Label details.
          schema:
            $ref: '#/definitions/LabelResource'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
      x-ms-examples:
        Labels:
          $ref: ./examples/Labels_GetByWorkspace.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Easm Workspaces Workspacename Labels Labelname
    put:
      tags:
      - Labels
      description: Create or update a Label.
      operationId: microsoftAzureLabelsCreateandupdate
      parameters:
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
      - $ref: '#/parameters/WorkspaceNameParameter'
      - $ref: '#/parameters/LabelNameParameter'
      - name: LabelResource
        description: Label details.
        in: body
        schema:
          $ref: '#/definitions/LabelResource'
      responses:
        '200':
          description: Successful.
          schema:
            $ref: '#/definitions/LabelResource'
        '201':
          description: Long running operation.
          schema:
            $ref: '#/definitions/LabelResource'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
      x-ms-long-running-operation: true
      x-ms-long-running-operation-options:
        final-state-via: azure-async-operation
      x-ms-examples:
        Labels:
          $ref: ./examples/Labels_CreateAndUpdate.json
      summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Easm Workspaces Workspacename Labels Labelname
    patch:
      tags:
      - Labels
      description: Update a Label.
      operationId: microsoftAzureLabelsUpdate
      parameters:
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
      - $ref: '#/parameters/WorkspaceNameParameter'
      - $ref: '#/parameters/LabelNameParameter'
      - name: LabelPatchResource
        description: Label patch details.
        in: body
        schema:
          $ref: '#/definitions/LabelPatchResource'
      responses:
        '200':
          description: Successful.
          schema:
            $ref: '#/definitions/LabelResource'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
      x-ms-examples:
        Labels:
          $ref: ./examples/Labels_Update.json
      summary: Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Easm Workspaces Workspacename Labels Labelname
    delete:
      tags:
      - Labels
      description: Delete a Label.
      operationId: microsoftAzureLabelsDelete
      parameters:
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
      - $ref: '#/parameters/WorkspaceNameParameter'
      - $ref: '#/parameters/LabelNameParameter'
      responses:
        '202':
          description: The Label will be deleted asynchronously.
        '204':
          description: The Label does not exist.
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
      x-ms-long-running-operation: true
      x-ms-long-running-operation-options:
        final-state-via: azure-async-operation
      x-ms-examples:
        Labels:
          $ref: ./examples/Labels_Delete.json
      summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Easm Workspaces Workspacename Labels Labelname
definitions:
  LabelResourceProperties:
    description: Label properties.
    type: object
    properties:
      displayName:
        description: Label display name.
        type: string
      color:
        description: Label color.
        type: string
    allOf:
    - $ref: '#/definitions/ResourceBaseProperties'
  LabelListResult:
    description: The result of a list request.
    type: object
    properties:
      items:
        description: The collection value.
        type: array
        items:
          $ref: '#/definitions/Label'
      '@nextLink':
        description: The URI that can be used to request the next set of paged results.
        type: string
  ResourceBaseProperties:
    description: Resource base properties.
    type: object
    properties:
      provisioningState:
        description: Resource provisioning state.
        $ref: '#/definitions/ResourceState'
        readOnly: true
  LabelResource:
    type: object
    description: Label details
    properties:
      properties:
        description: Label properties
        $ref: '#/definitions/LabelResourceProperties'
        x-ms-client-flatten: true
    allOf:
    - $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource
    x-ms-azure-resource: true
  LabelPatchResource:
    type: object
    description: Label patch properties
    allOf:
    - $ref: '#/definitions/LabelResource'
  ResourceState:
    description: Resources provisioning states.
    enum:
    - NotSpecified
    - Accepted
    - Creating
    - Succeeded
    - Failed
    - Canceled
    - ProvisioningResources
    - InstallingApplication
    - ConfiguringApplication
    - MigratingApplicationData
    - RunningValidations
    - CreatingArtifacts
    - DeletingArtifacts
    type: string
    x-ms-enum:
      name: ResourceState
      modelAsString: true
  Label:
    type: object
    properties:
      name:
        type: string
        readOnly: true
        description: The name of the label.
  Error:
    description: Azure App Configuration error object.
    type: object
    properties:
      type:
        description: The type of the error.
        type: string
      title:
        description: A brief summary of the error.
        type: string
      name:
        description: The name of the parameter that resulted in the error.
        type: string
      detail:
        description: A detailed description of the error.
        type: string
      status:
        description: The HTTP status code that the error maps to.
        type: integer
    readOnly: true
  LabelResourceList:
    type: object
    description: The list of labels.
    properties:
      value:
        type: array
        description: The list of labels.
        items:
          $ref: '#/definitions/LabelResource'
      nextLink:
        type: string
        description: The link used to get the next page of Label list.
parameters:
  WorkspaceNameParameter:
    name: workspaceName
    in: path
    required: true
    type: string
    description: The name of the Workspace.
    x-ms-parameter-location: method
  SyncTokens:
    name: Sync-Token
    in: header
    description: Used to guarantee real-time consistency between requests.
    type: string
  ApiVersion:
    name: api-version
    in: query
    description: The API version to be used with the HTTP request.
    required: true
    type: string
  LabelFields:
    name: $Select
    in: query
    description: Used to select what fields are present in the returned resource(s).
    type: array
    items:
      type: string
      enum:
      - name
      x-ms-enum:
        name: LabelFields
        modelAsString: true
    x-ms-parameter-location: method
    collectionFormat: csv
  LabelNameParameter:
    name: labelName
    in: path
    required: true
    type: string
    description: The name of the Label.
    x-ms-parameter-location: method
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'