TenantConfiguration interface

Package:

@azure/arm-apimanagement

Interface representing a TenantConfiguration.

Methods

beginDeploy(string, string, string, DeployConfigurationParameters, TenantConfigurationDeployOptionalParams)	This operation applies changes from the specified Git branch to the configuration database. This is a long running operation and could take several minutes to complete.
beginDeployAndWait(string, string, string, DeployConfigurationParameters, TenantConfigurationDeployOptionalParams)	This operation applies changes from the specified Git branch to the configuration database. This is a long running operation and could take several minutes to complete.
beginSave(string, string, string, SaveConfigurationParameter, TenantConfigurationSaveOptionalParams)	This operation creates a commit with the current configuration snapshot to the specified branch in the repository. This is a long running operation and could take several minutes to complete.
beginSaveAndWait(string, string, string, SaveConfigurationParameter, TenantConfigurationSaveOptionalParams)	This operation creates a commit with the current configuration snapshot to the specified branch in the repository. This is a long running operation and could take several minutes to complete.
beginValidate(string, string, string, DeployConfigurationParameters, TenantConfigurationValidateOptionalParams)	This operation validates the changes in the specified Git branch. This is a long running operation and could take several minutes to complete.
beginValidateAndWait(string, string, string, DeployConfigurationParameters, TenantConfigurationValidateOptionalParams)	This operation validates the changes in the specified Git branch. This is a long running operation and could take several minutes to complete.
getSyncState(string, string, string, TenantConfigurationGetSyncStateOptionalParams)	Gets the status of the most recent synchronization between the configuration database and the Git repository.

Method Details

beginDeploy(string, string, string, DeployConfigurationParameters, TenantConfigurationDeployOptionalParams)

This operation applies changes from the specified Git branch to the configuration database. This is a long running operation and could take several minutes to complete.

function beginDeploy(resourceGroupName: string, serviceName: string, configurationName: string, parameters: DeployConfigurationParameters, options?: TenantConfigurationDeployOptionalParams): Promise<SimplePollerLike<OperationState<OperationResultContract>, OperationResultContract>>

Parameters

resourceGroupName

string

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

serviceName

string

The name of the API Management service.

configurationName

string

The identifier of the Git Configuration Operation.

parameters

DeployConfigurationParameters

Deploy Configuration parameters.

options

TenantConfigurationDeployOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<OperationResultContract>, OperationResultContract>>

beginDeployAndWait(string, string, string, DeployConfigurationParameters, TenantConfigurationDeployOptionalParams)

This operation applies changes from the specified Git branch to the configuration database. This is a long running operation and could take several minutes to complete.

function beginDeployAndWait(resourceGroupName: string, serviceName: string, configurationName: string, parameters: DeployConfigurationParameters, options?: TenantConfigurationDeployOptionalParams): Promise<OperationResultContract>

Parameters

resourceGroupName

string

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

serviceName

string

The name of the API Management service.

configurationName

string

The identifier of the Git Configuration Operation.

parameters

DeployConfigurationParameters

Deploy Configuration parameters.

options

TenantConfigurationDeployOptionalParams

The options parameters.

Returns

Promise<OperationResultContract>

beginSave(string, string, string, SaveConfigurationParameter, TenantConfigurationSaveOptionalParams)

This operation creates a commit with the current configuration snapshot to the specified branch in the repository. This is a long running operation and could take several minutes to complete.

function beginSave(resourceGroupName: string, serviceName: string, configurationName: string, parameters: SaveConfigurationParameter, options?: TenantConfigurationSaveOptionalParams): Promise<SimplePollerLike<OperationState<OperationResultContract>, OperationResultContract>>

Parameters

resourceGroupName

string

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

serviceName

string

The name of the API Management service.

configurationName

string

The identifier of the Git Configuration Operation.

parameters

SaveConfigurationParameter

Save Configuration parameters.

options

TenantConfigurationSaveOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<OperationResultContract>, OperationResultContract>>

beginSaveAndWait(string, string, string, SaveConfigurationParameter, TenantConfigurationSaveOptionalParams)

This operation creates a commit with the current configuration snapshot to the specified branch in the repository. This is a long running operation and could take several minutes to complete.

function beginSaveAndWait(resourceGroupName: string, serviceName: string, configurationName: string, parameters: SaveConfigurationParameter, options?: TenantConfigurationSaveOptionalParams): Promise<OperationResultContract>

Parameters

resourceGroupName

string

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

serviceName

string

The name of the API Management service.

configurationName

string

The identifier of the Git Configuration Operation.

parameters

SaveConfigurationParameter

Save Configuration parameters.

options

TenantConfigurationSaveOptionalParams

The options parameters.

Returns

Promise<OperationResultContract>

beginValidate(string, string, string, DeployConfigurationParameters, TenantConfigurationValidateOptionalParams)

This operation validates the changes in the specified Git branch. This is a long running operation and could take several minutes to complete.

function beginValidate(resourceGroupName: string, serviceName: string, configurationName: string, parameters: DeployConfigurationParameters, options?: TenantConfigurationValidateOptionalParams): Promise<SimplePollerLike<OperationState<OperationResultContract>, OperationResultContract>>

Parameters

resourceGroupName

string

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

serviceName

string

The name of the API Management service.

configurationName

string

The identifier of the Git Configuration Operation.

parameters

DeployConfigurationParameters

Validate Configuration parameters.

options

TenantConfigurationValidateOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<OperationResultContract>, OperationResultContract>>

beginValidateAndWait(string, string, string, DeployConfigurationParameters, TenantConfigurationValidateOptionalParams)

This operation validates the changes in the specified Git branch. This is a long running operation and could take several minutes to complete.

function beginValidateAndWait(resourceGroupName: string, serviceName: string, configurationName: string, parameters: DeployConfigurationParameters, options?: TenantConfigurationValidateOptionalParams): Promise<OperationResultContract>

Parameters

resourceGroupName

string

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

serviceName

string

The name of the API Management service.

configurationName

string

The identifier of the Git Configuration Operation.

parameters

DeployConfigurationParameters

Validate Configuration parameters.

options

TenantConfigurationValidateOptionalParams

The options parameters.

Returns

Promise<OperationResultContract>

getSyncState(string, string, string, TenantConfigurationGetSyncStateOptionalParams)

Gets the status of the most recent synchronization between the configuration database and the Git repository.

function getSyncState(resourceGroupName: string, serviceName: string, configurationName: string, options?: TenantConfigurationGetSyncStateOptionalParams): Promise<TenantConfigurationSyncStateContract>

Parameters

resourceGroupName

string

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

serviceName

string

The name of the API Management service.

configurationName

string

The identifier of the Git Configuration Operation.

options

TenantConfigurationGetSyncStateOptionalParams

The options parameters.

Returns

Promise<TenantConfigurationSyncStateContract>