Package com.azure.resourcemanager.apimanagement.models

Interface DelegationSettings

public interface DelegationSettings

Resource collection API of DelegationSettings.

Method Summary

Modifier and Type	Method	Description
PortalDelegationSettings	createOrUpdate(String resourceGroupName, String serviceName, PortalDelegationSettingsInner parameters)	Create or Update Delegation settings.
com.azure.core.http.rest.Response<PortalDelegationSettings>	createOrUpdateWithResponse(String resourceGroupName, String serviceName, PortalDelegationSettingsInner parameters, String ifMatch, com.azure.core.util.Context context)	Create or Update Delegation settings.
PortalDelegationSettings	get(String resourceGroupName, String serviceName)	Get Delegation Settings for the Portal.
void	getEntityTag(String resourceGroupName, String serviceName)	Gets the entity state (Etag) version of the DelegationSettings.
DelegationSettingsGetEntityTagResponse	getEntityTagWithResponse(String resourceGroupName, String serviceName, com.azure.core.util.Context context)	Gets the entity state (Etag) version of the DelegationSettings.
com.azure.core.http.rest.Response<PortalDelegationSettings>	getWithResponse(String resourceGroupName, String serviceName, com.azure.core.util.Context context)	Get Delegation Settings for the Portal.
PortalSettingValidationKeyContract	listSecrets(String resourceGroupName, String serviceName)	Gets the secret validation key of the DelegationSettings.
com.azure.core.http.rest.Response<PortalSettingValidationKeyContract>	listSecretsWithResponse(String resourceGroupName, String serviceName, com.azure.core.util.Context context)	Gets the secret validation key of the DelegationSettings.
void	update(String resourceGroupName, String serviceName, String ifMatch, PortalDelegationSettingsInner parameters)	Update Delegation settings.
com.azure.core.http.rest.Response<Void>	updateWithResponse(String resourceGroupName, String serviceName, String ifMatch, PortalDelegationSettingsInner parameters, com.azure.core.util.Context context)	Update Delegation settings.

Method Detail

getEntityTag

void getEntityTag(String resourceGroupName,
                  String serviceName)

Gets the entity state (Etag) version of the DelegationSettings.

Parameters:

resourceGroupName - The name of the resource group.

serviceName - The name of the API Management service.

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.

getEntityTagWithResponse

DelegationSettingsGetEntityTagResponse getEntityTagWithResponse(String resourceGroupName,
                                                                String serviceName,
                                                                com.azure.core.util.Context context)

Gets the entity state (Etag) version of the DelegationSettings.

Parameters:

resourceGroupName - The name of the resource group.

serviceName - The name of the API Management service.

context - The context to associate with this operation.

Returns:

the entity state (Etag) version of the DelegationSettings.

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

PortalDelegationSettings get(String resourceGroupName,
                             String serviceName)

Get Delegation Settings for the Portal.

Parameters:

resourceGroupName - The name of the resource group.

serviceName - The name of the API Management service.

Returns:

delegation Settings for the Portal.

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

com.azure.core.http.rest.Response<PortalDelegationSettings> getWithResponse(String resourceGroupName,
                                                                            String serviceName,
                                                                            com.azure.core.util.Context context)

Get Delegation Settings for the Portal.

Parameters:

resourceGroupName - The name of the resource group.

serviceName - The name of the API Management service.

context - The context to associate with this operation.

Returns:

delegation Settings for the Portal.

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.

update

void update(String resourceGroupName,
            String serviceName,
            String ifMatch,
            PortalDelegationSettingsInner parameters)

Update Delegation settings.

Parameters:

resourceGroupName - The name of the resource group.

serviceName - The name of the API Management service.

ifMatch - ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.

parameters - Update Delegation 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.

updateWithResponse

com.azure.core.http.rest.Response<Void> updateWithResponse(String resourceGroupName,
                                                           String serviceName,
                                                           String ifMatch,
                                                           PortalDelegationSettingsInner parameters,
                                                           com.azure.core.util.Context context)

Update Delegation settings.

Parameters:

resourceGroupName - The name of the resource group.

serviceName - The name of the API Management service.

ifMatch - ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.

parameters - Update Delegation settings.

context - The context to associate with this operation.

Returns:

the 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.

createOrUpdate

PortalDelegationSettings createOrUpdate(String resourceGroupName,
                                        String serviceName,
                                        PortalDelegationSettingsInner parameters)

Create or Update Delegation settings.

Parameters:

resourceGroupName - The name of the resource group.

serviceName - The name of the API Management service.

parameters - Create or update parameters.

Returns:

delegation settings for a developer portal.

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.

createOrUpdateWithResponse

com.azure.core.http.rest.Response<PortalDelegationSettings> createOrUpdateWithResponse(String resourceGroupName,
                                                                                       String serviceName,
                                                                                       PortalDelegationSettingsInner parameters,
                                                                                       String ifMatch,
                                                                                       com.azure.core.util.Context context)

Create or Update Delegation settings.

Parameters:

resourceGroupName - The name of the resource group.

serviceName - The name of the API Management service.

parameters - Create or update parameters.

ifMatch - ETag of the Entity. Not required when creating an entity, but required when updating an entity.

context - The context to associate with this operation.

Returns:

delegation settings for a developer portal 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.

listSecrets

PortalSettingValidationKeyContract listSecrets(String resourceGroupName,
                                               String serviceName)

Gets the secret validation key of the DelegationSettings.

Parameters:

resourceGroupName - The name of the resource group.

serviceName - The name of the API Management service.

Returns:

the secret validation key of the DelegationSettings.

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.

listSecretsWithResponse

com.azure.core.http.rest.Response<PortalSettingValidationKeyContract> listSecretsWithResponse(String resourceGroupName,
                                                                                              String serviceName,
                                                                                              com.azure.core.util.Context context)

Gets the secret validation key of the DelegationSettings.

Parameters:

resourceGroupName - The name of the resource group.

serviceName - The name of the API Management service.

context - The context to associate with this operation.

Returns:

the secret validation key of the DelegationSettings 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.