您现在访问的是微软AZURE全球版技术文档网站,若需要访问由世纪互联运营的MICROSOFT AZURE中国区技术文档网站,请访问 https://docs.azure.cn.

Test-AzStaticWebAppCustomDomain

Description for Validates a particular custom domain can be added to a static site.

Syntax

Test-AzStaticWebAppCustomDomain
    -DomainName <String>
    -Name <String>
    -ResourceGroupName <String>
    [-SubscriptionId <String>]
    [-Kind <String>]
    [-ValidationMethod <String>]
    [-DefaultProfile <PSObject>]
    [-AsJob]
    [-NoWait]
    [-PassThru]
    [-Confirm]
    [-WhatIf]
    [<CommonParameters>]
Test-AzStaticWebAppCustomDomain
    -InputObject <IWebsitesIdentity>
    [-Kind <String>]
    [-ValidationMethod <String>]
    [-DefaultProfile <PSObject>]
    [-AsJob]
    [-NoWait]
    [-PassThru]
    [-Confirm]
    [-WhatIf]
    [<CommonParameters>]

Description

Description for Validates a particular custom domain can be added to a static site.

Examples

Example 1: Validate a particular custom domain can be added to a static site

PS C:\> Test-AzStaticWebAppCustomDomain -ResourceGroupName resourceGroup -Name staticweb00 -DomainName 'www01.azpstest.net'

This commnad validates a particular custom domain can be added to a static site

Example 2: Validate a particular custom domain can be added to a static site by pipeline

PS C:\> Get-AzStaticWebAppCustomDomain -ResourceGroupName resourceGroup -Name staticweb00 -DomainName 'www01.azpstest.net' | Get-AzStaticWebAppCustomDomain

This commnad validates a particular custom domain can be added to a static site by pipeline.

Parameters

-AsJob

Run the command as a job

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-DefaultProfile

The credentials, account, tenant, and subscription used for communication with Azure.

Type:PSObject
Aliases:AzureRMContext, AzureCredential
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-DomainName

The custom domain to validate.

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-InputObject

Identity Parameter To construct, see NOTES section for INPUTOBJECT properties and create a hash table.

Type:Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity
Position:Named
Default value:None
Accept pipeline input:True
Accept wildcard characters:False
-Kind

Kind of resource.

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Name

Name of the static site.

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-NoWait

Run the command asynchronously

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-PassThru

Returns true when the command succeeds

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-ResourceGroupName

Name of the resource group to which the resource belongs.

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-SubscriptionId

Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000).

Type:String
Position:Named
Default value:(Get-AzContext).Subscription.Id
Accept pipeline input:False
Accept wildcard characters:False
-ValidationMethod

Validation method for adding a custom domain

Type:String
Position:Named
Default value:None
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
Accept pipeline input:False
Accept wildcard characters:False

Inputs

Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.IWebsitesIdentity

Outputs

Boolean

Notes

ALIASES

COMPLEX PARAMETER PROPERTIES

To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables.

INPUTOBJECT : Identity Parameter

  • [Authprovider <String>]: The auth provider for the users.
  • [DomainName <String>]: The custom domain name.
  • [EnvironmentName <String>]: The stage site identifier.
  • [FunctionAppName <String>]: Name of the function app registered with the static site build.
  • [Id <String>]: Resource identity path
  • [Location <String>]: Location where you plan to create the static site.
  • [Name <String>]: Name of the static site.
  • [PrivateEndpointConnectionName <String>]: Name of the private endpoint connection.
  • [ResourceGroupName <String>]: Name of the resource group to which the resource belongs.
  • [SubscriptionId <String>]: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000).
  • [Userid <String>]: The user id of the user.