Test-MgmtSvcResourceProvider

Tests a resource provider.

Syntax

Test-MgmtSvcResourceProvider [-AdminUri] <Uri> [-Token] <String>
 [[-AdminAuthenticationMode] <AuthenticationMode>] [[-AdminAuthenticationUser] <PSCredential>]
 [[-TenantForwardingAddress] <Uri>] [[-TenantAuthenticationMode] <AuthenticationMode>]
 [[-TenantAuthenticationUsername] <String>] [[-TenantAuthenticationPassword] <String>]
 [[-UsageForwardingAddress] <Uri>] [[-UsageAuthenticationMode] <AuthenticationMode>]
 [[-UsageAuthenticationUsername] <String>] [-Name] <String> [[-UsageAuthenticationPassword] <String>]
 [[-HealthCheckForwardingAddress] <Uri>] [[-HealthCheckAuthenticationMode] <AuthenticationMode>]
 [[-HealthCheckAuthenticationUsername] <String>] [[-HealthCheckAuthenticationPassword] <String>]
 [[-NotificationForwardingAddress] <Uri>] [[-NotificationAuthenticationMode] <AuthenticationMode>]
 [[-NotificationAuthenticationUsername] <String>] [[-NotificationAuthenticationPassword] <String>]
 [[-InstanceId] <Guid>] [-DisplayName] <String> [-InstanceDisplayName] <String>
 [[-MaxQuotaUpdateBatchSize] <Int32>] [[-SubscriptionStatusPollingInterval] <TimeSpan>]
 [[-Type] <ResourceProviderType>] [-TestUri] <Uri> [[-Description] <String>] [[-Enabled] <Boolean>]
 [[-PassThroughEnabled] <Boolean>] [[-AllowAnonymousAccess] <Boolean>] [[-AllowMultipleInstances] <Boolean>]
 [[-AdminForwardingAddress] <Uri>] [-Confirm] [-DisableCertificateValidation] [-IsAdmin] [-WhatIf]
 [<CommonParameters>]
Test-MgmtSvcResourceProvider [-AdminUri] <Uri> [-Token] <String> [[-ResourceProvider] <ResourceProvider>]
 [-TestUri] <Uri> [-Confirm] [-DisableCertificateValidation] [-IsAdmin] [-WhatIf] [<CommonParameters>]

Description

The Test-MgmtSvcResourceProvider validates a resource provider.

Examples

Example 1: Test a resource provider

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
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.

Parameters

-AdminAuthenticationMode

Specifies the administrative authentication mode of a resource provider.
Valid values for this parameter are:

- None
- Basic
- Windows

Type:AuthenticationMode
Parameter Sets:None, Basic, Windows
Required:False
Position:10
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False

-AdminAuthenticationUser

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.

Type:PSCredential
Required:False
Position:11
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False

-AdminForwardingAddress

Specifies an administrator forwarding address for a resource provider.

Type:Uri
Required:False
Position:9
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False

-AdminUri

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.

Type:Uri
Required:True
Position:0
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False

-AllowAnonymousAccess

Indicates that anonymous access is allowed to a resource provider.

Type:Boolean
Required:False
Position:7
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False

-AllowMultipleInstances

Indicates whether the cmdlet allows multiple instances of the resource provider.

Type:Boolean
Required:False
Position:8
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Required:False
Position:Named
Default value:False
Accept pipeline input:False
Accept wildcard characters:False

-Description

Specifies a description for the resource provider.

Type:String
Required:False
Position:4
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False

-DisableCertificateValidation

Disables certificate validation for the Windows Azure Pack installation.

If you specify this parameter, you can use self-signed certificates.

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

-DisplayName

Specifies the display name of a resource provider.

Type:String
Required:True
Position:3
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False

-Enabled

Enables the resource provider.

Type:Boolean
Required:False
Position:5
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False

-HealthCheckAuthenticationMode

Specifies the health check authentication mode for a resource provider.
Valid values for this parameter are:

- None
- Basic
- Windows

Type:AuthenticationMode
Parameter Sets:None, Basic, Windows
Required:False
Position:22
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False

-HealthCheckAuthenticationPassword

Specifies a health check password to connect to a resource provider.

Type:String
Required:False
Position:24
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False

-HealthCheckAuthenticationUsername

Specifies a health check user name to connect to a resource provider.

Type:String
Required:False
Position:23
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False

-HealthCheckForwardingAddress

Specifies the health check forwarding address for a resource provider.

Type:Uri
Required:False
Position:21
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False

-InstanceDisplayName

Specifies a display name for an instance of a resource provider.

Type:String
Required:True
Position:30
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False

-InstanceId

Specifies an ID for an instance of a resource provider.

Type:Guid
Required:False
Position:29
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False

-IsAdmin

Indicates that the testing is performed against the Admin API endpoint.
If this parameter is not used, the Tenant API endpoint is tested.

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

-MaxQuotaUpdateBatchSize

Specifies the number of subscriptions that can be updated in a single request.
The default value is 5.

Type:Int32
Required:False
Position:31
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False

-Name

Specifies the name of a resource provider.

Type:String
Required:True
Position:2
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False

-NotificationAuthenticationMode

Specifies the notification authentication mode for a resource provider.
Valid values for this parameter are:

- None
- Basic
- Windows

Type:AuthenticationMode
Parameter Sets:None, Basic, Windows
Required:False
Position:26
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False

-NotificationAuthenticationPassword

Specifies a notification password to connect to a resource provider.

Type:String
Required:False
Position:28
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False

-NotificationAuthenticationUsername

Specifies a notification user name to connect to a resource provider.

Type:String
Required:False
Position:27
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False

-NotificationForwardingAddress

Specifies the notification forwarding address of a resource provider.

Type:Uri
Required:False
Position:25
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False

-PassThroughEnabled

Indicates whether the resource provider supports API pass-through.

Type:Boolean
Required:False
Position:6
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False

-ResourceProvider

Specifies a resource provider object.

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

-SubscriptionStatusPollingInterval

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.

Type:TimeSpan
Required:False
Position:32
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False

-TenantAuthenticationMode

Specifies the tenant authentication mode of a resource provider.
Valid values for this parameter are:

- None
- Basic
- Windows

Type:AuthenticationMode
Parameter Sets:None, Basic, Windows
Required:False
Position:14
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False

-TenantAuthenticationPassword

Specifies the tenant password to connect to a resource provider.

Type:String
Required:False
Position:16
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False

-TenantAuthenticationUsername

Specifies the tenant user name to connect to a resource provider.

Type:String
Required:False
Position:15
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False

-TenantForwardingAddress

Specifies the tenant forwarding address of a resource provider.

Type:Uri
Required:False
Position:13
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False

-TestUri

Specifies the URI used for testing.

Type:Uri
Required:True
Position:34
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False

-Token

Specifies an identity token.
To create a token, use the Get-MgmtSvcToken cmdlet.

Type:String
Required:True
Position:1
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False

-Type

Specifies the type of the resource provider.
Valid values for this parameter are:

- Standard
- UsageProvider
- CloudServiceProvider

Type:ResourceProviderType
Parameter Sets:Standard, UsageProvider, CloudServiceProvider
Required:False
Position:33
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False

-UsageAuthenticationMode

Specifies the usage authentication mode of a resource provider.
Valid values for this parameter are:

- None
- Basic
- Windows

Type:AuthenticationMode
Parameter Sets:None, Basic, Windows
Required:False
Position:18
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False

-UsageAuthenticationPassword

Specifies the usage password to connect to a resource provider.

Type:String
Required:False
Position:20
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False

-UsageAuthenticationUsername

Specifies the usage user name to connect to a resource provider.

Type:String
Required:False
Position:19
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False

-UsageForwardingAddress

Specifies the notification forwarding address of a resource provider.

Type:Uri
Required:False
Position:17
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False

-WhatIf

Shows what would happen if the cmdlet runs.
The cmdlet is not run.

Type:SwitchParameter
Aliases:wi
Required:False
Position:Named
Default value:False
Accept pipeline input:False
Accept wildcard characters:False