swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector NamedValue API
schemes:
- https
tags:
- name: NamedValue
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/namedValues
  : get:
      tags:
      - NamedValue
      operationId: microsoftAzureWorkspacenamedvalueListbyservice
      description: Lists a collection of named values defined within a workspace in a service instance.
      externalDocs:
        url: https://docs.microsoft.com/en-us/azure/api-management/api-management-howto-properties
      x-ms-examples:
        ApiManagementListWorkspaceNamedValues:
          $ref: ./examples/ApiManagementListWorkspaceNamedValues.json
      parameters:
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
      - $ref: ./apimanagement.json#/parameters/ServiceNameParameter
      - $ref: ./apimanagement.json#/parameters/WorkspaceIdParameter
      - name: $filter
        in: query
        required: false
        type: string
        description: '|     Field     |     Usage     |     Supported operators     |     Supported functions     |</br>|-------------|-------------|-------------|-------------|</br>| tags | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith, any, all |</br>| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>'
      - $ref: ./apimanagement.json#/parameters/TopQueryParameter
      - $ref: ./apimanagement.json#/parameters/SkipQueryParameter
      - name: isKeyVaultRefreshFailed
        in: query
        required: false
        type: string
        enum:
        - 'true'
        - 'false'
        x-ms-enum:
          name: KeyVaultRefreshState
          modelAsString: true
          values:
          - value: 'true'
            description: Entities for which KeyVault refresh failed.
          - value: 'false'
            description: Entities for which KeyVault refresh succeeded
        description: Query parameter to fetch named value entities based on refresh status.
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
      responses:
        '200':
          description: A Collection of the named value entities for the specified workspace in an API Management service instance.
          schema:
            $ref: ./definitions.json#/definitions/NamedValueCollection
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: ./apimanagement.json#/definitions/ErrorResponse
      x-ms-pageable:
        nextLinkName: nextLink
      x-ms-odata: ./definitions.json#/definitions/NamedValueContract
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Apimanagement Service Servicename Workspaces Workspaceid Namedvalues
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/namedValues/{namedValueId}
  : head:
      tags:
      - NamedValue
      operationId: microsoftAzureWorkspacenamedvalueGetentitytag
      description: Gets the entity state (Etag) version of the named value specified by its identifier.
      x-ms-examples:
        ApiManagementHeadWorkspaceNamedValue:
          $ref: ./examples/ApiManagementHeadWorkspaceNamedValue.json
      parameters:
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
      - $ref: ./apimanagement.json#/parameters/ServiceNameParameter
      - $ref: ./apimanagement.json#/parameters/WorkspaceIdParameter
      - $ref: ./apimanagement.json#/parameters/NamedValueIdParameter
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
      responses:
        '200':
          description: Specified named value entity exists and current entity state version is present in the ETag header.
          headers:
            ETag:
              description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.
              type: string
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: ./apimanagement.json#/definitions/ErrorResponse
      summary: Microsoft Azure Head Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Apimanagement Service Servicename Workspaces Workspaceid Namedvalues Namedvalueid
    get:
      tags:
      - NamedValue
      operationId: microsoftAzureWorkspacenamedvalueGet
      description: Gets the details of the named value specified by its identifier.
      x-ms-examples:
        ApiManagementGetWorkspaceNamedValue:
          $ref: ./examples/ApiManagementGetWorkspaceNamedValue.json
        ApiManagementGetWorkspaceNamedValueWithKeyVault:
          $ref: ./examples/ApiManagementGetWorkspaceNamedValueWithKeyVault.json
      parameters:
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
      - $ref: ./apimanagement.json#/parameters/ServiceNameParameter
      - $ref: ./apimanagement.json#/parameters/WorkspaceIdParameter
      - $ref: ./apimanagement.json#/parameters/NamedValueIdParameter
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
      responses:
        '200':
          description: The response body contains the specified named value entity. No secrets included
          schema:
            $ref: ./definitions.json#/definitions/NamedValueContract
          headers:
            ETag:
              description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.
              type: string
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: ./apimanagement.json#/definitions/ErrorResponse
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Apimanagement Service Servicename Workspaces Workspaceid Namedvalues Namedvalueid
    put:
      tags:
      - NamedValue
      operationId: microsoftAzureWorkspacenamedvalueCreateorupdate
      description: Creates or updates named value.
      x-ms-examples:
        ApiManagementCreateWorkspaceNamedValue:
          $ref: ./examples/ApiManagementCreateWorkspaceNamedValue.json
        ApiManagementCreateWorkspaceNamedValueWithKeyVault:
          $ref: ./examples/ApiManagementCreateWorkspaceNamedValueWithKeyVault.json
      parameters:
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
      - $ref: ./apimanagement.json#/parameters/ServiceNameParameter
      - $ref: ./apimanagement.json#/parameters/WorkspaceIdParameter
      - $ref: ./apimanagement.json#/parameters/NamedValueIdParameter
      - name: parameters
        in: body
        required: true
        schema:
          $ref: ./definitions.json#/definitions/NamedValueCreateContract
        description: Create parameters.
      - $ref: ./apimanagement.json#/parameters/IfMatchOptionalParameter
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
      responses:
        '200':
          description: Named value was successfully updated.
          schema:
            $ref: ./definitions.json#/definitions/NamedValueContract
          headers:
            ETag:
              description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.
              type: string
            location:
              description: Location header contains the URL where the status of the long running operation can be checked
              type: string
            Azure-AsyncOperation:
              description: Azure-AsyncOperation header contains the URL where the status of the long running operation can be checked
              type: string
        '201':
          description: Named value was successfully created.
          schema:
            $ref: ./definitions.json#/definitions/NamedValueContract
          headers:
            ETag:
              description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.
              type: string
            location:
              description: Location header contains the URL where the status of the long running operation can be checked
              type: string
            Azure-AsyncOperation:
              description: Azure-AsyncOperation header contains the URL where the status of the long running operation can be checked
              type: string
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: ./apimanagement.json#/definitions/ErrorResponse
      x-ms-long-running-operation: true
      x-ms-long-running-operation-options:
        final-state-via: location
      summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Apimanagement Service Servicename Workspaces Workspaceid Namedvalues Namedvalueid
    patch:
      tags:
      - NamedValue
      operationId: microsoftAzureWorkspacenamedvalueUpdate
      description: Updates the specific named value.
      x-ms-examples:
        ApiManagementUpdateWorkspaceNamedValue:
          $ref: ./examples/ApiManagementUpdateWorkspaceNamedValue.json
      parameters:
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
      - $ref: ./apimanagement.json#/parameters/ServiceNameParameter
      - $ref: ./apimanagement.json#/parameters/WorkspaceIdParameter
      - $ref: ./apimanagement.json#/parameters/NamedValueIdParameter
      - name: parameters
        in: body
        required: true
        schema:
          $ref: ./definitions.json#/definitions/NamedValueUpdateParameters
        description: Update parameters.
      - $ref: ./apimanagement.json#/parameters/IfMatchRequiredParameter
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
      responses:
        '200':
          description: Named value was successfully updated.
          schema:
            $ref: ./definitions.json#/definitions/NamedValueContract
          headers:
            ETag:
              description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.
              type: string
        '202':
          description: Request to create or update named value was accepted.
          headers:
            location:
              description: Location header contains the URL where the status of the long running operation can be checked
              type: string
            Azure-AsyncOperation:
              description: Azure-AsyncOperation header contains the URL where the status of the long running operation can be checked
              type: string
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: ./apimanagement.json#/definitions/ErrorResponse
      x-ms-long-running-operation: true
      x-ms-long-running-operation-options:
        final-state-via: location
      summary: Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Apimanagement Service Servicename Workspaces Workspaceid Namedvalues Namedvalueid
    delete:
      tags:
      - NamedValue
      operationId: microsoftAzureWorkspacenamedvalueDelete
      description: Deletes specific named value from the workspace in an API Management service instance.
      x-ms-examples:
        ApiManagementDeleteWorkspaceNamedValue:
          $ref: ./examples/ApiManagementDeleteWorkspaceNamedValue.json
      parameters:
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
      - $ref: ./apimanagement.json#/parameters/ServiceNameParameter
      - $ref: ./apimanagement.json#/parameters/WorkspaceIdParameter
      - $ref: ./apimanagement.json#/parameters/NamedValueIdParameter
      - $ref: ./apimanagement.json#/parameters/IfMatchRequiredParameter
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
      responses:
        '200':
          description: Named value was successfully deleted.
        '204':
          description: Named value was successfully deleted.
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: ./apimanagement.json#/definitions/ErrorResponse
      summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Apimanagement Service Servicename Workspaces Workspaceid Namedvalues Namedvalueid
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/namedValues/{namedValueId}/listValue
  : post:
      tags:
      - NamedValue
      operationId: microsoftAzureWorkspacenamedvalueListvalue
      description: Gets the secret of the named value specified by its identifier.
      x-ms-examples:
        ApiManagementWorkspaceNamedValueListValue:
          $ref: ./examples/ApiManagementWorkspaceNamedValueListValue.json
      parameters:
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
      - $ref: ./apimanagement.json#/parameters/ServiceNameParameter
      - $ref: ./apimanagement.json#/parameters/WorkspaceIdParameter
      - $ref: ./apimanagement.json#/parameters/NamedValueIdParameter
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
      responses:
        '200':
          description: The response body contains the specified named value secret.
          schema:
            $ref: ./definitions.json#/definitions/NamedValueSecretContract
          headers:
            ETag:
              description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.
              type: string
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: ./apimanagement.json#/definitions/ErrorResponse
      summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Apimanagement Service Servicename Workspaces Workspaceid Namedvalues Namedvalueid Listvalue
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/namedValues/{namedValueId}/refreshSecret
  : post:
      tags:
      - NamedValue
      operationId: microsoftAzureWorkspacenamedvalueRefreshsecret
      description: Refresh the secret of the named value specified by its identifier.
      x-ms-examples:
        ApiManagementRefreshWorkspaceNamedValue:
          $ref: ./examples/ApiManagementRefreshWorkspaceNamedValue.json
      parameters:
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
      - $ref: ./apimanagement.json#/parameters/ServiceNameParameter
      - $ref: ./apimanagement.json#/parameters/WorkspaceIdParameter
      - $ref: ./apimanagement.json#/parameters/NamedValueIdParameter
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
      responses:
        '200':
          description: Named value was successfully updated.
          schema:
            $ref: ./definitions.json#/definitions/NamedValueContract
          headers:
            ETag:
              description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.
              type: string
        '202':
          description: Request to refresh secret was accepted.
          headers:
            location:
              description: Location header contains the URL where the status of the long running operation can be checked
              type: string
            Azure-AsyncOperation:
              description: Azure-AsyncOperation header contains the URL where the status of the long running operation can be checked
              type: string
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: ./apimanagement.json#/definitions/ErrorResponse
      x-ms-long-running-operation: true
      x-ms-long-running-operation-options:
        final-state-via: location
      summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Apimanagement Service Servicename Workspaces Workspaceid Namedvalues Namedvalueid Refreshsecret
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'