1. Packages
  2. Azure Native
  3. API Docs
  4. discovery
  5. Bookshelf
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Viewing docs for Azure Native v3.16.0
published on Friday, Mar 20, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-azure-native

azure-native.discovery.Bookshelf

azure-native logo
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Viewing docs for Azure Native v3.16.0
published on Friday, Mar 20, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-azure-native

    Bookshelf tracked resource

    Uses Azure REST API version 2026-02-01-preview.

    Import

    An existing resource can be imported using its type token, name, and identifier, e.g.

    $ pulumi import azure-native:discovery:Bookshelf 21b8f5a6a47fa1fdcc /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Discovery/bookshelves/{bookshelfName}

    Create Bookshelf Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Bookshelf(name: string, args: BookshelfArgs, opts?: CustomResourceOptions);
    @overload
def Bookshelf(resource_name: str,
              args: BookshelfArgs,
              opts: Optional[ResourceOptions] = None)

@overload
def Bookshelf(resource_name: str,
              opts: Optional[ResourceOptions] = None,
              resource_group_name: Optional[str] = None,
              bookshelf_name: Optional[str] = None,
              location: Optional[str] = None,
              properties: Optional[BookshelfPropertiesArgs] = None,
              tags: Optional[Mapping[str, str]] = None)
    func NewBookshelf(ctx *Context, name string, args BookshelfArgs, opts ...ResourceOption) (*Bookshelf, error)
    public Bookshelf(string name, BookshelfArgs args, CustomResourceOptions? opts = null)
    public Bookshelf(String name, BookshelfArgs args)
public Bookshelf(String name, BookshelfArgs args, CustomResourceOptions options)

    type: azure-native:discovery:Bookshelf
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args BookshelfArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args BookshelfArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args BookshelfArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args BookshelfArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args BookshelfArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var bookshelfResource = new AzureNative.Discovery.Bookshelf("bookshelfResource", new()
{
    ResourceGroupName = "string",
    BookshelfName = "string",
    Location = "string",
    Properties = new AzureNative.Discovery.Inputs.BookshelfPropertiesArgs
    {
        CustomerManagedKeys = "string",
        KeyVaultProperties = new AzureNative.Discovery.Inputs.BookshelfKeyVaultPropertiesArgs
        {
            IdentityClientId = "string",
            KeyName = "string",
            KeyVaultUri = "string",
            KeyVersion = "string",
        },
        LogAnalyticsClusterId = "string",
        PrivateEndpointSubnetId = "string",
        PublicNetworkAccess = "string",
        SearchSubnetId = "string",
        WorkloadIdentities = new[]
        {
            "string",
        },
    },
    Tags = 
    {
        { "string", "string" },
    },
});

    example, err := discovery.NewBookshelf(ctx, "bookshelfResource", &discovery.BookshelfArgs{
	ResourceGroupName: pulumi.String("string"),
	BookshelfName:     pulumi.String("string"),
	Location:          pulumi.String("string"),
	Properties: &discovery.BookshelfPropertiesArgs{
		CustomerManagedKeys: pulumi.String("string"),
		KeyVaultProperties: &discovery.BookshelfKeyVaultPropertiesArgs{
			IdentityClientId: pulumi.String("string"),
			KeyName:          pulumi.String("string"),
			KeyVaultUri:      pulumi.String("string"),
			KeyVersion:       pulumi.String("string"),
		},
		LogAnalyticsClusterId:   pulumi.String("string"),
		PrivateEndpointSubnetId: pulumi.String("string"),
		PublicNetworkAccess:     pulumi.String("string"),
		SearchSubnetId:          pulumi.String("string"),
		WorkloadIdentities: pulumi.StringArray{
			pulumi.String("string"),
		},
	},
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
})

    var bookshelfResource = new Bookshelf("bookshelfResource", BookshelfArgs.builder()
    .resourceGroupName("string")
    .bookshelfName("string")
    .location("string")
    .properties(BookshelfPropertiesArgs.builder()
        .customerManagedKeys("string")
        .keyVaultProperties(BookshelfKeyVaultPropertiesArgs.builder()
            .identityClientId("string")
            .keyName("string")
            .keyVaultUri("string")
            .keyVersion("string")
            .build())
        .logAnalyticsClusterId("string")
        .privateEndpointSubnetId("string")
        .publicNetworkAccess("string")
        .searchSubnetId("string")
        .workloadIdentities("string")
        .build())
    .tags(Map.of("string", "string"))
    .build());

    bookshelf_resource = azure_native.discovery.Bookshelf("bookshelfResource",
    resource_group_name="string",
    bookshelf_name="string",
    location="string",
    properties={
        "customer_managed_keys": "string",
        "key_vault_properties": {
            "identity_client_id": "string",
            "key_name": "string",
            "key_vault_uri": "string",
            "key_version": "string",
        },
        "log_analytics_cluster_id": "string",
        "private_endpoint_subnet_id": "string",
        "public_network_access": "string",
        "search_subnet_id": "string",
        "workload_identities": ["string"],
    },
    tags={
        "string": "string",
    })

    const bookshelfResource = new azure_native.discovery.Bookshelf("bookshelfResource", {
    resourceGroupName: "string",
    bookshelfName: "string",
    location: "string",
    properties: {
        customerManagedKeys: "string",
        keyVaultProperties: {
            identityClientId: "string",
            keyName: "string",
            keyVaultUri: "string",
            keyVersion: "string",
        },
        logAnalyticsClusterId: "string",
        privateEndpointSubnetId: "string",
        publicNetworkAccess: "string",
        searchSubnetId: "string",
        workloadIdentities: ["string"],
    },
    tags: {
        string: "string",
    },
});

    type: azure-native:discovery:Bookshelf
properties:
    bookshelfName: string
    location: string
    properties:
        customerManagedKeys: string
        keyVaultProperties:
            identityClientId: string
            keyName: string
            keyVaultUri: string
            keyVersion: string
        logAnalyticsClusterId: string
        privateEndpointSubnetId: string
        publicNetworkAccess: string
        searchSubnetId: string
        workloadIdentities:
            - string
    resourceGroupName: string
    tags:
        string: string

    Bookshelf Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The Bookshelf resource accepts the following input properties:

    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    BookshelfName string
    The name of the Bookshelf
    Location string
    The geo-location where the resource lives
    Properties Pulumi.AzureNative.Discovery.Inputs.BookshelfProperties
    The resource-specific properties for this resource.
    Tags Dictionary<string, string>
    Resource tags.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    BookshelfName string
    The name of the Bookshelf
    Location string
    The geo-location where the resource lives
    Properties BookshelfPropertiesArgs
    The resource-specific properties for this resource.
    Tags map[string]string
    Resource tags.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    bookshelfName String
    The name of the Bookshelf
    location String
    The geo-location where the resource lives
    properties BookshelfProperties
    The resource-specific properties for this resource.
    tags Map<String,String>
    Resource tags.
    resourceGroupName string
    The name of the resource group. The name is case insensitive.
    bookshelfName string
    The name of the Bookshelf
    location string
    The geo-location where the resource lives
    properties BookshelfProperties
    The resource-specific properties for this resource.
    tags {[key: string]: string}
    Resource tags.
    resource_group_name str
    The name of the resource group. The name is case insensitive.
    bookshelf_name str
    The name of the Bookshelf
    location str
    The geo-location where the resource lives
    properties BookshelfPropertiesArgs
    The resource-specific properties for this resource.
    tags Mapping[str, str]
    Resource tags.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    bookshelfName String
    The name of the Bookshelf
    location String
    The geo-location where the resource lives
    properties Property Map
    The resource-specific properties for this resource.
    tags Map<String>
    Resource tags.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Bookshelf resource produces the following output properties:

    AzureApiVersion string
    The Azure API version of the resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    The name of the resource
    SystemData Pulumi.AzureNative.Discovery.Outputs.SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    Type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    AzureApiVersion string
    The Azure API version of the resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    The name of the resource
    SystemData SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    Type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    azureApiVersion String
    The Azure API version of the resource.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    The name of the resource
    systemData SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type String
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    azureApiVersion string
    The Azure API version of the resource.
    id string
    The provider-assigned unique ID for this managed resource.
    name string
    The name of the resource
    systemData SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    azure_api_version str
    The Azure API version of the resource.
    id str
    The provider-assigned unique ID for this managed resource.
    name str
    The name of the resource
    system_data SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type str
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    azureApiVersion String
    The Azure API version of the resource.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    The name of the resource
    systemData Property Map
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type String
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

    Supporting Types

    BookshelfKeyVaultProperties, BookshelfKeyVaultPropertiesArgs

    Key Vault Properties with clientId selection
    IdentityClientId string
    The client ID of the identity to use for accessing the Key Vault. Must be a workload identity assigned to the Bookshelf resource.
    KeyName string
    The Key Name in Key Vault
    KeyVaultUri string
    The Key Vault URI
    KeyVersion string
    The Key Version in Key Vault
    IdentityClientId string
    The client ID of the identity to use for accessing the Key Vault. Must be a workload identity assigned to the Bookshelf resource.
    KeyName string
    The Key Name in Key Vault
    KeyVaultUri string
    The Key Vault URI
    KeyVersion string
    The Key Version in Key Vault
    identityClientId String
    The client ID of the identity to use for accessing the Key Vault. Must be a workload identity assigned to the Bookshelf resource.
    keyName String
    The Key Name in Key Vault
    keyVaultUri String
    The Key Vault URI
    keyVersion String
    The Key Version in Key Vault
    identityClientId string
    The client ID of the identity to use for accessing the Key Vault. Must be a workload identity assigned to the Bookshelf resource.
    keyName string
    The Key Name in Key Vault
    keyVaultUri string
    The Key Vault URI
    keyVersion string
    The Key Version in Key Vault
    identity_client_id str
    The client ID of the identity to use for accessing the Key Vault. Must be a workload identity assigned to the Bookshelf resource.
    key_name str
    The Key Name in Key Vault
    key_vault_uri str
    The Key Vault URI
    key_version str
    The Key Version in Key Vault
    identityClientId String
    The client ID of the identity to use for accessing the Key Vault. Must be a workload identity assigned to the Bookshelf resource.
    keyName String
    The Key Name in Key Vault
    keyVaultUri String
    The Key Vault URI
    keyVersion String
    The Key Version in Key Vault

    BookshelfKeyVaultPropertiesResponse, BookshelfKeyVaultPropertiesResponseArgs

    Key Vault Properties with clientId selection
    IdentityClientId string
    The client ID of the identity to use for accessing the Key Vault. Must be a workload identity assigned to the Bookshelf resource.
    KeyName string
    The Key Name in Key Vault
    KeyVaultUri string
    The Key Vault URI
    KeyVersion string
    The Key Version in Key Vault
    IdentityClientId string
    The client ID of the identity to use for accessing the Key Vault. Must be a workload identity assigned to the Bookshelf resource.
    KeyName string
    The Key Name in Key Vault
    KeyVaultUri string
    The Key Vault URI
    KeyVersion string
    The Key Version in Key Vault
    identityClientId String
    The client ID of the identity to use for accessing the Key Vault. Must be a workload identity assigned to the Bookshelf resource.
    keyName String
    The Key Name in Key Vault
    keyVaultUri String
    The Key Vault URI
    keyVersion String
    The Key Version in Key Vault
    identityClientId string
    The client ID of the identity to use for accessing the Key Vault. Must be a workload identity assigned to the Bookshelf resource.
    keyName string
    The Key Name in Key Vault
    keyVaultUri string
    The Key Vault URI
    keyVersion string
    The Key Version in Key Vault
    identity_client_id str
    The client ID of the identity to use for accessing the Key Vault. Must be a workload identity assigned to the Bookshelf resource.
    key_name str
    The Key Name in Key Vault
    key_vault_uri str
    The Key Vault URI
    key_version str
    The Key Version in Key Vault
    identityClientId String
    The client ID of the identity to use for accessing the Key Vault. Must be a workload identity assigned to the Bookshelf resource.
    keyName String
    The Key Name in Key Vault
    keyVaultUri String
    The Key Vault URI
    keyVersion String
    The Key Version in Key Vault

    BookshelfProperties, BookshelfPropertiesArgs

    Bookshelf properties
    CustomerManagedKeys string | Pulumi.AzureNative.Discovery.CustomerManagedKeys
    Whether or not to use a customer managed key when encrypting data at rest
    KeyVaultProperties Pulumi.AzureNative.Discovery.Inputs.BookshelfKeyVaultProperties
    The key to use for encrypting data at rest when customer managed keys are enabled. Required if Customer Managed Keys is enabled.
    LogAnalyticsClusterId string
    The Log Analytics Cluster to use for debug logs. This is required when Customer Managed Keys are enabled.
    PrivateEndpointSubnetId string
    Private Endpoint Subnet ID for private endpoint connections.
    PublicNetworkAccess string | Pulumi.AzureNative.Discovery.PublicNetworkAccess
    Whether or not public network access is allowed for this resource. For security reasons, it is recommended to disable it whenever possible.
    SearchSubnetId string
    Search Subnet ID for search resources.
    WorkloadIdentities List<string>
    User assigned identity IDs to be used by knowledgebase workloads. The key value must be the resource ID of the identity resource.
    CustomerManagedKeys string | CustomerManagedKeys
    Whether or not to use a customer managed key when encrypting data at rest
    KeyVaultProperties BookshelfKeyVaultProperties
    The key to use for encrypting data at rest when customer managed keys are enabled. Required if Customer Managed Keys is enabled.
    LogAnalyticsClusterId string
    The Log Analytics Cluster to use for debug logs. This is required when Customer Managed Keys are enabled.
    PrivateEndpointSubnetId string
    Private Endpoint Subnet ID for private endpoint connections.
    PublicNetworkAccess string | PublicNetworkAccess
    Whether or not public network access is allowed for this resource. For security reasons, it is recommended to disable it whenever possible.
    SearchSubnetId string
    Search Subnet ID for search resources.
    WorkloadIdentities []string
    User assigned identity IDs to be used by knowledgebase workloads. The key value must be the resource ID of the identity resource.
    customerManagedKeys String | CustomerManagedKeys
    Whether or not to use a customer managed key when encrypting data at rest
    keyVaultProperties BookshelfKeyVaultProperties
    The key to use for encrypting data at rest when customer managed keys are enabled. Required if Customer Managed Keys is enabled.
    logAnalyticsClusterId String
    The Log Analytics Cluster to use for debug logs. This is required when Customer Managed Keys are enabled.
    privateEndpointSubnetId String
    Private Endpoint Subnet ID for private endpoint connections.
    publicNetworkAccess String | PublicNetworkAccess
    Whether or not public network access is allowed for this resource. For security reasons, it is recommended to disable it whenever possible.
    searchSubnetId String
    Search Subnet ID for search resources.
    workloadIdentities List<String>
    User assigned identity IDs to be used by knowledgebase workloads. The key value must be the resource ID of the identity resource.
    customerManagedKeys string | CustomerManagedKeys
    Whether or not to use a customer managed key when encrypting data at rest
    keyVaultProperties BookshelfKeyVaultProperties
    The key to use for encrypting data at rest when customer managed keys are enabled. Required if Customer Managed Keys is enabled.
    logAnalyticsClusterId string
    The Log Analytics Cluster to use for debug logs. This is required when Customer Managed Keys are enabled.
    privateEndpointSubnetId string
    Private Endpoint Subnet ID for private endpoint connections.
    publicNetworkAccess string | PublicNetworkAccess
    Whether or not public network access is allowed for this resource. For security reasons, it is recommended to disable it whenever possible.
    searchSubnetId string
    Search Subnet ID for search resources.
    workloadIdentities string[]
    User assigned identity IDs to be used by knowledgebase workloads. The key value must be the resource ID of the identity resource.
    customer_managed_keys str | CustomerManagedKeys
    Whether or not to use a customer managed key when encrypting data at rest
    key_vault_properties BookshelfKeyVaultProperties
    The key to use for encrypting data at rest when customer managed keys are enabled. Required if Customer Managed Keys is enabled.
    log_analytics_cluster_id str
    The Log Analytics Cluster to use for debug logs. This is required when Customer Managed Keys are enabled.
    private_endpoint_subnet_id str
    Private Endpoint Subnet ID for private endpoint connections.
    public_network_access str | PublicNetworkAccess
    Whether or not public network access is allowed for this resource. For security reasons, it is recommended to disable it whenever possible.
    search_subnet_id str
    Search Subnet ID for search resources.
    workload_identities Sequence[str]
    User assigned identity IDs to be used by knowledgebase workloads. The key value must be the resource ID of the identity resource.
    customerManagedKeys String | "Enabled" | "Disabled"
    Whether or not to use a customer managed key when encrypting data at rest
    keyVaultProperties Property Map
    The key to use for encrypting data at rest when customer managed keys are enabled. Required if Customer Managed Keys is enabled.
    logAnalyticsClusterId String
    The Log Analytics Cluster to use for debug logs. This is required when Customer Managed Keys are enabled.
    privateEndpointSubnetId String
    Private Endpoint Subnet ID for private endpoint connections.
    publicNetworkAccess String | "Enabled" | "Disabled"
    Whether or not public network access is allowed for this resource. For security reasons, it is recommended to disable it whenever possible.
    searchSubnetId String
    Search Subnet ID for search resources.
    workloadIdentities List<String>
    User assigned identity IDs to be used by knowledgebase workloads. The key value must be the resource ID of the identity resource.

    BookshelfPropertiesResponse, BookshelfPropertiesResponseArgs

    Bookshelf properties
    BookshelfUri string
    The bookshelf data plane API URI
    ManagedOnBehalfOfConfiguration Pulumi.AzureNative.Discovery.Inputs.WithMoboBrokerResourcesResponse
    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 List<Pulumi.AzureNative.Discovery.Inputs.PrivateEndpointConnectionResponse>
    List of private endpoint connections.
    ProvisioningState string
    The status of the last operation.
    CustomerManagedKeys string
    Whether or not to use a customer managed key when encrypting data at rest
    KeyVaultProperties Pulumi.AzureNative.Discovery.Inputs.BookshelfKeyVaultPropertiesResponse
    The key to use for encrypting data at rest when customer managed keys are enabled. Required if Customer Managed Keys is enabled.
    LogAnalyticsClusterId string
    The Log Analytics Cluster to use for debug logs. This is required when Customer Managed Keys are enabled.
    PrivateEndpointSubnetId string
    Private Endpoint Subnet ID for private endpoint connections.
    PublicNetworkAccess string
    Whether or not public network access is allowed for this resource. For security reasons, it is recommended to disable it whenever possible.
    SearchSubnetId string
    Search Subnet ID for search resources.
    WorkloadIdentities Dictionary<string, Pulumi.AzureNative.Discovery.Inputs.UserAssignedIdentityResponse>
    User assigned identity IDs to be used by knowledgebase workloads. The key value must be the resource ID of the identity resource.
    BookshelfUri string
    The bookshelf data plane API URI
    ManagedOnBehalfOfConfiguration WithMoboBrokerResourcesResponse
    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 []PrivateEndpointConnectionResponse
    List of private endpoint connections.
    ProvisioningState string
    The status of the last operation.
    CustomerManagedKeys string
    Whether or not to use a customer managed key when encrypting data at rest
    KeyVaultProperties BookshelfKeyVaultPropertiesResponse
    The key to use for encrypting data at rest when customer managed keys are enabled. Required if Customer Managed Keys is enabled.
    LogAnalyticsClusterId string
    The Log Analytics Cluster to use for debug logs. This is required when Customer Managed Keys are enabled.
    PrivateEndpointSubnetId string
    Private Endpoint Subnet ID for private endpoint connections.
    PublicNetworkAccess string
    Whether or not public network access is allowed for this resource. For security reasons, it is recommended to disable it whenever possible.
    SearchSubnetId string
    Search Subnet ID for search resources.
    WorkloadIdentities map[string]UserAssignedIdentityResponse
    User assigned identity IDs to be used by knowledgebase workloads. The key value must be the resource ID of the identity resource.
    bookshelfUri String
    The bookshelf data plane API URI
    managedOnBehalfOfConfiguration WithMoboBrokerResourcesResponse
    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 List<PrivateEndpointConnectionResponse>
    List of private endpoint connections.
    provisioningState String
    The status of the last operation.
    customerManagedKeys String
    Whether or not to use a customer managed key when encrypting data at rest
    keyVaultProperties BookshelfKeyVaultPropertiesResponse
    The key to use for encrypting data at rest when customer managed keys are enabled. Required if Customer Managed Keys is enabled.
    logAnalyticsClusterId String
    The Log Analytics Cluster to use for debug logs. This is required when Customer Managed Keys are enabled.
    privateEndpointSubnetId String
    Private Endpoint Subnet ID for private endpoint connections.
    publicNetworkAccess String
    Whether or not public network access is allowed for this resource. For security reasons, it is recommended to disable it whenever possible.
    searchSubnetId String
    Search Subnet ID for search resources.
    workloadIdentities Map<String,UserAssignedIdentityResponse>
    User assigned identity IDs to be used by knowledgebase workloads. The key value must be the resource ID of the identity resource.
    bookshelfUri string
    The bookshelf data plane API URI
    managedOnBehalfOfConfiguration WithMoboBrokerResourcesResponse
    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 PrivateEndpointConnectionResponse[]
    List of private endpoint connections.
    provisioningState string
    The status of the last operation.
    customerManagedKeys string
    Whether or not to use a customer managed key when encrypting data at rest
    keyVaultProperties BookshelfKeyVaultPropertiesResponse
    The key to use for encrypting data at rest when customer managed keys are enabled. Required if Customer Managed Keys is enabled.
    logAnalyticsClusterId string
    The Log Analytics Cluster to use for debug logs. This is required when Customer Managed Keys are enabled.
    privateEndpointSubnetId string
    Private Endpoint Subnet ID for private endpoint connections.
    publicNetworkAccess string
    Whether or not public network access is allowed for this resource. For security reasons, it is recommended to disable it whenever possible.
    searchSubnetId string
    Search Subnet ID for search resources.
    workloadIdentities {[key: string]: UserAssignedIdentityResponse}
    User assigned identity IDs to be used by knowledgebase workloads. The key value must be the resource ID of the identity resource.
    bookshelf_uri str
    The bookshelf data plane API URI
    managed_on_behalf_of_configuration WithMoboBrokerResourcesResponse
    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.
    managed_resource_group str
    The resource group for resources managed on behalf of customer.
    private_endpoint_connections Sequence[PrivateEndpointConnectionResponse]
    List of private endpoint connections.
    provisioning_state str
    The status of the last operation.
    customer_managed_keys str
    Whether or not to use a customer managed key when encrypting data at rest
    key_vault_properties BookshelfKeyVaultPropertiesResponse
    The key to use for encrypting data at rest when customer managed keys are enabled. Required if Customer Managed Keys is enabled.
    log_analytics_cluster_id str
    The Log Analytics Cluster to use for debug logs. This is required when Customer Managed Keys are enabled.
    private_endpoint_subnet_id str
    Private Endpoint Subnet ID for private endpoint connections.
    public_network_access str
    Whether or not public network access is allowed for this resource. For security reasons, it is recommended to disable it whenever possible.
    search_subnet_id str
    Search Subnet ID for search resources.
    workload_identities Mapping[str, UserAssignedIdentityResponse]
    User assigned identity IDs to be used by knowledgebase workloads. The key value must be the resource ID of the identity resource.
    bookshelfUri String
    The bookshelf data plane API URI
    managedOnBehalfOfConfiguration Property Map
    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 List<Property Map>
    List of private endpoint connections.
    provisioningState String
    The status of the last operation.
    customerManagedKeys String
    Whether or not to use a customer managed key when encrypting data at rest
    keyVaultProperties Property Map
    The key to use for encrypting data at rest when customer managed keys are enabled. Required if Customer Managed Keys is enabled.
    logAnalyticsClusterId String
    The Log Analytics Cluster to use for debug logs. This is required when Customer Managed Keys are enabled.
    privateEndpointSubnetId String
    Private Endpoint Subnet ID for private endpoint connections.
    publicNetworkAccess String
    Whether or not public network access is allowed for this resource. For security reasons, it is recommended to disable it whenever possible.
    searchSubnetId String
    Search Subnet ID for search resources.
    workloadIdentities Map<Property Map>
    User assigned identity IDs to be used by knowledgebase workloads. The key value must be the resource ID of the identity resource.

    CustomerManagedKeys, CustomerManagedKeysArgs

    Enabled
    Enabled Customer managed keys are enabled.
    Disabled
    Disabled Customer managed keys are disabled.
    CustomerManagedKeysEnabled
    Enabled Customer managed keys are enabled.
    CustomerManagedKeysDisabled
    Disabled Customer managed keys are disabled.
    Enabled
    Enabled Customer managed keys are enabled.
    Disabled
    Disabled Customer managed keys are disabled.
    Enabled
    Enabled Customer managed keys are enabled.
    Disabled
    Disabled Customer managed keys are disabled.
    ENABLED
    Enabled Customer managed keys are enabled.
    DISABLED
    Disabled Customer managed keys are disabled.
    "Enabled"
    Enabled Customer managed keys are enabled.
    "Disabled"
    Disabled Customer managed keys are disabled.

    MoboBrokerResourceResponse, MoboBrokerResourceResponseArgs

    Managed-On-Behalf-Of broker resource. This resource is created by the Resource Provider to manage some resources on behalf of the user.
    Id string
    Resource identifier of a Managed-On-Behalf-Of broker resource
    Id string
    Resource identifier of a Managed-On-Behalf-Of broker resource
    id String
    Resource identifier of a Managed-On-Behalf-Of broker resource
    id string
    Resource identifier of a Managed-On-Behalf-Of broker resource
    id str
    Resource identifier of a Managed-On-Behalf-Of broker resource
    id String
    Resource identifier of a Managed-On-Behalf-Of broker resource

    PrivateEndpointConnectionResponse, PrivateEndpointConnectionResponseArgs

    The private endpoint connection resource.
    GroupIds List<string>
    The group ids for the private endpoint resource.
    Id string
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    Name string
    The name of the resource
    PrivateLinkServiceConnectionState Pulumi.AzureNative.Discovery.Inputs.PrivateLinkServiceConnectionStateResponse
    A collection of information about the state of the connection between service consumer and provider.
    ProvisioningState string
    The provisioning state of the private endpoint connection resource.
    SystemData Pulumi.AzureNative.Discovery.Inputs.SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    Type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    PrivateEndpoint Pulumi.AzureNative.Discovery.Inputs.PrivateEndpointResponse
    The private endpoint resource.
    GroupIds []string
    The group ids for the private endpoint resource.
    Id string
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    Name string
    The name of the resource
    PrivateLinkServiceConnectionState PrivateLinkServiceConnectionStateResponse
    A collection of information about the state of the connection between service consumer and provider.
    ProvisioningState string
    The provisioning state of the private endpoint connection resource.
    SystemData SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    Type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    PrivateEndpoint PrivateEndpointResponse
    The private endpoint resource.
    groupIds List<String>
    The group ids for the private endpoint resource.
    id String
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    name String
    The name of the resource
    privateLinkServiceConnectionState PrivateLinkServiceConnectionStateResponse
    A collection of information about the state of the connection between service consumer and provider.
    provisioningState String
    The provisioning state of the private endpoint connection resource.
    systemData SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type String
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    privateEndpoint PrivateEndpointResponse
    The private endpoint resource.
    groupIds string[]
    The group ids for the private endpoint resource.
    id string
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    name string
    The name of the resource
    privateLinkServiceConnectionState PrivateLinkServiceConnectionStateResponse
    A collection of information about the state of the connection between service consumer and provider.
    provisioningState string
    The provisioning state of the private endpoint connection resource.
    systemData SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    privateEndpoint PrivateEndpointResponse
    The private endpoint resource.
    group_ids Sequence[str]
    The group ids for the private endpoint resource.
    id str
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    name str
    The name of the resource
    private_link_service_connection_state PrivateLinkServiceConnectionStateResponse
    A collection of information about the state of the connection between service consumer and provider.
    provisioning_state str
    The provisioning state of the private endpoint connection resource.
    system_data SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type str
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    private_endpoint PrivateEndpointResponse
    The private endpoint resource.
    groupIds List<String>
    The group ids for the private endpoint resource.
    id String
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    name String
    The name of the resource
    privateLinkServiceConnectionState Property Map
    A collection of information about the state of the connection between service consumer and provider.
    provisioningState String
    The provisioning state of the private endpoint connection resource.
    systemData Property Map
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type String
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    privateEndpoint Property Map
    The private endpoint resource.

    PrivateEndpointResponse, PrivateEndpointResponseArgs

    The private endpoint resource.
    Id string
    The ARM identifier for private endpoint.
    Id string
    The ARM identifier for private endpoint.
    id String
    The ARM identifier for private endpoint.
    id string
    The ARM identifier for private endpoint.
    id str
    The ARM identifier for private endpoint.
    id String
    The ARM identifier for private endpoint.

    PrivateLinkServiceConnectionStateResponse, PrivateLinkServiceConnectionStateResponseArgs

    A collection of information about the state of the connection between service consumer and provider.
    ActionsRequired string
    A message indicating if changes on the service provider require any updates on the consumer.
    Description string
    The reason for approval/rejection of the connection.
    Status string
    Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.
    ActionsRequired string
    A message indicating if changes on the service provider require any updates on the consumer.
    Description string
    The reason for approval/rejection of the connection.
    Status string
    Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.
    actionsRequired String
    A message indicating if changes on the service provider require any updates on the consumer.
    description String
    The reason for approval/rejection of the connection.
    status String
    Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.
    actionsRequired string
    A message indicating if changes on the service provider require any updates on the consumer.
    description string
    The reason for approval/rejection of the connection.
    status string
    Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.
    actions_required str
    A message indicating if changes on the service provider require any updates on the consumer.
    description str
    The reason for approval/rejection of the connection.
    status str
    Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.
    actionsRequired String
    A message indicating if changes on the service provider require any updates on the consumer.
    description String
    The reason for approval/rejection of the connection.
    status String
    Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.

    PublicNetworkAccess, PublicNetworkAccessArgs

    Enabled
    Enabled Public network access is enabled.
    Disabled
    Disabled Public network access is disabled.
    PublicNetworkAccessEnabled
    Enabled Public network access is enabled.
    PublicNetworkAccessDisabled
    Disabled Public network access is disabled.
    Enabled
    Enabled Public network access is enabled.
    Disabled
    Disabled Public network access is disabled.
    Enabled
    Enabled Public network access is enabled.
    Disabled
    Disabled Public network access is disabled.
    ENABLED
    Enabled Public network access is enabled.
    DISABLED
    Disabled Public network access is disabled.
    "Enabled"
    Enabled Public network access is enabled.
    "Disabled"
    Disabled Public network access is disabled.

    SystemDataResponse, SystemDataResponseArgs

    Metadata pertaining to creation and last modification of the resource.
    CreatedAt string
    The timestamp of resource creation (UTC).
    CreatedBy string
    The identity that created the resource.
    CreatedByType string
    The type of identity that created the resource.
    LastModifiedAt string
    The timestamp of resource last modification (UTC)
    LastModifiedBy string
    The identity that last modified the resource.
    LastModifiedByType string
    The type of identity that last modified the resource.
    CreatedAt string
    The timestamp of resource creation (UTC).
    CreatedBy string
    The identity that created the resource.
    CreatedByType string
    The type of identity that created the resource.
    LastModifiedAt string
    The timestamp of resource last modification (UTC)
    LastModifiedBy string
    The identity that last modified the resource.
    LastModifiedByType string
    The type of identity that last modified the resource.
    createdAt String
    The timestamp of resource creation (UTC).
    createdBy String
    The identity that created the resource.
    createdByType String
    The type of identity that created the resource.
    lastModifiedAt String
    The timestamp of resource last modification (UTC)
    lastModifiedBy String
    The identity that last modified the resource.
    lastModifiedByType String
    The type of identity that last modified the resource.
    createdAt string
    The timestamp of resource creation (UTC).
    createdBy string
    The identity that created the resource.
    createdByType string
    The type of identity that created the resource.
    lastModifiedAt string
    The timestamp of resource last modification (UTC)
    lastModifiedBy string
    The identity that last modified the resource.
    lastModifiedByType string
    The type of identity that last modified the resource.
    created_at str
    The timestamp of resource creation (UTC).
    created_by str
    The identity that created the resource.
    created_by_type str
    The type of identity that created the resource.
    last_modified_at str
    The timestamp of resource last modification (UTC)
    last_modified_by str
    The identity that last modified the resource.
    last_modified_by_type str
    The type of identity that last modified the resource.
    createdAt String
    The timestamp of resource creation (UTC).
    createdBy String
    The identity that created the resource.
    createdByType String
    The type of identity that created the resource.
    lastModifiedAt String
    The timestamp of resource last modification (UTC)
    lastModifiedBy String
    The identity that last modified the resource.
    lastModifiedByType String
    The type of identity that last modified the resource.

    UserAssignedIdentityResponse, UserAssignedIdentityResponseArgs

    User assigned identity properties
    ClientId string
    The client ID of the assigned identity.
    PrincipalId string
    The principal ID of the assigned identity.
    ClientId string
    The client ID of the assigned identity.
    PrincipalId string
    The principal ID of the assigned identity.
    clientId String
    The client ID of the assigned identity.
    principalId String
    The principal ID of the assigned identity.
    clientId string
    The client ID of the assigned identity.
    principalId string
    The principal ID of the assigned identity.
    client_id str
    The client ID of the assigned identity.
    principal_id str
    The principal ID of the assigned identity.
    clientId String
    The client ID of the assigned identity.
    principalId String
    The principal ID of the assigned identity.

    WithMoboBrokerResourcesResponse, WithMoboBrokerResourcesResponseArgs

    For tracking mobo resources
    MoboBrokerResources []MoboBrokerResourceResponse
    Managed-On-Behalf-Of broker resources
    moboBrokerResources List<MoboBrokerResourceResponse>
    Managed-On-Behalf-Of broker resources
    moboBrokerResources MoboBrokerResourceResponse[]
    Managed-On-Behalf-Of broker resources
    mobo_broker_resources Sequence[MoboBrokerResourceResponse]
    Managed-On-Behalf-Of broker resources
    moboBrokerResources List<Property Map>
    Managed-On-Behalf-Of broker resources

    Package Details

    Repository
    Azure Native pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native logo
    This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
    Viewing docs for Azure Native v3.16.0
    published on Friday, Mar 20, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-azure-native
      Try Pulumi Cloud free. Your team will thank you.