Update-AzDevCenterAdminProjectCatalog

  • Reference
Module:
Az.DevCenter

Partially updates a project catalog.

Syntax

Update-AzDevCenterAdminProjectCatalog
      -CatalogName <String>
      -ProjectName <String>
      -ResourceGroupName <String>
      [-SubscriptionId <String>]
      [-AdoGitBranch <String>]
      [-AdoGitPath <String>]
      [-AdoGitSecretIdentifier <String>]
      [-AdoGitUri <String>]
      [-GitHubBranch <String>]
      [-GitHubPath <String>]
      [-GitHubSecretIdentifier <String>]
      [-GitHubUri <String>]
      [-SyncType <CatalogSyncType>]
      [-Tag <Hashtable>]
      [-DefaultProfile <PSObject>]
      [-AsJob]
      [-NoWait]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Update-AzDevCenterAdminProjectCatalog
      -CatalogName <String>
      -ProjectName <String>
      -ResourceGroupName <String>
      [-SubscriptionId <String>]
      -Body <ICatalogUpdate>
      [-DefaultProfile <PSObject>]
      [-AsJob]
      [-NoWait]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Update-AzDevCenterAdminProjectCatalog
      -InputObject <IDevCenterIdentity>
      [-AdoGitBranch <String>]
      [-AdoGitPath <String>]
      [-AdoGitSecretIdentifier <String>]
      [-AdoGitUri <String>]
      [-GitHubBranch <String>]
      [-GitHubPath <String>]
      [-GitHubSecretIdentifier <String>]
      [-GitHubUri <String>]
      [-SyncType <CatalogSyncType>]
      [-Tag <Hashtable>]
      [-DefaultProfile <PSObject>]
      [-AsJob]
      [-NoWait]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Update-AzDevCenterAdminProjectCatalog
      -InputObject <IDevCenterIdentity>
      -Body <ICatalogUpdate>
      [-DefaultProfile <PSObject>]
      [-AsJob]
      [-NoWait]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Description

Partially updates a project catalog.

Examples

Example 1: Update a project catalog

Update-AzDevCenterAdminProjectCatalog -ProjectName DevProject -CatalogName CentralCatalog -ResourceGroupName testRg -GitHubPath "testpath" -GitHubSecretIdentifier "https://contosokv.vault.azure.net/secrets/CentralRepoPat"

This command updates a catalog named "CentralCatalog" in the project "DevProject".

Example 2: Update a project catalog using InputObject

$catalogInput = Get-AzDevCenterAdminProjectCatalog -ProjectName DevProject -CatalogName CentralCatalog -ResourceGroupName testRg

Update-AzDevCenterAdminProjectCatalog -InputObject $catalogInput -GitHubPath "testpath" -GitHubSecretIdentifier "https://contosokv.vault.azure.net/secrets/CentralRepoPat"

This command updates a catalog named "CentralCatalog" in the project "DevProject".

Parameters

-AdoGitBranch

Git branch.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-AdoGitPath

The folder where the catalog items can be found inside the repository.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-AdoGitSecretIdentifier

A reference to the Key Vault secret containing a security token to authenticate to a Git repository.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-AdoGitUri

Git URI.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-AsJob

Run the command as a job

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Body

The catalog's properties for partial update. Properties not provided in the update request will not be changed. To construct, see NOTES section for BODY properties and create a hash table.

Type:ICatalogUpdate
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-CatalogName

The name of the Catalog.

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-DefaultProfile

The DefaultProfile parameter is not functional. Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription.

Type:PSObject
Aliases:AzureRMContext, AzureCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-GitHubBranch

Git branch.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-GitHubPath

The folder where the catalog items can be found inside the repository.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-GitHubSecretIdentifier

A reference to the Key Vault secret containing a security token to authenticate to a Git repository.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-GitHubUri

Git URI.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-InputObject

Identity Parameter To construct, see NOTES section for INPUTOBJECT properties and create a hash table.

Type:IDevCenterIdentity
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-NoWait

Run the command asynchronously

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ProjectName

The name of the project.

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-ResourceGroupName

The name of the resource group. The name is case insensitive.

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-SubscriptionId

The ID of the target subscription.

Type:String
Position:Named
Default value:(Get-AzContext).Subscription.Id
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-SyncType

Indicates the type of sync that is configured for the catalog.

Type:CatalogSyncType
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Tag

Resource tags.

Type:Hashtable
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:SwitchParameter
Aliases:wi
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Inputs

ICatalogUpdate

IDevCenterIdentity

Outputs

ICatalog