ComputeExtensions.GetCloudServiceOSFamilyAsync Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
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 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.