Get-AzCloudServiceOSFamily

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

Syntax

Get-AzCloudServiceOSFamily
   -Location <String>
   [-SubscriptionId <String[]>]
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]
Get-AzCloudServiceOSFamily
   -Location <String>
   -OSFamilyName <String>
   [-SubscriptionId <String[]>]
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]
Get-AzCloudServiceOSFamily
   -InputObject <ICloudServiceIdentity>
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]

Description

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

Examples

Example 1: Get all OS families in a location

Get-AzCloudServiceOSFamily -location 'westus2'

Name Label
---- -----
5    Windows Server 2016
4    Windows Server 2012 R2
6    Windows Server 2019
3    Windows Server 2012
2    Windows Server 2008 R2

This command gets all OS families in location westus2

Example 2: Get OS family

Get-AzCloudServiceOSFamily -location 'westus2' -OSFamilyName 5

Name Label
---- -----
5    Windows Server 2016

This command gets OS family named 5 that is located in westus2.

Parameters

-DefaultProfile

The DefaultProfile parameter is not functional. Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription.

Type:PSObject
Aliases:AzureRMContext, AzureCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-InputObject

Identity Parameter To construct, see NOTES section for INPUTOBJECT properties and create a hash table.

Type:ICloudServiceIdentity
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-Location

Name of the location that the OS family pertains to.

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-OSFamilyName

Name of the OS family.

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-SubscriptionId

Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Type:String[]
Position:Named
Default value:(Get-AzContext).Subscription.Id
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Inputs

ICloudServiceIdentity

Outputs

IOSFamily

Notes

ALIASES

COMPLEX PARAMETER PROPERTIES

To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables.

INPUTOBJECT <ICloudServiceIdentity>: Identity Parameter

  • [CloudServiceName <String>]: Name of the cloud service.
  • [IPConfigurationName <String>]: The IP configuration name.
  • [Id <String>]: Resource identity path
  • [Location <String>]: Name of the location that the OS version pertains to.
  • [NetworkInterfaceName <String>]: The name of the network interface.
  • [OSFamilyName <String>]: Name of the OS family.
  • [OSVersionName <String>]: Name of the OS version.
  • [PublicIPAddressName <String>]: The name of the public IP Address.
  • [ResourceGroupName <String>]: Name of the resource group.
  • [RoleInstanceName <String>]: Name of the role instance.
  • [RoleName <String>]: Name of the role.
  • [SubscriptionId <String>]: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
  • [UpdateDomain <Int32?>]: Specifies an integer value that identifies the update domain. Update domains are identified with a zero-based index: the first update domain has an ID of 0, the second has an ID of 1, and so on.