New-SBNamespace
New-SBNamespace
This cmdlet creates a new Service Bus for Windows Server service namespace entry in the Service Bus for Windows Server farm.
Syntax
Parameter Set: Default
New-SBNamespace -ManageUsers <String[]> -Name <String> [-AddressingScheme <NamespaceFormat> ] [-DnsEntry <String> ] [-IssuerName <String> ] [-IssuerUri <String> ] [-PrimarySymmetricKey <String> ] [-SecondarySymmetricKey <String> ] [-SubscriptionId <Guid> ] [ <CommonParameters>]
Detailed Description
Run New-SBNamespace to create a new Service Bus for Windows Server service namespace.
A Service Bus for Windows Server service namespace acts like a scoping entity for Service Bus for Windows Server queues and topics providing isolation between multiple applications (tenants). When creating Service Bus for Windows Server entities (queues or topics), the Service Bus for Windows Server service namespace name is required. It sets the addressing schema as well as URI prefix for all the entities.
A Service Bus for Windows Server service namespace may follow one of the following addressing schemas:
1. Path based service namespace (default value) is using the Service Bus for Windows Server hosts FQDN as the prefix of the service namespace name.
2. Path with Service Id is used sharing a port. For this addressing schema a ServiceId parameter is required in addition to the mandatory parameters.
3. DNSRegistered service namespace is used when you register your service namespace with a naming authority (for example, DNS). For this addressing schema a URI is required in addition to the mandatory parameters.
The IssuerName, IssuerUri, PrimarySymmetricKey, and SecondarySymmetricKey are all optional.
Parameters
-AddressingScheme<NamespaceFormat>
Specifies the addressing scheme used in the service namespace. The possible values for this parameter are Path (default value) and DNSRegistered. If the value DNSRegistered is specified, the -DnsEntry parameter is required.
Aliases |
scheme |
Required? |
false |
Position? |
named |
Default Value |
NamespaceFormat.Path |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-DnsEntry<String>
Specifies the DNS entry.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-IssuerName<String>
Specifies the name of the trusted security issuer.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByValue, ByPropertyName) |
Accept Wildcard Characters? |
false |
-IssuerUri<String>
Specifies a case-sensitive issuer URI.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-ManageUsers<String[]>
Specifies user or group names that will be managers of the service namespace.
Aliases |
manage |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-Name<String>
Specifies the name for the new Service Bus for Windows Server service namespace.
Aliases |
n |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByValue, ByPropertyName) |
Accept Wildcard Characters? |
false |
-PrimarySymmetricKey<String>
Specifies the primary key to be used in this service namespace.
Aliases |
primary |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-SecondarySymmetricKey<String>
Specifies the secondary key to be used in this service namespace.
Aliases |
secondary |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-SubscriptionId<Guid>
An optional parameter that associates a namespace with a subscription. For example, this parameter is useful if an administrator creates a namespace on behalf of a user.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByValue, ByPropertyName) |
Accept Wildcard Characters? |
false |
<CommonParameters>
This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
Outputs
The output type is the type of the objects that the cmdlet emits.
Examples
Example 1
Creates a Service Bus for Windows Server service namespace with the name MyNamespace1 and assigns user1 to be its owner.
PS C:\> New-SBNamespace -Name MyNamespace1 -ManageUsers user1@domain1