Skip to main content

cloud_service_operating_systems_os_families

Creates, updates, deletes, gets or lists a cloud_service_operating_systems_os_families resource.

Overview

Namecloud_service_operating_systems_os_families
TypeResource
Idazure.compute.cloud_service_operating_systems_os_families

Fields

The following fields are returned by SELECT queries:

NameDatatypeDescription
idstringResource Id.
namestringResource name.
locationstringResource location.
propertiesobjectOS family properties.
typestringResource type.

Methods

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
getselectlocation, osFamilyName, subscriptionIdGets properties of a guest operating system family that can be specified in the XML service configuration (.cscfg) for a cloud service.
listselectlocation, subscriptionIdGets a list of all guest operating system families available to be specified in the XML service configuration (.cscfg) for a cloud service. Use nextLink property in the response to get the next page of OS Families. Do this till nextLink is null to fetch all the OS Families.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

NameDatatypeDescription
locationstringName of the location that the OS families pertain to.
osFamilyNamestringName of the OS family.
subscriptionIdstringSubscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

SELECT examples

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

SELECT
id,
name,
location,
properties,
type
FROM azure.compute.cloud_service_operating_systems_os_families
WHERE location = '{{ location }}' -- required
AND osFamilyName = '{{ osFamilyName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;