Set-MgmtSvcResourceProvider

Updates a resource provider.

Syntax

Parameter Set: ByProperties
Set-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} ] [-DisableCertificateValidation] [-Force] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: ByObject
Set-MgmtSvcResourceProvider [-AdminUri] <Uri> [-Token] <String> [[-ResourceProvider] <ResourceProvider> ] [-DisableCertificateValidation] [-Force] [-Confirm] [-WhatIf] [ <CommonParameters>]

 

Detailed Description

The Set-MgmtSvcResourceProvider cmdlet updates a resource provider.

Parameters

-AdminAuthenticationMode<AuthenticationMode>

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

 

-AdminAuthenticationUser<PSCredential>

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

 

-AdminForwardingAddress<Uri>

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

 

-AdminUri<Uri>

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

 

-AllowAnonymousAccess<Boolean>

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

 

-AllowMultipleInstances<Boolean>

Indicates that 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

 

-Description<String>

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

 

-DisableCertificateValidation

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

 

-DisplayName<String>

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

 

-Enabled<Boolean>

Enables the resource provider.

 

Aliases	none
Required?	false
Position?	6
Default Value	none
Accept Pipeline Input?	True (ByPropertyName)
Accept Wildcard Characters?	false

 

-Force

Performs the action without a confirmation message.

 

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

 

-HealthCheckAuthenticationMode<AuthenticationMode>

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

 

-HealthCheckAuthenticationPassword<String>

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

 

-HealthCheckAuthenticationUsername<String>

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

 

-HealthCheckForwardingAddress<Uri>

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

 

-InstanceDisplayName<String>

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

 

-InstanceId<Guid>

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

 

-MaxQuotaUpdateBatchSize<Int32>

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

 

-Name<String>

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

 

-NotificationAuthenticationMode<AuthenticationMode>

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

 

-NotificationAuthenticationPassword<String>

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

 

-NotificationAuthenticationUsername<String>

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

 

-NotificationForwardingAddress<Uri>

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

 

-PassThroughEnabled<Boolean>

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

 

-ResourceProvider<ResourceProvider>

Specifies a resource provider object.

 

Aliases	none
Required?	false
Position?	3
Default Value	none
Accept Pipeline Input?	True (ByValue)
Accept Wildcard Characters?	false

 

-SubscriptionStatusPollingInterval<TimeSpan>

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

 

-TenantAuthenticationMode<AuthenticationMode>

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

 

-TenantAuthenticationPassword<String>

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

 

-TenantAuthenticationUsername<String>

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

 

-TenantForwardingAddress<Uri>

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

 

-Token<String>

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

 

-Type<ResourceProviderType>

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

 

-UsageAuthenticationMode<AuthenticationMode>

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

 

-UsageAuthenticationPassword<String>

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

 

-UsageAuthenticationUsername<String>

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

 

-UsageForwardingAddress<Uri>

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

 

-Confirm

Prompts you for confirmation before executing the command.

 

Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

 

-WhatIf

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

 

<CommonParameters>

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see about_CommonParameters.

Examples

Example 1: Enable a resource provider

NOTE: This example assumes that you have created a token by using Get-MgmtSvcToken and have stored it in a variable named $Token.

This command enables the resource provider named ResourceProvider01.

PS C:\> Set-MgmtSvcResourceProvider -AdminUri "https://Computer01:30004" -Token $Token -Name "ResourceProvider02" -DisplayName "Resource Provider 02" -InstanceDisplayName "Resource Provider 02.1" -InstanceId "0602c550-0853-48fc-bfbb-dc1f84ac08a3" -Enabled $True

 

Related topics

Add-MgmtSvcResourceProvider

Get-MgmtSvcResourceProvider

Test-MgmtSvcResourceProvider

Remove-MgmtSvcResourceProvider