TenantConfiguration | @azure/arm-apimanagement

Interface representing a TenantConfiguration.

Hierarchy

TenantConfiguration

Implemented by

TenantConfigurationImpl

Index

Methods

beginDeploy

beginDeploy(resourceGroupName: string, serviceName: string, configurationName: ConfigurationIdName, parameters: DeployConfigurationParameters, options?: TenantConfigurationDeployOptionalParams): Promise<PollerLike<PollOperationState<TenantConfigurationDeployResponse>, TenantConfigurationDeployResponse>>

- Defined in operationsInterfaces/tenantConfiguration.ts:35
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: string
  
  The name of the resource group.
- serviceName: string
  
  The name of the API Management service.
- configurationName: ConfigurationIdName
  
  The identifier of the Git Configuration Operation.
- parameters: DeployConfigurationParameters
  
  Deploy Configuration parameters.
- Optional options: TenantConfigurationDeployOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<TenantConfigurationDeployResponse>, TenantConfigurationDeployResponse>>

beginDeployAndWait

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

- Defined in operationsInterfaces/tenantConfiguration.ts:56
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: string
  
  The name of the resource group.
- serviceName: string
  
  The name of the API Management service.
- configurationName: ConfigurationIdName
  
  The identifier of the Git Configuration Operation.
- parameters: DeployConfigurationParameters
  
  Deploy Configuration parameters.
- Optional options: TenantConfigurationDeployOptionalParams
  
  The options parameters.
Returns Promise<TenantConfigurationDeployResponse>

beginSave

beginSave(resourceGroupName: string, serviceName: string, configurationName: ConfigurationIdName, parameters: SaveConfigurationParameter, options?: TenantConfigurationSaveOptionalParams): Promise<PollerLike<PollOperationState<TenantConfigurationSaveResponse>, TenantConfigurationSaveResponse>>

- Defined in operationsInterfaces/tenantConfiguration.ts:72
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: string
  
  The name of the resource group.
- serviceName: string
  
  The name of the API Management service.
- configurationName: ConfigurationIdName
  
  The identifier of the Git Configuration Operation.
- parameters: SaveConfigurationParameter
  
  Save Configuration parameters.
- Optional options: TenantConfigurationSaveOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<TenantConfigurationSaveResponse>, TenantConfigurationSaveResponse>>

beginSaveAndWait

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

- Defined in operationsInterfaces/tenantConfiguration.ts:93
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: string
  
  The name of the resource group.
- serviceName: string
  
  The name of the API Management service.
- configurationName: ConfigurationIdName
  
  The identifier of the Git Configuration Operation.
- parameters: SaveConfigurationParameter
  
  Save Configuration parameters.
- Optional options: TenantConfigurationSaveOptionalParams
  
  The options parameters.
Returns Promise<TenantConfigurationSaveResponse>

beginValidate

beginValidate(resourceGroupName: string, serviceName: string, configurationName: ConfigurationIdName, parameters: DeployConfigurationParameters, options?: TenantConfigurationValidateOptionalParams): Promise<PollerLike<PollOperationState<TenantConfigurationValidateResponse>, TenantConfigurationValidateResponse>>

- Defined in operationsInterfaces/tenantConfiguration.ts:109
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: string
  
  The name of the resource group.
- serviceName: string
  
  The name of the API Management service.
- configurationName: ConfigurationIdName
  
  The identifier of the Git Configuration Operation.
- parameters: DeployConfigurationParameters
  
  Validate Configuration parameters.
- Optional options: TenantConfigurationValidateOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<TenantConfigurationValidateResponse>, TenantConfigurationValidateResponse>>

beginValidateAndWait

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

- Defined in operationsInterfaces/tenantConfiguration.ts:130
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: string
  
  The name of the resource group.
- serviceName: string
  
  The name of the API Management service.
- configurationName: ConfigurationIdName
  
  The identifier of the Git Configuration Operation.
- parameters: DeployConfigurationParameters
  
  Validate Configuration parameters.
- Optional options: TenantConfigurationValidateOptionalParams
  
  The options parameters.
Returns Promise<TenantConfigurationValidateResponse>

getSyncState

getSyncState(resourceGroupName: string, serviceName: string, configurationName: ConfigurationIdName, options?: TenantConfigurationGetSyncStateOptionalParams): Promise<TenantConfigurationGetSyncStateResponse>

- Defined in operationsInterfaces/tenantConfiguration.ts:145
Gets the status of the most recent synchronization between the configuration database and the Git repository.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- serviceName: string
  
  The name of the API Management service.
- configurationName: ConfigurationIdName
  
  The identifier of the Git Configuration Operation.
- Optional options: TenantConfigurationGetSyncStateOptionalParams
  
  The options parameters.
Returns Promise<TenantConfigurationGetSyncStateResponse>

Hierarchy

Implemented by

Index

Methods

Methods

beginDeploy

Parameters

resourceGroupName: string

serviceName: string

configurationName: ConfigurationIdName

parameters: DeployConfigurationParameters

Optional options: TenantConfigurationDeployOptionalParams

Returns Promise<PollerLike<PollOperationState<TenantConfigurationDeployResponse>, TenantConfigurationDeployResponse>>

beginDeployAndWait

Parameters

resourceGroupName: string

serviceName: string

configurationName: ConfigurationIdName

parameters: DeployConfigurationParameters

Optional options: TenantConfigurationDeployOptionalParams

Returns Promise<TenantConfigurationDeployResponse>

beginSave

Parameters

resourceGroupName: string

serviceName: string

configurationName: ConfigurationIdName

parameters: SaveConfigurationParameter

Optional options: TenantConfigurationSaveOptionalParams

Returns Promise<PollerLike<PollOperationState<TenantConfigurationSaveResponse>, TenantConfigurationSaveResponse>>

beginSaveAndWait

Parameters

resourceGroupName: string

serviceName: string

configurationName: ConfigurationIdName

parameters: SaveConfigurationParameter

Optional options: TenantConfigurationSaveOptionalParams

Returns Promise<TenantConfigurationSaveResponse>

beginValidate

Parameters

resourceGroupName: string

serviceName: string

configurationName: ConfigurationIdName

parameters: DeployConfigurationParameters

Optional options: TenantConfigurationValidateOptionalParams

Returns Promise<PollerLike<PollOperationState<TenantConfigurationValidateResponse>, TenantConfigurationValidateResponse>>

beginValidateAndWait

Parameters

resourceGroupName: string

serviceName: string

configurationName: ConfigurationIdName

parameters: DeployConfigurationParameters

Optional options: TenantConfigurationValidateOptionalParams

Returns Promise<TenantConfigurationValidateResponse>

getSyncState

Parameters

resourceGroupName: string

serviceName: string

configurationName: ConfigurationIdName

Optional options: TenantConfigurationGetSyncStateOptionalParams

Returns Promise<TenantConfigurationGetSyncStateResponse>