Package com.azure.resourcemanager.appcontainers.models

Interface ContainerApps

public interface ContainerApps

Resource collection API of ContainerApps.

Method Summary

Modifier and Type	Method	Description
ContainerApp.DefinitionStages.Blank	define(String name)	Begins definition for a new ContainerApp resource.
void	delete(String resourceGroupName, String containerAppName, com.azure.core.util.Context context)	Delete a Container App.
void	deleteById(String id)	Delete a Container App.
void	deleteByIdWithResponse(String id, com.azure.core.util.Context context)	Delete a Container App.
void	deleteByResourceGroup(String resourceGroupName, String containerAppName)	Delete a Container App.
ContainerApp	getById(String id)	Get the properties of a Container App.
com.azure.core.http.rest.Response<ContainerApp>	getByIdWithResponse(String id, com.azure.core.util.Context context)	Get the properties of a Container App.
ContainerApp	getByResourceGroup(String resourceGroupName, String containerAppName)	Get the properties of a Container App.
com.azure.core.http.rest.Response<ContainerApp>	getByResourceGroupWithResponse(String resourceGroupName, String containerAppName, com.azure.core.util.Context context)	Get the properties of a Container App.
com.azure.core.http.rest.PagedIterable<ContainerApp>	list()	Get the Container Apps in a given subscription.
com.azure.core.http.rest.PagedIterable<ContainerApp>	list(com.azure.core.util.Context context)	Get the Container Apps in a given subscription.
com.azure.core.http.rest.PagedIterable<ContainerApp>	listByResourceGroup(String resourceGroupName)	Get the Container Apps in a given resource group.
com.azure.core.http.rest.PagedIterable<ContainerApp>	listByResourceGroup(String resourceGroupName, com.azure.core.util.Context context)	Get the Container Apps in a given resource group.
CustomHostnameAnalysisResult	listCustomHostnameAnalysis(String resourceGroupName, String containerAppName)	Analyzes a custom hostname for a Container App.
com.azure.core.http.rest.Response<CustomHostnameAnalysisResult>	listCustomHostnameAnalysisWithResponse(String resourceGroupName, String containerAppName, String customHostname, com.azure.core.util.Context context)	Analyzes a custom hostname for a Container App.
SecretsCollection	listSecrets(String resourceGroupName, String containerAppName)	List secrets for a container app.
com.azure.core.http.rest.Response<SecretsCollection>	listSecretsWithResponse(String resourceGroupName, String containerAppName, com.azure.core.util.Context context)	List secrets for a container app.
void	update(String resourceGroupName, String containerAppName, ContainerAppInner containerAppEnvelope)	Patches a Container App using JSON Merge Patch.
void	update(String resourceGroupName, String containerAppName, ContainerAppInner containerAppEnvelope, com.azure.core.util.Context context)	Patches a Container App using JSON Merge Patch.

Method Detail

list

com.azure.core.http.rest.PagedIterable<ContainerApp> list()

Get the Container Apps in a given subscription.

Returns:

the Container Apps in a given subscription as paginated response with PagedIterable.

Throws:

DefaultErrorResponseErrorException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

list

com.azure.core.http.rest.PagedIterable<ContainerApp> list(com.azure.core.util.Context context)

Get the Container Apps in a given subscription.

Parameters:

context - The context to associate with this operation.

Returns:

the Container Apps in a given subscription as paginated response with PagedIterable.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

DefaultErrorResponseErrorException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

listByResourceGroup

com.azure.core.http.rest.PagedIterable<ContainerApp> listByResourceGroup(String resourceGroupName)

Get the Container Apps in a given resource group.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

Returns:

the Container Apps in a given resource group as paginated response with PagedIterable.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

DefaultErrorResponseErrorException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

listByResourceGroup

com.azure.core.http.rest.PagedIterable<ContainerApp> listByResourceGroup(String resourceGroupName,
                                                                         com.azure.core.util.Context context)

Get the Container Apps in a given resource group.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

context - The context to associate with this operation.

Returns:

the Container Apps in a given resource group as paginated response with PagedIterable.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

DefaultErrorResponseErrorException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

getByResourceGroup

ContainerApp getByResourceGroup(String resourceGroupName,
                                String containerAppName)

Get the properties of a Container App.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

containerAppName - Name of the Container App.

Returns:

the properties of a Container App.

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.

getByResourceGroupWithResponse

com.azure.core.http.rest.Response<ContainerApp> getByResourceGroupWithResponse(String resourceGroupName,
                                                                               String containerAppName,
                                                                               com.azure.core.util.Context context)

Get the properties of a Container App.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

containerAppName - Name of the Container App.

context - The context to associate with this operation.

Returns:

the properties of a Container App 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.

deleteByResourceGroup

void deleteByResourceGroup(String resourceGroupName,
                           String containerAppName)

Delete a Container App.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

containerAppName - Name of the Container App.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

DefaultErrorResponseErrorException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

delete

void delete(String resourceGroupName,
            String containerAppName,
            com.azure.core.util.Context context)

Delete a Container App.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

containerAppName - Name of the Container App.

context - The context to associate with this operation.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

DefaultErrorResponseErrorException - 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 containerAppName,
            ContainerAppInner containerAppEnvelope)

Patches a Container App using JSON Merge Patch.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

containerAppName - Name of the Container App.

containerAppEnvelope - Properties of a Container App that need to be updated.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

DefaultErrorResponseErrorException - 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 containerAppName,
            ContainerAppInner containerAppEnvelope,
            com.azure.core.util.Context context)

Patches a Container App using JSON Merge Patch.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

containerAppName - Name of the Container App.

containerAppEnvelope - Properties of a Container App that need to be updated.

context - The context to associate with this operation.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

DefaultErrorResponseErrorException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

listCustomHostnameAnalysis

CustomHostnameAnalysisResult listCustomHostnameAnalysis(String resourceGroupName,
                                                        String containerAppName)

Analyzes a custom hostname for a Container App.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

containerAppName - Name of the Container App.

Returns:

custom domain analysis.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

DefaultErrorResponseErrorException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

listCustomHostnameAnalysisWithResponse

com.azure.core.http.rest.Response<CustomHostnameAnalysisResult> listCustomHostnameAnalysisWithResponse(String resourceGroupName,
                                                                                                       String containerAppName,
                                                                                                       String customHostname,
                                                                                                       com.azure.core.util.Context context)

Analyzes a custom hostname for a Container App.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

containerAppName - Name of the Container App.

customHostname - Custom hostname.

context - The context to associate with this operation.

Returns:

custom domain analysis along with Response.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

DefaultErrorResponseErrorException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

listSecrets

SecretsCollection listSecrets(String resourceGroupName,
                              String containerAppName)

List secrets for a container app.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

containerAppName - Name of the Container App.

Returns:

container App Secrets Collection ARM resource.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

DefaultErrorResponseErrorException - 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<SecretsCollection> listSecretsWithResponse(String resourceGroupName,
                                                                             String containerAppName,
                                                                             com.azure.core.util.Context context)

List secrets for a container app.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

containerAppName - Name of the Container App.

context - The context to associate with this operation.

Returns:

container App Secrets Collection ARM resource along with Response.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

DefaultErrorResponseErrorException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

getById

ContainerApp getById(String id)

Get the properties of a Container App.

Parameters:

id - the resource ID.

Returns:

the properties of a Container App 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.

getByIdWithResponse

com.azure.core.http.rest.Response<ContainerApp> getByIdWithResponse(String id,
                                                                    com.azure.core.util.Context context)

Get the properties of a Container App.

Parameters:

id - the resource ID.

context - The context to associate with this operation.

Returns:

the properties of a Container App 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.

deleteById

void deleteById(String id)

Delete a Container App.

Parameters:

id - the resource ID.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

DefaultErrorResponseErrorException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

deleteByIdWithResponse

void deleteByIdWithResponse(String id,
                            com.azure.core.util.Context context)

Delete a Container App.

Parameters:

id - the resource ID.

context - The context to associate with this operation.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

DefaultErrorResponseErrorException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

define

ContainerApp.DefinitionStages.Blank define(String name)

Begins definition for a new ContainerApp resource.

Parameters:

name - resource name.

Returns:

the first stage of the new ContainerApp definition.