Package com.azure.resourcemanager.apimanagement.models

Interface SignInSettings

public interface SignInSettings

Resource collection API of SignInSettings.

Method Summary

Modifier and Type	Method	Description
PortalSigninSettings	createOrUpdate(String resourceGroupName, String serviceName, PortalSigninSettingsInner parameters)	Create or Update Sign-In settings.
com.azure.core.http.rest.Response<PortalSigninSettings>	createOrUpdateWithResponse(String resourceGroupName, String serviceName, PortalSigninSettingsInner parameters, String ifMatch, com.azure.core.util.Context context)	Create or Update Sign-In settings.
PortalSigninSettings	get(String resourceGroupName, String serviceName)	Get Sign In Settings for the Portal.
void	getEntityTag(String resourceGroupName, String serviceName)	Gets the entity state (Etag) version of the SignInSettings.
SignInSettingsGetEntityTagResponse	getEntityTagWithResponse(String resourceGroupName, String serviceName, com.azure.core.util.Context context)	Gets the entity state (Etag) version of the SignInSettings.
com.azure.core.http.rest.Response<PortalSigninSettings>	getWithResponse(String resourceGroupName, String serviceName, com.azure.core.util.Context context)	Get Sign In Settings for the Portal.
void	update(String resourceGroupName, String serviceName, String ifMatch, PortalSigninSettingsInner parameters)	Update Sign-In settings.
com.azure.core.http.rest.Response<Void>	updateWithResponse(String resourceGroupName, String serviceName, String ifMatch, PortalSigninSettingsInner parameters, com.azure.core.util.Context context)	Update Sign-In settings.

Method Detail

getEntityTag

void getEntityTag(String resourceGroupName,
                  String serviceName)

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

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

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

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

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

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

PortalSigninSettings get(String resourceGroupName,
                         String serviceName)

Get Sign In Settings for the Portal.

Parameters:

resourceGroupName - The name of the resource group.

serviceName - The name of the API Management service.

Returns:

sign In 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<PortalSigninSettings> getWithResponse(String resourceGroupName,
                                                                        String serviceName,
                                                                        com.azure.core.util.Context context)

Get Sign In 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:

sign In 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,
            PortalSigninSettingsInner parameters)

Update Sign-In 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 Sign-In 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,
                                                           PortalSigninSettingsInner parameters,
                                                           com.azure.core.util.Context context)

Update Sign-In 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 Sign-In 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

PortalSigninSettings createOrUpdate(String resourceGroupName,
                                    String serviceName,
                                    PortalSigninSettingsInner parameters)

Create or Update Sign-In settings.

Parameters:

resourceGroupName - The name of the resource group.

serviceName - The name of the API Management service.

parameters - Create or update parameters.

Returns:

sign-In settings for the 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<PortalSigninSettings> createOrUpdateWithResponse(String resourceGroupName,
                                                                                   String serviceName,
                                                                                   PortalSigninSettingsInner parameters,
                                                                                   String ifMatch,
                                                                                   com.azure.core.util.Context context)

Create or Update Sign-In 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:

sign-In settings for the 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.