Get-AzStaticWebAppCustomDomain
Description for Gets an existing custom domain for a particular static site.
Syntax
Get-AzStaticWebAppCustomDomain
-Name <String>
-ResourceGroupName <String>
[-SubscriptionId <String[]>]
[-DefaultProfile <PSObject>]
[<CommonParameters>]
Get-AzStaticWebAppCustomDomain
-DomainName <String>
-Name <String>
-ResourceGroupName <String>
[-SubscriptionId <String[]>]
[-DefaultProfile <PSObject>]
[<CommonParameters>]
Get-AzStaticWebAppCustomDomain
-InputObject <IWebsitesIdentity>
[-DefaultProfile <PSObject>]
[<CommonParameters>]
Description
Description for Gets an existing custom domain for a particular static site.
Examples
Example 1: List all existing custom domains for a particular static site
Get-AzStaticWebAppCustomDomain -ResourceGroupName azure-rg-test -Name staticweb00
Kind Name Type
---- ---- ----
www01.azpstest.net Microsoft.Web/staticSites/customDomains
This command lists all existing custom domains for a particular static site.
Example 2: Get an existing custom domain for a particular static site
Get-AzStaticWebAppCustomDomain -ResourceGroupName azure-rg-test -Name staticweb00 -DomainName 'www02.azpstest.net'
Kind Name Type
---- ---- ----
www02.azpstest.net Microsoft.Web/staticSites/customDomains
This command gets an existing custom domain for a particular static site.
Example 3: Get an existing custom domain for a particular static site by pipeline
New-AzStaticWebAppCustomDomain -ResourceGroupName azure-rg-test -Name staticweb00 -DomainName 'www02.azpstest.net' | Get-AzStaticWebAppCustomDomain
Kind Name Type
---- ---- ----
www02.azpstest.net Microsoft.Web/staticSites/customDomains
This command gets an existing custom domain for a particular static site by pipeline.
Parameters
-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 |
-DomainName
The custom domain name.
Type: | String |
Position: | Named |
Default value: | None |
Required: | True |
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: | IWebsitesIdentity |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-Name
Name of the static site resource to search in.
Type: | String |
Position: | Named |
Default value: | None |
Required: | True |
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 |
Required: | True |
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 |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |