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
List (Default)
Get-AzCloudServiceOSFamily
-Location <String>
[-SubscriptionId <String[]>]
[-DefaultProfile <PSObject>]
[<CommonParameters>]
Get
Get-AzCloudServiceOSFamily
-Location <String>
-OSFamilyName <String>
[-SubscriptionId <String[]>]
[-DefaultProfile <PSObject>]
[<CommonParameters>]
GetViaIdentityLocation
Get-AzCloudServiceOSFamily
-OSFamilyName <String>
-LocationInputObject <ICloudServiceIdentity>
[-DefaultProfile <PSObject>]
[<CommonParameters>]
GetViaIdentity
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.
Parameter properties
Type: PSObject
Default value: None Supports wildcards: False DontShow: False Aliases: AzureRMContext, AzureCredential
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
Identity Parameter
GetViaIdentity
Position: Named Mandatory: True Value from pipeline: True Value from pipeline by property name: False Value from remaining arguments: False
-Location
Name of the location that the OS family pertains to.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
List
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
Get
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
Identity Parameter
GetViaIdentityLocation
Position: Named Mandatory: True Value from pipeline: True Value from pipeline by property name: False Value from remaining arguments: False
-OSFamilyName
Name of the OS family.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
Get
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
GetViaIdentityLocation
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-SubscriptionId
Subscription credentials which uniquely identify Microsoft Azure subscription.
The subscription ID forms part of the URI for every service call.
Parameter properties
Type: String [ ]
Default value: (Get-AzContext).Subscription.Id Supports wildcards: False DontShow: False
Parameter sets
List
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
Get
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
-InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable,
-ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see
about_CommonParameters .
Outputs
