Skip to content

Latest commit

 

History

History
245 lines (195 loc) · 6.13 KB

File metadata and controls

245 lines (195 loc) · 6.13 KB
external help file Az.ServiceLinker-help.xml
Module Name Az.ServiceLinker
online version https://learn.microsoft.com/powershell/module/az.servicelinker/test-azservicelinkerforwebapp
schema 2.0.0
content_git_url https://github.com/Azure/azure-powershell/blob/main/src/ServiceLinker/ServiceLinker/help/Test-AzServiceLinkerForWebApp.md
original_content_git_url https://github.com/Azure/azure-powershell/blob/main/src/ServiceLinker/ServiceLinker/help/Test-AzServiceLinkerForWebApp.md
cmdletStatusMessage This cmdlet is part of a **Preview** module. Preview versions aren't recommended for use in production environments. For more information, see https://aka.ms/azps-refstatus.
cmdletStatus preview

Test-AzServiceLinkerForWebApp

SYNOPSIS

Validate a link in webapp.

SYNTAX

Validate (Default)

Test-AzServiceLinkerForWebApp -Name <String> [-ResourceUri <String>] [-DefaultProfile <PSObject>]
 -WebApp <String> -ResourceGroupName <String> [-SubscriptionId <String>] [-AsJob] [-NoWait]
 [-WhatIf] [-Confirm] [<CommonParameters>]

ValidateViaIdentity

Test-AzServiceLinkerForWebApp -InputObject <IServiceLinkerIdentity> [-DefaultProfile <PSObject>]
 [-SubscriptionId <String>] [-AsJob] [-NoWait] [-WhatIf] [-Confirm]
 [<CommonParameters>]

DESCRIPTION

Validate a link in webapp.

EXAMPLES

Example 1: Test Linker

Test-AzServiceLinkerForWebApp -WebApp servicelinker-webapp -ResourceGroupName servicelinker-test-group -Name postgresql_connection | Format-List
AuthType              : 
IsConnectionAvailable : True
LinkerName            : postgresql_connection
ReportEndTimeUtc      : 5/6/2022 8:32:26 AM
ReportStartTimeUtc    : 5/6/2022 8:32:24 AM
ResourceId            : /subscriptions/a0a0a0a0-bbbb-cccc-dddd-e1e1e1e1e1e1/resourceGroups/servicelinke 
                        r-test-group/providers/Microsoft.Web/sites/servicelinker-webapp/providers/Mi 
                        crosoft.ServiceLinker/linkers/postgresql_connection
SourceId              :
Status                : Succeeded
TargetId              : /subscriptions/937bc588-a144-4083-8612-5f9ffbbddb14/resourceGroups/servicelinke 
                        r-test-group/providers/Microsoft.Storage/storageAccounts/servicelinkersto 
                        rage/tableServices/default
ValidationDetail      : {The target existence is validated, The target service firewall is validated,   
                        The configured values is validated}

Test Linker

PARAMETERS

-AsJob

Run the command as a job

Type: System.Management.Automation.SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
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: System.Management.Automation.PSObject
Parameter Sets: (All)
Aliases: AzureRMContext, AzureCredential

Required: False
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.ServiceLinker.Models.IServiceLinkerIdentity
Parameter Sets: ValidateViaIdentity
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-Name

The name Linker resource.

Type: System.String
Parameter Sets: Validate
Aliases: LinkerName

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-NoWait

Run the command asynchronously

Type: System.Management.Automation.SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ResourceGroupName

The resource group of the resource to be connected.

Type: System.String
Parameter Sets: Validate
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ResourceUri

The fully qualified Azure Resource manager identifier of the resource to be connected.

Type: System.String
Parameter Sets: Validate
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-SubscriptionId

Gets subscription ID which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Type: System.String
Parameter Sets: (All)
Aliases:

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

-WebApp

The Name of webapp of the resource to be connected.

Type: System.String
Parameter Sets: Validate
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Confirm

Prompts you for confirmation before running the cmdlet.

Type: System.Management.Automation.SwitchParameter
Parameter Sets: (All)
Aliases: cf

Required: False
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: System.Management.Automation.SwitchParameter
Parameter Sets: (All)
Aliases: wi

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.

INPUTS

Microsoft.Azure.PowerShell.Cmdlets.ServiceLinker.Models.IServiceLinkerIdentity

OUTPUTS

Microsoft.Azure.PowerShell.Cmdlets.ServiceLinker.Models.IValidateResult

NOTES

RELATED LINKS