Feedback Edit

GoogleBigQueryLinkedService Class

  • Reference

Google BigQuery service linked service.

All required parameters must be populated in order to send to Azure.

Inheritance
azure.synapse.artifacts.models._models_py3.LinkedService
GoogleBigQueryLinkedService

Constructor

GoogleBigQueryLinkedService(*, project: object, authentication_type: Union[str, azure.synapse.artifacts.models._artifacts_client_enums.GoogleBigQueryAuthenticationType], additional_properties: Optional[Dict[str, object]] = None, connect_via: Optional[azure.synapse.artifacts.models._models_py3.IntegrationRuntimeReference] = None, description: Optional[str] = None, parameters: Optional[Dict[str, azure.synapse.artifacts.models._models_py3.ParameterSpecification]] = None, annotations: Optional[List[object]] = None, additional_projects: Optional[object] = None, request_google_drive_scope: Optional[object] = None, refresh_token: Optional[azure.synapse.artifacts.models._models_py3.SecretBase] = None, client_id: Optional[object] = None, client_secret: Optional[azure.synapse.artifacts.models._models_py3.SecretBase] = None, email: Optional[object] = None, key_file_path: Optional[object] = None, trusted_cert_path: Optional[object] = None, use_system_trust_store: Optional[object] = None, encrypted_credential: Optional[object] = None, **kwargs)

Parameters

additional_properties
dict[str, object]
Required

Unmatched properties from the message are deserialized to this collection.

type
str
Required

Required. Type of linked service.Constant filled by server.

connect_via
IntegrationRuntimeReference
Required

The integration runtime reference.

description
str
Required

Linked service description.

parameters
dict[str, ParameterSpecification]
Required

Parameters for linked service.

annotations
list[object]
Required

List of tags that can be used for describing the linked service.

project
object
Required

Required. The default BigQuery project to query against.

additional_projects
object
Required

A comma-separated list of public BigQuery projects to access.

request_google_drive_scope
object
Required

Whether to request access to Google Drive. Allowing Google Drive access enables support for federated tables that combine BigQuery data with data from Google Drive. The default value is false.

authentication_type
str or GoogleBigQueryAuthenticationType
Required

Required. The OAuth 2.0 authentication mechanism used for authentication. ServiceAuthentication can only be used on self-hosted IR. Possible values include: "ServiceAuthentication", "UserAuthentication".

refresh_token
SecretBase
Required

The refresh token obtained from Google for authorizing access to BigQuery for UserAuthentication.

client_id
object
Required

The client id of the google application used to acquire the refresh token. Type: string (or Expression with resultType string).

client_secret
SecretBase
Required

The client secret of the google application used to acquire the refresh token.

email
object
Required

The service account email ID that is used for ServiceAuthentication and can only be used on self-hosted IR.

key_file_path
object
Required

The full path to the .p12 key file that is used to authenticate the service account email address and can only be used on self-hosted IR.

trusted_cert_path
object
Required

The full path of the .pem file containing trusted CA certificates for verifying the server when connecting over SSL. This property can only be set when using SSL on self-hosted IR. The default value is the cacerts.pem file installed with the IR.

use_system_trust_store
object
Required

Specifies whether to use a CA certificate from the system trust store or from a specified PEM file. The default value is false.

encrypted_credential
object
Required

The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).