Package com.azure.resourcemanager.appcontainers.models

Interface ContainerApp

public interface ContainerApp
An immutable client-side representation of ContainerApp.

  • Method Details

    • id

      String id()
      Gets the id property: Fully qualified resource Id for the resource.
      Returns:
      the id value.

    • name

      String name()
      Gets the name property: The name of the resource.
      Returns:
      the name value.

    • type

      String type()
      Gets the type property: The type of the resource.
      Returns:
      the type value.

    • location

      String location()
      Gets the location property: The geo-location where the resource lives.
      Returns:
      the location value.

    • tags

      Map<String,String> tags()
      Gets the tags property: Resource tags.
      Returns:
      the tags value.

    • extendedLocation

      ExtendedLocation extendedLocation()
      Gets the extendedLocation property: The complex type of the extended location.
      Returns:
      the extendedLocation value.

    • identity

      ManagedServiceIdentity identity()
      Gets the identity property: managed identities for the Container App to interact with other Azure services without maintaining any secrets or credentials in code.
      Returns:
      the identity value.

    • managedBy

      String managedBy()
      Gets the managedBy property: The fully qualified resource ID of the resource that manages this resource. Indicates if this resource is managed by another Azure resource. If this is present, complete mode deployment will not delete the resource if it is removed from the template since it is managed by another resource.
      Returns:
      the managedBy value.

    • systemData

      com.azure.core.management.SystemData systemData()
      Gets the systemData property: Azure Resource Manager metadata containing createdBy and modifiedBy information.
      Returns:
      the systemData value.

    • provisioningState

      ContainerAppProvisioningState provisioningState()
      Gets the provisioningState property: Provisioning state of the Container App.
      Returns:
      the provisioningState value.

    • runningStatus

      ContainerAppRunningStatus runningStatus()
      Gets the runningStatus property: Running status of the Container App.
      Returns:
      the runningStatus value.

    • managedEnvironmentId

      String managedEnvironmentId()
      Gets the managedEnvironmentId property: Deprecated. Resource ID of the Container App's environment.
      Returns:
      the managedEnvironmentId value.

    • environmentId

      String environmentId()
      Gets the environmentId property: Resource ID of environment.
      Returns:
      the environmentId value.

    • workloadProfileName

      String workloadProfileName()
      Gets the workloadProfileName property: Workload profile name to pin for container app execution.
      Returns:
      the workloadProfileName value.

    • latestRevisionName

      String latestRevisionName()
      Gets the latestRevisionName property: Name of the latest revision of the Container App.
      Returns:
      the latestRevisionName value.

    • latestReadyRevisionName

      String latestReadyRevisionName()
      Gets the latestReadyRevisionName property: Name of the latest ready revision of the Container App.
      Returns:
      the latestReadyRevisionName value.

    • latestRevisionFqdn

      String latestRevisionFqdn()
      Gets the latestRevisionFqdn property: Fully Qualified Domain Name of the latest revision of the Container App.
      Returns:
      the latestRevisionFqdn value.

    • customDomainVerificationId

      String customDomainVerificationId()
      Gets the customDomainVerificationId property: Id used to verify domain name ownership.
      Returns:
      the customDomainVerificationId value.

    • configuration

      Configuration configuration()
      Gets the configuration property: Non versioned Container App configuration properties.
      Returns:
      the configuration value.

    • template

      Template template()
      Gets the template property: Container App versioned application definition.
      Returns:
      the template value.

    • outboundIpAddresses

      List<String> outboundIpAddresses()
      Gets the outboundIpAddresses property: Outbound IP Addresses for container app.
      Returns:
      the outboundIpAddresses value.

    • eventStreamEndpoint

      String eventStreamEndpoint()
      Gets the eventStreamEndpoint property: The endpoint of the eventstream of the container app.
      Returns:
      the eventStreamEndpoint value.

    • region

      com.azure.core.management.Region region()
      Gets the region of the resource.
      Returns:
      the region of the resource.

    • regionName

      String regionName()
      Gets the name of the resource region.
      Returns:
      the name of the resource region.

    • resourceGroupName

      String resourceGroupName()
      Gets the name of the resource group.
      Returns:
      the name of the resource group.

    • innerModel

      ContainerAppInner innerModel()
      Gets the inner com.azure.resourcemanager.appcontainers.fluent.models.ContainerAppInner object.
      Returns:
      the inner object.

    • update

      ContainerApp.Update update()
      Begins update for the ContainerApp resource.
      Returns:
      the stage of resource update.

    • refresh

      ContainerApp refresh()
      Refreshes the resource to sync with Azure.
      Returns:
      the refreshed resource.

    • refresh

      ContainerApp refresh(com.azure.core.util.Context context)
      Refreshes the resource to sync with Azure.
      Parameters:
      context - The context to associate with this operation.
      Returns:
      the refreshed resource.

    • listCustomHostnameAnalysisWithResponse

      com.azure.core.http.rest.Response<CustomHostnameAnalysisResult> listCustomHostnameAnalysisWithResponse(String customHostname, com.azure.core.util.Context context)
      Analyzes a custom hostname for a Container App.
      Parameters:
      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.

    • listCustomHostnameAnalysis

      CustomHostnameAnalysisResult listCustomHostnameAnalysis()
      Analyzes a custom hostname for a Container App.
      Returns:
      custom domain analysis.
      Throws:
      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(com.azure.core.util.Context context)
      List secrets for a container app.
      Parameters:
      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.

    • listSecrets

      SecretsCollection listSecrets()
      List secrets for a container app.
      Returns:
      container App Secrets Collection ARM resource.
      Throws:
      DefaultErrorResponseErrorException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • getAuthTokenWithResponse

      com.azure.core.http.rest.Response<ContainerAppAuthToken> getAuthTokenWithResponse(com.azure.core.util.Context context)
      Get auth token for a container app.
      Parameters:
      context - The context to associate with this operation.
      Returns:
      auth token for a container app along with Response.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      DefaultErrorResponseErrorException - thrown if the request is rejected by server.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server on status code 404.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • getAuthToken

      ContainerAppAuthToken getAuthToken()
      Get auth token for a container app.
      Returns:
      auth token for a container app.
      Throws:
      DefaultErrorResponseErrorException - thrown if the request is rejected by server.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server on status code 404.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • start

      ContainerApp start()
      Start a container app.
      Returns:
      container App.
      Throws:
      DefaultErrorResponseErrorException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • start

      ContainerApp start(com.azure.core.util.Context context)
      Start a container app.
      Parameters:
      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.

    • stop

      ContainerApp stop()
      Stop a container app.
      Returns:
      container App.
      Throws:
      DefaultErrorResponseErrorException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • stop

      ContainerApp stop(com.azure.core.util.Context context)
      Stop a container app.
      Parameters:
      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.