Package com.azure.resourcemanager.apimanagement.models

Interface TenantConfigurations

public interface TenantConfigurations
Resource collection API of TenantConfigurations.

  • Method Details

    • deploy

      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.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • deploy

      OperationResultContract deploy(String resourceGroupName, String serviceName, ConfigurationIdName configurationName, DeployConfigurationParameters parameters, com.azure.core.util.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.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • save

      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.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • save

      OperationResultContract save(String resourceGroupName, String serviceName, ConfigurationIdName configurationName, SaveConfigurationParameter parameters, com.azure.core.util.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.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • validate

      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.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • validate

      OperationResultContract validate(String resourceGroupName, String serviceName, ConfigurationIdName configurationName, DeployConfigurationParameters parameters, com.azure.core.util.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.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • getSyncStateWithResponse

      com.azure.core.http.rest.Response<TenantConfigurationSyncStateContract> getSyncStateWithResponse(String resourceGroupName, String serviceName, ConfigurationIdName configurationName, com.azure.core.util.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.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • getSyncState

      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.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.