| external help file | Module Name | online version | schema |
|---|---|---|---|
AMSoftware.Crm.PowerShell.Commands.dll-Help.xml |
AMSoftware.Crm |
2.0.0 |
Register-CrmServiceEndpoint
SYNOPSIS
Register a serviceendpoint.
SYNTAX
RelayEndpointWithToken
Register-CrmServiceEndpoint [-Id ] [-Name] [-Endpoint] [-EndpointPathOrName]
[-Description ] -RelayContract -SASToken
[-Claim ] [-PassThru] []
RelayEndpointWithKey
Register-CrmServiceEndpoint [-Id ] [-Name] [-Endpoint] [-EndpointPathOrName]
[-Description ] -RelayContract -SASKeyName -SASKey
[-Claim ] [-PassThru] []
QueueuEndpointWithToken
Register-CrmServiceEndpoint [-Id ] [-Name] [-Endpoint] [-EndpointPathOrName]
[-Description ] -QueueContract
[-MessageFormat ] -SASToken [-Claim ]
[-PassThru] []
QueueuEndpointWithKey
Register-CrmServiceEndpoint [-Id ] [-Name] [-Endpoint] [-EndpointPathOrName]
[-Description ] -QueueContract
[-MessageFormat ] -SASKeyName -SASKey
[-Claim ] [-PassThru] []
DESCRIPTION
Register a serviceendpoint.
EXAMPLES
PARAMETERS
-Claim
The type of claim for the serviceendpoint.
Parameter Sets: (All)
Aliases: UserInformation
Accepted values: None, UserId, UserInfo
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Description
The description for the serviceendpoint.
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Endpoint
The Endpoint URI of the service endpoint. URI depends on the type of service endpoint. Can be an Azure ServiceBus namespace URI, of a HTTP endpoint.
Parameter Sets: (All)
Aliases: NamespaceAddress, Namespace
Required: True
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-EndpointPathOrName
Name or Path specifier for the service endpoint. The name of the Topic or Queue, etc.
Parameter Sets: (All)
Aliases:
Required: True
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Id
If provided the Id of an existing Service Endpoint to update
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: False
-MessageFormat
The format of the messages send to an Azure ServiceBus.
Parameter Sets: QueueuEndpointWithToken, QueueuEndpointWithKey
Aliases:
Accepted values: DOTNETBinary, JSON, XML
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Name
The name for the serviceendpoint.
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-PassThru
Returns an object that represents the Service Endpoint. By default, this cmdlet does not generate any output.
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-QueueContract
The type of async messaging contract to use.
Parameter Sets: QueueuEndpointWithToken, QueueuEndpointWithKey
Aliases:
Accepted values: Queue, Topic, Eventhub
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-RelayContract
The type of async relay contract to use.
Parameter Sets: RelayEndpointWithToken, RelayEndpointWithKey
Aliases:
Accepted values: Oneway, Twoway, Rest
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-SASKey
The SASKey value to use with SASKey Authorization type
Parameter Sets: RelayEndpointWithKey, QueueuEndpointWithKey
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-SASKeyName
The SASKey name to use with SASKey Authorization type
Parameter Sets: RelayEndpointWithKey, QueueuEndpointWithKey
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-SASToken
The SASToken value to use with SASToken Authorization type
Parameter Sets: RelayEndpointWithToken, QueueuEndpointWithToken
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.