Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
20 commits
Select commit Hold shift + click to select a range
25b4689
chore: update version references; add tabs for auth methods
jeff-matthews Nov 7, 2025
538326e
docs: updates based on semi-successful config
jeff-matthews Nov 14, 2025
9b058dd
chore: editorial notes
jeff-matthews Nov 14, 2025
f50d321
docs: rewrite app registration and ms graph permissions
jeff-matthews Nov 18, 2025
ca0dbd7
docs: remove optional branding steps
jeff-matthews Nov 18, 2025
4299fee
chore: segment assign required access roles sections
jeff-matthews Nov 18, 2025
e52c654
chore: delete obsolete editorial note
jeff-matthews Dec 2, 2025
8f0dc6f
chore: formatting
jeff-matthews Dec 2, 2025
ffd73c8
docs: add placeholder sections for managed ID config
jeff-matthews Dec 2, 2025
4aedb0b
docs: clarify prerequisites
jeff-matthews Dec 2, 2025
379dffe
chore: remove VM note
jeff-matthews Dec 2, 2025
e238c10
chore: fix snippet file name and imports
jeff-matthews Dec 2, 2025
ff630a2
chore: fix typo
jeff-matthews Dec 2, 2025
bc4b0cd
Merge branch 'main' into BED-6715-managed-id-auth-method
jeff-matthews Jan 26, 2026
17dbac3
Merge branch 'main' into BED-6715-managed-id-auth-method
jeff-matthews May 13, 2026
9157f2e
chore: restore optional branding section since it's part of the ps sc…
jeff-matthews May 13, 2026
d15d578
chore: add missing image alt text
jeff-matthews May 13, 2026
7283670
docs: apply suggestions based on codex audit
jeff-matthews May 13, 2026
934ac6d
docs: apply suggestions from augment audit
jeff-matthews May 13, 2026
3a2da05
docs: apply suggestino from CR review
jeff-matthews May 13, 2026
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file removed docs/assets/azurehound-install-app-registrations.png
Binary file not shown.
Binary file removed docs/assets/image-103.png
Binary file not shown.
Binary file removed docs/assets/image-106.png
Binary file not shown.
Binary file removed docs/assets/image-108.png
Binary file not shown.
Binary file removed docs/assets/image-111.png
Binary file not shown.
Binary file removed docs/assets/image-113.png
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed docs/images/data_collectors/grant_admin_consent.png
Binary file not shown.
528 changes: 358 additions & 170 deletions docs/install-data-collector/install-azurehound/azure-configuration.mdx

Large diffs are not rendered by default.

159 changes: 109 additions & 50 deletions docs/install-data-collector/install-azurehound/create-configuration.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,37 +3,44 @@ title: Create an AzureHound Configuration
description: Learn how to create a configuration file for AzureHound Enterprise data collection.
---

import ManagedIdentityRecommendation from '/snippets/hounds/managed-id-recommendation.mdx';

<img noZoom src="/assets/enterprise-edition-pill-tag.svg" alt="Applies to BloodHound Enterprise only"/>

## Prerequisites

To complete the configuration process, you must have the following information:

| Item | Description |
| --- | --- |
| Directory (tenant) ID | Identifies the Microsoft Entra ID instance where you must [register](/install-data-collector/install-azurehound/azure-configuration) the AzureHound Enterprise application. |
| Application (client) ID | Identifies the AzureHound Enterprise [app registration](/install-data-collector/install-azurehound/azure-configuration) that you must create in the Microsoft Entra admin center. |
| AzureHound token ID | Identifies the AzureHound Enterprise [collector client](/collect-data/enterprise-collection/create-collector) that you must create in BloodHound Enterprise. |
| AzureHound token | Provides the authentication key for the AzureHound Enterprise [collector client](/collect-data/enterprise-collection/create-collector) that you must create in BloodHound Enterprise. |
| **Directory (tenant) ID** | Identifies the Microsoft Entra ID instance where you must [register](/install-data-collector/install-azurehound/azure-configuration) the AzureHound Enterprise application. |
| **Application (client) ID** | Identifies the AzureHound Enterprise [app registration](/install-data-collector/install-azurehound/azure-configuration) that you must create in the Microsoft Entra admin center. |
| **AzureHound token ID** | Identifies the AzureHound Enterprise [collector client](/collect-data/enterprise-collection/create-collector) that you must create in BloodHound Enterprise. |
| **AzureHound token** | Provides the authentication key for the AzureHound Enterprise [collector client](/collect-data/enterprise-collection/create-collector) that you must create in BloodHound Enterprise. |
| **BloodHound Enterprise URL** | The URL of your BloodHound Enterprise tenant (for example, `https://<your-tenant>.bloodhoundenterprise.io/`). |
| **Managed Identity Client ID** | If using [Azure Managed Identity](/install-data-collector/install-azurehound/azure-configuration#managed-identity-recommended) authentication, identifies the managed identity that the AzureHound Enterprise app registration trusts and that is assigned to the Azure resource where you run AzureHound Enterprise. |
| **Certificate and private key** | If using [Certificate](/install-data-collector/install-azurehound/azure-configuration#certificate) authentication, the certificate and private key used to authenticate the AzureHound Enterprise application. The AzureHound Enterprise CLI tool can generate this for you during the configuration process if needed. |

Configuring AzureHound Enterprise involves the following steps:

```mermaid
flowchart LR
subgraph Review
f(Configuration
Summary)
subgraph Download
a(AzureHound
Enterprise)
end
subgraph Configure
d-->e(AzureHound
logging)
c-->d(AzureHound
collector client)
b(Azure
b(Azure
connection)-->c(AzureHound
authentication)
c-->d(AzureHound
collector client)
d-->e(AzureHound
logging)
end
subgraph Download
a(AzureHound
Enterprise)
subgraph Review
f(Configuration
Summary)
end
Download-->Configure-->Review
```
Expand Down Expand Up @@ -92,51 +99,103 @@ Follow the steps below to create your AzureHound Enterprise configuration file u
</Step>

<Step title="Configure AzureHound authentication">
1. Select a method for authenticating AzureHound Enterprise to BloodHound Enterprise.
Choose one of the following authentication methods for AzureHound Enterprise to connect to your Microsoft Entra ID and Azure environment:

<Note>We **highly** recommend certificate-based authentication.</Note>
<Tabs>
<Tab title="Azure Managed Identity" icon="key">

```text
Use the arrow keys to navigate: ↓ ↑ ← →
? Authentication Method:
> Certificate
Client Secret
Username and Password
```
<ManagedIdentityRecommendation />

1. If using Certificate authentication, press **Enter** or type `Y` to create a new certificate and key.
Before configuring Azure Managed Identity authentication, you must first create a [user-assigned managed identity](/install-data-collector/install-azurehound/azure-configuration#managed-identity-recommended), assign it to the Azure resource where you plan to run AzureHound Enterprise, and configure the AzureHound Enterprise app registration to trust that identity.

```text
Authentication Method: Certificate
? Generate Certificate and Key? [Y/n]
```
1. Select **Azure Managed Identity** as the authentication method.

```text
Use the arrow keys to navigate: ↓ ↑ ← →
? Authentication Method:
Certificate
Client Secret
Username and Password
> Azure Managed Identity
```

1. Select **User-Assigned** as the Managed Identity type.

```text
Use the arrow keys to navigate: ↓ ↑ ← →
? Managed Identity Type:
System-Assigned
> User-Assigned
```

1. Enter the **Client ID** of the User-Assigned Managed Identity.

```text
v Input the User-Assigned Managed Identity (Client ID):
```

<Note>To find the Client ID, navigate to the Managed Identity in the Azure portal and copy the value from the **Client ID** field in the Overview.</Note>

1. Press **Enter** (or enter `Y`) to connect to BloodHound Enterprise.

<Note>
- The certificate generated by AzureHound expires after one year.
- If using a certificate issued by another authority, AzureHound Enterprise supports certificates with the following characteristics:
- PEM encoded
- RSA 256
- PKCS#8 or PKCS#5
</Note>
```text
? Setup connection to BloodHound Enterprise? [Y/n]
```

1. If using Certificate authentication, enter an optional passphrase for the private key.
1. Enter the URL of your BloodHound Enterprise tenant.

```text
v BloodHound Enterprise URL: https://<your-tenant>.bloodhoundenterprise.io/
```
</Tab>

<Tab title="Certificate" icon="file-certificate">
1. Select **Certificate** as the authentication method.

```text
Use the arrow keys to navigate: ↓ ↑ ← →
? Authentication Method:
> Certificate
Client Secret
Username and Password
Azure Managed Identity
```

1. Press **Enter** or type `Y` to create a new certificate and key.

```text
Authentication Method: Certificate
? Generate Certificate and Key? [Y/n]
```

<Note>
- The certificate generated by AzureHound expires after one year.
- If using a certificate issued by another authority, AzureHound Enterprise supports certificates with the following characteristics:
- PEM encoded
- RSA 256
- PKCS#8 or PKCS#5
</Note>

1. Enter an optional passphrase for the private key.

```text
Authentication Method: Certificate
v Private Key Passphrase (optional):
```
```text
Authentication Method: Certificate
v Private Key Passphrase (optional):
```

1. Press **Enter** (or enter `Y`) to connect to BloodHound Enterprise.
1. Press **Enter** (or enter `Y`) to connect to BloodHound Enterprise.

```text
? Setup connection to BloodHound Enterprise? [Y/n]
```
```text
? Setup connection to BloodHound Enterprise? [Y/n]
```

1. Enter the URL of your BloodHound Enterprise tenant.
1. Enter the URL of your BloodHound Enterprise tenant.

```text
v BloodHound Enterprise URL: https://enterprise.bloodhoundenterprise.io/
```
```text
v BloodHound Enterprise URL: https://<your-tenant>.bloodhoundenterprise.io/
```
</Tab>
</Tabs>
</Step>

<Step title="Configure AzureHound collector client">
Expand Down Expand Up @@ -212,6 +271,6 @@ Follow the steps below to create your AzureHound Enterprise configuration file u
Ensure certificate is uploaded to your application's client credentials
```

<Note>If you are using Certificate authentication, the summary also includes the location of the certificate to complete the configuration in Azure.</Note>
<Note>The example above shows the summary for Certificate authentication. For Azure Managed Identity authentication, the summary omits the key and certificate paths and the certificate upload reminder.</Note>
</Step>
</Steps>
1 change: 1 addition & 0 deletions docs/snippets/hounds/managed-id-recommendation.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Microsoft [recommends](https://learn.microsoft.com/en-us/entra/identity/managed-identities-azure-resources/overview#use-managed-identities-for-azure-resources) user-assigned managed identities for Microsoft services, so this example uses the **user-assigned** type. AzureHound Enterprise also supports system-assigned managed identities, but that workflow is not covered in this guide.
Loading