BookshelfProperties interface

Package:

@azure/arm-discovery

Bookshelf properties

Properties

bookshelfUri	The bookshelf data plane API URI
customerManagedKeys	Whether or not to use a customer managed key when encrypting data at rest
keyVaultProperties	The key to use for encrypting data at rest when customer managed keys are enabled. Required if Customer Managed Keys is enabled.
logAnalyticsClusterId	The Log Analytics Cluster to use for debug logs. This is required when Customer Managed Keys are enabled.
managedOnBehalfOfConfiguration	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	The resource group for resources managed on behalf of customer.
privateEndpointConnections	List of private endpoint connections.
privateEndpointSubnetId	Private Endpoint Subnet ID for private endpoint connections.
provisioningState	The status of the last operation.
publicNetworkAccess	Whether or not public network access is allowed for this resource. For security reasons, it is recommended to disable it whenever possible.
searchSubnetId	Search Subnet ID for search resources.
workloadIdentities	User assigned identity IDs to be used by knowledgebase workloads. The key value must be the resource ID of the identity resource.

Property Details

bookshelfUri

The bookshelf data plane API URI

bookshelfUri?: string

Property Value

string

customerManagedKeys

Whether or not to use a customer managed key when encrypting data at rest

customerManagedKeys?: string

Property Value

string

keyVaultProperties

The key to use for encrypting data at rest when customer managed keys are enabled. Required if Customer Managed Keys is enabled.

keyVaultProperties?: BookshelfKeyVaultProperties

Property Value

BookshelfKeyVaultProperties

logAnalyticsClusterId

The Log Analytics Cluster to use for debug logs. This is required when Customer Managed Keys are enabled.

logAnalyticsClusterId?: string

Property Value

string

managedOnBehalfOfConfiguration

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.

managedOnBehalfOfConfiguration?: WithMoboBrokerResources

Property Value

WithMoboBrokerResources

managedResourceGroup

The resource group for resources managed on behalf of customer.

managedResourceGroup?: string

Property Value

string

privateEndpointConnections

List of private endpoint connections.

privateEndpointConnections?: PrivateEndpointConnection[]

Property Value

PrivateEndpointConnection[]

privateEndpointSubnetId

Private Endpoint Subnet ID for private endpoint connections.

privateEndpointSubnetId?: string

Property Value

string

provisioningState

The status of the last operation.

provisioningState?: string

Property Value

string

publicNetworkAccess

Whether or not public network access is allowed for this resource. For security reasons, it is recommended to disable it whenever possible.

publicNetworkAccess?: string

Property Value

string

searchSubnetId

Search Subnet ID for search resources.

searchSubnetId?: string

Property Value

string

workloadIdentities

User assigned identity IDs to be used by knowledgebase workloads. The key value must be the resource ID of the identity resource.

workloadIdentities?: Record<string, UserAssignedIdentity>

Property Value

Record<string, UserAssignedIdentity>