Test-AzSpringCloudConfigServer
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 .
Check if the config server settings are valid.
Syntax
ValidateExpanded (Default)
Test-AzSpringCloudConfigServer
-Name <String>
-ResourceGroupName <String>
[-SubscriptionId <String>]
[-GitHostKey <String>]
[-GitHostKeyAlgorithm <String>]
[-GitLabel <String>]
[-GitPassword <String>]
[-GitPrivateKey <String>]
[-GitRepository <IGitPatternRepository[]>]
[-GitSearchPath <String[]>]
[-GitStrictHostKeyChecking]
[-GitUri <String>]
[-GitUsername <String>]
[-DefaultProfile <PSObject>]
[-AsJob]
[-NoWait]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
ValidateViaJsonString
Test-AzSpringCloudConfigServer
-Name <String>
-ResourceGroupName <String>
-JsonString <String>
[-SubscriptionId <String>]
[-DefaultProfile <PSObject>]
[-AsJob]
[-NoWait]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
ValidateViaJsonFilePath
Test-AzSpringCloudConfigServer
-Name <String>
-ResourceGroupName <String>
-JsonFilePath <String>
[-SubscriptionId <String>]
[-DefaultProfile <PSObject>]
[-AsJob]
[-NoWait]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
ValidateViaIdentityExpanded
Test-AzSpringCloudConfigServer
-InputObject <ISpringCloudIdentity>
[-GitHostKey <String>]
[-GitHostKeyAlgorithm <String>]
[-GitLabel <String>]
[-GitPassword <String>]
[-GitPrivateKey <String>]
[-GitRepository <IGitPatternRepository[]>]
[-GitSearchPath <String[]>]
[-GitStrictHostKeyChecking]
[-GitUri <String>]
[-GitUsername <String>]
[-DefaultProfile <PSObject>]
[-AsJob]
[-NoWait]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
Check if the config server settings are valid.
Examples
Example 1: Check if the config server settings are valid
Test-AzSpringCloudConfigServer -ResourceGroupName SpringCloud-gp-junxi -Name springcloud-service
IsValid
-------
True
Check if the config server settings are valid.
Example 2: Check if the config server settings are valid by pipeline
Get-AzSpringCloudConfigServer -ResourceGroupName SpringCloud-gp-junxi -Name springcloud-service | Test-AzSpringCloudConfigServer
IsValid
-------
True
Check if the config server settings are valid by pipeline.
Parameters
-AsJob
Run the command as a job
Parameter properties
Type: SwitchParameter
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-Confirm
Prompts you for confirmation before running the cmdlet.
Parameter properties
Type: SwitchParameter
Default value: None Supports wildcards: False DontShow: False Aliases: cf
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-DefaultProfile
The DefaultProfile parameter is not functional.
Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription.
Parameter properties
Type: PSObject
Default value: None Supports wildcards: False DontShow: False Aliases: AzureRMContext, AzureCredential
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-GitHostKey
Public sshKey of git repository.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
ValidateExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
ValidateViaIdentityExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-GitHostKeyAlgorithm
SshKey algorithm of git repository.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
ValidateExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
ValidateViaIdentityExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-GitLabel
Label of the repository
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
ValidateExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
ValidateViaIdentityExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-GitPassword
Password of git repository basic auth.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
ValidateExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
ValidateViaIdentityExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-GitPrivateKey
Private sshKey algorithm of git repository.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
ValidateExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
ValidateViaIdentityExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-GitRepository
Repositories of git.
Parameter properties
Parameter sets
ValidateExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
ValidateViaIdentityExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-GitSearchPath
Searching path of the repository
Parameter properties
Type: String [ ]
Default value: None Supports wildcards: False DontShow: False
Parameter sets
ValidateExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
ValidateViaIdentityExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-GitStrictHostKeyChecking
Strict host key checking or not.
Parameter properties
Type: SwitchParameter
Default value: None Supports wildcards: False DontShow: False
Parameter sets
ValidateExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
ValidateViaIdentityExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-GitUri
URI of the repository
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
ValidateExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
ValidateViaIdentityExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-GitUsername
Username of git repository basic auth.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
ValidateExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
ValidateViaIdentityExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
Identity Parameter
ValidateViaIdentityExpanded
Position: Named Mandatory: True Value from pipeline: True Value from pipeline by property name: False Value from remaining arguments: False
-JsonFilePath
Path of Json file supplied to the Validate operation
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
ValidateViaJsonFilePath
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-JsonString
Json string supplied to the Validate operation
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
ValidateViaJsonString
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-Name
The name of the Service resource.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
ValidateExpanded
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
ValidateViaJsonString
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
ValidateViaJsonFilePath
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-NoWait
Run the command asynchronously
Parameter properties
Type: SwitchParameter
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-ResourceGroupName
The name of the resource group that contains the resource.
You can obtain this value from the Azure Resource Manager API or the portal.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
ValidateExpanded
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
ValidateViaJsonString
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
ValidateViaJsonFilePath
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-SubscriptionId
Gets subscription ID which uniquely identify the Microsoft Azure subscription.
The subscription ID forms part of the URI for every service call.
Parameter properties
Type: String
Default value: (Get-AzContext).Subscription.Id Supports wildcards: False DontShow: False
Parameter sets
ValidateExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
ValidateViaJsonString
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
ValidateViaJsonFilePath
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-WhatIf
Shows what would happen if the cmdlet runs.
The cmdlet is not run.
Parameter properties
Type: SwitchParameter
Default value: None Supports wildcards: False DontShow: False Aliases: wi
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
-InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable,
-ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see
about_CommonParameters .
Outputs
