Azure Service Bus API Configuration

Request

POST https://api.fivetran.com/v1/connections

{
  "group_id": "group_id",
  "service": "azure_service_bus",
  "trust_certificates": true,
  "trust_fingerprints": true,
  "run_setup_tests": true,
  "paused": false,
  "pause_after_trial": false,
  "sync_frequency": 1440,
  "data_delay_sensitivity": "NORMAL",
  "data_delay_threshold": 0,
  "daily_sync_time": "14:00",
  "schedule_type": "auto",
  "connect_card_config": {
    "redirect_uri": "https://your.site/path",
    "hide_setup_guide": true
  },
  "proxy_agent_id": "proxy_agent_id",
  "private_link_id": "private_link_id",
  "networking_method": "Directly",
  "hybrid_deployment_agent_id": "hybrid_deployment_agent_id",
  "destination_configuration": {
    "virtual_warehouse": "virtual_warehouse"
  },
  "config": {
    "has_manage_permissions": true,
    "host_ip": "string",
    "auth_type": "ConnectionString | AzureActiveDirectory",
    "sync_type": "Packed | Unpacked",
    "topics": [
      "string"
    ],
    "message_type": "Xml | Text | Json | Avro",
    "connection_string": "Connection String",
    "connection_method": "SSH_TUNNEL | DIRECT | PRIVATE_LINK",
    "namespace": "my_namespace",
    "schema_registry_secret": "schema_registry_secret",
    "subscriber_name": "subscriber_name",
    "host_user": "string",
    "asb_ip": "string",
    "schema_registry_key": "schema_registry_key",
    "schema_registry_urls": [
      "string"
    ],
    "schema": "schema_name"
  },
  "auth": {
    "refresh_token": "refresh_token",
    "client_access": {
      "client_secret": "my_client_secret",
      "client_id": "my_client_id"
    }
  }
}

Config parameters

Name	Description
`has_manage_permissions`	The boolean value specifying whether the connection string has manage permissions
`host_ip`	The IP address of the host machine which we use to connect to ASB via ssh
`auth_type`	The authentication mode to access the topic
`sync_type`	The sync type, which is based on the message type. For `text` and `xml`, `packed` is supported. For `protobuf` and `avro`, `unpacked` is supported. For `json`, both `packed` and `unpacked` are supported
`topics`	The comma-separated list of topics which should be synced. Required if you do not have manage permissions
`message_type`	The format of messages in the topic
`connection_string`	The connection string used for authentication. Required if the authentication type is `ConnectionString`
`connection_method`	The connection method
`namespace`	The ASB namespace which we have to sync. Required for `AzureActiveDirectory` authentication.
`schema_registry_secret`	The secret used to access the schema registry. Required for the `avro` and `protobuf` message types
`subscriber_name`	The subscriber name. If the connection string does not have manage permission, you need to specify a subscriber name we can use to fetch data. If not specified, we default to `fivetran_sub_<schema>`
`host_user`	The username on the host machine which we use to connect to ASB via ssh
`asb_ip`	The IP address (or) the URL of ASB namespace
`schema_registry_key`	The key used to access the schema registry. Required for the `avro` and `protobuf` message types
`schema_registry_urls`	The comma-separated list of schema registry servers in the `server:port` format
`schema` (required)	Destination schema name. Schema name is permanent and cannot be changed after connection creation

Authorization

There are three ways to authorize this connector type:

Connection String: By specifying the auth_type as "ConnectionString" and the value for the connection_string parameter in the request.

POST https://api.fivetran.com/v1/connections

{
  "service": "azure_service_bus",
  "group_id": "group_id",
  "config": {
    "connection_string": "Connection String",
    "auth_type": "ConnectionString"
  }
}

AzureActiveDirectory: By specifying the values for the refresh_token and client_access parameters in the auth section and the auth_type as "AzureActiveDirectory" in the request.

POST https://api.fivetran.com/v1/connections

{
  "service": "azure_service_bus",
  "group_id": "group_id",
  "auth": {
    "refresh_token": "refresh_token",
    "client_access": {
      "client_secret": "my_client_secret",
      "client_id": "my_client_id"
    }
  },
  "config": {
    "auth_type": "AzureActiveDirectory"
  }
}

Auth Parameters

Name	Description
`refresh_token`	The refresh token. Required if the authentication type is `AzureActiveDirectory`
`client_access`
`client_access.client_secret`	`Client Secret` of your Azure application. Required if the authentication type is `AzureActiveDirectory`
`client_access.client_id`	`Client ID` of your Azure application. Required if the authentication type is `AzureActiveDirectory`

By using the Connect Card or the Fivetran dashboard.