Connect-AzDevCenterAdminCatalog

  • Reference
Module:
Az.DevCenter

Connects a catalog to enable syncing.

Syntax

Connect-AzDevCenterAdminCatalog
       -DevCenterName <String>
       -Name <String>
       -ResourceGroupName <String>
       [-SubscriptionId <String>]
       [-DefaultProfile <PSObject>]
       [-AsJob]
       [-NoWait]
       [-PassThru]
       [-WhatIf]
       [-Confirm]
       [<CommonParameters>]
Connect-AzDevCenterAdminCatalog
       -InputObject <IDevCenterIdentity>
       [-DefaultProfile <PSObject>]
       [-AsJob]
       [-NoWait]
       [-PassThru]
       [-WhatIf]
       [-Confirm]
       [<CommonParameters>]

Description

Connects a catalog to enable syncing.

Examples

Example 1: Connect a catalog

Connect-AzDevCenterAdminCatalog -DevCenterName Contoso -Name CentralCatalog -ResourceGroupName testRg

This command connects the catalog named "CentralCatalog" in the dev center "Contoso" under the resource group "testRg".

Example 2: Connect a catalog using InputObject

$catalog = @{"ResourceGroupName" = "testRg"; "DevCenterName" = "Contoso"; "CatalogName" = "CentralCatalog"; "SubscriptionId" = "0ac520ee-14c0-480f-b6c9-0a90c58ffff"}
$catalog = Connect-AzDevCenterAdminCatalog -InputObject $catalog

This command connects the catalog named "CentralCatalog" in the dev center "Contoso" under the resource group "testRg".

Parameters

-AsJob

Run the command as a job

Type:SwitchParameter
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: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

-DevCenterName

The name of the devcenter.

Type:String
Position:Named
Default value:None
Required:True
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

-Name

The name of the Catalog.

Type:String
Aliases:CatalogName
Position:Named
Default value:None
Required:True
Accept pipeline input:False
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

-PassThru

Returns true when the command succeeds

Type:SwitchParameter
Position:Named
Default value:None
Required:False
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

-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

IDevCenterIdentity

Outputs

Boolean