Microsoft Azure KeyValues API

openapi: 3.2.0
info:
  title: Microsoft Azure Key Values API
  version: '1.0'
  description: 'Operations tagged KeyValues across 2 of this provider''s published API definitions: appconfigurationmanagementclient-openapi-original.yml, azure-app-configuration-openapi-original.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://management.azure.com
tags:
- name: KeyValues
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppConfiguration/configurationStores/{configStoreName}/keyValues
  : get:
      tags:
      - KeyValues
      description: Lists the key-values for a given configuration store.
      operationId: microsoftAzureKeyvaluesListbyconfigurationstore
      parameters:
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      - $ref: '#/components/parameters/ConfigStoreNameParameter'
      - $ref: '#/components/parameters/ApiVersionParameter'
      - name: $skipToken
        in: query
        description: A skip token is used to continue retrieving items after an operation returns a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skipToken parameter that specifies a starting point to use for subsequent calls.
        required: false
        schema:
          type: string
      responses:
        '200':
          description: The request was successful; the request was well-formed and received properly.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/KeyValueListResult'
        default:
          description: Error response describing why the operation failed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-ms-examples:
        KeyValues_ListByConfigurationStore:
          $ref: ./examples/ConfigurationStoresListKeyValues.json
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups…
      security:
      - azure_auth:
        - user_impersonation
    servers:
    - url: https://management.azure.com
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppConfiguration/configurationStores/{configStoreName}/keyValues/{keyValueName}
  : get:
      tags:
      - KeyValues
      description: Gets the properties of the specified key-value.
      operationId: microsoftAzureKeyvaluesGet
      parameters:
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      - $ref: '#/components/parameters/ConfigStoreNameParameter'
      - $ref: '#/components/parameters/ApiVersionParameter'
      - name: keyValueName
        in: path
        description: Identifier of key and label combination. Key and label are joined by $ character. Label is optional.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: The request was successful; the request was well-formed and received properly.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/KeyValue'
        default:
          description: Error response describing why the operation failed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-ms-examples:
        KeyValues_Get:
          $ref: ./examples/ConfigurationStoresGetKeyValue.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups…
      security:
      - azure_auth:
        - user_impersonation
    put:
      tags:
      - KeyValues
      description: Creates a key-value.
      operationId: microsoftAzureKeyvaluesCreateorupdate
      parameters:
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      - $ref: '#/components/parameters/ConfigStoreNameParameter'
      - $ref: '#/components/parameters/ApiVersionParameter'
      - name: keyValueName
        in: path
        description: Identifier of key and label combination. Key and label are joined by $ character. Label is optional.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: The request was successful; the request was well-formed and received properly.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/KeyValue'
        default:
          description: Error response describing why the operation failed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-ms-examples:
        KeyValues_CreateOrUpdate:
          $ref: ./examples/ConfigurationStoresCreateKeyValue.json
      summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups…
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/KeyValue'
        description: The parameters for creating a key-value.
      security:
      - azure_auth:
        - user_impersonation
    delete:
      tags:
      - KeyValues
      description: Deletes a key-value.
      operationId: microsoftAzureKeyvaluesDelete
      parameters:
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      - $ref: '#/components/parameters/ConfigStoreNameParameter'
      - $ref: '#/components/parameters/ApiVersionParameter'
      - name: keyValueName
        in: path
        description: Identifier of key and label combination. Key and label are joined by $ character. Label is optional.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: The request was successful; the request was well-formed and received properly.
        '202':
          description: The request was successful; the operation will complete asynchronously.
        '204':
          description: No Content - the specified resource was not found.
        default:
          description: Error response describing why the operation failed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-ms-examples:
        KeyValues_Delete:
          $ref: ./examples/ConfigurationStoresDeleteKeyValue.json
      x-ms-long-running-operation: true
      summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups…
      security:
      - azure_auth:
        - user_impersonation
    servers:
    - url: https://management.azure.com
  /kv:
    get:
      tags:
      - KeyValues
      summary: Microsoft Azure Gets A List Of Key Values
      operationId: microsoftAzureGetkeyvalues
      parameters:
      - name: key
        in: query
        description: A filter used to match keys.
        schema:
          type: string
      - name: label
        in: query
        description: A filter used to match labels
        schema:
          type: string
      - $ref: '#/components/parameters/SyncTokens'
      - $ref: '#/components/parameters/ApiVersion'
      - name: After
        in: query
        description: Instructs the server to return elements that appear after the element referred to by the specified token.
        schema:
          type: string
      - name: Accept-Datetime
        in: header
        description: Requests the server to respond with the state of the resource at the specified time.
        schema:
          type: string
      - $ref: '#/components/parameters/KeyValueFields'
      - name: snapshot
        in: query
        description: A filter used get key-values for a snapshot. The value should be the name of the snapshot. Not valid when used with 'key' and 'label' filters.
        schema:
          type: string
      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.
              schema:
                type: string
          content:
            application/vnd.microsoft.appconfig.kvset+json:
              schema:
                $ref: '#/components/schemas/KeyValueListResult_2'
            application/problem+json:
              schema:
                $ref: '#/components/schemas/KeyValueListResult_2'
        default:
          description: Error response describing why the operation failed
          content:
            application/vnd.microsoft.appconfig.kvset+json:
              schema:
                $ref: '#/components/schemas/Error'
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Error'
      x-ms-examples:
        GetKeyValues:
          $ref: ./examples/GetKeyValues.json
      x-ms-pageable:
        itemName: items
        nextLinkName: '@nextLink'
      description: Needs a more full description created.
    head:
      tags:
      - KeyValues
      summary: Microsoft Azure Requests The Headers And Status Of The Given Resource
      operationId: microsoftAzureCheckkeyvalues
      parameters:
      - name: key
        in: query
        description: A filter used to match keys.
        schema:
          type: string
      - name: label
        in: query
        description: A filter used to match labels
        schema:
          type: string
      - $ref: '#/components/parameters/SyncTokens'
      - $ref: '#/components/parameters/ApiVersion'
      - name: After
        in: query
        description: Instructs the server to return elements that appear after the element referred to by the specified token.
        schema:
          type: string
      - name: Accept-Datetime
        in: header
        description: Requests the server to respond with the state of the resource at the specified time.
        schema:
          type: string
      - $ref: '#/components/parameters/KeyValueFields'
      - name: snapshot
        in: query
        description: A filter used get key-values for a snapshot. Not valid when used with 'key' and 'label' filters.
        schema:
          type: string
      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.
              schema:
                type: string
        default:
          description: Error response.
      x-ms-examples:
        CheckKeyValues:
          $ref: ./examples/CheckKeyValues.json
      description: Needs a more full description created.
  /kv/{key}:
    get:
      tags:
      - KeyValues
      summary: Microsoft Azure Gets A Single Key Value
      operationId: microsoftAzureGetkeyvalue
      parameters:
      - name: key
        in: path
        description: The key of the key-value to retrieve.
        required: true
        schema:
          type: string
      - name: label
        in: query
        description: The label of the key-value to retrieve.
        schema:
          type: string
      - $ref: '#/components/parameters/SyncTokens'
      - $ref: '#/components/parameters/ApiVersion'
      - name: Accept-Datetime
        in: header
        description: Requests the server to respond with the state of the resource at the specified time.
        schema:
          type: string
      - name: If-Match
        in: header
        description: Used to perform an operation only if the targeted resource's etag matches the value provided.
        schema:
          type: string
      - name: If-None-Match
        in: header
        description: Used to perform an operation only if the targeted resource's etag does not match the value provided.
        schema:
          type: string
      - $ref: '#/components/parameters/KeyValueFields'
      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.
              schema:
                type: string
            ETag:
              description: An identifier representing the returned state of the resource.
              schema:
                type: string
          content:
            application/vnd.microsoft.appconfig.kv+json:
              schema:
                $ref: '#/components/schemas/KeyValue_2'
            application/problem+json:
              schema:
                $ref: '#/components/schemas/KeyValue_2'
        default:
          description: Error response describing why the operation failed
          content:
            application/vnd.microsoft.appconfig.kv+json:
              schema:
                $ref: '#/components/schemas/Error'
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Error'
      x-ms-examples:
        GetKeyValue:
          $ref: ./examples/GetKeyValue.json
        GetKeyValue_IfMatch:
          $ref: ./examples/GetKeyValue_IfMatch.json
        GetKeyValue_IfNoneMatch:
          $ref: ./examples/GetKeyValue_IfNoneMatch.json
      description: Needs a more full description created.
    put:
      tags:
      - KeyValues
      summary: Microsoft Azure Creates A Key Value
      operationId: microsoftAzurePutkeyvalue
      parameters:
      - name: key
        in: path
        description: The key of the key-value to create.
        required: true
        schema:
          type: string
      - name: label
        in: query
        description: The label of the key-value to create.
        schema:
          type: string
      - $ref: '#/components/parameters/SyncTokens'
      - $ref: '#/components/parameters/ApiVersion'
      - name: If-Match
        in: header
        description: Used to perform an operation only if the targeted resource's etag matches the value provided.
        schema:
          type: string
      - name: If-None-Match
        in: header
        description: Used to perform an operation only if the targeted resource's etag does not match the value provided.
        schema:
          type: string
      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.
              schema:
                type: string
            ETag:
              description: An identifier representing the returned state of the resource.
              schema:
                type: string
          content:
            application/vnd.microsoft.appconfig.kv+json:
              schema:
                $ref: '#/components/schemas/KeyValue_2'
            application/problem+json:
              schema:
                $ref: '#/components/schemas/KeyValue_2'
        default:
          description: Error response describing why the operation failed
          content:
            application/vnd.microsoft.appconfig.kv+json:
              schema:
                $ref: '#/components/schemas/Error'
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Error'
      x-ms-examples:
        PutKeyValue:
          $ref: ./examples/PutKeyValue.json
        PutKeyValue_IfMatch:
          $ref: ./examples/PutKeyValue_IfMatch.json
      description: Needs a more full description created.
      requestBody:
        content:
          application/vnd.microsoft.appconfig.kv+json:
            schema:
              $ref: '#/components/schemas/KeyValue_2'
          application/vnd.microsoft.appconfig.kvset+json:
            schema:
              $ref: '#/components/schemas/KeyValue_2'
          application/json:
            schema:
              $ref: '#/components/schemas/KeyValue_2'
          text/json:
            schema:
              $ref: '#/components/schemas/KeyValue_2'
          application/*+json:
            schema:
              $ref: '#/components/schemas/KeyValue_2'
          application/json-patch+json:
            schema:
              $ref: '#/components/schemas/KeyValue_2'
        description: The key-value to create.
    delete:
      tags:
      - KeyValues
      summary: Microsoft Azure Deletes A Key Value
      operationId: microsoftAzureDeletekeyvalue
      parameters:
      - name: key
        in: path
        description: The key of the key-value to delete.
        required: true
        schema:
          type: string
      - name: label
        in: query
        description: The label of the key-value to delete.
        schema:
          type: string
      - $ref: '#/components/parameters/SyncTokens'
      - $ref: '#/components/parameters/ApiVersion'
      - name: If-Match
        in: header
        description: Used to perform an operation only if the targeted resource's etag matches the value provided.
        schema:
          type: string
      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.
              schema:
                type: string
            ETag:
              description: An identifier representing the returned state of the resource.
              schema:
                type: string
          content:
            application/vnd.microsoft.appconfig.kv+json:
              schema:
                $ref: '#/components/schemas/KeyValue_2'
            application/problem+json:
              schema:
                $ref: '#/components/schemas/KeyValue_2'
        '204':
          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.
              schema:
                type: string
        default:
          description: Error response describing why the operation failed
          content:
            application/vnd.microsoft.appconfig.kv+json:
              schema:
                $ref: '#/components/schemas/Error'
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Error'
      x-ms-examples:
        DeleteKeyValue:
          $ref: ./examples/DeleteKeyValue.json
        DeleteKeyValue_IfMatch:
          $ref: ./examples/DeleteKeyValue_IfMatch.json
      description: Needs a more full description created.
    head:
      tags:
      - KeyValues
      summary: Microsoft Azure Requests The Headers And Status Of The Given Resource
      operationId: microsoftAzureCheckkeyvalue
      parameters:
      - name: key
        in: path
        description: The key of the key-value to retrieve.
        required: true
        schema:
          type: string
      - name: label
        in: query
        description: The label of the key-value to retrieve.
        schema:
          type: string
      - $ref: '#/components/parameters/SyncTokens'
      - $ref: '#/components/parameters/ApiVersion'
      - name: Accept-Datetime
        in: header
        description: Requests the server to respond with the state of the resource at the specified time.
        schema:
          type: string
      - name: If-Match
        in: header
        description: Used to perform an operation only if the targeted resource's etag matches the value provided.
        schema:
          type: string
      - name: If-None-Match
        in: header
        description: Used to perform an operation only if the targeted resource's etag does not match the value provided.
        schema:
          type: string
      - $ref: '#/components/parameters/KeyValueFields'
      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.
              schema:
                type: string
            ETag:
              description: An identifier representing the returned state of the resource.
              schema:
                type: string
        default:
          description: Error response.
      x-ms-examples:
        CheckKeyValue:
          $ref: ./examples/CheckKeyValue.json
        CheckKeyValue_IfMatch:
          $ref: ./examples/CheckKeyValue_IfMatch.json
        CheckKeyValue_IfNoneMatch:
          $ref: ./examples/CheckKeyValue_IfNoneMatch.json
      description: Needs a more full description created.
components:
  schemas:
    KeyValue:
      description: The key-value resource along with all resource properties.
      type: object
      properties:
        id:
          description: The resource ID.
          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
        properties:
          $ref: '#/components/schemas/KeyValueProperties'
          description: All key-value properties.
          x-ms-client-flatten: true
      x-ms-azure-resource: true
    KeyValueListResult:
      description: The result of a request to list key-values.
      type: object
      properties:
        value:
          description: The collection value.
          type: array
          items:
            $ref: '#/components/schemas/KeyValue'
        nextLink:
          description: The URI that can be used to request the next set of paged results.
          type: string
    KeyValueProperties:
      description: All key-value properties.
      type: object
      properties:
        key:
          description: 'The primary identifier of a key-value.

            The key is used in unison with the label to uniquely identify a key-value.'
          type: string
          readOnly: true
        label:
          description: 'A value used to group key-values.

            The label is used in unison with the key to uniquely identify a key-value.'
          type: string
          readOnly: true
        value:
          description: The value of the key-value.
          type: string
        contentType:
          description: 'The content type of the key-value''s value.

            Providing a proper content-type can enable transformations of values when they are retrieved by applications.'
          type: string
        eTag:
          description: An ETag indicating the state of a key-value within a configuration store.
          type: string
          readOnly: true
        lastModified:
          format: date-time
          description: The last time a modifying operation was performed on the given key-value.
          type: string
          readOnly: true
        locked:
          description: 'A value indicating whether the key-value is locked.

            A locked key-value may not be modified until it is unlocked.'
          type: boolean
          readOnly: true
        tags:
          description: A dictionary of tags that can help identify what a key-value may be applicable for.
          type: object
          additionalProperties:
            type: string
    ErrorDetails:
      description: The details of the error.
      properties:
        code:
          description: Error code.
          type: string
          readOnly: true
        message:
          description: Error message indicating why the operation failed.
          type: string
          readOnly: true
        additionalInfo:
          readOnly: true
          type: array
          items:
            $ref: '#/components/schemas/ErrorAdditionalInfo'
          x-ms-identifiers: []
          description: The error additional info.
    ErrorAdditionalInfo:
      properties:
        type:
          readOnly: true
          type: string
          description: The additional info type.
        info:
          readOnly: true
          type: object
          description: The additional info.
      description: The resource management error additional info.
    ErrorResponse:
      description: Error response indicates that the service is not able to process the incoming request. The reason is provided in the error message.
      type: object
      properties:
        error:
          description: The details of the error.
          $ref: '#/components/schemas/ErrorDetails'
    KeyValue_2:
      type: object
      properties:
        key:
          type: string
          description: The key of the key-value.
        label:
          type: string
          description: The label the key-value belongs to.
        content_type:
          type: string
          description: The content type of the value stored within the key-value.
        value:
          type: string
          description: The value of the key-value.
        last_modified:
          format: date-time
          type: string
          description: A date representing the last time the key-value was modified.
        tags:
          type: object
          additionalProperties:
            type: string
          description: The tags of the key-value
        locked:
          type: boolean
          description: Indicates whether the key-value is locked.
        etag:
          type: string
          description: A value representing the current state of the resource.
    KeyValueListResult_2:
      description: The result of a list request.
      type: object
      properties:
        items:
          description: The collection value.
          type: array
          items:
            $ref: '#/components/schemas/KeyValue_2'
        '@nextLink':
          description: The URI that can be used to request the next set of paged results.
          type: string
    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
  parameters:
    ConfigStoreNameParameter:
      name: configStoreName
      in: path
      description: The name of the configuration store.
      required: true
      x-ms-parameter-location: method
      schema:
        type: string
        maxLength: 50
        minLength: 5
        pattern: ^[a-zA-Z0-9_-]*$
    ApiVersionParameter:
      name: api-version
      in: query
      description: The client API version.
      required: true
      schema:
        type: string
    SubscriptionIdParameter:
      name: subscriptionId
      in: path
      description: The Microsoft Azure subscription ID.
      required: true
      schema:
        type: string
    ResourceGroupNameParameter:
      name: resourceGroupName
      in: path
      description: The name of the resource group to which the container registry belongs.
      required: true
      x-ms-parameter-location: method
      schema:
        type: string
    KeyValueFields:
      name: $Select
      in: query
      description: Used to select what fields are present in the returned resource(s).
      x-ms-parameter-location: method
      style: form
      explode: false
      schema:
        type: array
        items:
          type: string
          enum:
          - key
          - label
          - content_type
          - value
          - last_modified
          - tags
          - locked
          - etag
          x-ms-enum:
            name: KeyValueFields
            modelAsString: true
    SyncTokens:
      name: Sync-Token
      in: header
      description: Used to guarantee real-time consistency between requests.
      schema:
        type: string
    ApiVersion:
      name: api-version
      in: query
      description: The API version to be used with the HTTP request.
      required: true
      schema:
        type: string
  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-refined-from:
- appconfigurationmanagementclient-openapi-original.yml
- azure-app-configuration-openapi-original.yml
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/components/parameters/Endpoint'