Interface ContainerAppsClient


  • public interface ContainerAppsClient
    An instance of this class provides access to all the operations defined in ContainerAppsClient.
    • Method Detail

      • list

        com.azure.core.http.rest.PagedIterable<ContainerAppInner> 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<ContainerAppInner> 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<ContainerAppInner> 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<ContainerAppInner> 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

        ContainerAppInner getByResourceGroup​(String resourceGroupName,
                                             String name)
        Get the properties of a Container App.
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        name - 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<ContainerAppInner> getByResourceGroupWithResponse​(String resourceGroupName,
                                                                                            String name,
                                                                                            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.
        name - 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.
      • beginCreateOrUpdate

        com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<ContainerAppInner>,​ContainerAppInner> beginCreateOrUpdate​(String resourceGroupName,
                                                                                                                                                            String name,
                                                                                                                                                            ContainerAppInner containerAppEnvelope)
        Description for Create or update a Container App.
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        name - Name of the Container App.
        containerAppEnvelope - Properties used to create a container app.
        Returns:
        the SyncPoller for polling of 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.
      • beginCreateOrUpdate

        com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<ContainerAppInner>,​ContainerAppInner> beginCreateOrUpdate​(String resourceGroupName,
                                                                                                                                                            String name,
                                                                                                                                                            ContainerAppInner containerAppEnvelope,
                                                                                                                                                            com.azure.core.util.Context context)
        Description for Create or update a Container App.
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        name - Name of the Container App.
        containerAppEnvelope - Properties used to create a container app.
        context - The context to associate with this operation.
        Returns:
        the SyncPoller for polling of 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.
      • createOrUpdate

        ContainerAppInner createOrUpdate​(String resourceGroupName,
                                         String name,
                                         ContainerAppInner containerAppEnvelope)
        Description for Create or update a Container App.
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        name - Name of the Container App.
        containerAppEnvelope - Properties used to create a container app.
        Returns:
        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.
      • createOrUpdate

        ContainerAppInner createOrUpdate​(String resourceGroupName,
                                         String name,
                                         ContainerAppInner containerAppEnvelope,
                                         com.azure.core.util.Context context)
        Description for Create or update a Container App.
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        name - Name of the Container App.
        containerAppEnvelope - Properties used to create a container app.
        context - The context to associate with this operation.
        Returns:
        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.
      • beginDelete

        com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Void>,​Void> beginDelete​(String resourceGroupName,
                                                                                                                          String name)
        Description for Delete a Container App.
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        name - Name of the Container App.
        Returns:
        the SyncPoller for polling of long-running 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.
      • beginDelete

        com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Void>,​Void> beginDelete​(String resourceGroupName,
                                                                                                                          String name,
                                                                                                                          com.azure.core.util.Context context)
        Description for Delete a Container App.
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        name - Name of the Container App.
        context - The context to associate with this operation.
        Returns:
        the SyncPoller for polling of long-running 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.
      • delete

        void delete​(String resourceGroupName,
                    String name)
        Description for Delete a Container App.
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        name - 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 name,
                    com.azure.core.util.Context context)
        Description for Delete a Container App.
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        name - 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.
      • beginUpdate

        com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Void>,​Void> beginUpdate​(String resourceGroupName,
                                                                                                                          String name,
                                                                                                                          ContainerAppInner containerAppEnvelope)
        Patches a Container App using JSON Merge Patch.
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        name - Name of the Container App.
        containerAppEnvelope - Properties of a Container App that need to be updated.
        Returns:
        the SyncPoller for polling of long-running 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.
      • beginUpdate

        com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Void>,​Void> beginUpdate​(String resourceGroupName,
                                                                                                                          String name,
                                                                                                                          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.
        name - Name of the Container App.
        containerAppEnvelope - Properties of a Container App that need to be updated.
        context - The context to associate with this operation.
        Returns:
        the SyncPoller for polling of long-running 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 name,
                    ContainerAppInner containerAppEnvelope)
        Patches a Container App using JSON Merge Patch.
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        name - 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 name,
                    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.
        name - 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

        CustomHostnameAnalysisResultInner 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<CustomHostnameAnalysisResultInner> 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

        SecretsCollectionInner listSecrets​(String resourceGroupName,
                                           String name)
        List secrets for a container app.
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        name - 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<SecretsCollectionInner> listSecretsWithResponse​(String resourceGroupName,
                                                                                          String name,
                                                                                          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.
        name - 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.