IAppServicePlansOperations.ListWebAppsWithHttpMessagesAsync Method

Definition

Namespace:

Microsoft.Azure.Management.WebSites

Assembly:

Microsoft.Azure.Management.Websites.dll

Package:

Microsoft.Azure.Management.WebSites v4.0.0

Get all apps associated with an App Service plan.

public System.Threading.Tasks.Task<Microsoft.Rest.Azure.AzureOperationResponse<Microsoft.Rest.Azure.IPage<Microsoft.Azure.Management.WebSites.Models.Site>>> ListWebAppsWithHttpMessagesAsync (string resourceGroupName, string name, string skipToken = default, string filter = default, string top = default, System.Collections.Generic.Dictionary<string,System.Collections.Generic.List<string>> customHeaders = default, System.Threading.CancellationToken cancellationToken = default);

abstract member ListWebAppsWithHttpMessagesAsync : string * string * string * string * string * System.Collections.Generic.Dictionary<string, System.Collections.Generic.List<string>> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Rest.Azure.AzureOperationResponse<Microsoft.Rest.Azure.IPage<Microsoft.Azure.Management.WebSites.Models.Site>>>

Public Function ListWebAppsWithHttpMessagesAsync (resourceGroupName As String, name As String, Optional skipToken As String = Nothing, Optional filter As String = Nothing, Optional top As String = Nothing, Optional customHeaders As Dictionary(Of String, List(Of String)) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of AzureOperationResponse(Of IPage(Of Site)))

Parameters

resourceGroupName

String

Name of the resource group to which the resource belongs.

name

String

Name of the App Service plan.

skipToken

String

Skip to a web app in the list of webapps associated with app service plan. If specified, the resulting list will contain web apps starting from (including) the skipToken. Otherwise, the resulting list contains web apps from the start of the list

filter

String

Supported filter: $filter=state eq running. Returns only web apps that are currently running

top

String

List page size. If specified, results are paged.

customHeaders

Dictionary<String,List<String>>

The headers that will be added to request.

cancellationToken

CancellationToken

The cancellation token.

Returns

Task<AzureOperationResponse<IPage<Site>>>

Exceptions

DefaultErrorResponseException

Thrown when the operation returned an invalid status code

SerializationException

Thrown when unable to deserialize the response

ValidationException

Thrown when a required parameter is null

Remarks

Description for Get all apps associated with an App Service plan.