C# Class Microsoft.WindowsAzure.Commands.Utilities.ServiceBus.ServiceBusClientExtensions

Show file Open project: Azure/azure-powershell Class Usage Examples

Public Methods

Method	Description
CreateNamespace ( string name, string location, NamespaceType type, bool createACSNamespace = false ) : Microsoft.WindowsAzure.Commands.Utilities.ServiceBus.ExtendedServiceBusNamespace
CreateNotificationHub ( string namespaceName, string name ) : NotificationHubDescription	Creates new service bus notification hub in the given name.
CreateQueue ( string namespaceName, string name ) : QueueDescription	Creates new service bus queue in the given name.
CreateRelay ( string namespaceName, string name, RelayType type ) : RelayDescription	Creates new service bus relay in the given name.
CreateSharedAccessAuthorization ( string namespaceName, string entityName, ServiceBusEntityType entityType, string ruleName, string primaryKey, string secondaryKey ) : Microsoft.WindowsAzure.Commands.Utilities.ServiceBus.ExtendedAuthorizationRule	Creates shared access signature authorization for the service bus entity. This authorization works on public Microsoft Azure environments and Windows Azure Pack on prim as well.
CreateSharedAccessAuthorization ( string namespaceName, string ruleName, string primaryKey, string secondaryKey ) : Microsoft.WindowsAzure.Commands.Utilities.ServiceBus.ExtendedAuthorizationRule	Creates shared access signature authorization for the service bus namespace. This authorization works on public Microsoft Azure environments and Windows Azure Pack on prim as well.
CreateTopic ( string namespaceName, string name ) : TopicDescription	Creates new service bus topic in the given name.
GetAuthorizationRule ( string namespaceName, string ruleName ) : Microsoft.WindowsAzure.Commands.Utilities.ServiceBus.ExtendedAuthorizationRule	Gets the authorization rule with the specified name in the namespace level.
GetAuthorizationRule ( string namespaceName, string entityName, ServiceBusEntityType entityType, string ruleName ) : Microsoft.WindowsAzure.Commands.Utilities.ServiceBus.ExtendedAuthorizationRule	Gets the authorization rule with the specified name in the entity level.
GetAuthorizationRule ( Microsoft.WindowsAzure.Commands.Utilities.ServiceBus.AuthorizationRuleFilterOption filterOptions ) : List	Gets authorization rules based on the passed filter options.
GetConnectionString ( string namespaceName ) : List	Gets all the available connection strings for given namespace.
GetConnectionString ( string namespaceName, string entityName, ServiceBusEntityType entityType ) : List	Gets available connection strings for the specified entity.
GetConnectionString ( string namespaceName, string keyName ) : string	Gets the connection string with the given name.
GetConnectionString ( string namespaceName, string entityName, ServiceBusEntityType entityType, string keyName ) : string	Gets the connection string with the given name for the entity.
GetDefaultLocation ( ) : string
GetNamespace ( string name ) : Microsoft.WindowsAzure.Commands.Utilities.ServiceBus.ExtendedServiceBusNamespace
GetNamespace ( ) : List
GetServiceBusRegions ( ) : List
IsAvailableNamespace ( string name ) : bool
NamespaceExists ( string name ) : bool
RemoveAuthorizationRule ( Microsoft.WindowsAzure.Commands.Utilities.ServiceBus.AuthorizationRuleFilterOption options ) : void	Removes set of authorization rules that matches filter options.
RemoveAuthorizationRule ( string namespaceName, string ruleName ) : void	Removes shared access signature authorization for the service bus namespace.
RemoveAuthorizationRule ( string namespaceName, string entityName, ServiceBusEntityType entityType, string ruleName ) : void	Removed shared access signature authorization for the service bus entity.
RemoveNamespace ( string name ) : bool
ServiceBusClientExtensions ( ) : System	Parameterless constructs for mocking framework.
ServiceBusClientExtensions ( AzureSMProfile profile ) : System	Creates new instance from ServiceBusClientExtensions
UpdateSharedAccessAuthorization ( string namespaceName, string entityName, ServiceBusEntityType entityType, string ruleName, string primaryKey, string secondaryKey ) : Microsoft.WindowsAzure.Commands.Utilities.ServiceBus.ExtendedAuthorizationRule	Updates shared access signature authorization for the service bus entity. This authorization works on public Microsoft Azure environments and Windows Azure Pack on prim as well.
UpdateSharedAccessAuthorization ( string namespaceName, string ruleName, string primaryKey, string secondaryKey ) : Microsoft.WindowsAzure.Commands.Utilities.ServiceBus.ExtendedAuthorizationRule	Updates shared access signature authorization for the service bus namespace. This authorization works on public Microsoft Azure environments and Windows Azure Pack on prim as well.

Private Methods

Method	Description
CreateExtendedAuthorizationRule ( AuthorizationRule rule, string namespaceName ) : Microsoft.WindowsAzure.Commands.Utilities.ServiceBus.ExtendedAuthorizationRule
CreateExtendedAuthorizationRule ( AuthorizationRule rule, string namespaceName, string entityName, ServiceBusEntityType entityType ) : Microsoft.WindowsAzure.Commands.Utilities.ServiceBus.ExtendedAuthorizationRule
CreateNamespaceManager ( string namespaceName ) : NamespaceManager
FilterAuthorizationRules ( Microsoft.WindowsAzure.Commands.Utilities.ServiceBus.AuthorizationRuleFilterOption options ) : List
GetAuthorizationRuleCore ( string namespaceName, string entityName, ServiceBusEntityType entityType, Predicate match ) : List
GetAuthorizationRulesToFilter ( Microsoft.WindowsAzure.Commands.Utilities.ServiceBus.AuthorizationRuleFilterOption options ) : List
GetExtendedServiceBusNamespace ( string name ) : Microsoft.WindowsAzure.Commands.Utilities.ServiceBus.ExtendedServiceBusNamespace
IsActiveNamespace ( string name ) : bool
TryGetNamespace ( string name ) : Microsoft.WindowsAzure.Management.ServiceBus.Models.ServiceBusNamespace

Method Details

CreateNamespace() public method

public CreateNamespace ( string name, string location, NamespaceType type, bool createACSNamespace = false ) : Microsoft.WindowsAzure.Commands.Utilities.ServiceBus.ExtendedServiceBusNamespace
name	string
location	string
type	NamespaceType
createACSNamespace	bool
return	Microsoft.WindowsAzure.Commands.Utilities.ServiceBus.ExtendedServiceBusNamespace

CreateNotificationHub() public method

Creates new service bus notification hub in the given name.

public CreateNotificationHub ( string namespaceName, string name ) : NotificationHubDescription
namespaceName	string	The namespace name
name	string	The notification hub name
return	NotificationHubDescription

CreateQueue() public method

Creates new service bus queue in the given name.

public CreateQueue ( string namespaceName, string name ) : QueueDescription
namespaceName	string	The namespace name
name	string	The queue name
return	QueueDescription

CreateRelay() public method

Creates new service bus relay in the given name.

public CreateRelay ( string namespaceName, string name, RelayType type ) : RelayDescription
namespaceName	string	The namespace name
name	string	The relay name
type	RelayType	The relay type
return	RelayDescription

CreateSharedAccessAuthorization() public method

Creates shared access signature authorization for the service bus entity. This authorization works on public Microsoft Azure environments and Windows Azure Pack on prim as well.

public CreateSharedAccessAuthorization ( string namespaceName, string entityName, ServiceBusEntityType entityType, string ruleName, string primaryKey, string secondaryKey ) : Microsoft.WindowsAzure.Commands.Utilities.ServiceBus.ExtendedAuthorizationRule
namespaceName	string	The service bus namespace name
entityName	string	The fully qualified service bus entity name
entityType	ServiceBusEntityType	The service bus entity type (e.g. Queue)
ruleName	string	The SAS authorization rule name
primaryKey	string	The SAS primary key. It'll be generated if empty
secondaryKey	string	The SAS secondary key
return	Microsoft.WindowsAzure.Commands.Utilities.ServiceBus.ExtendedAuthorizationRule

CreateSharedAccessAuthorization() public method

Creates shared access signature authorization for the service bus namespace. This authorization works on public Microsoft Azure environments and Windows Azure Pack on prim as well.

public CreateSharedAccessAuthorization ( string namespaceName, string ruleName, string primaryKey, string secondaryKey ) : Microsoft.WindowsAzure.Commands.Utilities.ServiceBus.ExtendedAuthorizationRule
namespaceName	string	The service bus namespace name
ruleName	string	The SAS authorization rule name
primaryKey	string	The SAS primary key. It'll be generated if empty
secondaryKey	string	The SAS secondary key
return	Microsoft.WindowsAzure.Commands.Utilities.ServiceBus.ExtendedAuthorizationRule

CreateTopic() public method

Creates new service bus topic in the given name.

public CreateTopic ( string namespaceName, string name ) : TopicDescription
namespaceName	string	The namespace name
name	string	The topic name
return	TopicDescription

GetAuthorizationRule() public method

Gets the authorization rule with the specified name in the namespace level.

public GetAuthorizationRule ( string namespaceName, string ruleName ) : Microsoft.WindowsAzure.Commands.Utilities.ServiceBus.ExtendedAuthorizationRule
namespaceName	string	The namespace name
ruleName	string	The rule name
return	Microsoft.WindowsAzure.Commands.Utilities.ServiceBus.ExtendedAuthorizationRule

GetAuthorizationRule() public method

Gets the authorization rule with the specified name in the entity level.

public GetAuthorizationRule ( string namespaceName, string entityName, ServiceBusEntityType entityType, string ruleName ) : Microsoft.WindowsAzure.Commands.Utilities.ServiceBus.ExtendedAuthorizationRule
namespaceName	string	The namespace name
entityName	string	The entity name
entityType	ServiceBusEntityType	The entity type
ruleName	string	The rule name
return	Microsoft.WindowsAzure.Commands.Utilities.ServiceBus.ExtendedAuthorizationRule

GetAuthorizationRule() public method

Gets authorization rules based on the passed filter options.

public GetAuthorizationRule ( Microsoft.WindowsAzure.Commands.Utilities.ServiceBus.AuthorizationRuleFilterOption filterOptions ) : List
filterOptions	Microsoft.WindowsAzure.Commands.Utilities.ServiceBus.AuthorizationRuleFilterOption	The filter options
return	List

GetConnectionString() public method

Gets all the available connection strings for given namespace.

public GetConnectionString ( string namespaceName ) : List
namespaceName	string	The namespace name
return	List

GetConnectionString() public method

Gets available connection strings for the specified entity.

public GetConnectionString ( string namespaceName, string entityName, ServiceBusEntityType entityType ) : List
namespaceName	string	The namespace name
entityName	string	The entity name
entityType	ServiceBusEntityType	The entity type
return	List

GetConnectionString() public method

Gets the connection string with the given name.

public GetConnectionString ( string namespaceName, string keyName ) : string
namespaceName	string	The namespace name
keyName	string	The connection string key name
return	string

GetConnectionString() public method

Gets the connection string with the given name for the entity.

public GetConnectionString ( string namespaceName, string entityName, ServiceBusEntityType entityType, string keyName ) : string
namespaceName	string	The namespace name
entityName	string
entityType	ServiceBusEntityType
keyName	string	The connection string key name
return	string

GetDefaultLocation() public method

public GetDefaultLocation ( ) : string
return	string

GetNamespace() public method

public GetNamespace ( string name ) : Microsoft.WindowsAzure.Commands.Utilities.ServiceBus.ExtendedServiceBusNamespace
name	string
return	Microsoft.WindowsAzure.Commands.Utilities.ServiceBus.ExtendedServiceBusNamespace

GetNamespace() public method

public GetNamespace ( ) : List
return	List

GetServiceBusRegions() public method

public GetServiceBusRegions ( ) : List
return	List

IsAvailableNamespace() public method

public IsAvailableNamespace ( string name ) : bool
name	string
return	bool

NamespaceExists() public method

public NamespaceExists ( string name ) : bool
name	string
return	bool

RemoveAuthorizationRule() public method

Removes set of authorization rules that matches filter options.

public RemoveAuthorizationRule ( Microsoft.WindowsAzure.Commands.Utilities.ServiceBus.AuthorizationRuleFilterOption options ) : void
options	Microsoft.WindowsAzure.Commands.Utilities.ServiceBus.AuthorizationRuleFilterOption	The filter options
return	void

RemoveAuthorizationRule() public method

Removes shared access signature authorization for the service bus namespace.

public RemoveAuthorizationRule ( string namespaceName, string ruleName ) : void
namespaceName	string	The service bus namespace name
ruleName	string	The SAS authorization rule name
return	void

RemoveAuthorizationRule() public method

Removed shared access signature authorization for the service bus entity.

public RemoveAuthorizationRule ( string namespaceName, string entityName, ServiceBusEntityType entityType, string ruleName ) : void
namespaceName	string	The service bus namespace name
entityName	string	The fully qualified service bus entity name
entityType	ServiceBusEntityType	The service bus entity type (e.g. Queue)
ruleName	string	The SAS authorization rule name
return	void

RemoveNamespace() public method

public RemoveNamespace ( string name ) : bool
name	string
return	bool

ServiceBusClientExtensions() public method

Parameterless constructs for mocking framework.

public ServiceBusClientExtensions ( ) : System
return	System

ServiceBusClientExtensions() public method

Creates new instance from ServiceBusClientExtensions

public ServiceBusClientExtensions ( AzureSMProfile profile ) : System
profile	AzureSMProfile
return	System

UpdateSharedAccessAuthorization() public method

Updates shared access signature authorization for the service bus entity. This authorization works on public Microsoft Azure environments and Windows Azure Pack on prim as well.

public UpdateSharedAccessAuthorization ( string namespaceName, string entityName, ServiceBusEntityType entityType, string ruleName, string primaryKey, string secondaryKey ) : Microsoft.WindowsAzure.Commands.Utilities.ServiceBus.ExtendedAuthorizationRule
namespaceName	string	The service bus namespace name
entityName	string	The fully qualified service bus entity name
entityType	ServiceBusEntityType	The service bus entity type (e.g. Queue)
ruleName	string	The SAS authorization rule name
primaryKey	string	The SAS primary key. It'll be generated if empty
secondaryKey	string	The SAS secondary key
return	Microsoft.WindowsAzure.Commands.Utilities.ServiceBus.ExtendedAuthorizationRule

UpdateSharedAccessAuthorization() public method

Updates shared access signature authorization for the service bus namespace. This authorization works on public Microsoft Azure environments and Windows Azure Pack on prim as well.

public UpdateSharedAccessAuthorization ( string namespaceName, string ruleName, string primaryKey, string secondaryKey ) : Microsoft.WindowsAzure.Commands.Utilities.ServiceBus.ExtendedAuthorizationRule
namespaceName	string	The service bus namespace name
ruleName	string	The SAS authorization rule name
primaryKey	string	The SAS primary key. It'll be generated if empty
secondaryKey	string	The SAS secondary key
return	Microsoft.WindowsAzure.Commands.Utilities.ServiceBus.ExtendedAuthorizationRule