Export (0) Print
Expand All
Expand Minimize

Set-ASAppServiceMetadata

Set-ASAppServiceMetadata

Adds the serviceMetadata element to configuration file associated with the specified scope if the element does not already exist and sets the value of httpGetEnabled attribute on the element.

Syntax

Parameter Set: SiteNameAndVirtualPath
Set-ASAppServiceMetadata [-SiteName] <String> [[-VirtualPath] <String> ] [-HttpGetEnabled <Boolean> ] [-UseInherited] [-Confirm] [-WhatIf] [ <CommonParameters>]


Detailed Description

Adds the serviceMetadata element to configuration file associated with the specified scope if the element does not already exist and sets the values of httpGetEnabled and httpGetUrl attributes on the element. It also removes any <remove name=”serviceMetadata”> element from configuration file associated with the specified scope.

You should use either httpGetEnabled or userInherited parameters when using this cmdlet to set the service metadata. If you run this cmdlet without specifying one of these parameters, you will see the following message: WARNING: The parameter combination does not specify any configuration changes. No change to the configuration will be made.

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?

-HttpGetEnabled<Boolean>

Specifies whether the metadata of service can be accessed over HTTP.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

true (ByPropertyName)

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 serviceMetadata behavior defined at the specified level. The cmdlet also removes any <remove name=”serviceMetadata”> 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..


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.

  • ApplicationInfo and ServiceInfo.


Outputs

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

  • ServiceMetadataInfo


Examples

EXAMPLE 1

This sample command adds the serviceMetadata element if the element does not already exist to the Web.config file associated with root level and sets the value of the httpGetEnabled attribute on the element to true.


Set-ASAppServiceMetadata –root –httpGetEnabled 1

Example 2

This sample command adds the serviceMetadata element if the element does not already exist to the Web.config file associated with the “Default Web Site” and sets the value of the httpGetEnabled attribute on the element to true.


Set-ASAppServiceMetadata –SiteName “Default Web Site” –httpGetEnabled 1

Example 3

These sample commands add the serviceMetadata element if the element does not already exist to the Web.config file associated with the SampleApp and sets the value of the httpGetEnabled attribute on the element to true.


Set-ASAppServiceMetadata –SiteName “Default Web Site” –VirtualPath /SampleApp –httpGetEnabled 1Get-ASApplication -SiteName "Default Web Site" -VirtualPath /SampleApp | Set-ASAppServiceMetadata –httpGetEnabled 1

Example 4

These sample commands add the serviceMetadata element if the element does not already exist to the Web.config file associated with the SampleService and sets the value of the httpGetEnabled attribute on the element to true.


Set-ASAppServiceMetadata –SiteName “Default Web Site” –VirtualPath “/SampleApp/SampleService.xamlx” –httpGetEnabled 1Get-ASAppService –SiteName “Default Web Site” –VirtualPath “/SampleApp/SampleService.xamlx” | Set-ASAppServiceMetadata –httpGetEnabled 1

Example 5

These sample commands add the serviceMetadata element if the element does not already exist to the Web.config file associated with the scope determined by the URI and sets the value of the httpGetEnabled attribute on the element to true.


Set-ASAppServiceMetadata –Uri http://localhost –httpGetEnabled 1Set-ASAppServiceMetadata –Uri http://localhost/SampleService -httpGetEnabled 1Set-ASAppServiceMetadata –Uri http://localhost/SampleService/SampleService.xamlx -httpGetEnabled 1

Example 6

These sample commands add the serviceMetadata element if the element does not already exist to Web.config files associated with all services in the SampleApp and sets the value of the httpGetEnabled attribute on the element to true.


Get-ASAppService –SiteName “Default Web Site” –VirtualPath “/SampleApp” | Set-ASAppServiceMetadata
Show:
© 2014 Microsoft