en-US/about_AzDoExtension.help.txt
|
.NAME
AzDoExtension .SYNOPSIS DSC resource for managing Azure DevOps Marketplace extensions. .DESCRIPTION This resource manages the installation of extensions from the Visual Studio Marketplace in an Azure DevOps organization. To find the PublisherId and ExtensionId for an extension, look at its URL in the Marketplace: https://marketplace.visualstudio.com/items?itemName={PublisherId}.{ExtensionId} .PARAMETER PublisherId Key - System.String The publisher ID of the extension in the Visual Studio Marketplace. This property is mandatory and serves as a key property for the resource. .PARAMETER ExtensionId Required - System.String The extension ID in the Visual Studio Marketplace. This is a key property. .PARAMETER Version Read - System.String The installed version of the extension. Read-only - it is reported by Get and cannot be set. .PARAMETER DisplayName Read - System.String The display name of the extension as published in the Marketplace. Read-only - it is reported by Get and cannot be set. .EXAMPLE 1 This example shows how to install an extension in an Azure DevOps organization. Configuration Example { Import-DscResource -ModuleName 'AzureDevOpsDscNative' node localhost { AzDoExtension 'AddAzDoExtension' { Ensure = 'Present' PublisherId = 'ms' ExtensionId = 'vss-services-github' } } } .EXAMPLE 2 This example shows how to install a different extension in an Azure DevOps organization. Configuration Example { Import-DscResource -ModuleName 'AzureDevOpsDscNative' node localhost { AzDoExtension 'UpdateAzDoExtension' { Ensure = 'Present' PublisherId = 'ms-devlabs' ExtensionId = 'workitemsearch' } } } .EXAMPLE 3 This example shows how to uninstall an extension from an Azure DevOps organization. Configuration Example { Import-DscResource -ModuleName 'AzureDevOpsDscNative' node localhost { AzDoExtension 'RemoveAzDoExtension' { Ensure = 'Absent' PublisherId = 'ms' ExtensionId = 'vss-services-github' } } } |