---
title: "GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Discovery/bookshelves/{bookshelfName}"
method: GET
path: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Discovery/bookshelves/{bookshelfName}"
tags: ["Bookshelves"]
---

# GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Discovery/bookshelves/{bookshelfName}

`GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Discovery/bookshelves/{bookshelfName}`

## Request

- Base URL: `https://management.azure.com`
- URL: `https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Discovery/bookshelves/{bookshelfName}`
- Auth: OAuth 2
  - Implicit: `https://login.microsoftonline.com/common/oauth2/authorize`
  - Scopes: `user_impersonation`

Get a Bookshelf

## Path parameters

- `subscriptionId` string, uuid, required
- `resourceGroupName` string, required
- `bookshelfName` string, required

## Query parameters

- `api-version` string, required

## Response `200`

Azure operation completed successfully.

- Bookshelf: Bookshelf tracked resource
  - `id` string, arm-id: Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
  - `name` string: The name of the resource
  - `type` string: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
  - `systemData` SystemData: Metadata pertaining to creation and last modification of the resource.
    - `createdBy` string: The identity that created the resource.
    - `createdByType` 'User' | 'Application' | 'ManagedIdentity' | 'Key': The type of identity that created the resource.
    - `createdAt` string, date-time: The timestamp of resource creation (UTC).
    - `lastModifiedBy` string: The identity that last modified the resource.
    - `lastModifiedByType` 'User' | 'Application' | 'ManagedIdentity' | 'Key': The type of identity that last modified the resource.
    - `lastModifiedAt` string, date-time: The timestamp of resource last modification (UTC)
  - `tags` object: Resource tags.
  - `location` string, required: The geo-location where the resource lives
  - `properties` BookshelfProperties: Bookshelf properties
    - `provisioningState` 'Succeeded' | 'Failed' | 'Canceled' | 'Accepted' | 'Provisioning' | 'Updating' | 'Deleting': The resource provisioning state.
    - `workloadIdentities` object: User assigned identity IDs to be used by knowledgebase workloads. The key value must be the resource ID of the identity resource.
    - `customerManagedKeys` 'Enabled' | 'Disabled': State of customer managed key usage.
    - `keyVaultProperties` BookshelfKeyVaultProperties: Key Vault Properties with clientId selection
      - `keyVaultUri` string, uri, required: The Key Vault URI
      - `keyName` string, required: The Key Name in Key Vault
      - `keyVersion` string: The Key Version in Key Vault
      - `identityClientId` string, required: The client ID of the identity to use for accessing the Key Vault. Must be a workload identity assigned to the Bookshelf resource.
    - `logAnalyticsClusterId` string, arm-id: The Log Analytics Cluster to use for debug logs. This is required when Customer Managed Keys are enabled.
    - `privateEndpointConnections` PrivateEndpointConnection[]: List of private endpoint connections.
      - `id` string, arm-id: Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
      - `name` string: The name of the resource
      - `type` string: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
      - `systemData` SystemData: Metadata pertaining to creation and last modification of the resource.
        - `createdBy` string: The identity that created the resource.
        - `createdByType` 'User' | 'Application' | 'ManagedIdentity' | 'Key': The type of identity that created the resource.
        - `createdAt` string, date-time: The timestamp of resource creation (UTC).
        - `lastModifiedBy` string: The identity that last modified the resource.
        - `lastModifiedByType` 'User' | 'Application' | 'ManagedIdentity' | 'Key': The type of identity that last modified the resource.
        - `lastModifiedAt` string, date-time: The timestamp of resource last modification (UTC)
      - `properties` PrivateEndpointConnectionProperties: Properties of the private endpoint connection.
        - `groupIds` string[]: The group ids for the private endpoint resource.
        - `privateEndpoint` PrivateEndpoint: The private endpoint resource.
          - `id` string: The ARM identifier for private endpoint.
        - `privateLinkServiceConnectionState` PrivateLinkServiceConnectionState, required: A collection of information about the state of the connection between service consumer and provider.
          - `status` 'Pending' | 'Approved' | 'Rejected': The private endpoint connection status.
          - `description` string: The reason for approval/rejection of the connection.
          - `actionsRequired` string: A message indicating if changes on the service provider require any updates on the consumer.
        - `provisioningState` 'Succeeded' | 'Creating' | 'Deleting' | 'Failed': The current provisioning state.
    - `publicNetworkAccess` 'Enabled' | 'Disabled': State of public network access.
    - `privateEndpointSubnetId` string, arm-id: Private Endpoint Subnet ID for private endpoint connections.
    - `searchSubnetId` string, arm-id: Search Subnet ID for search resources.
    - `managedResourceGroup` string: The resource group for resources managed on behalf of customer.
    - `managedOnBehalfOfConfiguration` WithMoboBrokerResources: For tracking mobo resources
      - `moboBrokerResources` MoboBrokerResource[]: Managed-On-Behalf-Of broker resources
        - `id` string, arm-id: Resource identifier of a Managed-On-Behalf-Of broker resource
    - `bookshelfUri` string, uri: The bookshelf data plane API URI

## Other responses

- `default`: An unexpected error response.

## Changes

- **2026-07-13** (2026-02-01-preview) `8f1da44a8fab`: 3 breaking
  - added the new path request parameter `resourceGroupName`
  - added the new path request parameter `subscriptionId`
  - added the new required `query` request parameter `api-version`

[Operation history](https://skmtc.dev/azure/apis/discovery-microsoft-discovery/changes/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Discovery/bookshelves/:bookshelfName/get.md)

---

[API](https://skmtc.dev/azure/apis/discovery-microsoft-discovery.md) - [All operations](https://skmtc.dev/azure/apis/discovery-microsoft-discovery/llms.txt) - [OpenAPI document](https://skmtc.dev/azure/apis/discovery-microsoft-discovery/revisions/8f1da44a8fab?raw)
