Package com.azure.resourcemanager.apimanagement.fluent

Interface TenantSettingsClient

public interface TenantSettingsClient

An instance of this class provides access to all the operations defined in TenantSettingsClient.

Method Summary

Modifier and Type	Method	Description
TenantSettingsContractInner	get(String resourceGroupName, String serviceName, SettingsTypeName settingsType)	Get tenant settings.
TenantSettingsGetResponse	getWithResponse(String resourceGroupName, String serviceName, SettingsTypeName settingsType, com.azure.core.util.Context context)	Get tenant settings.
com.azure.core.http.rest.PagedIterable<TenantSettingsContractInner>	listByService(String resourceGroupName, String serviceName)	Public settings.
com.azure.core.http.rest.PagedIterable<TenantSettingsContractInner>	listByService(String resourceGroupName, String serviceName, String filter, com.azure.core.util.Context context)	Public settings.

Method Detail

listByService

com.azure.core.http.rest.PagedIterable<TenantSettingsContractInner> listByService(String resourceGroupName,
                                                                                  String serviceName)

Public settings.

Parameters:

resourceGroupName - The name of the resource group.

serviceName - The name of the API Management service.

Returns:

paged AccessInformation list representation as paginated response with PagedIterable.

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.

listByService

com.azure.core.http.rest.PagedIterable<TenantSettingsContractInner> listByService(String resourceGroupName,
                                                                                  String serviceName,
                                                                                  String filter,
                                                                                  com.azure.core.util.Context context)

Public settings.

Parameters:

resourceGroupName - The name of the resource group.

serviceName - The name of the API Management service.

filter - Not used.

context - The context to associate with this operation.

Returns:

paged AccessInformation list representation as paginated response with PagedIterable.

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.

get

TenantSettingsContractInner get(String resourceGroupName,
                                String serviceName,
                                SettingsTypeName settingsType)

Get tenant settings.

Parameters:

resourceGroupName - The name of the resource group.

serviceName - The name of the API Management service.

settingsType - The identifier of the settings.

Returns:

tenant settings.

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.

getWithResponse

TenantSettingsGetResponse getWithResponse(String resourceGroupName,
                                          String serviceName,
                                          SettingsTypeName settingsType,
                                          com.azure.core.util.Context context)

Get tenant settings.

Parameters:

resourceGroupName - The name of the resource group.

serviceName - The name of the API Management service.

settingsType - The identifier of the settings.

context - The context to associate with this operation.

Returns:

tenant settings.

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.