ICloudServiceRoleInstancesOperations.ListWithHttpMessagesAsync Method

Definition

Namespace:

Microsoft.Azure.Management.Compute

Assembly:

Microsoft.Azure.Management.Compute.dll

Package:

Microsoft.Azure.Management.Compute v61.0.0

Gets the list of all role instances in a cloud service. Use nextLink property in the response to get the next page of role instances. Do this till nextLink is null to fetch all the role instances.

public System.Threading.Tasks.Task<Microsoft.Rest.Azure.AzureOperationResponse<Microsoft.Rest.Azure.IPage<Microsoft.Azure.Management.Compute.Models.RoleInstance>>> ListWithHttpMessagesAsync (string resourceGroupName, string cloudServiceName, Microsoft.Azure.Management.Compute.Models.InstanceViewTypes? expand = default, System.Collections.Generic.Dictionary<string,System.Collections.Generic.List<string>> customHeaders = default, System.Threading.CancellationToken cancellationToken = default);

abstract member ListWithHttpMessagesAsync : string * string * Nullable<Microsoft.Azure.Management.Compute.Models.InstanceViewTypes> * 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.Compute.Models.RoleInstance>>>

Public Function ListWithHttpMessagesAsync (resourceGroupName As String, cloudServiceName As String, Optional expand As Nullable(Of InstanceViewTypes) = Nothing, Optional customHeaders As Dictionary(Of String, List(Of String)) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of AzureOperationResponse(Of IPage(Of RoleInstance)))

Parameters

resourceGroupName

String

Name of the resource group.

cloudServiceName

String

Name of the cloud service.

expand

Nullable<InstanceViewTypes>

The expand expression to apply to the operation. 'UserData' is not supported for cloud services. Possible values include: 'instanceView', 'userData'

customHeaders

Dictionary<String,List<String>>

The headers that will be added to request.

cancellationToken

CancellationToken

The cancellation token.

Returns

Task<AzureOperationResponse<IPage<RoleInstance>>>

Exceptions

CloudException

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