sys.routes (Transact-SQL)

Applies to: yesSQL Server (all supported versions) YesAzure SQL Managed Instance

This catalog views contains one row per route. Service Broker uses routes to locate the network address for a service.

Column name Data type Description
name sysname Name of the route, unique within the database. Not NULLABLE.
route_id int Identifier for the route. Not NULLABLE.
principal_id int Identifier for the database principal that owns the route. NULLABLE.
remote_service_name nvarchar(256) Name of the remote service. NULLABLE.
broker_instance nvarchar(128) Identifier of the broker that hosts the remote service. NULLABLE.
lifetime datetime The date and time when the route expires. Notice that this value does not use the local time zone. Instead, the value shows the expiration time for UTC. NULLABLE.
address nvarchar(256) Network address to which Service Broker sends messages for the remote service. NULLABLE. For SQL Managed Instance, address must be local.
mirror_address nvarchar(256) Network address of the mirroring partner for the server specified in the address. NULLABLE.

Permissions

The visibility of the metadata in catalog views is limited to securables that a user either owns or on which the user has been granted some permission. For more information, see Metadata Visibility Configuration.