ComputeExtensions.GetCloudServiceOSFamily 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: 2022-09-04
  • Resource: CloudServiceOSFamilyResource
public static Azure.Response<Azure.ResourceManager.Compute.CloudServiceOSFamilyResource> GetCloudServiceOSFamily (this Azure.ResourceManager.Resources.SubscriptionResource subscriptionResource, Azure.Core.AzureLocation location, string osFamilyName, System.Threading.CancellationToken cancellationToken = default);
static member GetCloudServiceOSFamily : Azure.ResourceManager.Resources.SubscriptionResource * Azure.Core.AzureLocation * string * System.Threading.CancellationToken -> Azure.Response<Azure.ResourceManager.Compute.CloudServiceOSFamilyResource>
<Extension()>
Public Function GetCloudServiceOSFamily (subscriptionResource As SubscriptionResource, location As AzureLocation, osFamilyName As String, Optional cancellationToken As CancellationToken = Nothing) As 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