yujunjun/OpenMetadata
1
0
Fork 0
mirror of https://github.com/open-metadata/OpenMetadata.git synced 2025-08-19 06:28:03 +00:00
Code Issues Packages Projects Releases Wiki Activity

Docs: Azure Partial Creation and Addition (#20363)

Browse Source
This commit is contained in:
Rounak Dhillon 2025-03-24 09:57:06 +05:30 committed by GitHub
parent d1ecf60acb
commit d9923d0c42
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
10 changed files with 111 additions and 273 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

36
openmetadata-docs/content/partials/v1.6/connectors/yaml/common/azure-config-def.md Normal file
View File

@ -0,0 +1,36 @@
{% codeInfo srNumber=163 %}
- **Client ID**: This is the unique identifier for your application registered in Azure AD. It’s used in conjunction with the Client Secret to authenticate your application.
- **Client Secret**: A key that your application uses, along with the Client ID, to access Azure resources.
1. Log into [Microsoft Azure](https://ms.portal.azure.com/#allservices).
2. Search for `App registrations` and select the `App registrations link`.
3. Select the `Azure AD` app you're using for this connection.
4. Under `Manage`, select `Certificates & secrets`.
5. Under `Client secrets`, select `New client secret`.
6. In the `Add a client secret` pop-up window, provide a description for your application secret. Choose when the application should expire, and select `Add`.
7. From the `Client secrets` section, copy the string in the `Value` column of the newly created application secret.
- **Tenant ID**: The unique identifier of the Azure AD instance under which your account and application are registered.
To get the tenant ID, follow these steps:
1. Log into [Microsoft Azure](https://ms.portal.azure.com/#allservices).
2. Search for `App registrations` and select the `App registrations link`.
3. Select the `Azure AD` app you're using for Power BI.
4. From the `Overview` section, copy the `Directory (tenant) ID`.
- **Account Name**: The name of your ADLS account.
Here are the step-by-step instructions for finding the account name for an Azure Data Lake Storage account:
1. Sign in to the Azure portal and navigate to the `Storage accounts` page.
2. Find the Data Lake Storage account you want to access and click on its name.
3. In the account overview page, locate the `Account name` field. This is the unique identifier for the Data Lake Storage account.
4. You can use this account name to access and manage the resources associated with the account, such as creating and managing containers and directories.
- **Key Vault**: Azure Key Vault serves as a centralized secrets manager, securely storing and managing sensitive information, such as connection strings and cryptographic keys.
{% /codeInfo %}

7
openmetadata-docs/content/partials/v1.6/connectors/yaml/common/azure-config.md Normal file
View File

@ -0,0 +1,7 @@
```yaml {% srNumber=163 %}
clientId: client-id
clientSecret: client-secret
tenantId: tenant-id
accountName: account-name
vaultName: vault-name
```

36
openmetadata-docs/content/partials/v1.7/connectors/yaml/common/azure-config-def.md Normal file
View File

@ -0,0 +1,36 @@
{% codeInfo srNumber=163 %}
- **Client ID**: This is the unique identifier for your application registered in Azure AD. It’s used in conjunction with the Client Secret to authenticate your application.
- **Client Secret**: A key that your application uses, along with the Client ID, to access Azure resources.
1. Log into [Microsoft Azure](https://ms.portal.azure.com/#allservices).
2. Search for `App registrations` and select the `App registrations link`.
3. Select the `Azure AD` app you're using for this connection.
4. Under `Manage`, select `Certificates & secrets`.
5. Under `Client secrets`, select `New client secret`.
6. In the `Add a client secret` pop-up window, provide a description for your application secret. Choose when the application should expire, and select `Add`.
7. From the `Client secrets` section, copy the string in the `Value` column of the newly created application secret.
- **Tenant ID**: The unique identifier of the Azure AD instance under which your account and application are registered.
To get the tenant ID, follow these steps:
1. Log into [Microsoft Azure](https://ms.portal.azure.com/#allservices).
2. Search for `App registrations` and select the `App registrations link`.
3. Select the `Azure AD` app you're using for Power BI.
4. From the `Overview` section, copy the `Directory (tenant) ID`.
- **Account Name**: The name of your ADLS account.
Here are the step-by-step instructions for finding the account name for an Azure Data Lake Storage account:
1. Sign in to the Azure portal and navigate to the `Storage accounts` page.
2. Find the Data Lake Storage account you want to access and click on its name.
3. In the account overview page, locate the `Account name` field. This is the unique identifier for the Data Lake Storage account.
4. You can use this account name to access and manage the resources associated with the account, such as creating and managing containers and directories.
- **Key Vault**: Azure Key Vault serves as a centralized secrets manager, securely storing and managing sensitive information, such as connection strings and cryptographic keys.
{% /codeInfo %}

7
openmetadata-docs/content/partials/v1.7/connectors/yaml/common/azure-config.md Normal file
View File

@ -0,0 +1,7 @@
```yaml {% srNumber=163 %}
clientId: client-id
clientSecret: client-secret
tenantId: tenant-id
accountName: account-name
vaultName: vault-name
```

18
openmetadata-docs/content/v1.6.x/connectors/database/adls-datalake/yaml.md
View File

@ -58,15 +58,7 @@ The workflow is modeled around the following JSON Schema.
#### Source Configuration - Service Connection
{% codeInfo srNumber=9 %}
- **Client ID** : Client ID of the data storage account
- **Client Secret** : Client Secret of the account
- **Tenant ID** : Tenant ID under which the data storage account falls
- **Account Name** : Account Name of the data Storage
{% /codeInfo %}
{% partial file="/v1.6/connectors/yaml/common/azure-config-def.md" /%}
{% partial file="/v1.6/connectors/yaml/database/source-config-def.md" /%}
@ -87,13 +79,11 @@ source:
config:
type: Datalake
configSource:
securityConfig:
```
{% partial file="/v1.6/connectors/yaml/common/azure-config.md" /%}
```yaml {% srNumber=9 %}
securityConfig:
clientId: client-id
clientSecret: client-secret
tenantId: tenant-id
accountName: account-name
prefix: prefix
```

66
openmetadata-docs/content/v1.6.x/connectors/pipeline/datafactory/yaml.md
View File

@ -68,56 +68,7 @@ This is a sample config for Data Factory:
#### Source Configuration - Service Connection
{% codeInfo srNumber=1 %}
**clientId**: To get the Client ID (also known as application ID), follow these steps:
1. Log into [Microsoft Azure](https://ms.portal.azure.com/#allservices).
2. Search for `App registrations` and select the `App registrations link`.
3. Select the `Azure AD` app you're using for this connection.
4. From the Overview section, copy the `Application (client) ID`.
{% /codeInfo %}
{% codeInfo srNumber=2 %}
**clientSecret**: To get the client secret, follow these steps:
1. Log into [Microsoft Azure](https://ms.portal.azure.com/#allservices).
2. Search for `App registrations` and select the `App registrations link`.
3. Select the `Azure AD` app you're using for this connection.
4. Under `Manage`, select `Certificates & secrets`.
5. Under `Client secrets`, select `New client secret`.
6. In the `Add a client secret` pop-up window, provide a description for your application secret. Choose when the application should expire, and select `Add`.
7. From the `Client secrets` section, copy the string in the `Value` column of the newly created application secret.
{% /codeInfo %}
{% codeInfo srNumber=3 %}
**tenantId**: To get the tenant ID, follow these steps:
1. Log into [Microsoft Azure](https://ms.portal.azure.com/#allservices).
2. Search for `App registrations` and select the `App registrations link`.
3. Select the `Azure AD` app you're using for Power BI.
4. From the `Overview` section, copy the `Directory (tenant) ID`.
{% /codeInfo %}
{% codeInfo srNumber=4 %}
**accountName**: Here are the step-by-step instructions for finding the account name for an Azure Data Lake Storage account:
1. Sign in to the Azure portal and navigate to the `Storage accounts` page.
2. Find the Data Lake Storage account you want to access and click on its name.
3. In the account overview page, locate the `Account name` field. This is the unique identifier for the Data Lake Storage account.
4. You can use this account name to access and manage the resources associated with the account, such as creating and managing containers and directories.
{% /codeInfo %}
{% partial file="/v1.6/connectors/yaml/common/azure-config-def.md" /%}
{% codeInfo srNumber=5 %}
@ -167,18 +118,9 @@ source:
type: DataFactory
configSource:
```
```yaml {% srNumber=1 %}
clientId: client_id
```
```yaml {% srNumber=2 %}
clientSecret: client_secret
```
```yaml {% srNumber=3 %}
tenantId: tenant_id
```
```yaml {% srNumber=4 %}
accountName: account_name
```
{% partial file="/v1.6/connectors/yaml/common/azure-config.md" /%}
```yaml {% srNumber=5 %}
subscription_id: subscription_id
```

64
openmetadata-docs/content/v1.6.x/connectors/storage/adls/yaml.md
View File

@ -70,51 +70,7 @@ This is a sample config for Athena:
#### Source Configuration - Service Connection
{% codeInfo srNumber=1 %}
- **Client ID**: This is the unique identifier for your application registered in Azure AD. It’s used in conjunction with the Client Secret to authenticate your application.
{% /codeInfo %}
{% codeInfo srNumber=2 %}
- **Client Secret**: A key that your application uses, along with the Client ID, to access Azure resources.
1. Log into [Microsoft Azure](https://ms.portal.azure.com/#allservices).
2. Search for `App registrations` and select the `App registrations link`.
3. Select the `Azure AD` app you're using for this connection.
4. Under `Manage`, select `Certificates & secrets`.
5. Under `Client secrets`, select `New client secret`.
6. In the `Add a client secret` pop-up window, provide a description for your application secret. Choose when the application should expire, and select `Add`.
7. From the `Client secrets` section, copy the string in the `Value` column of the newly created application secret.
{% /codeInfo %}
{% codeInfo srNumber=3 %}
- **Tenant ID**: The unique identifier of the Azure AD instance under which your account and application are registered.
To get the tenant ID, follow these steps:
1. Log into [Microsoft Azure](https://ms.portal.azure.com/#allservices).
2. Search for `App registrations` and select the `App registrations link`.
3. Select the `Azure AD` app you're using for Power BI.
4. From the `Overview` section, copy the `Directory (tenant) ID`.
{% /codeInfo %}
{% codeInfo srNumber=4 %}
- **Account Name**: The name of your ADLS account.
Here are the step-by-step instructions for finding the account name for an Azure Data Lake Storage account:
1. Sign in to the Azure portal and navigate to the `Storage accounts` page.
2. Find the Data Lake Storage account you want to access and click on its name.
3. In the account overview page, locate the `Account name` field. This is the unique identifier for the Data Lake Storage account.
4. You can use this account name to access and manage the resources associated with the account, such as creating and managing containers and directories.
{% /codeInfo %}
{% codeInfo srNumber=5 %}
- **Key Vault**: Azure Key Vault serves as a centralized secrets manager, securely storing and managing sensitive information, such as connection strings and cryptographic keys.
{% /codeInfo %}
{% partial file="/v1.6/connectors/yaml/common/azure-config-def.md" /%}
{% partial file="/v1.6/connectors/yaml/storage/source-config-def.md" /%}
@ -149,21 +105,9 @@ source:
type: ADLS
credentials:
```
```yaml {% srNumber=1 %}
clientId: client-id
```
```yaml {% srNumber=2 %}
clientSecret: client-secret
```
```yaml {% srNumber=3 %}
tenantId: tenant-id
```
```yaml {% srNumber=4 %}
accountName: account-name
```
```yaml {% srNumber=5 %}
vaultName: vault-name
```
{% partial file="/v1.6/connectors/yaml/common/azure-config.md" /%}
```yaml {% srNumber=6 %}
# connectionOptions:
# key: value

20
openmetadata-docs/content/v1.7.x-SNAPSHOT/connectors/database/adls-datalake/yaml.md
View File

@ -58,15 +58,7 @@ The workflow is modeled around the following JSON Schema.
#### Source Configuration - Service Connection
{% codeInfo srNumber=9 %}
- **Client ID** : Client ID of the data storage account
- **Client Secret** : Client Secret of the account
- **Tenant ID** : Tenant ID under which the data storage account falls
- **Account Name** : Account Name of the data Storage
{% /codeInfo %}
{% partial file="/v1.7/connectors/yaml/common/azure-config-def.md" /%}
{% partial file="/v1.7/connectors/yaml/database/source-config-def.md" /%}
@ -86,14 +78,12 @@ source:
serviceConnection:
config:
type: Datalake
configSource:
configSource:
securityConfig:
```
{% partial file="/v1.7/connectors/yaml/common/azure-config.md" /%}
```yaml {% srNumber=9 %}
securityConfig:
clientId: client-id
clientSecret: client-secret
tenantId: tenant-id
accountName: account-name
prefix: prefix
```

66
openmetadata-docs/content/v1.7.x-SNAPSHOT/connectors/pipeline/datafactory/yaml.md
View File

@ -68,56 +68,7 @@ This is a sample config for Data Factory:
#### Source Configuration - Service Connection
{% codeInfo srNumber=1 %}
**clientId**: To get the Client ID (also known as application ID), follow these steps:
1. Log into [Microsoft Azure](https://ms.portal.azure.com/#allservices).
2. Search for `App registrations` and select the `App registrations link`.
3. Select the `Azure AD` app you're using for this connection.
4. From the Overview section, copy the `Application (client) ID`.
{% /codeInfo %}
{% codeInfo srNumber=2 %}
**clientSecret**: To get the client secret, follow these steps:
1. Log into [Microsoft Azure](https://ms.portal.azure.com/#allservices).
2. Search for `App registrations` and select the `App registrations link`.
3. Select the `Azure AD` app you're using for this connection.
4. Under `Manage`, select `Certificates & secrets`.
5. Under `Client secrets`, select `New client secret`.
6. In the `Add a client secret` pop-up window, provide a description for your application secret. Choose when the application should expire, and select `Add`.
7. From the `Client secrets` section, copy the string in the `Value` column of the newly created application secret.
{% /codeInfo %}
{% codeInfo srNumber=3 %}
**tenantId**: To get the tenant ID, follow these steps:
1. Log into [Microsoft Azure](https://ms.portal.azure.com/#allservices).
2. Search for `App registrations` and select the `App registrations link`.
3. Select the `Azure AD` app you're using for Power BI.
4. From the `Overview` section, copy the `Directory (tenant) ID`.
{% /codeInfo %}
{% codeInfo srNumber=4 %}
**accountName**: Here are the step-by-step instructions for finding the account name for an Azure Data Lake Storage account:
1. Sign in to the Azure portal and navigate to the `Storage accounts` page.
2. Find the Data Lake Storage account you want to access and click on its name.
3. In the account overview page, locate the `Account name` field. This is the unique identifier for the Data Lake Storage account.
4. You can use this account name to access and manage the resources associated with the account, such as creating and managing containers and directories.
{% /codeInfo %}
{% partial file="/v1.7/connectors/yaml/common/azure-config-def.md" /%}
{% codeInfo srNumber=5 %}
@ -167,18 +118,9 @@ source:
type: DataFactory
configSource:
```
```yaml {% srNumber=1 %}
clientId: client_id
```
```yaml {% srNumber=2 %}
clientSecret: client_secret
```
```yaml {% srNumber=3 %}
tenantId: tenant_id
```
```yaml {% srNumber=4 %}
accountName: account_name
```
{% partial file="/v1.7/connectors/yaml/common/azure-config.md" /%}
```yaml {% srNumber=5 %}
subscription_id: subscription_id
```

64
openmetadata-docs/content/v1.7.x-SNAPSHOT/connectors/storage/adls/yaml.md
View File

@ -70,51 +70,7 @@ This is a sample config for Athena:
#### Source Configuration - Service Connection
{% codeInfo srNumber=1 %}
- **Client ID**: This is the unique identifier for your application registered in Azure AD. It’s used in conjunction with the Client Secret to authenticate your application.
{% /codeInfo %}
{% codeInfo srNumber=2 %}
- **Client Secret**: A key that your application uses, along with the Client ID, to access Azure resources.
1. Log into [Microsoft Azure](https://ms.portal.azure.com/#allservices).
2. Search for `App registrations` and select the `App registrations link`.
3. Select the `Azure AD` app you're using for this connection.
4. Under `Manage`, select `Certificates & secrets`.
5. Under `Client secrets`, select `New client secret`.
6. In the `Add a client secret` pop-up window, provide a description for your application secret. Choose when the application should expire, and select `Add`.
7. From the `Client secrets` section, copy the string in the `Value` column of the newly created application secret.
{% /codeInfo %}
{% codeInfo srNumber=3 %}
- **Tenant ID**: The unique identifier of the Azure AD instance under which your account and application are registered.
To get the tenant ID, follow these steps:
1. Log into [Microsoft Azure](https://ms.portal.azure.com/#allservices).
2. Search for `App registrations` and select the `App registrations link`.
3. Select the `Azure AD` app you're using for Power BI.
4. From the `Overview` section, copy the `Directory (tenant) ID`.
{% /codeInfo %}
{% codeInfo srNumber=4 %}
- **Account Name**: The name of your ADLS account.
Here are the step-by-step instructions for finding the account name for an Azure Data Lake Storage account:
1. Sign in to the Azure portal and navigate to the `Storage accounts` page.
2. Find the Data Lake Storage account you want to access and click on its name.
3. In the account overview page, locate the `Account name` field. This is the unique identifier for the Data Lake Storage account.
4. You can use this account name to access and manage the resources associated with the account, such as creating and managing containers and directories.
{% /codeInfo %}
{% codeInfo srNumber=5 %}
- **Key Vault**: Azure Key Vault serves as a centralized secrets manager, securely storing and managing sensitive information, such as connection strings and cryptographic keys.
{% /codeInfo %}
{% partial file="/v1.7/connectors/yaml/common/azure-config-def.md" /%}
{% partial file="/v1.7/connectors/yaml/storage/source-config-def.md" /%}
@ -149,21 +105,9 @@ source:
type: ADLS
credentials:
```
```yaml {% srNumber=1 %}
clientId: client-id
```
```yaml {% srNumber=2 %}
clientSecret: client-secret
```
```yaml {% srNumber=3 %}
tenantId: tenant-id
```
```yaml {% srNumber=4 %}
accountName: account-name
```
```yaml {% srNumber=5 %}
vaultName: vault-name
```
{% partial file="/v1.7/connectors/yaml/common/azure-config.md" /%}
```yaml {% srNumber=6 %}
# connectionOptions:
# key: value