Skip to content

Set-AdoFeatureState.md

Latest commit

 

History

History
219 lines (173 loc) · 4.66 KB

Set-AdoFeatureState.md

File metadata and controls

219 lines (173 loc) · 4.66 KB

Set-AdoFeatureState

SYNOPSIS

Set the feature state for an Azure DevOps project feature.

SYNTAX

__AllParameterSets

Set-AdoFeatureState [[-CollectionUri] <string>] [[-ProjectName] <string>] [-Feature] <string>
 [[-FeatureState] <string>] [[-Version] <string>] [<CommonParameters>]

ALIASES

This cmdlet has the following aliases,

  • ProjectId

DESCRIPTION

This cmdlet sets the feature state for an Azure DevOps project feature through REST API. Controls whether features like Boards, Repos, Pipelines, Test Plans, and Artifacts are enabled or disabled.

EXAMPLES

EXAMPLE 1

PowerShell

$params = @{
    CollectionUri = 'https://dev.azure.com/my-org'
    ProjectName   = 'my-project-002'
    Feature       = 'Boards'
    FeatureState  = 'Disabled'
}
Set-AdoFeatureState @params

Sets the feature state for Boards to Disabled for the specified project.

EXAMPLE 2

PowerShell

Set-AdoFeatureState -ProjectName 'my-project-002' -Feature 'Repos' -FeatureState 'Enabled'

Enables the Repos feature for the specified project using the default collection URI.

PARAMETERS

-CollectionUri

Optional. The collection URI of the Azure DevOps collection/organization, e.g., https://dev.azure.com/my-org.

Type: System.String
DefaultValue: $env:DefaultAdoCollectionUri
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: true
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-ProjectName

Optional. The ID or name of the project. Defaults to the value of $env:DefaultAdoProject.

Type: System.String
DefaultValue: $env:DefaultAdoProject
SupportsWildcards: false
Aliases:
- ProjectId
ParameterSets:
- Name: (All)
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: true
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-Feature

Mandatory. The feature to set the state for. Valid values are 'boards', 'repos', 'pipelines', 'testPlans', 'artifacts'.

Type: System.String
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
  Position: Named
  IsRequired: true
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: true
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues:
- boards
- repos
- pipelines
- testPlans
- artifacts
HelpMessage: ''

-FeatureState

Optional. The state to set the feature to. Valid values are 'enabled' or 'disabled'. Default is 'disabled'.

Type: System.String
DefaultValue: disabled
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: true
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues:
- enabled
- disabled
HelpMessage: ''

-Version

Optional. The API version to use. Default is '4.1-preview.1'.

Type: System.String
DefaultValue: 4.1-preview.1
SupportsWildcards: false
Aliases:
- ApiVersion
ParameterSets:
- Name: (All)
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues:
- 4.1-preview.1
HelpMessage: ''

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

  • N/A

OUTPUTS

PSCustomObject

NOTES

  • Turning off a feature hides this service for all members of this project. If you choose to enable this service later, all your existing data will be available.
  • Requires authentication to Azure DevOps. Use Set-AdoDefault to configure default organization and project values.
  • The cmdlet automatically retrieves authentication through Invoke-AdoRestMethod which calls New-AdoAuthHeader.

RELATED LINKS