Configuring an ADF Linked Service Connection for ServiceNow V2
For information on how to enable a connection for use with linked services, see Configuring a Linked Service Connection.
Field labels in this walkthrough follow the underlying Azure Data Factory property names, with the connection column that carries each value named alongside. The exact labels shown in the BimlFlex Connection Editor may differ.
After selecting ServiceNow V2 from the Linked Service Type dropdown, the form required for creating a ServiceNow V2 Linked Service will appear.
The ServiceNow V2 connector is the successor to the ServiceNow 1.0 connector. A connection that uses the ServiceNow 1.0 connector reports message CON_21005014. To resolve it, move the connection to the ServiceNow V2 System Type and complete the fields described on this page.
Source Only Connector
A ServiceNow V2 connection is used as a source. It is not available as a target.
Each ServiceNow object is copied whole. The copy has no source query and takes no ExecuteSqlOnSource parameters.
Choosing an Authentication Method
| Method | Credentials | Additional Settings |
|---|---|---|
| Basic | Username and Password | None |
| OAuth2 | Service Principal Id and Service Principal Key, with the Username and Password also carried when supplied | grantType set to password or client_credentials |
Recommendation: Store the Password and the Service Principal Key in Azure Key Vault rather than entering them as plaintext.
Complete Example: Basic Authentication with Azure Key Vault
| Field | Example Value |
|---|---|
| Connect via Integration Runtime | AutoResolveIntegrationRuntime |
| Endpoint | dev12345.service-now.com |
| Authentication Type | Basic |
| Username | bfx-integration |
| Azure Key Vault Linked Service | bfx-kv |
| Secret Name (for Password) | BFX-LND-ServiceNowPassword |
Required Fields
Common Required Fields
Most required fields for a ServiceNow V2 Linked Service connection depend on the Authentication Type used. There are some fields that are required regardless of Authentication Type.
These common required fields are:
Authentication Type Dependent Required Fields
The remaining field requirements are dependent on Authentication Type.
Required fields for Basic:
- Username
- Password (or Azure Key Vault)
Required fields for OAuth2:
- Service Principal Id
- Service Principal Key (or Azure Key Vault)
- Grant Type
Connect via Integration Runtime
Connect via Integration Runtime names the integration runtime for a ServiceNow V2 Linked Service connection.
The default value is AutoResolveIntegrationRuntime.
To use another runtime, select it from the dropdown or choose + New to add one.
When a custom value is saved in the linked service form, it will be added to the custom integration runtimes.
The custom values that appear in this dropdown can be maintained in Settings under Azure - AzureIntegrationRuntime.
Endpoint
The Endpoint identifies the ServiceNow instance the connector reads from (for example, dev12345.service-now.com).
It is stored in the connection's LS_Endpoint column and maps to the ADF endpoint property.
Authentication Type
The ServiceNow V2 Linked Service connection can use Basic or OAuth2 authentication.
The selected value is stored in the connection's LS_AuthenticationType column.
When using Basic, a Username and Password are required.
For OAuth2, a Service Principal Id, Service Principal Key, and Grant Type are required.
Basic
Basic authentication signs in to the ServiceNow instance with a Username and Password.
The Username is stored in the connection's LS_Username column.
The Password field accepts the password as plaintext in the LS_Password column, or an Azure Key Vault reference held in the LS_PasswordKVS_ fields that resolves to the password at runtime.
A connection in the Basic form carries no Service Principal Id, Service Principal Key, or Grant Type in the generated linked service.
It is suggested that Azure Key Vault be used in place of manually entering the Password.
OAuth2
OAuth2 authentication authorizes API access with a Service Principal Id and Service Principal Key.
The Service Principal Id supplies the client id and is stored in the connection's LS_ServicePrincipalId column.
The Service Principal Key supplies the client secret as plaintext in the LS_ServicePrincipalKey column, or as an Azure Key Vault reference held in the LS_ServicePrincipalKeyKVS_ fields that resolves to the secret at runtime.
A Username and Password entered on an OAuth2 connection are written to the linked service alongside the client credentials.
It is suggested that Azure Key Vault be used in place of manually entering the Service Principal Key.
Grant Type
The Grant Type selects the OAuth2 flow the connector uses.
Supported values are password and client_credentials.
The Grant Type is stored in the connection's Additional Settings (LS_AdditionalSettings) under the key grantType, and maps to the ADF grantType property.
It applies to the OAuth2 Authentication Type only.
Azure Data Factory Linked Service Additional Information
For additional information on ADF ServiceNow V2 Linked Service and its connection requirements see the Azure Data Factory ServiceNow Connector documentation.