Publish-AzApiManagementTenantGitConfiguration

  • Reference
Module:
Az.ApiManagement

Publishes changes from a Git branch to the configuration database.

Syntax

Publish-AzApiManagementTenantGitConfiguration
       -Context <PsApiManagementContext>
       -Branch <String>
       [-Force]
       [-ValidateOnly]
       [-PassThru]
       [-DefaultProfile <IAzureContextContainer>]
       [-WhatIf]
       [-Confirm]
       [<CommonParameters>]

Description

The Publish-AzApiManagementTenantGitConfiguration cmdlet publishes the changes from a Git branch to the configuration database. You can alternatively validate the changes in a Git branch without publishing.

Examples

Example 1: Deploy Git changes

$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
Publish-AzApiManagementTenantGitConfiguration -Context $apimContext -Branch 'master' -PassThru

This command publishes the changes from the specified branch to the configuration database.

Example 2: Validate Git changes

$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
Publish-AzApiManagementTenantGitConfiguration -Context $apimContext -Branch 'master' -ValidateOnly -PassThru

This command validates the changes in the Git branch against the configuration database. It does not publish changes.

Parameters

-Branch

Specifies the name of the Git branch from which this cmdlet deploys the configuration to the configuration database.

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

-Confirm

Prompts you for confirmation before running the cmdlet.

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

-Context

Specifies a PsApiManagementContext object.

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

-DefaultProfile

The credentials, account, tenant, and subscription used for communication with azure.

Type:IAzureContextContainer
Aliases:AzContext, AzureRmContext, AzureCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Force

Indicates that this cmdlet deletes subscriptions to products that are deleted in this update.

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

-PassThru

Indicates that this cmdlet returns a PsApiManagementOperationResult object.

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

-ValidateOnly

Indicates that this cmdlet validates the changes in the specified Git branch. It does not publish to the configuration database.

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

Inputs

PsApiManagementContext

String

SwitchParameter

Outputs

PsApiManagementOperationResult