Share via


ComputeExtensions.GetCloudServiceOSFamilyAsync Method

Definition

Gets properties of a guest operating system family that can be specified in the XML service configuration (.cscfg) for a cloud service.

  • Request Path: /subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{___location}/cloudServiceOsFamilies/{osFamilyName}
  • Operation Id: CloudServiceOperatingSystems_GetOSFamily
  • Default Api Version: 2024-11-04
  • Resource: CloudServiceOSFamilyResource
<item>MockingTo mock this method, please mock GetCloudServiceOSFamilyAsync(AzureLocation, String, CancellationToken) instead.</item>
public static System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.Compute.CloudServiceOSFamilyResource>> GetCloudServiceOSFamilyAsync(this Azure.ResourceManager.Resources.SubscriptionResource subscriptionResource, Azure.Core.AzureLocation ___location, string osFamilyName, System.Threading.CancellationToken cancellationToken = default);
static member GetCloudServiceOSFamilyAsync : Azure.ResourceManager.Resources.SubscriptionResource * Azure.Core.AzureLocation * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.Compute.CloudServiceOSFamilyResource>>
<Extension()>
Public Function GetCloudServiceOSFamilyAsync (subscriptionResource As SubscriptionResource, ___location As AzureLocation, osFamilyName As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of CloudServiceOSFamilyResource))

Parameters

subscriptionResource
SubscriptionResource

The SubscriptionResource instance the method will execute against.

___location
AzureLocation

Name of the ___location that the OS families pertain to.

osFamilyName
String

Name of the OS family.

cancellationToken
CancellationToken

The cancellation token to use.

Returns

Exceptions

subscriptionResource or osFamilyName is null.

osFamilyName is an empty string, and was expected to be non-empty.

Applies to