Display Endpoint Data Using Windows Server AppFabric Cmdlets

This topic describes how you can display information about endpoints by using Windows Server AppFabric cmdlets.

Note

To execute an AppFabric cmdlet manually, open the Windows PowerShell console for AppFabric, enter the appropriate cmdlet, and then press ENTER. For more information about executing cmdlets, refer to Running Windows Server AppFabric Cmdlets. For information about any of the classes or common parameters used in the syntax statements in this document, refer to Windows PowerShell for Windows Server AppFabric Reference.

To obtain an endpoint for a service

In the Windows PowerShell console for AppFabric, execute the Get-ASAppServiceEndpoint cmdlet to view information about endpoints exposed by services available at the specified scope.

Syntax options for the Get-ASAppServiceEndpoint cmdlet:

Syntax 1

Get-ASAppServiceEndpoint [-SiteName <String>] [-VirtualPath <String>]

Syntax 2

Get-ASAppServiceEndpoint [-Uri <String>]

Syntax 3

Get-ASAppServiceEndpoint [-ServiceObject <ServiceInfo>]
Parameter Description

-SiteName (optional)

Specifies the name of a site. If specified, neither -Uri nor –ServiceObject must be specified. When you use this parameter, the cmdlet returns endpoints of services in the specified site.

Get-ASAppServiceEndpoint -SiteName "Default Web Site" -VirtualPath "/MyWFService/Service1.xamlx"

-VirtualPath (Optional)

Specifies the virtual path to a service or application; for example, /MyDir1/MyApp1/POService.svc. An optional parameter used with -SiteName when neither –Uri nor –ServiceObject is specified.

-Uri (Optional)

Specifies a URI to a site, application, or service. If specified, neither –SiteName, -VirtualPath, nor –ServiceObject must be specified. When you use this parameter, the cmdlet returns endpoints of services contained in the specified URI scope.

Get-ASAppServiceEndpoint -Uri "https://localhost/MyWFService/Service1.xamlx"

-ServiceObject (Optional)

Specifies a ServiceObject object that is used to determine the service instances for which to return information. If specified, neither –SiteName, -VirtualPath, nor –Uri must be specified. For more information, refer to Windows PowerShell for Windows Server AppFabric Reference. This parameter is used mainly in piping scenarios.

Get-ASAppService -SiteName "Default Web Site" | Get-ASAppServiceEndpoint

For more information about this cmdlet, see Get-ASAppServiceEndpoint.

To obtain endpoint transport quota data for a service

In the AppFabric Windows PowerShell console, execute the Get-ASAppServiceEndpointTransportQuota cmdlet to view the endpoint transport quota configuration of the given service.

Syntax options for the Get-ASAppServiceEndpointTransportQuota cmdlet:

Syntax 1

Get-ASAppServiceEndpointTransportQuota -SiteName <string> -VirtualPath <string> -Address <string> -Binding <string> –Contract <string>

Syntax 2

Get-ASAppServiceEndpointTransportQuota -Uri <string> -Address <string> -Binding <string> –Contract <string>

Syntax 3

Get-ASAppServiceEndpointTransportQuota -ServiceObject <ServiceInfo> -Address <string> -Binding <string> –Contract <string>
Parameter Description

-Address, -Binding, and -Contract

Required if the ServiceEndpointObject parameter is not specified

-SiteName (optional)

Specifies the name of a site. If specified, neither -Uri nor –ServiceObject must be specified. When you use this parameter, only endpoints of services that are in the site are returned.

-VirtualPath (Optional)

Specifies the virtual path to a service or application; for example, /MyDir1/MyApp1/POService.svc. An optional parameter used with -SiteName when neither –Uri nor –ServiceObject is specified.

-Uri (Optional)

Specifies a URI to a site, application, or service. If specified, neither –SiteName, -VirtualPath, nor –ServiceObject must be specified.

-ServiceObject (Optional)

Specifies a ServiceObject object that is used to determine the service instances for which to return information. If specified, neither –SiteName, -VirtualPath, nor –Uri must be specified. For more information, refer to Windows PowerShell for Windows Server AppFabric Reference.

For more information about this cmdlet, see Get-ASAppServiceEndpointTransportQuota.

To get endpoint authentication data for a service

In the AppFabric Windows PowerShell console, execute the Get-ASAppServiceEndpointAuthentication cmdlet to return the currently set authentication properties for an endpoint used with that binding.

Syntax options for the Get-ASAppServiceEndpointAuthentication cmdlet:

Syntax 1

   Get-ASAppServiceEndpointAuthentication [-SiteName] <String> [-VirtualPath] <String> [[-Address] <String>] [-Binding
   ] <String> [-Contract] <String> [<CommonParameters>]

Syntax 2

   Get-ASAppServiceEndpointAuthentication [-Uri] <Uri> [[-Address] <String>] [-Binding] <String> [-Contract] <String>
   [<CommonParameters>]

Syntax 3

   Get-ASAppServiceEndpointAuthentication [[-Address] <String>] [-Binding] <String> [-Contract] <String> -ServiceObjec
   t <ServiceInfo> [<CommonParameters>]
Parameter Description

-SiteName (optional)

Specifies the name of a site. If specified, neither -Uri nor –ServiceObject must be specified.

-VirtualPath (Optional)

Specifies the virtual path to a service or application; for example, /MyDir1/MyApp1/POService.svc. An optional parameter used with -SiteName when neither –Uri nor –ServiceObject is specified.

-Uri (Optional)

Specifies a URI to a site, application, or service. If specified, neither –SiteName, -VirtualPath, nor –ServiceObject must be specified. When you use this parameter, only service instances that are under this URI are returned.

-ServiceObject (Optional)

Specifies a ServiceObject object that is used to determine the service instances for which to return information. If specified, neither –SiteName, -VirtualPath, nor –Uri must be specified. For more information, refer to Windows PowerShell for Windows Server AppFabric Reference.

For more information about this cmdlet, see Get-ASAppServiceEndpointAuthentication.