ServiceBusEnvironment ServiceBusEnvironment Class

Describes the Service Bus environment.

Syntax

Declaration

public static class ServiceBusEnvironmentPublic Module ServiceBusEnvironment

Inheritance Hierarchy

Properties summary

Gets the default host name for the Access Control Service.

Gets the singleton ConnectivitySettings instance that holds the connectivity settings for TCP and HTTP-based endpoints.

Methods summary

Creates a URI string to use with access control for the specified service namespace.

Constructs the Service Bus URI for an application, using the specified scheme, service namespace, and service path.

Constructs the Service Bus URI for an application, using the specified scheme, service namespace, service path, and relayed path prefix.

Properties

  • DefaultIdentityHostName
    DefaultIdentityHostName

    Gets the default host name for the Access Control Service.

    public static string DefaultIdentityHostName { get; }Public Shared ReadOnly Property DefaultIdentityHostName As String

    Property Value

  • SystemConnectivity
    SystemConnectivity

    Gets the singleton ConnectivitySettings instance that holds the connectivity settings for TCP and HTTP-based endpoints.

    public static ConnectivitySettings SystemConnectivity { get; }Public Shared ReadOnly Property SystemConnectivity As ConnectivitySettings

    Property Value

Methods

  • CreateAccessControlUri(String)
    CreateAccessControlUri(String)

    Creates a URI string to use with access control for the specified service namespace.

    public static Uri CreateAccessControlUri(string serviceNamespace)Public Shared Function CreateAccessControlUri(serviceNamespace As String) As Uri

    Parameters

    • serviceNamespace

      The service namespace to create the URI for.

    Returns

    • Returns a Uri that contains the specified URI.

  • CreateServiceUri(String, String, String)
    CreateServiceUri(String, String, String)

    Constructs the Service Bus URI for an application, using the specified scheme, service namespace, and service path.

    public static Uri CreateServiceUri(string scheme, string serviceNamespace, string servicePath)Public Shared Function CreateServiceUri(scheme As String, serviceNamespace As String, servicePath As String) As Uri

    Parameters

    • scheme

      The scheme of the URI.

    • serviceNamespace

      The service namespace used by the application.

    • servicePath

      The service path that follows the host name section of the URI.

    Returns

    • Returns a Uri that contains the new URI.

  • CreateServiceUri(String, String, String, Boolean)
    CreateServiceUri(String, String, String, Boolean)

    Constructs the Service Bus URI for an application, using the specified scheme, service namespace, service path, and relayed path prefix.

    public static Uri CreateServiceUri(string scheme, string serviceNamespace, string servicePath, bool suppressRelayPathPrefix)Public Shared Function CreateServiceUri(scheme As String, serviceNamespace As String, servicePath As String, suppressRelayPathPrefix As Boolean) As Uri

    Parameters

    • scheme

      The scheme of the URI.

    • serviceNamespace

      The service namespace used by the application.

    • servicePath

      The service path that follows the host name section of the URI.

    • suppressRelayPathPrefix

      True if the relay path prefix is suppressed; otherwise, false.

    Returns

    • Returns a Uri that contains the new URI.

Details

Assembly

Microsoft.ServiceBus.dll