Interface Job
public interface Job
An immutable client-side representation of Job.
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic interface
The entirety of the Job definition.static interface
The Job definition stages.static interface
The template for Job update.static interface
The Job update stages. -
Method Summary
Modifier and TypeMethodDescriptionGets the configuration property: Container Apps Job configuration properties.Gets the environmentId property: Resource ID of environment.Gets the eventStreamEndpoint property: The endpoint of the eventstream of the container apps job.id()
Gets the id property: Fully qualified resource Id for the resource.identity()
Gets the identity property: Managed identities needed by a container app job to interact with other Azure services to not maintain any secrets or credentials in code.Gets the inner com.azure.resourcemanager.appcontainers.fluent.models.JobInner object.List secrets for a container apps job.com.azure.core.http.rest.Response
<JobSecretsCollection> listSecretsWithResponse
(com.azure.core.util.Context context) List secrets for a container apps job.location()
Gets the location property: The geo-location where the resource lives.name()
Gets the name property: The name of the resource.Gets the outboundIpAddresses property: Outbound IP Addresses of a container apps job.Gets the provisioningState property: Provisioning state of the Container Apps Job.refresh()
Refreshes the resource to sync with Azure.refresh
(com.azure.core.util.Context context) Refreshes the resource to sync with Azure.com.azure.core.management.Region
region()
Gets the region of the resource.Gets the name of the resource region.Gets the name of the resource group.start()
Start a Container Apps Job.start
(JobExecutionTemplate template, com.azure.core.util.Context context) Start a Container Apps Job.Terminates execution of a running container apps job.stopMultipleExecutions
(com.azure.core.util.Context context) Terminates execution of a running container apps job.com.azure.core.management.SystemData
Gets the systemData property: Azure Resource Manager metadata containing createdBy and modifiedBy information.tags()
Gets the tags property: Resource tags.template()
Gets the template property: Container Apps job definition.type()
Gets the type property: The type of the resource.update()
Begins update for the Job resource.Gets the workloadProfileName property: Workload profile name to pin for container apps job execution.
-
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
Gets the tags property: Resource tags.- Returns:
- the tags value.
-
identity
ManagedServiceIdentity identity()Gets the identity property: Managed identities needed by a container app job to interact with other Azure services to not maintain any secrets or credentials in code.- Returns:
- the identity 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
JobProvisioningState provisioningState()Gets the provisioningState property: Provisioning state of the Container Apps Job.- Returns:
- the provisioningState 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 apps job execution.- Returns:
- the workloadProfileName value.
-
configuration
JobConfiguration configuration()Gets the configuration property: Container Apps Job configuration properties.- Returns:
- the configuration value.
-
template
JobTemplate template()Gets the template property: Container Apps job definition.- Returns:
- the template value.
-
outboundIpAddresses
Gets the outboundIpAddresses property: Outbound IP Addresses of a container apps job.- Returns:
- the outboundIpAddresses value.
-
eventStreamEndpoint
String eventStreamEndpoint()Gets the eventStreamEndpoint property: The endpoint of the eventstream of the container apps job.- 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
JobInner innerModel()Gets the inner com.azure.resourcemanager.appcontainers.fluent.models.JobInner object.- Returns:
- the inner object.
-
update
Job.Update update()Begins update for the Job resource.- Returns:
- the stage of resource update.
-
refresh
Job refresh()Refreshes the resource to sync with Azure.- Returns:
- the refreshed resource.
-
refresh
Refreshes the resource to sync with Azure.- Parameters:
context
- The context to associate with this operation.- Returns:
- the refreshed resource.
-
start
JobExecutionBase start()Start a Container Apps Job.- Returns:
- container App's Job execution name.
- Throws:
DefaultErrorResponseErrorException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.
-
start
Start a Container Apps Job.- Parameters:
template
- Properties used to start a job execution.context
- The context to associate with this operation.- Returns:
- container App's Job execution name.
- 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.
-
stopMultipleExecutions
ContainerAppJobExecutions stopMultipleExecutions()Terminates execution of a running container apps job.- Returns:
- container App executions 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.
-
stopMultipleExecutions
Terminates execution of a running container apps job.- Parameters:
context
- The context to associate with this operation.- Returns:
- container App executions 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<JobSecretsCollection> listSecretsWithResponse(com.azure.core.util.Context context) List secrets for a container apps job.- Parameters:
context
- The context to associate with this operation.- Returns:
- container Apps Job 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
JobSecretsCollection listSecrets()List secrets for a container apps job.- Returns:
- container Apps Job 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.
-