Share via

ApiPortalsClient Interface

  • Reference
Package:
com.azure.resourcemanager.appplatform.fluent
Maven Artifact:
com.azure.resourcemanager:azure-resourcemanager-appplatform:2.44.0

public interface ApiPortalsClient

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

Method Summary

Modifier and Type Method and Description
abstract SyncPoller<PollResult<ApiPortalResourceInner>,ApiPortalResourceInner> beginCreateOrUpdate(String resourceGroupName, String serviceName, String apiPortalName, ApiPortalResourceInner apiPortalResource)

Create the default API portal or update the existing API portal.
abstract SyncPoller<PollResult<ApiPortalResourceInner>,ApiPortalResourceInner> beginCreateOrUpdate(String resourceGroupName, String serviceName, String apiPortalName, ApiPortalResourceInner apiPortalResource, Context context)

Create the default API portal or update the existing API portal.
abstract PollerFlux<PollResult<ApiPortalResourceInner>,ApiPortalResourceInner> beginCreateOrUpdateAsync(String resourceGroupName, String serviceName, String apiPortalName, ApiPortalResourceInner apiPortalResource)

Create the default API portal or update the existing API portal.
abstract SyncPoller<PollResult<Void>,Void> beginDelete(String resourceGroupName, String serviceName, String apiPortalName)

Delete the default API portal.
abstract SyncPoller<PollResult<Void>,Void> beginDelete(String resourceGroupName, String serviceName, String apiPortalName, Context context)

Delete the default API portal.
abstract PollerFlux<PollResult<Void>,Void> beginDeleteAsync(String resourceGroupName, String serviceName, String apiPortalName)

Delete the default API portal.
abstract ApiPortalResourceInner createOrUpdate(String resourceGroupName, String serviceName, String apiPortalName, ApiPortalResourceInner apiPortalResource)

Create the default API portal or update the existing API portal.
abstract ApiPortalResourceInner createOrUpdate(String resourceGroupName, String serviceName, String apiPortalName, ApiPortalResourceInner apiPortalResource, Context context)

Create the default API portal or update the existing API portal.
abstract Mono<ApiPortalResourceInner> createOrUpdateAsync(String resourceGroupName, String serviceName, String apiPortalName, ApiPortalResourceInner apiPortalResource)

Create the default API portal or update the existing API portal.
abstract Mono<Response<Flux<ByteBuffer>>> createOrUpdateWithResponseAsync(String resourceGroupName, String serviceName, String apiPortalName, ApiPortalResourceInner apiPortalResource)

Create the default API portal or update the existing API portal.
abstract void delete(String resourceGroupName, String serviceName, String apiPortalName)

Delete the default API portal.
abstract void delete(String resourceGroupName, String serviceName, String apiPortalName, Context context)

Delete the default API portal.
abstract Mono<Void> deleteAsync(String resourceGroupName, String serviceName, String apiPortalName)

Delete the default API portal.
abstract Mono<Response<Flux<ByteBuffer>>> deleteWithResponseAsync(String resourceGroupName, String serviceName, String apiPortalName)

Delete the default API portal.
abstract ApiPortalResourceInner get(String resourceGroupName, String serviceName, String apiPortalName)

Get the API portal and its properties.
abstract Mono<ApiPortalResourceInner> getAsync(String resourceGroupName, String serviceName, String apiPortalName)

Get the API portal and its properties.
abstract Response<ApiPortalResourceInner> getWithResponse(String resourceGroupName, String serviceName, String apiPortalName, Context context)

Get the API portal and its properties.
abstract Mono<Response<ApiPortalResourceInner>> getWithResponseAsync(String resourceGroupName, String serviceName, String apiPortalName)

Get the API portal and its properties.
abstract PagedIterable<ApiPortalResourceInner> list(String resourceGroupName, String serviceName)

Handles requests to list all resources in a Service.
abstract PagedIterable<ApiPortalResourceInner> list(String resourceGroupName, String serviceName, Context context)

Handles requests to list all resources in a Service.
abstract PagedFlux<ApiPortalResourceInner> listAsync(String resourceGroupName, String serviceName)

Handles requests to list all resources in a Service.
abstract CustomDomainValidateResult validateDomain(String resourceGroupName, String serviceName, String apiPortalName, CustomDomainValidatePayload validatePayload)

Check the domains are valid as well as not in use.
abstract Mono<CustomDomainValidateResult> validateDomainAsync(String resourceGroupName, String serviceName, String apiPortalName, CustomDomainValidatePayload validatePayload)

Check the domains are valid as well as not in use.
abstract Response<CustomDomainValidateResult> validateDomainWithResponse(String resourceGroupName, String serviceName, String apiPortalName, CustomDomainValidatePayload validatePayload, Context context)

Check the domains are valid as well as not in use.
abstract Mono<Response<CustomDomainValidateResult>> validateDomainWithResponseAsync(String resourceGroupName, String serviceName, String apiPortalName, CustomDomainValidatePayload validatePayload)

Check the domains are valid as well as not in use.

Method Details

beginCreateOrUpdate

public abstract SyncPoller,ApiPortalResourceInner> beginCreateOrUpdate(String resourceGroupName, String serviceName, String apiPortalName, ApiPortalResourceInner apiPortalResource)

Create the default API portal or update the existing API portal.

Parameters:

resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
serviceName - The name of the Service resource.
apiPortalName - The name of API portal.
apiPortalResource - The API portal for the create or update operation.

Returns:

the SyncPoller<T,U> for polling of aPI portal resource.

beginCreateOrUpdate

public abstract SyncPoller,ApiPortalResourceInner> beginCreateOrUpdate(String resourceGroupName, String serviceName, String apiPortalName, ApiPortalResourceInner apiPortalResource, Context context)

Create the default API portal or update the existing API portal.

Parameters:

resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
serviceName - The name of the Service resource.
apiPortalName - The name of API portal.
apiPortalResource - The API portal for the create or update operation.
context - The context to associate with this operation.

Returns:

the SyncPoller<T,U> for polling of aPI portal resource.

beginCreateOrUpdateAsync

public abstract PollerFlux,ApiPortalResourceInner> beginCreateOrUpdateAsync(String resourceGroupName, String serviceName, String apiPortalName, ApiPortalResourceInner apiPortalResource)

Create the default API portal or update the existing API portal.

Parameters:

resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
serviceName - The name of the Service resource.
apiPortalName - The name of API portal.
apiPortalResource - The API portal for the create or update operation.

Returns:

the PollerFlux<T,U> for polling of aPI portal resource.

beginDelete

public abstract SyncPoller,Void> beginDelete(String resourceGroupName, String serviceName, String apiPortalName)

Delete the default API portal.

Parameters:

resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
serviceName - The name of the Service resource.
apiPortalName - The name of API portal.

Returns:

the SyncPoller<T,U> for polling of long-running operation.

beginDelete

public abstract SyncPoller,Void> beginDelete(String resourceGroupName, String serviceName, String apiPortalName, Context context)

Delete the default API portal.

Parameters:

resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
serviceName - The name of the Service resource.
apiPortalName - The name of API portal.
context - The context to associate with this operation.

Returns:

the SyncPoller<T,U> for polling of long-running operation.

beginDeleteAsync

public abstract PollerFlux,Void> beginDeleteAsync(String resourceGroupName, String serviceName, String apiPortalName)

Delete the default API portal.

Parameters:

resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
serviceName - The name of the Service resource.
apiPortalName - The name of API portal.

Returns:

the PollerFlux<T,U> for polling of long-running operation.

createOrUpdate

public abstract ApiPortalResourceInner createOrUpdate(String resourceGroupName, String serviceName, String apiPortalName, ApiPortalResourceInner apiPortalResource)

Create the default API portal or update the existing API portal.

Parameters:

resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
serviceName - The name of the Service resource.
apiPortalName - The name of API portal.
apiPortalResource - The API portal for the create or update operation.

Returns:

aPI portal resource.

createOrUpdate

public abstract ApiPortalResourceInner createOrUpdate(String resourceGroupName, String serviceName, String apiPortalName, ApiPortalResourceInner apiPortalResource, Context context)

Create the default API portal or update the existing API portal.

Parameters:

resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
serviceName - The name of the Service resource.
apiPortalName - The name of API portal.
apiPortalResource - The API portal for the create or update operation.
context - The context to associate with this operation.

Returns:

aPI portal resource.

createOrUpdateAsync

public abstract Mono createOrUpdateAsync(String resourceGroupName, String serviceName, String apiPortalName, ApiPortalResourceInner apiPortalResource)

Create the default API portal or update the existing API portal.

Parameters:

resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
serviceName - The name of the Service resource.
apiPortalName - The name of API portal.
apiPortalResource - The API portal for the create or update operation.

Returns:

aPI portal resource on successful completion of Mono.

createOrUpdateWithResponseAsync

public abstract Mono>> createOrUpdateWithResponseAsync(String resourceGroupName, String serviceName, String apiPortalName, ApiPortalResourceInner apiPortalResource)

Create the default API portal or update the existing API portal.

Parameters:

resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
serviceName - The name of the Service resource.
apiPortalName - The name of API portal.
apiPortalResource - The API portal for the create or update operation.

Returns:

aPI portal resource along with Response<T> on successful completion of Mono.

delete

public abstract void delete(String resourceGroupName, String serviceName, String apiPortalName)

Delete the default API portal.

Parameters:

resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
serviceName - The name of the Service resource.
apiPortalName - The name of API portal.

delete

public abstract void delete(String resourceGroupName, String serviceName, String apiPortalName, Context context)

Delete the default API portal.

Parameters:

resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
serviceName - The name of the Service resource.
apiPortalName - The name of API portal.
context - The context to associate with this operation.

deleteAsync

public abstract Mono deleteAsync(String resourceGroupName, String serviceName, String apiPortalName)

Delete the default API portal.

Parameters:

resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
serviceName - The name of the Service resource.
apiPortalName - The name of API portal.

Returns:

A Mono that completes when a successful response is received.

deleteWithResponseAsync

public abstract Mono>> deleteWithResponseAsync(String resourceGroupName, String serviceName, String apiPortalName)

Delete the default API portal.

Parameters:

resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
serviceName - The name of the Service resource.
apiPortalName - The name of API portal.

Returns:

the Response<T> on successful completion of Mono.

get

public abstract ApiPortalResourceInner get(String resourceGroupName, String serviceName, String apiPortalName)

Get the API portal and its properties.

Parameters:

resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
serviceName - The name of the Service resource.
apiPortalName - The name of API portal.

Returns:

the API portal and its properties.

getAsync

public abstract Mono getAsync(String resourceGroupName, String serviceName, String apiPortalName)

Get the API portal and its properties.

Parameters:

resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
serviceName - The name of the Service resource.
apiPortalName - The name of API portal.

Returns:

the API portal and its properties on successful completion of Mono.

getWithResponse

public abstract Response getWithResponse(String resourceGroupName, String serviceName, String apiPortalName, Context context)

Get the API portal and its properties.

Parameters:

resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
serviceName - The name of the Service resource.
apiPortalName - The name of API portal.
context - The context to associate with this operation.

Returns:

the API portal and its properties along with Response<T>.

getWithResponseAsync

public abstract Mono> getWithResponseAsync(String resourceGroupName, String serviceName, String apiPortalName)

Get the API portal and its properties.

Parameters:

resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
serviceName - The name of the Service resource.
apiPortalName - The name of API portal.

Returns:

the API portal and its properties along with Response<T> on successful completion of Mono.

list

public abstract PagedIterable list(String resourceGroupName, String serviceName)

Handles requests to list all resources in a Service.

Parameters:

resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
serviceName - The name of the Service resource.

Returns:

object that includes an array of API portal resources and a possible link for next set as paginated response with PagedIterable<T>.

list

public abstract PagedIterable list(String resourceGroupName, String serviceName, Context context)

Handles requests to list all resources in a Service.

Parameters:

resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
serviceName - The name of the Service resource.
context - The context to associate with this operation.

Returns:

object that includes an array of API portal resources and a possible link for next set as paginated response with PagedIterable<T>.

listAsync

public abstract PagedFlux listAsync(String resourceGroupName, String serviceName)

Handles requests to list all resources in a Service.

Parameters:

resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
serviceName - The name of the Service resource.

Returns:

object that includes an array of API portal resources and a possible link for next set as paginated response with PagedFlux<T>.

validateDomain

public abstract CustomDomainValidateResult validateDomain(String resourceGroupName, String serviceName, String apiPortalName, CustomDomainValidatePayload validatePayload)

Check the domains are valid as well as not in use.

Parameters:

resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
serviceName - The name of the Service resource.
apiPortalName - The name of API portal.
validatePayload - Custom domain payload to be validated.

Returns:

validation result for custom domain.

validateDomainAsync

public abstract Mono validateDomainAsync(String resourceGroupName, String serviceName, String apiPortalName, CustomDomainValidatePayload validatePayload)

Check the domains are valid as well as not in use.

Parameters:

resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
serviceName - The name of the Service resource.
apiPortalName - The name of API portal.
validatePayload - Custom domain payload to be validated.

Returns:

validation result for custom domain on successful completion of Mono.

validateDomainWithResponse

public abstract Response validateDomainWithResponse(String resourceGroupName, String serviceName, String apiPortalName, CustomDomainValidatePayload validatePayload, Context context)

Check the domains are valid as well as not in use.

Parameters:

resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
serviceName - The name of the Service resource.
apiPortalName - The name of API portal.
validatePayload - Custom domain payload to be validated.
context - The context to associate with this operation.

Returns:

validation result for custom domain along with Response<T>.

validateDomainWithResponseAsync

public abstract Mono> validateDomainWithResponseAsync(String resourceGroupName, String serviceName, String apiPortalName, CustomDomainValidatePayload validatePayload)

Check the domains are valid as well as not in use.

Parameters:

resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
serviceName - The name of the Service resource.
apiPortalName - The name of API portal.
validatePayload - Custom domain payload to be validated.

Returns:

validation result for custom domain along with Response<T> on successful completion of Mono.

Applies to