Export (0) Print
Expand All
Expand Minimize

Set-ASInstanceManagement

Set-ASInstanceManagement

Enables workflow instance management and/or sets the Windows group authorized to manage workflow service instances at the specified scope.

Syntax

Parameter Set: SiteNameAndVirtualPath
Set-ASInstanceManagement [-SiteName] <String> [[-VirtualPath] <String> ] [-AuthorizedWindowsGroup <String> ] [-EnableNetPipeProtocol] [-UseInherited] [-Confirm] [-WhatIf] [ <CommonParameters>]


Detailed Description

The cmdlet adds workflowInstanceManagement element if the element does not already exists and sets the value of the authorizedWindowsGroup attribute.

When you use the -UseInherited parameter, the cmdlet removes <workflowInstanceManagement> element or <remove name=”workflowInstanceManagement”> element from configuration file so that the workflowInstanceManagement behavior settings are inherited from the higher levels.

Parameters

-ApplicationObject<ApplicationInfo>

The name of the ApplicationObject, which specifies that the cmdlet will operate on that application. This parameter is used to pipe the output of the Get-ASApplication cmdlet to a cmdlet containing the ApplicationObject parameter.


Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

true (ByValue)

Accept Wildcard Characters?

-AuthorizedWindowsGroup<String>

The Windows group authorized to manage workflow service instances.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

true (ByPropertyName)

Accept Wildcard Characters?

-EnableNetPipeProtocol

Enables the net.pipe protocol for a Web site or for an application. If you use this parameter with a command that is run against a service, the cmdlet enables the protocol on the application that contains the service.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

-Root

The name of the root application, which specifies that the cmdlet will operate at that scope. If you use the Root parameter, do not use the SiteName, VirtualPath, or Uri parameter.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

-ServiceObject<ServiceInfo>

The name of the ServiceObject, which specifies that the cmdlet will operate on that service. This parameter is typically used to pipe the output of the Get-ASAppService cmdlet to a cmdlet containing the ServiceObject parameter.


Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

true (ByValue)

Accept Wildcard Characters?

-SiteName<String>

The name of a Web site, as defined in the IIS Connections pane, which specifies that the cmdlet will operate at the scope of that site, or at the scope of an application, virtual directory, or service contained within that site. To the SiteName parameter, you can add the VirtualPath parameter that identifies an application, directory, or service included in the site.

For an application or virtual directory, the virtual path includes the name of the application, as defined in IIS. For a service, the virtual path includes the name of the application, a forward slash, and the name of the .svc file or .xamlx file for the service. The VirtualPath parameter is not necessary for the site scope. The leading "/" character in the virtual path is optional. If you use the SiteName parameter, do not use the Uri parameter.


Aliases

none

Required?

true

Position?

1

Default Value

none

Accept Pipeline Input?

true (ByPropertyName)

Accept Wildcard Characters?

-Uri<Uri>

A URI for an IIS site, application, virtual directory, or service, which specifies that the cmdlet will operate at that scope. If you use the Uri parameter, do not use the SiteName parameter or the SiteName and VirtualPath parameter set.


Aliases

none

Required?

true

Position?

1

Default Value

none

Accept Pipeline Input?

true (ByPropertyName)

Accept Wildcard Characters?

-UseInherited

Use this parameter to use inherited settings from the higher scope. When you use this parameter, the cmdlet removes any workflowInstanceManagement behavior defined at the specified level. The cmdlet also removes any <remove name=”workflowInstanceManagement”> element from the configuration file.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

-VirtualPath<String>

The virtual path for an application, directory, or service, as defined in the IIS Manager Connections pane, which specifies that the cmdlet will operate at the application, virtual directory, or service. You must add the VirtualPath parameter to the SiteName parameter, using SiteName to identify the site that the application, directory, or service is contained within. The leading "/" character in the virtual path is optional.

For an application, the virtual path includes the name of the application, as defined in IIS. For a service, the virtual path includes the name of the application, a forward slash, and the name of the .svc file or .xamlx file for the service. If you use the SiteName and VirtualName parameter set, do not use the Uri parameter.ps_virtualpath


Aliases

none

Required?

false

Position?

2

Default Value

none

Accept Pipeline Input?

true (ByPropertyName)

Accept Wildcard Characters?

-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

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

  • None.


Outputs

The output type is the type of the objects that the cmdlet emits.

  • None.


Examples

Example 1

The following command clears workflow instance management settings at the root level.


Set-ASInstanceManagement –root –AuthorizedWindowsGroup AS_Administrators

Example 2

The following command sets workflow instance management settings at the Web site level.


Set-ASInstanceManagement –SiteName “Default Web Site” –AuthorizedWindowsGroup AS_Administrators

Example 3

The following command clears workflow instance management settings at the application level.


Set-ASInstanceManagement –SiteName “Default Web Site” –virtualpath “/SampleApplication” –AuthorizedWindowsGroup AS_Administrators

Example 4

The following command clears workflow instance management settings at the service level.


Set-ASInstanceManagement –SiteName “Default Web Site” –virtualpath “/SampleApp/SampleService.xamlx” –AuthorizedWindowsGroup AS_AdministratorsGet-ASApplicationService –SiteName “Default Web Site” –VirtualPath “/SampleApp/SampleService.xamlx” | Set-ASInstanceManagement –AuthorizedWindowsGroup AS_Administrators

Example 5

The following commands clear workflow instance management settings at the level determined by the value of Uri parameter.


Set-ASAppInstanceManagement –Uri http://localhost –AuthorizedWindowsGroup AS_AdministratorsSet-ASAppInstanceManagement –Uri http://localhost/SampleApp –AuthorizedWindowsGroup AS_AdministratorsSet-ASAppInstanceManagement –Uri http://localhost/SampleApp/SampleService.xamlx –AuthorizedWindowsGroup AS_Administrators
Show:
© 2014 Microsoft