Add-AzsVMExtension
Create a Virtual Machine Extension Image with publisher, version.
Syntax
Add-AzsVMExtension
-Publisher <String>
-Type <String>
-Version <String>
[-Location <String>]
[-SubscriptionId <String>]
[-ComputeRole <String>]
[-IsSystemExtension]
[-PropertiesPublisher <String>]
[-ProvisioningState <ProvisioningState>]
[-SourceBlob <String>]
[-SupportMultipleExtensions]
[-VmOsType <OSType>]
[-VMScaleSetEnabled]
[-DefaultProfile <PSObject>]
[-Confirm]
[-WhatIf]
[<CommonParameters>] Add-AzsVMExtension
-Publisher <String>
-Type <String>
-Version <String>
-Extension \<IVMExtensionParameters>
[-Location <String>]
[-SubscriptionId <String>]
[-DefaultProfile <PSObject>]
[-Confirm]
[-WhatIf]
[<CommonParameters>] Add-AzsVMExtension
-INPUTOBJECT \<IComputeAdminIdentity>
-Extension \<IVMExtensionParameters>
[-DefaultProfile <PSObject>]
[-Confirm]
[-WhatIf]
[<CommonParameters>] Add-AzsVMExtension
-INPUTOBJECT \<IComputeAdminIdentity>
[-Publisher <String>]
[-ComputeRole <String>]
[-IsSystemExtension]
[-ProvisioningState <ProvisioningState>]
[-SourceBlob <String>]
[-SupportMultipleExtensions]
[-VmOsType <OSType>]
[-VMScaleSetEnabled]
[-DefaultProfile <PSObject>]
[-Confirm]
[-WhatIf]
[<CommonParameters>] Description
Create a Virtual Machine Extension Image with publisher, version.
Examples
-------------------------- EXAMPLE 1 --------------------------
Add-AzsVMExtension -Location "local" -Publisher "Microsoft" -Type "MicroExtension" -Version "0.1.0" -ComputeRole "IaaS" -SourceBlob "https://github.com/Microsoft/PowerShell-DSC-for-Linux/archive/v1.1.1-294.zip" -SupportMultipleExtensions -VmOsType "Linux"ExtensionType : MicroExtension TypeHandlerVersion : 0.1.0 ComputeRole : IaaS Id : /subscriptions/74c72bdc-d917-431c-a377-8ca80f4238a0/providers/Microsoft.Compute.Admin/locati ons/local/artifactTypes/VMExtension/publishers/Microsoft/types/MicroExtension/versions/0.1.0 IsSystemExtension : False Location : local Name : ProvisioningState : Creating Publisher : Microsoft SourceBlobUri : https://github.com/Microsoft/PowerShell-DSC-for-Linux/archive/v1.1.1-294.zip SupportMultipleExtension : True Type : Microsoft.Compute.Admin/locations/artifactTypes/publishers/types/versions VMScaleSetEnabled : False VmosType : Linux
Parameters
-ComputeRole
Compute role
| Type: | System.String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Confirm
Prompts you for confirmation before running the cmdlet.
| Type: | System.Management.Automation.SwitchParameter |
| Aliases: | cf |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-DefaultProfile
The credentials, account, tenant, and subscription used for communication with Azure.
| Type: | System.Management.Automation.PSObject |
| Aliases: | AzureRMContext, AzureCredential |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Extension
Parameters used to create a new Virtual Machine Extension Image. To construct, see NOTES section for EXTENSION properties and create a hash table.
| Type: | Microsoft.Azure.PowerShell.Cmdlets.ComputeAdmin.Models.Api20151201Preview.IVMExtensionParameters |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-InputObject
Identity Parameter To construct, see NOTES section for INPUTOBJECT properties and create a hash table.
| Type: | Microsoft.Azure.PowerShell.Cmdlets.ComputeAdmin.Models.IComputeAdminIdentity |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-IsSystemExtension
Indicates if the extension is for the system.
| Type: | System.Management.Automation.SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Location
Location of the resource.
| Type: | System.String |
| Position: | Named |
| Default value: | (Get-AzLocation)[0].Location |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-PropertiesPublisher
The publisher of the VM Extension
| Type: | System.String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ProvisioningState
Provisioning state of extension.
| Type: | Microsoft.Azure.PowerShell.Cmdlets.ComputeAdmin.Support.ProvisioningState |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Publisher
Name of the publisher.
| Type: | System.String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-SourceBlob
URI to Azure or AzureStack blob.
| Type: | System.String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-SubscriptionId
Subscription credentials that uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
| Type: | System.String |
| Position: | Named |
| Default value: | (Get-AzContext).Subscription.Id |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-SupportMultipleExtensions
True if supports multiple extensions.
| Type: | System.Management.Automation.SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Type
Type of extension.
| Type: | System.String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Version
The version of the resource.
| Type: | System.String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-VmOsType
Target virtual machine operating system type necessary for deploying the extension handler.
| Type: | Microsoft.Azure.PowerShell.Cmdlets.ComputeAdmin.Support.OSType |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-VMScaleSetEnabled
Value indicating whether the extension is enabled for virtual machine scale set support.
| Type: | System.Management.Automation.SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
| Type: | System.Management.Automation.SwitchParameter |
| Aliases: | wi |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
Inputs
Microsoft.Azure.PowerShell.Cmdlets.ComputeAdmin.Models.Api20151201Preview.IVMExtensionParameters
Microsoft.Azure.PowerShell.Cmdlets.ComputeAdmin.Models.IComputeAdminIdentity
Outputs
Microsoft.Azure.PowerShell.Cmdlets.ComputeAdmin.Models.Api20151201Preview.IVMExtension
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.
EXTENSION <IVMExtensionParameters>: Parameters used to create a new Virtual Machine Extension Image.
[ComputeRole <String>]: Compute role[IsSystemExtension <Boolean?>]: Indicates if the extension is for the system.[ProvisioningState <ProvisioningState?>]: Provisioning state of extension.[Publisher <String>]: The publisher of the VM Extension[SourceBlobUri <String>]: URI to Azure or AzureStack blob.[SupportMultipleExtension <Boolean?>]: True if supports multiple extensions.[VMScaleSetEnabled <Boolean?>]: Value indicating whether the extension is enabled for virtual machine scale set support.[VmosType <OSType?>]: Target virtual machine operating system type necessary for deploying the extension handler.
INPUTOBJECT <IComputeAdminIdentity>: Identity Parameter
[DiskId <String>]: The disk guid as identity.[FeatureName <String>]: Name of the feature.[Id <String>]: Resource identity path[Location <String>]: Location of the resource.[MigrationId <String>]: The migration job guid name.[Offer <String>]: Name of the offer.[Publisher <String>]: Name of the publisher.[QuotaName <String>]: Name of the quota.[ScaleUnitName <String>]: Name of the scale unit.[Sku <String>]: Name of the SKU.[SubscriptionId <String>]: Subscription credentials that uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.[Type <String>]: Type of extension.[Version <String>]: The version of the resource.