bin/PSServiceBus.dll-Help.xml
<?xml version="1.0" encoding="utf-8"?>
<helpItems schema="maml" xmlns="http://msh"> <!-- Cmdlet: Test-SbConnectionString --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Test-SbConnectionString</command:name> <command:verb>Test</command:verb> <command:noun>SbConnectionString</command:noun> <maml:description> <maml:para>Tests whether a connection string is valid or not.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Tests whether a connection string is valid or not.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Test-SbConnectionString</maml:name> <!-- Parameter: NamespaceConnectionString --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>NamespaceConnectionString</maml:name> <maml:description> <maml:para>Connection string to test.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: NamespaceConnectionString --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>NamespaceConnectionString</maml:name> <maml:description> <maml:para>Connection string to test.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <!-- OutputType: Boolean --> <command:returnValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>Test-SbConnectionString -NamespaceConnectionString $namespaceConnectionString</dev:code> <dev:remarks> <maml:para>This tests whether $namespaceConnectionString is valid or not.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Receive-SbMessage --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Receive-SbMessage</command:name> <command:verb>Receive</command:verb> <command:noun>SbMessage</command:noun> <maml:description> <maml:para>Receives a message or messages from an Azure Service Bus queue or subscription.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet retrieves a message or messages from an Azure Service Bus queue or subscription. Two receive modes are available:</maml:para> <maml:para>PeekOnly/ReceiveAndKeep (default) and ReceiveAndDelete which if specified will remove the message from the queue. Multiple messages can be</maml:para> <maml:para>received using the -NumberOfMessagesToRetrieve parameter, they will be returned individually to the pipeline. Messages can also be</maml:para> <maml:para>received from the dead letter queue by adding the -ReceiveFromDeadLetterQueue parameter.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ReceiveFromQueue --> <command:syntaxItem> <maml:name>Receive-SbMessage</maml:name> <!-- Parameter: NamespaceConnectionString --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>NamespaceConnectionString</maml:name> <maml:description> <maml:para>A connection string with 'Manage' rights for the Azure Service Bus Namespace.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: QueueName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>QueueName</maml:name> <maml:description> <maml:para>The name of the queue to retrieve messages from.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: NumberOfMessagesToRetrieve --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NumberOfMessagesToRetrieve</maml:name> <maml:description> <maml:para>The number of messages to retrieve - defaults to 1.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1</dev:defaultValue> </command:parameter> <!-- Parameter: ReceiveFromDeadLetterQueue --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ReceiveFromDeadLetterQueue</maml:name> <maml:description> <maml:para>Retrieves messages from the entity's dead letter queue.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: ReceiveType --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ReceiveType</maml:name> <maml:description> <maml:para>Specifies the receive behaviour - defaults to PeekOnly.</maml:para> <maml:para>Possible values: ReceiveAndDelete, ReceiveAndKeep, PeekOnly</maml:para> </maml:description> <command:parameterValue required="true">SbReceiveTypes</command:parameterValue> <dev:type> <maml:name>PSServiceBus.Enums.SbReceiveTypes</maml:name> <maml:uri /> <maml:description> <maml:para>Valid ways to receive a message from a Service Bus entity</maml:para> </maml:description> </dev:type> <dev:defaultValue>PeekOnly</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">ReceiveAndDelete</command:parameterValue> <command:parameterValue required="false" variableLength="false">ReceiveAndKeep</command:parameterValue> <command:parameterValue required="false" variableLength="false">PeekOnly</command:parameterValue> </command:parameterValueGroup> </command:parameter> </command:syntaxItem> <!-- Parameter set: ReceiveFromSubscription --> <command:syntaxItem> <maml:name>Receive-SbMessage</maml:name> <!-- Parameter: NamespaceConnectionString --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>NamespaceConnectionString</maml:name> <maml:description> <maml:para>A connection string with 'Manage' rights for the Azure Service Bus Namespace.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SubscriptionName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>SubscriptionName</maml:name> <maml:description> <maml:para>The name of the subscription to retrieve messages from.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: TopicName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>TopicName</maml:name> <maml:description> <maml:para>The name of the topic containing the subscription to retrieve messages from.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: NumberOfMessagesToRetrieve --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NumberOfMessagesToRetrieve</maml:name> <maml:description> <maml:para>The number of messages to retrieve - defaults to 1.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1</dev:defaultValue> </command:parameter> <!-- Parameter: ReceiveFromDeadLetterQueue --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ReceiveFromDeadLetterQueue</maml:name> <maml:description> <maml:para>Retrieves messages from the entity's dead letter queue.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: ReceiveType --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ReceiveType</maml:name> <maml:description> <maml:para>Specifies the receive behaviour - defaults to PeekOnly.</maml:para> <maml:para>Possible values: ReceiveAndDelete, ReceiveAndKeep, PeekOnly</maml:para> </maml:description> <command:parameterValue required="true">SbReceiveTypes</command:parameterValue> <dev:type> <maml:name>PSServiceBus.Enums.SbReceiveTypes</maml:name> <maml:uri /> <maml:description> <maml:para>Valid ways to receive a message from a Service Bus entity</maml:para> </maml:description> </dev:type> <dev:defaultValue>PeekOnly</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">ReceiveAndDelete</command:parameterValue> <command:parameterValue required="false" variableLength="false">ReceiveAndKeep</command:parameterValue> <command:parameterValue required="false" variableLength="false">PeekOnly</command:parameterValue> </command:parameterValueGroup> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: NamespaceConnectionString --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>NamespaceConnectionString</maml:name> <maml:description> <maml:para>A connection string with 'Manage' rights for the Azure Service Bus Namespace.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: QueueName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>QueueName</maml:name> <maml:description> <maml:para>The name of the queue to retrieve messages from.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: TopicName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>TopicName</maml:name> <maml:description> <maml:para>The name of the topic containing the subscription to retrieve messages from.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SubscriptionName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>SubscriptionName</maml:name> <maml:description> <maml:para>The name of the subscription to retrieve messages from.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: NumberOfMessagesToRetrieve --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NumberOfMessagesToRetrieve</maml:name> <maml:description> <maml:para>The number of messages to retrieve - defaults to 1.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1</dev:defaultValue> </command:parameter> <!-- Parameter: ReceiveType --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ReceiveType</maml:name> <maml:description> <maml:para>Specifies the receive behaviour - defaults to PeekOnly.</maml:para> <maml:para>Possible values: ReceiveAndDelete, ReceiveAndKeep, PeekOnly</maml:para> </maml:description> <command:parameterValue required="true">SbReceiveTypes</command:parameterValue> <dev:type> <maml:name>PSServiceBus.Enums.SbReceiveTypes</maml:name> <maml:uri /> <maml:description> <maml:para>Valid ways to receive a message from a Service Bus entity</maml:para> </maml:description> </dev:type> <dev:defaultValue>PeekOnly</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">ReceiveAndDelete</command:parameterValue> <command:parameterValue required="false" variableLength="false">ReceiveAndKeep</command:parameterValue> <command:parameterValue required="false" variableLength="false">PeekOnly</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: ReceiveFromDeadLetterQueue --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ReceiveFromDeadLetterQueue</maml:name> <maml:description> <maml:para>Retrieves messages from the entity's dead letter queue.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <!-- OutputType: SbMessage --> <command:returnValue> <dev:type> <maml:name>PSServiceBus.Outputs.SbMessage</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>Receive-SbMessage -NamespaceConnectionString $namespaceConnectionString -QueueName 'example-queue'</dev:code> <dev:remarks> <maml:para>Receives a single message from the queue 'example-queue' and leaves it there</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>Receive-SbMessage -NamespaceConnectionString $namespaceConnectionString -TopicName 'example-topic' -SubscriptionName 'example-subscription' -NumberOfMessagesToRetrieve 5</dev:code> <dev:remarks> <maml:para>Receives 5 messages from the subscription called 'example-subscription' in the topic 'example-topic' and leaves them there</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <dev:code>Receive-SbMessage -NamespaceConnectionString $namespaceConnectionString -QueueName 'example-queue' -ReceiveType ReceiveAndDelete</dev:code> <dev:remarks> <maml:para>Receives a single message from the queue 'example-queue' and removes it from the queue</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 4 ----------</maml:title> <dev:code>Receive-SbMessage -NamespaceConnectionString $namespaceConnectionString -QueueName 'example-queue' -ReceiveFromDeadLetterQueue</dev:code> <dev:remarks> <maml:para>Receives a single message from the dead letter queue for queue 'example-queue' and leaves it there</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Send-SbMessage --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Send-SbMessage</command:name> <command:verb>Send</command:verb> <command:noun>SbMessage</command:noun> <maml:description> <maml:para>Sends a message to an Azure Service Bus queue or topic.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Sends a message to an Azure Service Bus queue or topic.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: SendToQueue --> <command:syntaxItem> <maml:name>Send-SbMessage</maml:name> <!-- Parameter: Message --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Message</maml:name> <maml:description> <maml:para>Body of the message to send.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: NamespaceConnectionString --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>NamespaceConnectionString</maml:name> <maml:description> <maml:para>A connection string with 'Manage' rights for the Azure Service Bus Namespace.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: QueueName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>QueueName</maml:name> <maml:description> <maml:para>Name of the queue to send a message to.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: SendToTopic --> <command:syntaxItem> <maml:name>Send-SbMessage</maml:name> <!-- Parameter: Message --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Message</maml:name> <maml:description> <maml:para>Body of the message to send.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: NamespaceConnectionString --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>NamespaceConnectionString</maml:name> <maml:description> <maml:para>A connection string with 'Manage' rights for the Azure Service Bus Namespace.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: TopicName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>TopicName</maml:name> <maml:description> <maml:para>Name of the topic to send a message to.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: NamespaceConnectionString --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>NamespaceConnectionString</maml:name> <maml:description> <maml:para>A connection string with 'Manage' rights for the Azure Service Bus Namespace.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: QueueName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>QueueName</maml:name> <maml:description> <maml:para>Name of the queue to send a message to.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: TopicName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>TopicName</maml:name> <maml:description> <maml:para>Name of the topic to send a message to.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Message --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Message</maml:name> <maml:description> <maml:para>Body of the message to send.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>Send-SbMessage -NamespaceConnectionString $namespaceConnectionString -QueueName 'example-queue' -Message '{ "example": "message" }'</dev:code> <dev:remarks> <maml:para>This sends a message to the queue 'example-queue' with body '{ "example": "message" }'.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>Send-SbMessage -NamespaceConnectionString $namespaceConnectionString -TopicName 'example-topic' -Message '{ "example": "message" }'</dev:code> <dev:remarks> <maml:para>This sends a message to the topic 'example-topic' with body '{ "example": "message" }'.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Test-SbMessageBatchSize --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Test-SbMessageBatchSize</command:name> <command:verb>Test</command:verb> <command:noun>SbMessageBatchSize</command:noun> <maml:description> <maml:para>Tests whether a message batch is valid for a range of different namespace skus</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The different Service Bus Namespaces skus have different limits for the maximum message or message batch size.</maml:para> <maml:para>This cmdlet tests whether a given message batch is valid for the different skus. If the -NamespaceConnectionString</maml:para> <maml:para>parameter is supplied then the batch is also evaluated against the in-scope namespace.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Test-SbMessageBatchSize</maml:name> <!-- Parameter: Messages --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Messages</maml:name> <maml:description> <maml:para>Batch of messages to be tested</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: NamespaceConnectionString --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NamespaceConnectionString</maml:name> <maml:description> <maml:para>A connection string with 'Manage' rights for the Azure Service Bus Namespace.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: NamespaceConnectionString --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NamespaceConnectionString</maml:name> <maml:description> <maml:para>A connection string with 'Manage' rights for the Azure Service Bus Namespace.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Messages --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Messages</maml:name> <maml:description> <maml:para>Batch of messages to be tested</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <!-- OutputType: SbMessageBatchTestResult --> <command:returnValue> <dev:type> <maml:name>PSServiceBus.Outputs.SbMessageBatchTestResult</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>Test-SbMessageBatchSize -Messages $messagesToSend -NamespaceConnectionString $namespaceConnectionString</dev:code> <dev:remarks> <maml:para>This tests whether the message batch $messagesToSend is within the contsraints of the various namespace skus, including</maml:para> <maml:para>the namespace $namespaceConnectionString.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Receive-SbMessagesInBatch --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Receive-SbMessagesInBatch</command:name> <command:verb>Receive</command:verb> <command:noun>SbMessagesInBatch</command:noun> <maml:description> <maml:para>Receives messages in batch from an Azure Service Bus queue or subscription.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet retrieves messages in batch from an Azure Service Bus queue or subscription. Two receive modes are available:</maml:para> <maml:para>ReceiveAndKeep (default) and ReceiveAndDelete which if specified will remove the message from the queue. Multiple messages can be</maml:para> <maml:para>received using the -ReceiveQty parameter, they will be returned individually to the pipeline. Messages can also be</maml:para> <maml:para>received from the dead letter queue by adding the -ReceiveFromDeadLetterQueue parameter.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ReceiveFromQueue --> <command:syntaxItem> <maml:name>Receive-SbMessagesInBatch</maml:name> <!-- Parameter: NamespaceConnectionString --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>NamespaceConnectionString</maml:name> <maml:description> <maml:para>A connection string with 'Manage' rights for the Azure Service Bus Namespace.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: QueueName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>QueueName</maml:name> <maml:description> <maml:para>The name of the queue to retrieve messages from.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ReceiveFromDeadLetterQueue --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ReceiveFromDeadLetterQueue</maml:name> <maml:description> <maml:para>Retrieves messages from the entity's dead letter queue.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: ReceiveQty --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ReceiveQty</maml:name> <maml:description> <maml:para>The number of messages to retrieve - defaults to 1.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1</dev:defaultValue> </command:parameter> <!-- Parameter: ReceiveType --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ReceiveType</maml:name> <maml:description> <maml:para>Specifies the receive behaviour - defaults to ReceiveAndKeep.</maml:para> <maml:para>Possible values: ReceiveAndDelete, ReceiveAndKeep, PeekOnly</maml:para> </maml:description> <command:parameterValue required="true">SbReceiveTypes</command:parameterValue> <dev:type> <maml:name>PSServiceBus.Enums.SbReceiveTypes</maml:name> <maml:uri /> <maml:description> <maml:para>Valid ways to receive a message from a Service Bus entity</maml:para> </maml:description> </dev:type> <dev:defaultValue>ReceiveAndKeep</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">ReceiveAndDelete</command:parameterValue> <command:parameterValue required="false" variableLength="false">ReceiveAndKeep</command:parameterValue> <command:parameterValue required="false" variableLength="false">PeekOnly</command:parameterValue> </command:parameterValueGroup> </command:parameter> </command:syntaxItem> <!-- Parameter set: ReceiveFromSubscription --> <command:syntaxItem> <maml:name>Receive-SbMessagesInBatch</maml:name> <!-- Parameter: NamespaceConnectionString --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>NamespaceConnectionString</maml:name> <maml:description> <maml:para>A connection string with 'Manage' rights for the Azure Service Bus Namespace.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SubscriptionName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>SubscriptionName</maml:name> <maml:description> <maml:para>The name of the subscription to retrieve messages from.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: TopicName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>TopicName</maml:name> <maml:description> <maml:para>The name of the topic containing the subscription to retrieve messages from.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ReceiveFromDeadLetterQueue --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ReceiveFromDeadLetterQueue</maml:name> <maml:description> <maml:para>Retrieves messages from the entity's dead letter queue.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: ReceiveQty --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ReceiveQty</maml:name> <maml:description> <maml:para>The number of messages to retrieve - defaults to 1.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1</dev:defaultValue> </command:parameter> <!-- Parameter: ReceiveType --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ReceiveType</maml:name> <maml:description> <maml:para>Specifies the receive behaviour - defaults to ReceiveAndKeep.</maml:para> <maml:para>Possible values: ReceiveAndDelete, ReceiveAndKeep, PeekOnly</maml:para> </maml:description> <command:parameterValue required="true">SbReceiveTypes</command:parameterValue> <dev:type> <maml:name>PSServiceBus.Enums.SbReceiveTypes</maml:name> <maml:uri /> <maml:description> <maml:para>Valid ways to receive a message from a Service Bus entity</maml:para> </maml:description> </dev:type> <dev:defaultValue>ReceiveAndKeep</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">ReceiveAndDelete</command:parameterValue> <command:parameterValue required="false" variableLength="false">ReceiveAndKeep</command:parameterValue> <command:parameterValue required="false" variableLength="false">PeekOnly</command:parameterValue> </command:parameterValueGroup> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: NamespaceConnectionString --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>NamespaceConnectionString</maml:name> <maml:description> <maml:para>A connection string with 'Manage' rights for the Azure Service Bus Namespace.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: QueueName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>QueueName</maml:name> <maml:description> <maml:para>The name of the queue to retrieve messages from.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: TopicName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>TopicName</maml:name> <maml:description> <maml:para>The name of the topic containing the subscription to retrieve messages from.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SubscriptionName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>SubscriptionName</maml:name> <maml:description> <maml:para>The name of the subscription to retrieve messages from.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ReceiveQty --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ReceiveQty</maml:name> <maml:description> <maml:para>The number of messages to retrieve - defaults to 1.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1</dev:defaultValue> </command:parameter> <!-- Parameter: ReceiveType --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ReceiveType</maml:name> <maml:description> <maml:para>Specifies the receive behaviour - defaults to ReceiveAndKeep.</maml:para> <maml:para>Possible values: ReceiveAndDelete, ReceiveAndKeep, PeekOnly</maml:para> </maml:description> <command:parameterValue required="true">SbReceiveTypes</command:parameterValue> <dev:type> <maml:name>PSServiceBus.Enums.SbReceiveTypes</maml:name> <maml:uri /> <maml:description> <maml:para>Valid ways to receive a message from a Service Bus entity</maml:para> </maml:description> </dev:type> <dev:defaultValue>ReceiveAndKeep</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">ReceiveAndDelete</command:parameterValue> <command:parameterValue required="false" variableLength="false">ReceiveAndKeep</command:parameterValue> <command:parameterValue required="false" variableLength="false">PeekOnly</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: ReceiveFromDeadLetterQueue --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ReceiveFromDeadLetterQueue</maml:name> <maml:description> <maml:para>Retrieves messages from the entity's dead letter queue.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <!-- OutputType: SbMessage --> <command:returnValue> <dev:type> <maml:name>PSServiceBus.Outputs.SbMessage</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>Receive-SbMessagesInBatch -NamespaceConnectionString $namespaceConnectionString -QueueName 'example-queue'</dev:code> <dev:remarks> <maml:para>Receives a single message in batch from the queue 'example-queue' and leaves it there</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>Receive-SbMessagesInBatch -NamespaceConnectionString $namespaceConnectionString -TopicName 'example-topic' -SubscriptionName 'example-subscription' -ReceiveQty 5</dev:code> <dev:remarks> <maml:para>Receives 5 messages in batch from the subscription called 'example-subscription' in the topic 'example-topic' and leaves them there</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <dev:code>Receive-SbMessagesInBatch -NamespaceConnectionString $namespaceConnectionString -QueueName 'example-queue' -ReceiveType ReceiveAndDelete</dev:code> <dev:remarks> <maml:para>Receives a single message in batch from the queue 'example-queue' and removes it from the queue</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 4 ----------</maml:title> <dev:code>Receive-SbMessagesInBatch -NamespaceConnectionString $namespaceConnectionString -QueueName 'example-queue' -ReceiveFromDeadLetterQueue</dev:code> <dev:remarks> <maml:para>Receives a single message in batch from the dead letter queue for queue 'example-queue' and leaves it there</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Send-SbMessagesInBatch --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Send-SbMessagesInBatch</command:name> <command:verb>Send</command:verb> <command:noun>SbMessagesInBatch</command:noun> <maml:description> <maml:para>Sends a set of messages to an Azure Service Bus queue or topic.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Sends a set of messages to an Azure Service Bus queue or topic.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: SendToQueue --> <command:syntaxItem> <maml:name>Send-SbMessagesInBatch</maml:name> <!-- Parameter: Messages --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Messages</maml:name> <maml:description> <maml:para>Set of the messages to send.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: NamespaceConnectionString --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>NamespaceConnectionString</maml:name> <maml:description> <maml:para>A connection string with 'Manage' rights for the Azure Service Bus Namespace.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: QueueName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>QueueName</maml:name> <maml:description> <maml:para>Name of the queue to send a message to.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: SendToTopic --> <command:syntaxItem> <maml:name>Send-SbMessagesInBatch</maml:name> <!-- Parameter: Messages --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Messages</maml:name> <maml:description> <maml:para>Set of the messages to send.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: NamespaceConnectionString --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>NamespaceConnectionString</maml:name> <maml:description> <maml:para>A connection string with 'Manage' rights for the Azure Service Bus Namespace.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: TopicName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>TopicName</maml:name> <maml:description> <maml:para>Name of the topic to send a message to.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: NamespaceConnectionString --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>NamespaceConnectionString</maml:name> <maml:description> <maml:para>A connection string with 'Manage' rights for the Azure Service Bus Namespace.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: QueueName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>QueueName</maml:name> <maml:description> <maml:para>Name of the queue to send a message to.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: TopicName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>TopicName</maml:name> <maml:description> <maml:para>Name of the topic to send a message to.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Messages --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Messages</maml:name> <maml:description> <maml:para>Set of the messages to send.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>Send-SbMessagesInBatch -NamespaceConnectionString $namespaceConnectionString -QueueName 'example-queue' -Messages '{ "example": "message1" }','{ "example": "message2" }'</dev:code> <dev:remarks> <maml:para>This sends a set of messages to the queue 'example-queue' with body '{ "example": "message1" }','{ "example": "message2" }'.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>Send-SbMessagesInBatch -NamespaceConnectionString $namespaceConnectionString -TopicName 'example-topic' -Messages '{ "example": "message1" }','{ "example": "message2" }'</dev:code> <dev:remarks> <maml:para>This sends a set of messages to the topic 'example-topic' with body '{ "example": "message1" }','{ "example": "message2" }'.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Clear-SbQueue --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Clear-SbQueue</command:name> <command:verb>Clear</command:verb> <command:noun>SbQueue</command:noun> <maml:description> <maml:para>Clears all messages from an Azure Service Bus queue or subscription.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet clears all messages from an Azure Service Bus queue or subscription.</maml:para> <maml:para>The messages will be destroyed and not outputted to the console.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ClearQueue --> <command:syntaxItem> <maml:name>Clear-SbQueue</maml:name> <!-- Parameter: NamespaceConnectionString --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>NamespaceConnectionString</maml:name> <maml:description> <maml:para>A connection string with 'Manage' rights for the Azure Service Bus Namespace.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: QueueName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>QueueName</maml:name> <maml:description> <maml:para>The name of the queue to retrieve messages from.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: DeadLetterQueue --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DeadLetterQueue</maml:name> <maml:description> <maml:para>Retrieves messages from the entity's dead letter queue.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <!-- Parameter set: ClearSubscription --> <command:syntaxItem> <maml:name>Clear-SbQueue</maml:name> <!-- Parameter: NamespaceConnectionString --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>NamespaceConnectionString</maml:name> <maml:description> <maml:para>A connection string with 'Manage' rights for the Azure Service Bus Namespace.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SubscriptionName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>SubscriptionName</maml:name> <maml:description> <maml:para>The name of the subscription to retrieve messages from.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: TopicName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>TopicName</maml:name> <maml:description> <maml:para>The name of the topic containing the subscription to retrieve messages from.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: DeadLetterQueue --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DeadLetterQueue</maml:name> <maml:description> <maml:para>Retrieves messages from the entity's dead letter queue.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: NamespaceConnectionString --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>NamespaceConnectionString</maml:name> <maml:description> <maml:para>A connection string with 'Manage' rights for the Azure Service Bus Namespace.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: QueueName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>QueueName</maml:name> <maml:description> <maml:para>The name of the queue to retrieve messages from.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: TopicName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>TopicName</maml:name> <maml:description> <maml:para>The name of the topic containing the subscription to retrieve messages from.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SubscriptionName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>SubscriptionName</maml:name> <maml:description> <maml:para>The name of the subscription to retrieve messages from.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: DeadLetterQueue --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DeadLetterQueue</maml:name> <maml:description> <maml:para>Retrieves messages from the entity's dead letter queue.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>Clear-SbQueue -NamespaceConnectionString $namespaceConnectionString -QueueName 'example-queue'</dev:code> <dev:remarks> <maml:para>Clears all messages from the queue 'example-queue'</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>Clear-SbQueue -NamespaceConnectionString $namespaceConnectionString -TopicName 'example-topic' -SubscriptionName 'example-subscription'</dev:code> <dev:remarks> <maml:para>Clears all messages from the subscription called 'example-subscription' in the topic 'example-topic'</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-SbQueue --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-SbQueue</command:name> <command:verb>Get</command:verb> <command:noun>SbQueue</command:noun> <maml:description> <maml:para>Gets a queue by name or a list of all queues from an Azure Service Bus Namespace. Returns the number of messages in the active and dead letter queues.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Gets a queue by name or a list of all queues from an Azure Service Bus Namespace. Returns the number of messages in the active and dead letter queues.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-SbQueue</maml:name> <!-- Parameter: NamespaceConnectionString --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>NamespaceConnectionString</maml:name> <maml:description> <maml:para>A connection string with 'Manage' rights for the Azure Service Bus Namespace.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: QueueName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>QueueName</maml:name> <maml:description> <maml:para>The name of the queue to retrieve. All queues are returned if not specified.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: NamespaceConnectionString --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>NamespaceConnectionString</maml:name> <maml:description> <maml:para>A connection string with 'Manage' rights for the Azure Service Bus Namespace.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: QueueName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>QueueName</maml:name> <maml:description> <maml:para>The name of the queue to retrieve. All queues are returned if not specified.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <!-- OutputType: SbQueue --> <command:returnValue> <dev:type> <maml:name>PSServiceBus.Outputs.SbQueue</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Contains the name of a queue and the number of messages in the 'active' and 'dead letter' queues.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>Get-SbQueue -NamespaceConnectionString $namespaceConnectionString -QueueName 'example-queue'</dev:code> <dev:remarks> <maml:para>This gets information about a single queue called 'example-queue'.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>Get-SbQueue -NamespaceConnectionString $namespaceConnectionString</dev:code> <dev:remarks> <maml:para>This gets information about all queues.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-SbSubscription --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-SbSubscription</command:name> <command:verb>Get</command:verb> <command:noun>SbSubscription</command:noun> <maml:description> <maml:para>Gets a subscription by name or a list of all subscriptions in an from an Azure Service Bus Topic. Returns the number of messages in the active and dead letter queues.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Gets a subscription by name or a list of all subscriptions in an from an Azure Service Bus Topic. Returns the number of messages in the active and dead letter queues.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-SbSubscription</maml:name> <!-- Parameter: NamespaceConnectionString --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>NamespaceConnectionString</maml:name> <maml:description> <maml:para>A connection string with 'Manage' rights for the Azure Service Bus Namespace.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: TopicName --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>TopicName</maml:name> <maml:description> <maml:para>Name of the topic to retrieve subscriptions from.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SubscriptionName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SubscriptionName</maml:name> <maml:description> <maml:para>Name of a specific subscription to retrieve.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: NamespaceConnectionString --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>NamespaceConnectionString</maml:name> <maml:description> <maml:para>A connection string with 'Manage' rights for the Azure Service Bus Namespace.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: TopicName --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>TopicName</maml:name> <maml:description> <maml:para>Name of the topic to retrieve subscriptions from.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SubscriptionName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SubscriptionName</maml:name> <maml:description> <maml:para>Name of a specific subscription to retrieve.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Name of the topic to retrieve subscriptions from.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: SbSubscription --> <command:returnValue> <dev:type> <maml:name>PSServiceBus.Outputs.SbSubscription</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Contains the name of a subscription, the name of the containing topic, and the number of messages in the 'active' and 'dead letter' queues.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>Get-SbSubscription -NamespaceConnectionString $namespaceConnectionString -TopicName 'example-topic' -SubscriptionName 'example-subscription'</dev:code> <dev:remarks> <maml:para>This gets information about a single subscription called 'example-subscription' in a topic called 'example-topic'.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>Get-SbSubscription -NamespaceConnectionString $namespaceConnectionString -TopicName 'example-topic'</dev:code> <dev:remarks> <maml:para>This gets information about all subscriptions in a topic called 'example-topic'.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-SbTopic --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-SbTopic</command:name> <command:verb>Get</command:verb> <command:noun>SbTopic</command:noun> <maml:description> <maml:para>Gets a topic by name or a list of all topics from an Azure Service Bus Namespace. Returns the names of the subscriptions in the retrieved topic(s).</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Gets a topic by name or a list of all topics from an Azure Service Bus Namespace. Returns the names of the subscriptions in the retrieved topic(s).</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-SbTopic</maml:name> <!-- Parameter: NamespaceConnectionString --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>NamespaceConnectionString</maml:name> <maml:description> <maml:para>A connection string with 'Manage' rights for the Azure Service Bus Namespace.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: TopicName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TopicName</maml:name> <maml:description> <maml:para>The name of the topic to retrieve. All topics are returned if not specified.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: NamespaceConnectionString --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>NamespaceConnectionString</maml:name> <maml:description> <maml:para>A connection string with 'Manage' rights for the Azure Service Bus Namespace.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: TopicName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TopicName</maml:name> <maml:description> <maml:para>The name of the topic to retrieve. All topics are returned if not specified.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <!-- OutputType: SbTopic --> <command:returnValue> <dev:type> <maml:name>PSServiceBus.Outputs.SbTopic</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Contains the name of a topic and a list of its subscriptions.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>Get-SbTopic -NamespaceConnectionString $namespaceConnectionString -TopicName 'example-topic'</dev:code> <dev:remarks> <maml:para>This gets information about a single topic called 'example-topic'.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>Get-SbTopic -NamespaceConnectionString $namespaceConnectionString</dev:code> <dev:remarks> <maml:para>This gets information about all topics.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> </helpItems> |