Microsoft Cognitive Services Encryption Scopes API

The EncryptionScopes API from Microsoft Cognitive Services — 2 operation(s) for encryptionscopes.

GitHub OpenAPI

Operations 4

GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/encryptionScopes Encryption scopes list #
GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/encryptionScopes/{encryptionScopeName} Encryption scopes get #
PUT /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/encryptionScopes/{encryptionScopeName} Encryption scopes create or update #
DELETE /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/encryptionScopes/{encryptionScopeName} Encryption scopes delete #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/microsoft-cognitive-services:microsoft-cognitive-services-encryptionscopes-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

microsoft-cognitive-services-encryptionscopes-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: CognitiveServicesManagementClient Encryption Scopes API
  version: '2026-11-01'
  description: Cognitive Services Management Client
  x-typespec-generated:
  - emitter: '@azure-tools/typespec-autorest'
servers:
- url: https://management.azure.com
security:
- azure_auth:
  - user_impersonation
tags:
- name: EncryptionScopes
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/encryptionScopes
  : get:
      operationId: EncryptionScopes_List
      tags:
      - EncryptionScopes
      description: Gets the content filters associated with the Azure OpenAI account.
      parameters:
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      - name: accountName
        in: path
        description: The name of Cognitive Services account.
        required: true
        schema:
          type: string
          maxLength: 64
          minLength: 2
          pattern: ^[a-zA-Z0-9][a-zA-Z0-9_.-]*$
      responses:
        '200':
          description: The request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EncryptionScopeListResult'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Encryption scopes list
      x-summary-source: derived
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/encryptionScopes/{encryptionScopeName}
  : get:
      operationId: EncryptionScopes_Get
      tags:
      - EncryptionScopes
      description: Gets the specified EncryptionScope associated with the Cognitive Services account.
      parameters:
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      - name: accountName
        in: path
        description: The name of Cognitive Services account.
        required: true
        schema:
          type: string
          maxLength: 64
          minLength: 2
          pattern: ^[a-zA-Z0-9][a-zA-Z0-9_.-]*$
      - name: encryptionScopeName
        in: path
        description: The name of the encryptionScope associated with the Cognitive Services Account
        required: true
        schema:
          type: string
          pattern: ^[a-zA-Z0-9][a-zA-Z0-9_.-]*$
      responses:
        '200':
          description: Azure operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EncryptionScope'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      summary: Encryption scopes get
      x-summary-source: derived
    put:
      operationId: EncryptionScopes_CreateOrUpdate
      tags:
      - EncryptionScopes
      description: Update the state of specified encryptionScope associated with the Cognitive Services account.
      parameters:
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      - name: accountName
        in: path
        description: The name of Cognitive Services account.
        required: true
        schema:
          type: string
          maxLength: 64
          minLength: 2
          pattern: ^[a-zA-Z0-9][a-zA-Z0-9_.-]*$
      - name: encryptionScopeName
        in: path
        description: The name of the encryptionScope associated with the Cognitive Services Account
        required: true
        schema:
          type: string
          pattern: ^[a-zA-Z0-9][a-zA-Z0-9_.-]*$
      responses:
        '200':
          description: Resource 'EncryptionScope' update operation succeeded
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EncryptionScope'
        '201':
          description: Resource 'EncryptionScope' create operation succeeded
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EncryptionScope'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EncryptionScope'
        description: The encryptionScope properties.
        required: true
      summary: Encryption scopes create or update
      x-summary-source: derived
    delete:
      operationId: EncryptionScopes_Delete
      tags:
      - EncryptionScopes
      description: Deletes the specified encryptionScope associated with the Cognitive Services account.
      parameters:
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      - name: accountName
        in: path
        description: The name of Cognitive Services account.
        required: true
        schema:
          type: string
          maxLength: 64
          minLength: 2
          pattern: ^[a-zA-Z0-9][a-zA-Z0-9_.-]*$
      - name: encryptionScopeName
        in: path
        description: The name of the encryptionScope associated with the Cognitive Services Account
        required: true
        schema:
          type: string
          pattern: ^[a-zA-Z0-9][a-zA-Z0-9_.-]*$
      responses:
        '202':
          description: Resource deletion accepted.
          headers:
            Retry-After:
              description: The Retry-After header can indicate how long the client should wait before polling the operation status.
              schema:
                type: integer
                format: int32
            location:
              description: The Location header contains the URL where the status of the long running operation can be checked.
              schema:
                type: string
        '204':
          description: Resource does not exist.
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-ms-long-running-operation-options:
        final-state-via: location
      x-ms-long-running-operation: true
      summary: Encryption scopes delete
      x-summary-source: derived
components:
  schemas:
    Encryption:
      type: object
      description: Properties to configure Encryption
      properties:
        keyVaultProperties:
          $ref: '#/components/schemas/KeyVaultProperties'
          description: Properties of KeyVault
        keySource:
          type: string
          description: Enumerates the possible value of keySource for Encryption
          default: Microsoft.KeyVault
          enum:
          - Microsoft.CognitiveServices
          - Microsoft.KeyVault
          x-ms-enum:
            name: KeySource
            modelAsString: true
            values:
            - name: Microsoft.CognitiveServices
              value: Microsoft.CognitiveServices
            - name: Microsoft.KeyVault
              value: Microsoft.KeyVault
    Resource:
      type: object
      title: Resource
      description: Common fields that are returned in the response for all Azure Resource Manager resources
      properties:
        id:
          type: string
          description: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
          readOnly: true
        name:
          type: string
          description: The name of the resource
          readOnly: true
        type:
          type: string
          description: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
          readOnly: true
        systemData:
          $ref: '#/components/schemas/systemData'
          type: object
          description: Azure Resource Manager metadata containing createdBy and modifiedBy information.
          readOnly: true
      x-ms-azure-resource: true
    systemData:
      type: object
      description: Metadata pertaining to creation and last modification of the resource.
      properties:
        createdBy:
          type: string
          description: The identity that created the resource.
        createdByType:
          type: string
          description: The type of identity that created the resource.
          enum:
          - User
          - Application
          - ManagedIdentity
          - Key
          x-ms-enum:
            name: createdByType
            modelAsString: true
        createdAt:
          type: string
          format: date-time
          description: The timestamp of resource creation (UTC).
        lastModifiedBy:
          type: string
          description: The identity that last modified the resource.
        lastModifiedByType:
          type: string
          description: The type of identity that last modified the resource.
          enum:
          - User
          - Application
          - ManagedIdentity
          - Key
          x-ms-enum:
            name: createdByType
            modelAsString: true
        lastModifiedAt:
          type: string
          format: date-time
          description: The timestamp of resource last modification (UTC)
      readOnly: true
    EncryptionScopeListResult:
      type: object
      description: The list of cognitive services EncryptionScopes.
      properties:
        nextLink:
          type: string
          description: The link used to get the next page of EncryptionScope.
        value:
          type: array
          description: The list of EncryptionScope.
          items:
            $ref: '#/components/schemas/EncryptionScope'
          x-ms-identifiers:
          - name
    EncryptionScopeProperties:
      type: object
      description: Properties to EncryptionScope
      properties:
        provisioningState:
          $ref: '#/components/schemas/EncryptionScopeProvisioningState'
          description: Gets the status of the resource at the time the operation was called.
          readOnly: true
        state:
          $ref: '#/components/schemas/EncryptionScopeState'
          description: The encryptionScope state.
      allOf:
      - $ref: '#/components/schemas/Encryption'
    EncryptionScopeProvisioningState:
      type: string
      description: Gets the status of the resource at the time the operation was called.
      enum:
      - Accepted
      - Creating
      - Deleting
      - Moving
      - Failed
      - Succeeded
      - Canceled
      x-ms-enum:
        name: EncryptionScopeProvisioningState
        modelAsString: true
        values:
        - name: Accepted
          value: Accepted
        - name: Creating
          value: Creating
        - name: Deleting
          value: Deleting
        - name: Moving
          value: Moving
        - name: Failed
          value: Failed
        - name: Succeeded
          value: Succeeded
        - name: Canceled
          value: Canceled
      readOnly: true
    KeyVaultProperties:
      type: object
      description: Properties to configure keyVault Properties
      properties:
        keyName:
          type: string
          description: Name of the Key from KeyVault
        keyVersion:
          type: string
          description: Version of the Key from KeyVault
        keyVaultUri:
          type: string
          description: Uri of KeyVault
        identityClientId:
          type: string
    ProxyResource:
      type: object
      title: Proxy Resource
      description: The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location
      allOf:
      - $ref: '#/components/schemas/Resource'
    EncryptionScope:
      type: object
      description: Cognitive Services EncryptionScope
      properties:
        properties:
          $ref: '#/components/schemas/EncryptionScopeProperties'
          description: Properties of Cognitive Services EncryptionScope.
        etag:
          type: string
          description: Resource Etag.
          readOnly: true
        tags:
          type: object
          description: Resource tags.
          additionalProperties:
            type: string
          x-ms-mutability:
          - read
          - update
          - create
      allOf:
      - $ref: '#/components/schemas/ProxyResource'
    EncryptionScopeState:
      type: string
      description: The encryptionScope state.
      enum:
      - Disabled
      - Enabled
      x-ms-enum:
        name: EncryptionScopeState
        modelAsString: true
        values:
        - name: Disabled
          value: Disabled
        - name: Enabled
          value: Enabled
    ErrorResponse:
      type: object
      title: Error response
      description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).
      properties:
        error:
          $ref: '#/components/schemas/ErrorDetail'
          description: The error object.
  parameters:
    ApiVersionParameter:
      name: api-version
      in: query
      description: The API version to use for this operation.
      required: true
      schema:
        type: string
        minLength: 1
    ResourceGroupNameParameter:
      name: resourceGroupName
      in: path
      description: The name of the resource group. The name is case insensitive.
      required: true
      x-ms-parameter-location: method
      schema:
        type: string
        maxLength: 90
        minLength: 1
    SubscriptionIdParameter:
      name: subscriptionId
      in: path
      description: The ID of the target subscription.
      required: true
      schema:
        type: string
        minLength: 1
  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.