bookshelves

Creates, updates, deletes, gets or lists a bookshelves resource.

Overview

Name	bookshelves
Type	Resource
Id	azure.discovery.bookshelves

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
bookshelfUri	string	The bookshelf data plane API URI.
customerManagedKeys	string	Whether or not to use a customer managed key when encrypting data at rest. Known values are: "Enabled" and "Disabled". (Enabled, Disabled)
keyVaultProperties	object	The key to use for encrypting data at rest when customer managed keys are enabled. Required if Customer Managed Keys is enabled.
location	string	The geo-location where the resource lives. Required.
logAnalyticsClusterId	string	The Log Analytics Cluster to use for debug logs. This is required when Customer Managed Keys are enabled.
managedOnBehalfOfConfiguration	object	Managed-On-Behalf-Of configuration properties. This configuration exists for the resources where a resource provider manages those resources on behalf of the resource owner.
managedResourceGroup	string	The resource group for resources managed on behalf of customer.
privateEndpointConnections	array	List of private endpoint connections.
privateEndpointSubnetId	string	Private Endpoint Subnet ID for private endpoint connections.
provisioningState	string	The status of the last operation. Known values are: "Succeeded", "Failed", "Canceled", "Accepted", "Provisioning", "Updating", and "Deleting". (Succeeded, Failed, Canceled, Accepted, Provisioning, Updating, Deleting)
publicNetworkAccess	string	Whether or not public network access is allowed for this resource. For security reasons, it is recommended to disable it whenever possible. Known values are: "Enabled" and "Disabled". (Enabled, Disabled)
searchSubnetId	string	Search Subnet ID for search resources.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
workloadIdentities	object	User assigned identity IDs to be used by knowledgebase workloads. The key value must be the resource ID of the identity resource.

list_by_resource_group

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
bookshelfUri	string	The bookshelf data plane API URI.
customerManagedKeys	string	Whether or not to use a customer managed key when encrypting data at rest. Known values are: "Enabled" and "Disabled". (Enabled, Disabled)
keyVaultProperties	object	The key to use for encrypting data at rest when customer managed keys are enabled. Required if Customer Managed Keys is enabled.
location	string	The geo-location where the resource lives. Required.
logAnalyticsClusterId	string	The Log Analytics Cluster to use for debug logs. This is required when Customer Managed Keys are enabled.
managedOnBehalfOfConfiguration	object	Managed-On-Behalf-Of configuration properties. This configuration exists for the resources where a resource provider manages those resources on behalf of the resource owner.
managedResourceGroup	string	The resource group for resources managed on behalf of customer.
privateEndpointConnections	array	List of private endpoint connections.
privateEndpointSubnetId	string	Private Endpoint Subnet ID for private endpoint connections.
provisioningState	string	The status of the last operation. Known values are: "Succeeded", "Failed", "Canceled", "Accepted", "Provisioning", "Updating", and "Deleting". (Succeeded, Failed, Canceled, Accepted, Provisioning, Updating, Deleting)
publicNetworkAccess	string	Whether or not public network access is allowed for this resource. For security reasons, it is recommended to disable it whenever possible. Known values are: "Enabled" and "Disabled". (Enabled, Disabled)
searchSubnetId	string	Search Subnet ID for search resources.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
workloadIdentities	object	User assigned identity IDs to be used by knowledgebase workloads. The key value must be the resource ID of the identity resource.

list_by_subscription

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
bookshelfUri	string	The bookshelf data plane API URI.
customerManagedKeys	string	Whether or not to use a customer managed key when encrypting data at rest. Known values are: "Enabled" and "Disabled". (Enabled, Disabled)
keyVaultProperties	object	The key to use for encrypting data at rest when customer managed keys are enabled. Required if Customer Managed Keys is enabled.
location	string	The geo-location where the resource lives. Required.
logAnalyticsClusterId	string	The Log Analytics Cluster to use for debug logs. This is required when Customer Managed Keys are enabled.
managedOnBehalfOfConfiguration	object	Managed-On-Behalf-Of configuration properties. This configuration exists for the resources where a resource provider manages those resources on behalf of the resource owner.
managedResourceGroup	string	The resource group for resources managed on behalf of customer.
privateEndpointConnections	array	List of private endpoint connections.
privateEndpointSubnetId	string	Private Endpoint Subnet ID for private endpoint connections.
provisioningState	string	The status of the last operation. Known values are: "Succeeded", "Failed", "Canceled", "Accepted", "Provisioning", "Updating", and "Deleting". (Succeeded, Failed, Canceled, Accepted, Provisioning, Updating, Deleting)
publicNetworkAccess	string	Whether or not public network access is allowed for this resource. For security reasons, it is recommended to disable it whenever possible. Known values are: "Enabled" and "Disabled". (Enabled, Disabled)
searchSubnetId	string	Search Subnet ID for search resources.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
workloadIdentities	object	User assigned identity IDs to be used by knowledgebase workloads. The key value must be the resource ID of the identity resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, bookshelf_name, subscription_id		Get a Bookshelf.
list_by_resource_group	select	resource_group_name, subscription_id		List Bookshelf resources by resource group.
list_by_subscription	select	subscription_id		List Bookshelf resources by subscription ID.
create_or_update	insert	resource_group_name, bookshelf_name, subscription_id, location		Create a Bookshelf.
update	update	resource_group_name, bookshelf_name, subscription_id, location		Update a Bookshelf.
create_or_update	replace	resource_group_name, bookshelf_name, subscription_id, location		Create a Bookshelf.
delete	delete	resource_group_name, bookshelf_name, subscription_id		Delete a Bookshelf.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
bookshelf_name	string	The name of the Bookshelf. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string

SELECT examples

get

Get a Bookshelf.

SELECT
id,
name,
bookshelfUri,
customerManagedKeys,
keyVaultProperties,
location,
logAnalyticsClusterId,
managedOnBehalfOfConfiguration,
managedResourceGroup,
privateEndpointConnections,
privateEndpointSubnetId,
provisioningState,
publicNetworkAccess,
searchSubnetId,
systemData,
tags,
type,
workloadIdentities
FROM azure.discovery.bookshelves
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND bookshelf_name = '{{ bookshelf_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_resource_group

List Bookshelf resources by resource group.

SELECT
id,
name,
bookshelfUri,
customerManagedKeys,
keyVaultProperties,
location,
logAnalyticsClusterId,
managedOnBehalfOfConfiguration,
managedResourceGroup,
privateEndpointConnections,
privateEndpointSubnetId,
provisioningState,
publicNetworkAccess,
searchSubnetId,
systemData,
tags,
type,
workloadIdentities
FROM azure.discovery.bookshelves
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_subscription

List Bookshelf resources by subscription ID.

SELECT
id,
name,
bookshelfUri,
customerManagedKeys,
keyVaultProperties,
location,
logAnalyticsClusterId,
managedOnBehalfOfConfiguration,
managedResourceGroup,
privateEndpointConnections,
privateEndpointSubnetId,
provisioningState,
publicNetworkAccess,
searchSubnetId,
systemData,
tags,
type,
workloadIdentities
FROM azure.discovery.bookshelves
WHERE subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Create a Bookshelf.

INSERT INTO azure.discovery.bookshelves (
tags,
location,
properties,
resource_group_name,
bookshelf_name,
subscription_id
)
SELECT 
'{{ tags }}',
'{{ location }}' /* required */,
'{{ properties }}',
'{{ resource_group_name }}',
'{{ bookshelf_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: bookshelves
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the bookshelves resource.
  - name: bookshelf_name
    value: "{{ bookshelf_name }}"
    description: Required parameter for the bookshelves resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the bookshelves resource.
  - name: tags
    value: "{{ tags }}"
    description: |
      Resource tags.
  - name: location
    value: "{{ location }}"
    description: |
      The geo-location where the resource lives. Required.
  - name: properties
    description: |
      The resource-specific properties for this resource.
    value:
      provisioningState: "{{ provisioningState }}"
      workloadIdentities: "{{ workloadIdentities }}"
      customerManagedKeys: "{{ customerManagedKeys }}"
      keyVaultProperties:
        keyVaultUri: "{{ keyVaultUri }}"
        keyName: "{{ keyName }}"
        keyVersion: "{{ keyVersion }}"
        identityClientId: "{{ identityClientId }}"
      logAnalyticsClusterId: "{{ logAnalyticsClusterId }}"
      privateEndpointConnections:
        - id: "{{ id }}"
          name: "{{ name }}"
          type: "{{ type }}"
          systemData:
            createdBy: "{{ createdBy }}"
            createdByType: "{{ createdByType }}"
            createdAt: "{{ createdAt }}"
            lastModifiedBy: "{{ lastModifiedBy }}"
            lastModifiedByType: "{{ lastModifiedByType }}"
            lastModifiedAt: "{{ lastModifiedAt }}"
          properties:
            groupIds:
              - "{{ groupIds }}"
            privateEndpoint:
              id: "{{ id }}"
            privateLinkServiceConnectionState:
              status: "{{ status }}"
              description: "{{ description }}"
              actionsRequired: "{{ actionsRequired }}"
            provisioningState: "{{ provisioningState }}"
      publicNetworkAccess: "{{ publicNetworkAccess }}"
      privateEndpointSubnetId: "{{ privateEndpointSubnetId }}"
      searchSubnetId: "{{ searchSubnetId }}"
      managedResourceGroup: "{{ managedResourceGroup }}"
      managedOnBehalfOfConfiguration:
        moboBrokerResources:
          - id: "{{ id }}"
      bookshelfUri: "{{ bookshelfUri }}"

UPDATE examples

update

Update a Bookshelf.

UPDATE azure.discovery.bookshelves
SET 
tags = '{{ tags }}',
location = '{{ location }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND bookshelf_name = '{{ bookshelf_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND location = '{{ location }}' --required
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type;

REPLACE examples

create_or_update

Create a Bookshelf.

REPLACE azure.discovery.bookshelves
SET 
tags = '{{ tags }}',
location = '{{ location }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND bookshelf_name = '{{ bookshelf_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND location = '{{ location }}' --required
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type;

DELETE examples

delete

Delete a Bookshelf.

DELETE FROM azure.discovery.bookshelves
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND bookshelf_name = '{{ bookshelf_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;