Package com.azure.resourcemanager.apimanagement.models

Interface SignUpSettings

public interface SignUpSettings

Resource collection API of SignUpSettings.

Method Summary

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

Method Detail

getEntityTag

void getEntityTag(String resourceGroupName,
                  String serviceName)

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

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

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

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

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

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

PortalSignupSettings get(String resourceGroupName,
                         String serviceName)

Get Sign Up Settings for the Portal.

Parameters:

resourceGroupName - The name of the resource group.

serviceName - The name of the API Management service.

Returns:

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

Get Sign Up 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 Up 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,
            PortalSignupSettingsInner parameters)

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

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

PortalSignupSettings createOrUpdate(String resourceGroupName,
                                    String serviceName,
                                    PortalSignupSettingsInner parameters)

Create or Update Sign-Up settings.

Parameters:

resourceGroupName - The name of the resource group.

serviceName - The name of the API Management service.

parameters - Create or update parameters.

Returns:

sign-Up 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<PortalSignupSettings> createOrUpdateWithResponse(String resourceGroupName,
                                                                                   String serviceName,
                                                                                   PortalSignupSettingsInner parameters,
                                                                                   String ifMatch,
                                                                                   com.azure.core.util.Context context)

Create or Update Sign-Up 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-Up 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.