Get-AzureVMAvailableExtension

  • Article

[This topic is pre-release documentation and is subject to change in future releases. Blank topics are included as placeholders.]

Get-AzureVMAvailableExtension

Gets information for the latest available extensions for VMs.

Syntax

Parameter Set: ListLatestExtensions
Get-AzureVMAvailableExtension [[-ExtensionName] <String> ] [[-Publisher] <String> ] [ <CommonParameters>]

Parameter Set: ListAllVersions
Get-AzureVMAvailableExtension [-ExtensionName] <String> [-Publisher] <String> [-AllVersions] [ <CommonParameters>]

Parameter Set: ListSingleVersion
Get-AzureVMAvailableExtension [-ExtensionName] <String> [-Publisher] <String> [-Version] <String> [ <CommonParameters>]

Detailed Description

Gets information for the latest available extensions for VMs.

Parameters

-AllVersions

Specify to list all versions of an extension.

Aliases

none

Required?

true

Position?

3

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-ExtensionName<String>

Specifies the name of the extension.

Aliases

none

Required?

true

Position?

1

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-Publisher<String>

Specifies the publisher of the extension.

Aliases

none

Required?

true

Position?

2

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-Version<String>

Specifies the version of the extension.

Aliases

none

Required?

true

Position?

3

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

<CommonParameters>

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see  about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

Outputs

The output type is the type of the objects that the cmdlet emits.

Examples

EXAMPLE 1

C:\PS>Get-AzureVMAvailableExtension

Publisher                  : Microsoft.Compute
ExtensionName              : VMAccessAgent
Version                    : 1.0
PublicConfigurationSchema  : <?xml version="1.0" encoding="utf-8"?>
<xs:schema attributeFormDefault="unqualified" elementFormDefault="qualified"
xmlns:xs="https://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="https://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

EXAMPLE 2

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

Publisher                  : Microsoft.Compute
ExtensionName              : VMAccessAgent
Version                    : 1.0.2
PublicConfigurationSchema  :
<?xml version="1.0" encoding="utf-8"?>
<xs:schema attributeFormDefault="unqualified" elementFormDefault="qualified"
xmlns:xs="https://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="https://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                  : Microsoft.Compute
ExtensionName              : VMAccessAgent
Version                    : 1.0.3
PublicConfigurationSchema  : <?xml version="1.0" encoding="utf-8"?>
<xs:schema attributeFormDefault="unqualified" elementFormDefault="qualified"
xmlns:xs="https://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="https://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

EXAMPLE 3

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

Publisher                  : Microsoft.Compute
ExtensionName              : VMAccessAgent
Version                    : 1.0.3
PublicConfigurationSchema  : <?xml version="1.0" encoding="utf-8"?>
<xs:schema attributeFormDefault="unqualified" elementFormDefault="qualified"
xmlns:xs="https://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="https://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

Get-AzureVMExtension

Remove-AzureVMExtension

Manage Extensions