Tests a resource provider.
Syntax
Parameter Set: ByProperties
Test-MgmtSvcResourceProvider [-AdminUri] <Uri> [-Token]
<String> [-Name] <String> [-DisplayName] <String>
[[-Description] <String> ] [[-Enabled] <Boolean> ]
[[-PassThroughEnabled] <Boolean> ] [[-AllowAnonymousAccess]
<Boolean> ] [[-AllowMultipleInstances] <Boolean> ]
[[-AdminForwardingAddress] <Uri> ]
[[-AdminAuthenticationMode] {None | Basic | Windows} ]
[[-AdminAuthenticationUser] <PSCredential> ]
[[-TenantForwardingAddress] <Uri> ]
[[-TenantAuthenticationMode] {None | Basic | Windows} ]
[[-TenantAuthenticationUsername] <String> ]
[[-TenantAuthenticationPassword] <String> ]
[[-UsageForwardingAddress] <Uri> ]
[[-UsageAuthenticationMode] {None | Basic | Windows} ]
[[-UsageAuthenticationUsername] <String> ]
[[-UsageAuthenticationPassword] <String> ]
[[-HealthCheckForwardingAddress] <Uri> ]
[[-HealthCheckAuthenticationMode] {None | Basic | Windows} ]
[[-HealthCheckAuthenticationUsername] <String> ]
[[-HealthCheckAuthenticationPassword] <String> ]
[[-NotificationForwardingAddress] <Uri> ]
[[-NotificationAuthenticationMode] {None | Basic | Windows} ]
[[-NotificationAuthenticationUsername] <String> ]
[[-NotificationAuthenticationPassword] <String> ]
[[-InstanceId] <Guid> ] [-InstanceDisplayName] <String>
[[-MaxQuotaUpdateBatchSize] <Int32> ]
[[-SubscriptionStatusPollingInterval] <TimeSpan> ] [[-Type]
{Standard | UsageProvider | CloudServiceProvider} ] [-TestUri]
<Uri> [-DisableCertificateValidation] [-IsAdmin] [-Confirm]
[-WhatIf] [ <CommonParameters>]
Parameter Set: ByObject
Test-MgmtSvcResourceProvider [-AdminUri] <Uri> [-Token]
<String> [[-ResourceProvider] <ResourceProvider> ]
[-TestUri] <Uri> [-DisableCertificateValidation] [-IsAdmin]
[-Confirm] [-WhatIf] [ <CommonParameters>]
The Test-MgmtSvcResourceProvider validates a resource provider.
Specifies the administrative authentication mode of a resource provider. Valid values for this parameter are:
-- None
-- Basic
-- Windows
The acceptable values for this parameter are:
None |
|
Basic |
|
Windows |
|
Aliases |
none |
Required? |
false |
Position? |
11 |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
Specifies, as a PSCredential object, an administrative user name and password to connect to a resource provider. To get a PSCredential object, use the Get-Credential cmdlet.
Aliases |
none |
Required? |
false |
Position? |
12 |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
Specifies an administrator forwarding address for a resource provider.
Aliases |
none |
Required? |
false |
Position? |
10 |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
Specifies the URI of the Windows Azure Pack administrator API. Use the following format: https://<computer>:<port>, where <computer> is the computer on which the administrator API is installed.
Aliases |
none |
Required? |
true |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
Indicates that anonymous access is allowed to a resource provider.
Aliases |
none |
Required? |
false |
Position? |
8 |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
Indicates whether the cmdlet allows multiple instances of the resource provider.
Aliases |
none |
Required? |
false |
Position? |
9 |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
Specifies a description for the resource provider.
Aliases |
none |
Required? |
false |
Position? |
5 |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
Disables certificate validation for the Windows Azure Pack installation.
If you specifiy this parameter, you can use self-signed certificates.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
Specifies the display name of a resource provider.
Aliases |
none |
Required? |
true |
Position? |
4 |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
Enables the resource provider.
Aliases |
none |
Required? |
false |
Position? |
6 |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
Specifies the health check authentication mode for a resource provider. Valid values for this parameter are:
-- None
-- Basic
-- Windows
The acceptable values for this parameter are:
None |
|
Basic |
|
Windows |
|
Aliases |
none |
Required? |
false |
Position? |
23 |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
Specifies a health check password to connect to a resource provider.
Aliases |
none |
Required? |
false |
Position? |
25 |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
Specifies a health check user name to connect to a resource provider.
Aliases |
none |
Required? |
false |
Position? |
24 |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
Specifies the health check forwarding address for a resource provider.
Aliases |
none |
Required? |
false |
Position? |
22 |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
Specifies a display name for an instance of a resource provider.
Aliases |
none |
Required? |
true |
Position? |
31 |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
Specifies an ID for an instance of a resource provider.
Aliases |
none |
Required? |
false |
Position? |
30 |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
Indicates that the testing is performed against the Admin API endpoint. If this parameter is not used, the Tenant API endpoint is tested.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
Specifies the number of subscriptions that can be updated in a single request. The default value is 5.
Aliases |
none |
Required? |
false |
Position? |
32 |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
Specifies the name of a resource provider.
Aliases |
none |
Required? |
true |
Position? |
3 |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
Specifies the notification authentication mode for a resource provider. Valid values for this parameter are:
-- None
-- Basic
-- Windows
The acceptable values for this parameter are:
None |
|
Basic |
|
Windows |
|
Aliases |
none |
Required? |
false |
Position? |
27 |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
Specifies a notification password to connect to a resource provider.
Aliases |
none |
Required? |
false |
Position? |
29 |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
Specifies a notification user name to connect to a resource provider.
Aliases |
none |
Required? |
false |
Position? |
28 |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
Specifies the notification forwarding address of a resource provider.
Aliases |
none |
Required? |
false |
Position? |
26 |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
Indicates whether the resource provider supports API pass-through.
Aliases |
none |
Required? |
false |
Position? |
7 |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
Specifies a resource provider object.
Aliases |
none |
Required? |
false |
Position? |
3 |
Default Value |
none |
Accept Pipeline Input? |
True (ByValue) |
Accept Wildcard Characters? |
false |
Specifies the time interval at which the management service polls the resource provider for subscription status updates. The default is 10 seconds.
Format this value in the standard JASON serialized timespan of 00:00:00. For example, 10 seconds is formatted as 00:00:10.
Aliases |
none |
Required? |
false |
Position? |
33 |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
Specifies the tenant authentication mode of a resource provider. Valid values for this parameter are:
-- None
-- Basic
-- Windows
The acceptable values for this parameter are:
None |
|
Basic |
|
Windows |
|
Aliases |
none |
Required? |
false |
Position? |
15 |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
Specifies the tenant password to connect to a resource provider.
Aliases |
none |
Required? |
false |
Position? |
17 |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
Specifies the tenant user name to connect to a resource provider.
Aliases |
none |
Required? |
false |
Position? |
16 |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
Specifies the tenant forwarding address of a resource provider.
Aliases |
none |
Required? |
false |
Position? |
14 |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
Specifies the URI used for testing.
Aliases |
none |
Required? |
true |
Position? |
35 |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
Specifies an identity token. To create a token, use the Get-MgmtSvcToken cmdlet.
Aliases |
none |
Required? |
true |
Position? |
2 |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
Specifies the type of the resource provider. Valid values for this parameter are:
-- Standard
-- UsageProvider
-- CloudServiceProvider
The acceptable values for this parameter are:
Standard |
|
UsageProvider |
|
CloudServiceProvider |
|
Aliases |
none |
Required? |
false |
Position? |
34 |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
Specifies the usage authentication mode of a resource provider. Valid values for this parameter are:
-- None
-- Basic
-- Windows
The acceptable values for this parameter are:
None |
|
Basic |
|
Windows |
|
Aliases |
none |
Required? |
false |
Position? |
19 |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
Specifies the usage password to connect to a resource provider.
Aliases |
none |
Required? |
false |
Position? |
21 |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
Specifies the usage user name to connect to a resource provider.
Aliases |
none |
Required? |
false |
Position? |
20 |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
Specifies the notification forwarding address of a resource provider.
Aliases |
none |
Required? |
false |
Position? |
18 |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
Prompts you for confirmation before executing the command.
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
Describes what would happen if you executed the command without actually executing the command.
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see about_CommonParameters.
NOTE: This example assumes that you have created a token by using Get-MgmtSvcToken and have stored it in a variable named $Token.
The first command prompts the user for credentials and stores the resulting PSCredential object in the $AdminUser variable.
The second command tests the resource provider named sqlservers.
PS C:\> $AdminUser = Get-Credential
PS C:\> Test-MgmtSvcResourceProvider -TestUri
'https://testserver01:30010/'-Name 'sqlservers' -DisplayName 'SQL
Servers' -InstanceDisplayName 'SQL Servers'
-AdminAuthenticationUser $AdminUser -AdminUri
"https://Computer01:30004" -Token $Token
-DisableCertificateValidation
Remove-MgmtSvcResourceProvider