New-SMServer
SYNOPSIS
Registers a SWA server
SYNTAX
New-SMServer [-Name] <String> [-sub] <String> [-trustDomainName] <String> [-serverGroupName] <String> [-InformationAction <ActionPreference>] [-ErrorVariable <String>] [-WarningAction <ActionPreference>] [-Debug] [-ErrorAction <ActionPreference>] [-OutBuffer <Int32>] [-PipelineVariable <String>] [-OutVariable <String>] [-WarningVariable <String>] [-InformationVariable <String>] [-public_keys <Hashtable>] [-issuer <String>] [-jwks_uri <String>] [-ca_cert <String>] [-audience <String>] [-token_app_property <String>] [-Verbose] [-identity_path <String>] [-claim_aliases <Hashtable>] [-enforced_claims <String[]>] [-WhatIf] [-Confirm] [<CommonParameters>]
DESCRIPTION
Registers a server in the specified server group, with a JWT authenticator configuration.
EXAMPLES
Example 1
New-SMServer
Registers a SWA server
PARAMETERS
-trustDomainName
The name of the trust domain.
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-serverGroupName
The name of the server group.
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-Name
The name of the resource.
Type: String
Parameter Sets: (All)
Aliases: serverName
Required: True
Position: 2
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-sub
The expected subject claim value from the workload JWT, identifying the server.
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 3
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-ca_cert
PEM-encoded CA certificate(s) used to validate the JWKS provider TLS connection.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 4
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-audience
Expected audience claim (aud) value used to validate the JWT.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 5
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-jwks_uri
The URL of the JWKS endpoint used to retrieve the JWT signing keys.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 6
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-public_keys
Inline JWKS used when the JWKS URL cannot be reached remotely.
Type: Hashtable
Parameter Sets: (All)
Aliases:
Required: False
Position: 7
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-issuer
Expected issuer claim (iss) value used to validate the JWT.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 8
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-claim_aliases
A mapping of custom alias names to JWT claim names.
Type: Hashtable
Parameter Sets: (All)
Aliases:
Required: False
Position: 9
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-enforced_claims
JWT claims that all associated workloads must include in their annotations.
Type: String[]
Parameter Sets: (All)
Aliases:
Required: False
Position: 10
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-identity_path
The workload’s policy ID (full pathname), used together with -token_app_property.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 11
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-token_app_property
The name of the JWT claim whose value is matched against the workload’s ID.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 12
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Confirm
Prompts you for confirmation before running the cmdlet.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf
Required: False
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.