< Back

Get-AzureVMAvailableExtension

Wed Jan 30, 2019 5:46 pm

NAME Get-AzureVMAvailableExtension



SYNOPSIS

Gets information for the latest available extensions for virtual machines.





SYNTAX

Get-AzureVMAvailableExtension [[-ExtensionName] <String>] [[-Publisher] <String>] [-AllVersions] [-Profile <AzureSMProfile>] [-InformationAction

<ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]



Get-AzureVMAvailableExtension [[-ExtensionName] <String>] [[-Publisher] <String>] [-Version] <String> [-Profile <AzureSMProfile>] [-InformationAction

<ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]





DESCRIPTION

The Get-AzureVMAvailableExtension cmdlet gets information for the latest available extensions for virtual machines.





PARAMETERS

-ExtensionName <String>

Specifies the name of the available extension.



Required? false

Position? 0

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-Publisher <String>

Specifies the publisher of the extension.



Required? false

Position? 1

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-Profile <AzureSMProfile>

Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile.



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-InformationAction <ActionPreference>





Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-InformationVariable <String>





Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-AllVersions [<SwitchParameter>]

Indicates that this cmdlet lists all versions of an extension.



Required? true

Position? 2

Default value False

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-Version <String>

Specifies the version of the extension.



Required? true

Position? 2

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).



INPUTS



OUTPUTS



NOTES









-------------------------- Example 1: Get information for the latest available extensions --------------------------



PS C:\\>Get-AzureVMAvailableExtension

Publisher : Contoso.Compute

ExtensionName : VMAccessAgent

Version : 1.0

PublicConfigurationSchema : <?xml version="1.0" encoding="utf-8"?>

<xs:schema attributeFormDefault="unqualified" elementFormDefault="qualified"

xmlns:xs="http://www.w3.org/2001/XMLSchema">

<xs:element name="PublicConfig">

<xs:complexType>

<xs:sequence>

<xs:element name="UserName" type="xs:string" minOccurs="0" />

</xs:sequence>

</xs:complexType>

</xs:element>

</xs:schema>

PrivateConfigurationSchema : <?xml version="1.0" encoding="utf-8"?>

<xs:schema attributeFormDefault="unqualified" elementFormDefault="qualified"

xmlns:xs="http://www.w3.org/2001/XMLSchema">

<xs:element name="PrivateConfig">

<xs:complexType>

<xs:sequence>

<xs:element name="Password" type="xs:string" minOccurs="0" />

</xs:sequence>

</xs:complexType>

</xs:element>

</xs:schema>

SampleConfig :

OperationDescription : Get-AzureVMAvailableExtension

OperationId : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx

OperationStatus : Succeeded



This command gets information for the latest available extensions for all virtual machines.

-------------------------- Example 2: Get information from a specified extension name --------------------------



PS C:\\>Get-AzureVMAvailableExtension -Publisher Contoso.Compute -ExtensionName "VMAccessAgent" -AllVersions

Publisher : Contoso.Compute

ExtensionName : VMAccessAgent

Version : 1.0.2

PublicConfigurationSchema :

<?xml version="1.0" encoding="utf-8"?>

<xs:schema attributeFormDefault="unqualified" elementFormDefault="qualified"

xmlns:xs="http://www.w3.org/2001/XMLSchema">

<xs:element name="PublicConfig">

<xs:complexType>

<xs:sequence>

<xs:element name="UserName" type="xs:string" minOccurs="0" />

</xs:sequence>

</xs:complexType>

</xs:element>

</xs:schema>



PrivateConfigurationSchema :

<?xml version="1.0" encoding="utf-8"?>

<xs:schema attributeFormDefault="unqualified" elementFormDefault="qualified"

xmlns:xs="http://www.w3.org/2001/XMLSchema">

<xs:element name="PrivateConfig">

<xs:complexType>

<xs:sequence>

<xs:element name="Password" type="xs:string" minOccurs="0" />

</xs:sequence>

</xs:complexType>

</xs:element>

</xs:schema>



SampleConfig :

OperationDescription : Get-AzureVMAvailableExtension

OperationId : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx

OperationStatus : Succeeded



Publisher : Contoso.Compute

ExtensionName : VMAccessAgent

Version : 1.0.3

PublicConfigurationSchema : <?xml version="1.0" encoding="utf-8"?>

<xs:schema attributeFormDefault="unqualified" elementFormDefault="qualified"

xmlns:xs="http://www.w3.org/2001/XMLSchema">

<xs:element name="PublicConfig">

<xs:complexType>

<xs:sequence>

<xs:element name="UserName" type="xs:string" minOccurs="0" />

</xs:sequence>

</xs:complexType>

</xs:element>

</xs:schema>

PrivateConfigurationSchema : <?xml version="1.0" encoding="utf-8"?>

<xs:schema attributeFormDefault="unqualified" elementFormDefault="qualified"

xmlns:xs="http://www.w3.org/2001/XMLSchema">

<xs:element name="PrivateConfig">

<xs:complexType>

<xs:sequence>

<xs:element name="Password" type="xs:string" minOccurs="0" />

</xs:sequence>

</xs:complexType>

</xs:element>

</xs:schema>

SampleConfig :

OperationDescription : Get-AzureVMAvailableExtension

OperationId : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx

OperationStatus : Succeeded



This command gets information from all versions of the extension named VMAccessAgent and the publisher named Contoso.Computer.

-------------------------- Example 3: Get information from a specific virtual machine extension by version number --------------------------



PS C:\\>Get-AzureVMAvailableExtension -Publisher Contoso.Compute -ExtensionName VMAccessAgent -Version 1.0.3

Publisher : Contoso.Compute

ExtensionName : VMAccessAgent

Version : 1.0.3

PublicConfigurationSchema : <?xml version="1.0" encoding="utf-8"?>

<xs:schema attributeFormDefault="unqualified" elementFormDefault="qualified"

xmlns:xs="http://www.w3.org/2001/XMLSchema">

<xs:element name="PublicConfig">

<xs:complexType>

<xs:sequence>

<xs:element name="UserName" type="xs:string" minOccurs="0" />

</xs:sequence>

</xs:complexType>

</xs:element>

</xs:schema>

PrivateConfigurationSchema : <?xml version="1.0" encoding="utf-8"?>

<xs:schema attributeFormDefault="unqualified" elementFormDefault="qualified"

xmlns:xs="http://www.w3.org/2001/XMLSchema">

<xs:element name="PrivateConfig">

<xs:complexType>

<xs:sequence>

<xs:element name="Password" type="xs:string" minOccurs="0" />

</xs:sequence>

</xs:complexType>

</xs:element>

</xs:schema>

SampleConfig :

OperationDescription : Get-AzureVMAvailableExtension

OperationId : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx

OperationStatus : Succeeded



This command gets information for the extension named VMAccessAgent and the publisher named Contoso.Compute for the extension version 1.0.3.



RELATED LINKS

Azure Service Cmdlets