Dataverse Linked Service doesn't get export in ADF ARM Template

Question

Dataverse Linked Service doesn't get export in ADF ARM Template

Diana Rus 55

Hi,

I have a CICD pipeline in ADO for ADF. I have a Dataverse linked service that needs to be connected to different environment depending in which ADF we're in (Dev for Dev, UAT for UAT, prod for prod). The dataverse linked service properties don't appear in the ARM template for me to parameterize in the release pipeline in ADO. How do I add them in the ARM template?

Amira Bedhiafi 33,071 Reputation points Volunteer Moderator

2024-10-24T18:50:54.88+00:00
To include the Dataverse linked service properties in the ARM template for ADF and parameterize them in your release pipeline, follow these steps:

Check Export Settings: Ensure you have selected the option to export your ADF components, including linked services, when generating the ARM template. Typically, the ARM template export includes the linked services, datasets, and pipelines, but this needs to be configured correctly during the export.

Manually Add Linked Service to ARM Template:

If the Dataverse linked service is not being exported, you can manually add the linked service definition in the ARM template.

Locate the linkedServices section in the ARM template JSON.

Add the JSON representation of your Dataverse linked service, following this pattern:
{ "name": "LinkedServiceName", "properties": { "type": "Dataverse", "typeProperties": { "environmentUrl": { "value": "@{parameters('environmentUrl')}" }, "servicePrincipalId": { "value": "@{parameters('servicePrincipalId')}" }, "tenant": { "value": "@{parameters('tenantId')}" } } } }

Parameterize Linked Service Properties:

In your ARM template, parameterize the fields like environmentUrl, servicePrincipalId, and tenantId.

Add these parameters to the parameters section of your ARM template:
"parameters": { "environmentUrl": { "type": "string" }, "servicePrincipalId": { "type": "string" }, "tenantId": { "type": "string" } }

Modify your CICD Pipeline:

In your ADO pipeline, modify the release pipeline to pass different values for these parameters based on the target environment (Dev, UAT, or Prod).

This can be done by setting up different variable groups or using pipeline stages with environment-specific variables.

Test: After modifying the ARM template and the pipeline, test to ensure that during deployment, the appropriate values are being injected into the Dataverse linked service based on the environment.

This approach will allow you to handle the different environments dynamically by setting up appropriate parameters and ensuring that the linked service is defined and parameterized in the ARM template.

Diana Rus 55

Hi Amira,

Thank you for that. The linked service section in my arm template, currently looks like below, adding Dataverse as above doesn't let me save the json.

 "Microsoft.DataFactory/factories/linkedServices": {
        "*": {
            "properties": {
                "typeProperties": {
                    "accountName": "=",
                    "accountEndpoint": "=",
                    "username": "=",
                    "userName": "=",
                    "accessKeyId": "=",
                    "endpoint": "=",
                    "servicePrincipalId": "=",
                    "userId": "=",
                    "host": "=",
                    "clientId": "=",
                    "existingClusterId": "=",
                    "clusterUserName": "=",
                    "clusterSshUserName": "=",
                    "hostSubscriptionId": "=",
                    "clusterResourceGroup": "=",
                    "subscriptionId": "=",
                    "resourceGroupName": "=",
                    "tenant": "=",
                    "dataLakeStoreUri": "=",
                    "baseUrl": "=",
                    "database": "=",
                    "serviceEndpoint": "=",
                    "batchUri": "=",
                    "poolName": "=",
                    "databaseName": "=",
                    "systemNumber": "=",
                    "server": "=",
                    "url": "=",
                    "functionAppUrl": "=",
                    "environmentUrl": "=",
                    "aadResourceId": "=",
                    "sasUri": "|:-sasUri:secureString",
                    "sasToken": "|",
                    "connectionString": "|:-connectionString:secureString",
                    "hostKeyFingerprint": "=",
                    "mlWorkspaceName": "=",
                    "servicePrincipalCredential": {
                        "secretName": "="
                    }
                }
            }
        },
        "Odbc": {
            "properties": {
                "typeProperties": {
                    "userName": "=",
                    "connectionString": {
                        "secretName": "="
                    }
                }
            }
        }

Smaran Thoomu 24,110 Reputation points Microsoft External Staff Moderator

2024-10-25T13:20:00.05+00:00
@Diana Rus It sounds like the JSON structure of your ARM template may not match the expected format for adding a Dataverse Linked Service manually. Here are some adjustments to help you add Dataverse in a compatible way:

Modify the linkedServices section to include Dataverse properties specifically. Ensure each required property is listed as follows:

{ "name": "YourDataverseLinkedService", "properties": { "type": "Microsoft.Dynamics.CRM", "typeProperties": { "environmentUrl": { "value": "@{parameters('environmentUrl')}" }, "servicePrincipalId": { "value": "@{parameters('servicePrincipalId')}" }, "tenant": { "value": "@{parameters('tenantId')}" } } } }

For sensitive properties (like servicePrincipalId or connectionString), use "type": "SecureString" in the parameters section to protect them.

Place this JSON structure inside the "resources" array of your ARM template, ensuring that the Dataverse properties fit within the linkedServices array.

Double-check JSON brackets and commas to ensure the format aligns with ARM template standards. Invalid JSON will prevent you from saving it.

In ADO, ensure these parameters match those in the ARM template. You can assign different values per environment (Dev, UAT, Prod) to dynamically configure the linked service on deployment.

I hope this helps. Please let me know if you have any questions.
Smaran Thoomu 24,110 Reputation points Microsoft External Staff Moderator

2024-10-28T10:08:47.1433333+00:00

@Diana Rus Just checking if you got a chance to look at the previous response. Kindly do let us know if it helped to resolve your issue. Thankyou
Diana Rus 55 Reputation points

2024-10-28T10:18:19.51+00:00

Hello,

I have just managed to get it working, however the solution was different than what was suggest and I would say easier.

In the ARM template, in the linked services section, in the list of type properties, I simply had to add serviceuri.
Smaran Thoomu 24,110 Reputation points Microsoft External Staff Moderator

2024-10-28T10:35:18.9566667+00:00

@Diana Rus Glad to know your issue has been resolved. Since the Microsoft Q&A community has a policy that "The question author cannot accept their own answer. They can only accept answers by others "I'll repost your solution in case you'd like to accept the answer.
Smaran Thoomu 24,110 Reputation points Microsoft External Staff Moderator

2024-10-29T11:18:35.53+00:00

@Diana Rus Following up to see if the below answer was helpful. If this answers your query, do click Accept Answer and Yes for was this answer helpful. And, if you have any further query do let us know.

1 answer

Your answer

Diana Rus 55 Reputation points

2024-10-25T07:47:07.57+00:00

Hi Amira,

Thank you for that. The linked service section in my arm template, currently looks like below, adding Dataverse as above doesn't let me save the json.

"Microsoft.DataFactory/factories/linkedServices": { "*": { "properties": { "typeProperties": { "accountName": "=", "accountEndpoint": "=", "username": "=", "userName": "=", "accessKeyId": "=", "endpoint": "=", "servicePrincipalId": "=", "userId": "=", "host": "=", "clientId": "=", "existingClusterId": "=", "clusterUserName": "=", "clusterSshUserName": "=", "hostSubscriptionId": "=", "clusterResourceGroup": "=", "subscriptionId": "=", "resourceGroupName": "=", "tenant": "=", "dataLakeStoreUri": "=", "baseUrl": "=", "database": "=", "serviceEndpoint": "=", "batchUri": "=", "poolName": "=", "databaseName": "=", "systemNumber": "=", "server": "=", "url": "=", "functionAppUrl": "=", "environmentUrl": "=", "aadResourceId": "=", "sasUri": "|:-sasUri:secureString", "sasToken": "|", "connectionString": "|:-connectionString:secureString", "hostKeyFingerprint": "=", "mlWorkspaceName": "=", "servicePrincipalCredential": { "secretName": "=" } } } }, "Odbc": { "properties": { "typeProperties": { "userName": "=", "connectionString": { "secretName": "=" } } } }
Smaran Thoomu 24,110 Reputation points Microsoft External Staff Moderator

2024-10-25T13:20:00.05+00:00

@Diana Rus It sounds like the JSON structure of your ARM template may not match the expected format for adding a Dataverse Linked Service manually. Here are some adjustments to help you add Dataverse in a compatible way:

Modify the linkedServices section to include Dataverse properties specifically. Ensure each required property is listed as follows:

{ "name": "YourDataverseLinkedService", "properties": { "type": "Microsoft.Dynamics.CRM", "typeProperties": { "environmentUrl": { "value": "@{parameters('environmentUrl')}" }, "servicePrincipalId": { "value": "@{parameters('servicePrincipalId')}" }, "tenant": { "value": "@{parameters('tenantId')}" } } } }

For sensitive properties (like servicePrincipalId or connectionString), use "type": "SecureString" in the parameters section to protect them.

Place this JSON structure inside the "resources" array of your ARM template, ensuring that the Dataverse properties fit within the linkedServices array.

Double-check JSON brackets and commas to ensure the format aligns with ARM template standards. Invalid JSON will prevent you from saving it.

In ADO, ensure these parameters match those in the ARM template. You can assign different values per environment (Dev, UAT, Prod) to dynamically configure the linked service on deployment.

I hope this helps. Please let me know if you have any questions.
Smaran Thoomu 24,110 Reputation points Microsoft External Staff Moderator

2024-10-28T10:08:47.1433333+00:00

@Diana Rus Just checking if you got a chance to look at the previous response. Kindly do let us know if it helped to resolve your issue. Thankyou
Diana Rus 55 Reputation points

2024-10-28T10:18:19.51+00:00

Hello,

I have just managed to get it working, however the solution was different than what was suggest and I would say easier.

In the ARM template, in the linked services section, in the list of type properties, I simply had to add serviceuri.
Smaran Thoomu 24,110 Reputation points Microsoft External Staff Moderator

2024-10-28T10:35:18.9566667+00:00

@Diana Rus Glad to know your issue has been resolved. Since the Microsoft Q&A community has a policy that "The question author cannot accept their own answer. They can only accept answers by others "I'll repost your solution in case you'd like to accept the answer.
Smaran Thoomu 24,110 Reputation points Microsoft External Staff Moderator

2024-10-29T11:18:35.53+00:00

@Diana Rus Following up to see if the below answer was helpful. If this answers your query, do click Accept Answer and Yes for was this answer helpful. And, if you have any further query do let us know.

Answer 1

Hi @Diana Rus

I'm glad that you were able to resolve your issue and thank you for posting your solution so that others experiencing the same thing can easily reference this! Since the Microsoft Q&A community has a policy that "The question author cannot accept their own answer. They can only accept answers by others "I'll repost your solution in case you'd like to accept the answer.

Issue: I have a CICD pipeline in ADO for ADF. I have a Dataverse linked service that needs to be connected to different environment depending in which ADF we're in (Dev for Dev, UAT for UAT, prod for prod). The dataverse linked service properties don't appear in the ARM template for me to parameterize in the release pipeline in ADO. How do I add them in the ARM template?

Solution: I have just managed to get it working, however the solution was different than what was suggest and I would say easier.

In the ARM template, in the linked services section, in the list of type properties, I simply had to add serviceuri.

If I missed anything please let me know and I'd be happy to add it to my answer, or feel free to comment below with any additional information.

If you have any other questions, please let me know. Thank you again for your time and patience throughout this issue.
Hope this helps. If you have any questions, please let me know.

Please don’t forget to Accept Answer and Yes for "was this answer helpful" wherever the information provided helps you, this can be beneficial to other community members

Smaran Thoomu 24,110 Reputation points Microsoft External Staff Moderator

2024-10-30T13:17:47.2066667+00:00

@Diana Rus Following up to see if the above answer was helpful. If this answers your query, do click Accept Answer and Yes for was this answer helpful. And, if you have any further query do let us know.

Share via

Dataverse Linked Service doesn't get export in ADF ARM Template

1 answer

Your answer