CloudServiceOSFamilyCollection.GetAsync(String, CancellationToken) Method

  • Reference

Definition

Namespace:
Azure.ResourceManager.Compute
Assembly:
Azure.ResourceManager.Compute.dll
Package:
Azure.ResourceManager.Compute v1.6.0
Package:
Azure.ResourceManager.Compute v1.7.0-beta.1
Source:
CloudServiceOSFamilyCollection.cs
Source:
CloudServiceOSFamilyCollection.cs

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 virtual System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.Compute.CloudServiceOSFamilyResource>> GetAsync (string osFamilyName, System.Threading.CancellationToken cancellationToken = default);
abstract member GetAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.Compute.CloudServiceOSFamilyResource>>
override this.GetAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.Compute.CloudServiceOSFamilyResource>>
Public Overridable Function GetAsync (osFamilyName As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of CloudServiceOSFamilyResource))

Parameters

osFamilyName
String

Name of the OS family.

cancellationToken
CancellationToken

The cancellation token to use.

Returns

Task<Response<CloudServiceOSFamilyResource>>

Exceptions

ArgumentException

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

ArgumentNullException

osFamilyName is null.

Applies to