New-AzWcfRelay
Creates or updates a WCF relay. This operation is idempotent.
Syntax
New-AzWcfRelay
-Name <String>
-Namespace <String>
-ResourceGroupName <String>
[-SubscriptionId <String>]
[-RequiresClientAuthorization]
[-RequiresTransportSecurity]
[-UserMetadata <String>]
[-WcfRelayType <Relaytype>]
[-DefaultProfile <PSObject>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] New-AzWcfRelay
-Name <String>
-Namespace <String>
-ResourceGroupName <String>
[-SubscriptionId <String>]
-InputObject <IWcfRelay>
[-DefaultProfile <PSObject>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Description
Creates or updates a WCF relay. This operation is idempotent.
Examples
Example 1: Create a new Wcf Relay
New-AzWcfRelay -ResourceGroupName lucas-relay-rg -Namespace namespace-pwsh01 -Name wcf-02 -WcfRelayType 'NetTcp' -UserMetadata "test 01"
CreatedAt : 12/20/2022 9:01:10 AM
Id : /subscriptions/9e223dbe-3399-4e19-88eb-0975f02ac87f/resourceGroups/lucas-relay-rg/providers/Microsoft.Relay/namespaces/namespa
ce-pwsh01/wcfrelays/wcf-02
IsDynamic : False
ListenerCount : 0
Location : eastus
Name : wcf-02
RelayType : NetTcp
RequiresClientAuthorization : False
RequiresTransportSecurity : False
ResourceGroupName : lucas-relay-rg
SystemDataCreatedAt :
SystemDataCreatedBy :
SystemDataCreatedByType :
SystemDataLastModifiedAt :
SystemDataLastModifiedBy :
SystemDataLastModifiedByType :
Type : Microsoft.Relay/namespaces/wcfrelays
UpdatedAt : 12/20/2022 9:01:10 AM
UserMetadata : test 01This command creates a new Wcf Relay.
Example 2: Create a new Wcf Relay using an existing Wcf Relay as a parameter
$wcf = Get-AzWcfRelay -ResourceGroupName lucas-relay-rg -Namespace namespace-pwsh01 -Name wcf-02
$wcf.UserMetadata = "User Date"
New-AzWcfRelay -ResourceGroupName lucas-relay-rg -Namespace namespace-pwsh01 -Name wcf-03 -InputObject $wcf
Location Name ResourceGroupName
-------- ---- -----------------
eastus wcf-03 lucas-relay-rgThis command creates a new Wcf Relay using an existing Wcf Relay as a parameter.
Example 3: Update an existing Wcf Relay
$wcf = Get-AzWcfRelay -ResourceGroupName lucas-relay-rg -Namespace namespace-pwsh01 -Name wcf-02
$wcf.UserMetadata = "User Date"
New-AzWcfRelay -ResourceGroupName lucas-relay-rg -Namespace namespace-pwsh01 -Name wcf-02 -InputObject $wcf
Location Name ResourceGroupName
-------- ---- -----------------
eastus wcf-02 lucas-relay-rgThis command updates an existing Wcf Relay.
Parameters
-Confirm
Prompts you for confirmation before running the cmdlet.
| Type: | SwitchParameter |
| Aliases: | cf |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-DefaultProfile
The DefaultProfile parameter is not functional. Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription.
| Type: | PSObject |
| Aliases: | AzureRMContext, AzureCredential |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-InputObject
Description of the WCF relay resource. To construct, see NOTES section for INPUTOBJECT properties and create a hash table.
| Type: | IWcfRelay |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-Name
The relay name.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Namespace
The namespace name
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-RequiresClientAuthorization
Returns true if client authorization is needed for this relay; otherwise, false.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-RequiresTransportSecurity
Returns true if transport security is needed for this relay; otherwise, false.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ResourceGroupName
Name of the Resource group within the Azure subscription.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-SubscriptionId
Subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
| Type: | String |
| Position: | Named |
| Default value: | (Get-AzContext).Subscription.Id |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-UserMetadata
The usermetadata is a placeholder to store user-defined string data for the WCF Relay endpoint. For example, it can be used to store descriptive data, such as list of teams and their contact information. Also, user-defined configuration settings can be stored.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-WcfRelayType
WCF relay type.
| Type: | Relaytype |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
| Type: | SwitchParameter |
| Aliases: | wi |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |