Microsoft Azure
Microsoft Azure API Management Client

Microsoft Azure API Management Client is a tool that allows users to easily manage and monitor their APIs in Azure. With this client, users can create, deploy, and secure APIs, as well as control access to them. The client provides a centralized hub for managing all aspects of APIs, including setting policies, monitoring performance, and analyzing usage data.
Documentation GitHub OpenAPI
OpenAPI Specification

swagger: '2.0'
info:
  title: Microsoft Azure ApiManagementClient
  description: >-
    Use these REST APIs for performing operations on Workspace entity and its
    associated entities within your Azure API Management deployment.
  version: 2023-05-01-preview
host: management.azure.com
schemes:
  - https
consumes:
  - application/json
produces:
  - application/json
security:
  - azure_auth:
      - user_impersonation
securityDefinitions:
  azure_auth:
    type: oauth2
    authorizationUrl: https://login.microsoftonline.com/common/oauth2/authorize
    flow: implicit
    description: Azure Active Directory OAuth2 Flow.
    scopes:
      user_impersonation: impersonate your user account
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces
  : get:
      tags:
        - Workspace
      operationId: microsoftAzureWorkspaceListbyservice
      description: Lists all workspaces of the API Management service instance.
      x-ms-examples:
        ApiManagementListWorkspaces:
          $ref: ./examples/ApiManagementListWorkspaces.json
      parameters:
        - $ref: >-
            ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
        - $ref: ./apimanagement.json#/parameters/ServiceNameParameter
        - name: $filter
          in: query
          required: false
          type: string
          description: >-
            |     Field     |     Usage     |     Supported operators     |     Supported functions     |</br>|-------------|-------------|-------------|-------------|</br>|
            displayName | filter | ge, le, eq, ne, gt, lt | substringof,
            contains, startswith, endswith |</br></br>| description | filter |
            ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith
            |</br>
        - $ref: ./apimanagement.json#/parameters/TopQueryParameter
        - $ref: ./apimanagement.json#/parameters/SkipQueryParameter
        - $ref: >-
            ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
        - $ref: >-
            ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
      responses:
        '200':
          description: Paged Result response of workspaces.
          schema:
            $ref: ./definitions.json#/definitions/WorkspaceCollection
        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/WorkspaceContract
      summary: >-
        Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Apimanagement Service Servicename Workspaces
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}
  : head:
      tags:
        - Workspace
      operationId: microsoftAzureWorkspaceGetentitytag
      description: >-
        Gets the entity state (Etag) version of the workspace specified by its
        identifier.
      x-ms-examples:
        ApiManagementHeadWorkspace:
          $ref: ./examples/ApiManagementHeadWorkspace.json
      parameters:
        - $ref: >-
            ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
        - $ref: ./apimanagement.json#/parameters/ServiceNameParameter
        - $ref: ./apimanagement.json#/parameters/WorkspaceIdParameter
        - $ref: >-
            ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
        - $ref: >-
            ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
      responses:
        '200':
          description: Gets the entity tag of the workspace
          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
    get:
      tags:
        - Workspace
      operationId: microsoftAzureWorkspaceGet
      description: Gets the details of the workspace specified by its identifier.
      x-ms-examples:
        ApiManagementGetWorkspace:
          $ref: ./examples/ApiManagementGetWorkspace.json
      parameters:
        - $ref: >-
            ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
        - $ref: ./apimanagement.json#/parameters/ServiceNameParameter
        - $ref: ./apimanagement.json#/parameters/WorkspaceIdParameter
        - $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 workspace entity.
          headers:
            ETag:
              description: >-
                Current entity state version. Should be treated as opaque and
                used to make conditional HTTP requests.
              type: string
          schema:
            $ref: ./definitions.json#/definitions/WorkspaceContract
        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
    put:
      tags:
        - Workspace
      operationId: microsoftAzureWorkspaceCreateorupdate
      description: Creates a new workspace or updates an existing one.
      x-ms-examples:
        ApiManagementCreateWorkspace:
          $ref: ./examples/ApiManagementCreateWorkspace.json
      parameters:
        - $ref: >-
            ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
        - $ref: ./apimanagement.json#/parameters/ServiceNameParameter
        - $ref: ./apimanagement.json#/parameters/WorkspaceIdParameter
        - name: parameters
          in: body
          required: true
          schema:
            $ref: ./definitions.json#/definitions/WorkspaceContract
          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: Workspace successfully updated
          headers:
            ETag:
              description: >-
                Current entity state version. Should be treated as opaque and
                used to make conditional HTTP requests.
              type: string
          schema:
            $ref: ./definitions.json#/definitions/WorkspaceContract
        '201':
          description: Workspace was successfully created.
          headers:
            ETag:
              description: >-
                Current entity state version. Should be treated as opaque and
                used to make conditional HTTP requests.
              type: string
          schema:
            $ref: ./definitions.json#/definitions/WorkspaceContract
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: ./apimanagement.json#/definitions/ErrorResponse
      summary: >-
        Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Apimanagement Service Servicename Workspaces Workspaceid
    patch:
      tags:
        - Workspace
      operationId: microsoftAzureWorkspaceUpdate
      description: Updates the details of the workspace specified by its identifier.
      x-ms-examples:
        ApiManagementUpdateWorkspace:
          $ref: ./examples/ApiManagementUpdateWorkspace.json
      parameters:
        - $ref: >-
            ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
        - $ref: ./apimanagement.json#/parameters/ServiceNameParameter
        - $ref: ./apimanagement.json#/parameters/WorkspaceIdParameter
        - name: parameters
          in: body
          required: true
          schema:
            $ref: ./definitions.json#/definitions/WorkspaceContract
          description: Workspace 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: Workspace successfully updated
          schema:
            $ref: ./definitions.json#/definitions/WorkspaceContract
          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 Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Apimanagement Service Servicename Workspaces Workspaceid
    delete:
      tags:
        - Workspace
      operationId: microsoftAzureWorkspaceDelete
      description: Deletes the specified workspace.
      x-ms-examples:
        ApiManagementDeleteWorkspace:
          $ref: ./examples/ApiManagementDeleteWorkspace.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/IfMatchRequiredParameter
        - $ref: >-
            ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
        - $ref: >-
            ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
      responses:
        '200':
          description: The workspace was successfully deleted.
        '204':
          description: The workspace 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
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/policies
  : get:
      tags:
        - WorkspacePolicy
      operationId: microsoftAzureWorkspacepolicyListbyapi
      description: Get the policy configuration at the workspace level.
      x-ms-examples:
        ApiManagementListWorkspacePolicies:
          $ref: ./examples/ApiManagementListWorkspacePolicies.json
      parameters:
        - $ref: >-
            ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
        - $ref: ./apimanagement.json#/parameters/ServiceNameParameter
        - $ref: ./apimanagement.json#/parameters/WorkspaceIdParameter
        - $ref: >-
            ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
        - $ref: >-
            ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
      responses:
        '200':
          description: Workspace Policy Collection.
          schema:
            $ref: ./definitions.json#/definitions/PolicyCollection
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: ./apimanagement.json#/definitions/ErrorResponse
      x-ms-pageable:
        nextLinkName: nextLink
      summary: >-
        Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Apimanagement Service Servicename Workspaces Workspaceid Policies
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/policies/{policyId}
  : head:
      tags:
        - WorkspacePolicy
      operationId: microsoftAzureWorkspacepolicyGetentitytag
      description: >-
        Gets the entity state (Etag) version of the workspace policy specified
        by its identifier.
      x-ms-examples:
        ApiManagementHeadWorkspacePolicy:
          $ref: ./examples/ApiManagementHeadWorkspacePolicy.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/PolicyIdParameter
        - $ref: >-
            ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
        - $ref: >-
            ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
      responses:
        '200':
          description: >-
            Specified workspace Policy 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 Policies Policyid
    get:
      tags:
        - WorkspacePolicy
      operationId: microsoftAzureWorkspacepolicyGet
      description: Get the policy configuration at the API level.
      x-ms-examples:
        ApiManagementGetWorkspacePolicy:
          $ref: ./examples/ApiManagementGetWorkspacePolicy.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/PolicyIdParameter
        - $ref: ./apimanagement.json#/parameters/PolicyExportFormat
        - $ref: >-
            ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
        - $ref: >-
            ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
      responses:
        '200':
          description: Workspace Policy information.
          schema:
            $ref: ./definitions.json#/definitions/PolicyContract
          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 Policies Policyid
    put:
      tags:
        - WorkspacePolicy
      operationId: microsoftAzureWorkspacepolicyCreateorupdate
      description: Creates or updates policy configuration for the workspace.
      x-ms-examples:
        ApiManagementCreateWorkspacePolicy:
          $ref: ./examples/ApiManagementCreateWorkspacePolicy.json
        ApiManagementCreateWorkspacePolicyNonXmlEncoded:
          $ref: ./examples/ApiManagementCreateWorkspacePolicyNonXmlEncoded.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/PolicyIdParameter
        - name: parameters
          in: body
          required: true
          schema:
            $ref: ./definitions.json#/definitions/PolicyContract
          description: The policy contents to apply.
        - $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: >-
            Workspace policy configuration of the tenant was successfully
            updated.
          schema:
            $ref: ./definitions.json#/definitions/PolicyContract
          headers:
            ETag:
              description: >-
                Current entity state version. Should be treated as opaque and
                used to make conditional HTTP requests.
              type: string
        '201':
          description: Workspace policy configuration was successfully created.
          schema:
            $ref: ./definitions.json#/definitions/PolicyContract
          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 Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Apimanagement Service Servicename Workspaces Workspaceid Policies Policyid
    delete:
      tags:
        - WorkspacePolicy
      operationId: microsoftAzureWorkspacepolicyDelete
      description: Deletes the policy configuration at the workspace.
      x-ms-examples:
        ApiManagementDeleteWorkspacePolicy:
          $ref: ./examples/ApiManagementDeleteWorkspacePolicy.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/PolicyIdParameter
        - $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: >-
            Successfully deleted the policy configuration at the workspace
            level.
        '204':
          description: >-
            Successfully deleted the policy configuration at the workspace
            level.
        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 Policies Policyid
  ? /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
          requ

# --- truncated at 32 KB (282 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/microsoft-azure/refs/heads/main/openapi/apimanagementclient-openapi-original.yml
Microsoft Azure API Management Client

Documentation

Specifications

Other Resources

OpenAPI Specification
