ben.carrasco/prowler
1
0
Fork 0
mirror of https://github.com/prowler-cloud/prowler.git synced 2026-07-24 13:01:56 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs(azure): improve docstrings (#5715)

Browse Source
This commit is contained in:
Pedro Martín
2024-11-18 10:46:34 +01:00
committed by GitHub
parent 78b518e22b
commit 0d01790b22
1 changed files with 62 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
prowler/providers/azure/azure_provider.py
+62
View File
@@ -152,6 +152,68 @@ class AzureProvider(Provider):
AzureConfigCredentialsError: If there is an error in configuring the Azure credentials from a dictionary.
AzureGetTokenIdentityError: If there is an error in getting the token from the Azure identity.
AzureHTTPResponseError: If there is an HTTP response error.
Usage:
- Authentication: By default Prowler uses Azure Python SDK identity package authentication methods using the classes DefaultAzureCredential and InteractiveBrowserCredential.
- Using static credentials:
>>> AzureProvider(
... az_cli_auth=False,
... sp_env_auth=False,
... browser_auth=False,
... managed_identity_auth=False,
... tenant_id="XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
... client_id="XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
... client_secret="XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
... )
- Using Azure CLI authentication:
>>> AzureProvider(
... az_cli_auth=True,
... sp_env_auth=False,
... browser_auth=False,
... managed_identity_auth=False,
... )
- Using Service Principal environment authentication:
>>> AzureProvider(
... az_cli_auth=False,
... sp_env_auth=True,
... browser_auth=False,
... managed_identity_auth=False,
... )
- Using interactive browser authentication:
>>> AzureProvider(
... az_cli_auth=False,
... sp_env_auth=False,
... browser_auth=True,
... managed_identity_auth=False,
... tenant_id="XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
... )
* Note: Azure Tenant ID is required for browser authentication mode.
- Using managed identity authentication:
>>> AzureProvider(
... az_cli_auth=False,
... sp_env_auth=False,
... browser_auth=False,
... managed_identity_auth=True,
... )
- Non default azure region: Microsoft provides clouds for compliance with regional laws, which are available for your use. By default, Prowler uses AzureCloud cloud which is the comercial one.
If you want to use a different one, you can specify it using the region parameter.
>>> AzureProvider(
... az_cli_auth=False,
... sp_env_auth=True,
... browser_auth=False,
... managed_identity_auth=False,
... region="AzureUSGovernment",
... )
- Subscriptions: rowler is multisubscription, which means that is going to scan all the subscriptions is able to list. If you only assign permissions to one subscription, it is going to scan a single one.
Prowler also allows you to specify the subscriptions you want to scan by passing a list of subscription IDs.
>>> AzureProvider(
... az_cli_auth=False,
... sp_env_auth=True,
... browser_auth=False,
... managed_identity_auth=False,
... subscription_ids=["XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX"],
... )
"""
logger.info("Setting Azure provider ...")