TenantConfigurations Interface

public interface TenantConfigurations

Resource collection API of TenantConfigurations.

Method Summary

Modifier and Type Method and Description
abstract OperationResultContract deploy(String resourceGroupName, String serviceName, ConfigurationIdName configurationName, DeployConfigurationParameters parameters)

This operation applies changes from the specified Git branch to the configuration database.

abstract OperationResultContract deploy(String resourceGroupName, String serviceName, ConfigurationIdName configurationName, DeployConfigurationParameters parameters, Context context)

This operation applies changes from the specified Git branch to the configuration database.

abstract TenantConfigurationSyncStateContract getSyncState(String resourceGroupName, String serviceName, ConfigurationIdName configurationName)

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

abstract Response<TenantConfigurationSyncStateContract> getSyncStateWithResponse(String resourceGroupName, String serviceName, ConfigurationIdName configurationName, Context context)

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

abstract OperationResultContract save(String resourceGroupName, String serviceName, ConfigurationIdName configurationName, SaveConfigurationParameter parameters)

This operation creates a commit with the current configuration snapshot to the specified branch in the repository.

abstract OperationResultContract save(String resourceGroupName, String serviceName, ConfigurationIdName configurationName, SaveConfigurationParameter parameters, Context context)

This operation creates a commit with the current configuration snapshot to the specified branch in the repository.

abstract OperationResultContract validate(String resourceGroupName, String serviceName, ConfigurationIdName configurationName, DeployConfigurationParameters parameters)

This operation validates the changes in the specified Git branch.

abstract OperationResultContract validate(String resourceGroupName, String serviceName, ConfigurationIdName configurationName, DeployConfigurationParameters parameters, Context context)

This operation validates the changes in the specified Git branch.

Method Details

deploy

public abstract OperationResultContract deploy(String resourceGroupName, String serviceName, ConfigurationIdName configurationName, DeployConfigurationParameters parameters)

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.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
serviceName - The name of the API Management service.
configurationName - The identifier of the Git Configuration Operation.
parameters - Deploy Configuration parameters.

Returns:

long Running Git Operation Results.

deploy

public abstract OperationResultContract deploy(String resourceGroupName, String serviceName, ConfigurationIdName configurationName, DeployConfigurationParameters parameters, Context context)

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.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
serviceName - The name of the API Management service.
configurationName - The identifier of the Git Configuration Operation.
parameters - Deploy Configuration parameters.
context - The context to associate with this operation.

Returns:

long Running Git Operation Results.

getSyncState

public abstract TenantConfigurationSyncStateContract getSyncState(String resourceGroupName, String serviceName, ConfigurationIdName configurationName)

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

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
serviceName - The name of the API Management service.
configurationName - The identifier of the Git Configuration Operation.

Returns:

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

getSyncStateWithResponse

public abstract Response getSyncStateWithResponse(String resourceGroupName, String serviceName, ConfigurationIdName configurationName, Context context)

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

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
serviceName - The name of the API Management service.
configurationName - The identifier of the Git Configuration Operation.
context - The context to associate with this operation.

Returns:

the status of the most recent synchronization between the configuration database and the Git repository along with Response<T>.

save

public abstract OperationResultContract save(String resourceGroupName, String serviceName, ConfigurationIdName configurationName, SaveConfigurationParameter parameters)

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.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
serviceName - The name of the API Management service.
configurationName - The identifier of the Git Configuration Operation.
parameters - Save Configuration parameters.

Returns:

long Running Git Operation Results.

save

public abstract OperationResultContract save(String resourceGroupName, String serviceName, ConfigurationIdName configurationName, SaveConfigurationParameter parameters, Context context)

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.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
serviceName - The name of the API Management service.
configurationName - The identifier of the Git Configuration Operation.
parameters - Save Configuration parameters.
context - The context to associate with this operation.

Returns:

long Running Git Operation Results.

validate

public abstract OperationResultContract validate(String resourceGroupName, String serviceName, ConfigurationIdName configurationName, DeployConfigurationParameters parameters)

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

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
serviceName - The name of the API Management service.
configurationName - The identifier of the Git Configuration Operation.
parameters - Validate Configuration parameters.

Returns:

long Running Git Operation Results.

validate

public abstract OperationResultContract validate(String resourceGroupName, String serviceName, ConfigurationIdName configurationName, DeployConfigurationParameters parameters, Context context)

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

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
serviceName - The name of the API Management service.
configurationName - The identifier of the Git Configuration Operation.
parameters - Validate Configuration parameters.
context - The context to associate with this operation.

Returns:

long Running Git Operation Results.

Applies to