Get-AzIotHubRoutingEndpoint
Get information on all the endpoints for your IoT Hub
Syntax
Get-AzIotHubRoutingEndpoint
[-ResourceGroupName] <String>
[-Name] <String>
[-EndpointType <PSEndpointType>]
[-EndpointName <String>]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
Get-AzIotHubRoutingEndpoint
[-InputObject] <PSIotHub>
[-EndpointType <PSEndpointType>]
[-EndpointName <String>]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
Get-AzIotHubRoutingEndpoint
[-ResourceId] <String>
[-EndpointType <PSEndpointType>]
[-EndpointName <String>]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
Description
Get information on the endpoint.
Examples
Example 1
Get-AzIotHubRoutingEndpoint -ResourceGroupName "myresourcegroup" -Name "myiothub"
Name EndpointType AzureResource
---- ------------ -------------
E1 EventHub resourcegroup1/event1
E2 EventHub resourcegroup1/event2
S1 AzureStorageContainer mystorage1/container
Get all the endpoints from "myiothub" IoT Hub.
Example 2
Get-AzIotHubRoutingEndpoint -ResourceGroupName "myresourcegroup" -Name "myiothub" -EndpointType EventHub
ResourceGroupName SubscriptionId EndpointName
----------------- -------------- ------------
resourcegroup1 91d12343-a3de-345d-b2ea-135792468abc E1
resourcegroup1 91d12343-a3de-345d-b2ea-135792468abc E2
Get all the endpoints of type EventHub from "myiothub" IoT Hub.
Example 3
Get-AzIotHubRoutingEndpoint -ResourceGroupName "myresourcegroup" -Name "myiothub" -EndpointType EventHub
ResourceGroupName : resourcegroup1
SubscriptionId : 91d12343-a3de-345d-b2ea-135792468abc
EndpointName : E1
ConnectionString : Endpoint=sb://myeventhub1.servicebus.windows.net:5671/;SharedAccessKeyName=iothubroutes_myeventhub1;SharedAccessKey=****;EntityPath=event1
Get all the endpoints of type EventHub from "myiothub" IoT Hub.
Example 4
Get-AzIotHubRoutingEndpoint -ResourceGroupName "myresourcegroup" -Name "myiothub" -EndpointName E1
ResourceGroupName : resourcegroup1
SubscriptionId : 91d12343-a3de-345d-b2ea-135792468abc
EndpointName : E1
ConnectionString : Endpoint=sb://myeventhub1.servicebus.windows.net:5671/;SharedAccessKeyName=iothubroutes_myeventhub1;SharedAccessKey=****;EntityPath=event1
Get an endpoint information from "myiothub" IoT Hub.
Parameters
-DefaultProfile
The credentials, account, tenant, and subscription used for communication with Azure.
Type: | IAzureContextContainer |
Aliases: | AzContext, AzureRmContext, AzureCredential |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-EndpointName
Name of the Routing Endpoint
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-EndpointType
Type of the Routing Endpoint
Type: | PSEndpointType |
Accepted values: | EventHub, ServiceBusQueue, ServiceBusTopic, AzureStorageContainer |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-InputObject
IotHub Object
Type: | PSIotHub |
Position: | 0 |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-Name
Name of the Iot Hub
Type: | String |
Position: | 1 |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-ResourceGroupName
Name of the Resource Group
Type: | String |
Position: | 0 |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-ResourceId
IotHub Resource Id
Type: | String |
Position: | 0 |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
Inputs
Outputs
List<T>[[Microsoft.Azure.Commands.Management.IotHub.Models.PSRoutingEventHubProperties, Microsoft.Azure.PowerShell.Cmdlets.IotHub, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]
PSRoutingServiceBusQueueEndpoint
PSRoutingServiceBusQueueEndpointProperties[]
PSRoutingServiceBusTopicEndpoint
PSRoutingServiceBusTopicEndpointProperties[]
PSRoutingStorageContainerEndpoint