container_apps_diagnostics

Creates, updates, deletes, gets or lists a container_apps_diagnostics resource.

Overview

Name	container_apps_diagnostics
Type	Resource
Id	azure.app_containers.container_apps_diagnostics

Fields

The following fields are returned by SELECT queries:

get_revision

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
active	boolean	Boolean describing if the Revision is Active.
createdTime	string (date-time)	Timestamp describing when the revision was created by controller.
fqdn	string	Fully qualified domain name of the revision.
healthState	string	Current health State of the revision. Known values are: "Healthy", "Unhealthy", and "None". (Healthy, Unhealthy, None)
lastActiveTime	string (date-time)	Timestamp describing when the revision was last active. Only meaningful when revision is inactive.
provisioningError	string	Optional Field - Platform Error Message.
provisioningState	string	Current provisioning State of the revision. Known values are: "Provisioning", "Provisioned", "Failed", "Deprovisioning", and "Deprovisioned". (Provisioning, Provisioned, Failed, Deprovisioning, Deprovisioned)
replicas	integer	Number of pods currently running for this revision.
runningState	string	Current running state of the revision. Known values are: "Running", "Processing", "Stopped", "Degraded", "Failed", and "Unknown". (Running, Processing, Stopped, Degraded, Failed, Unknown)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
template	object	Container App Revision Template with all possible settings and the defaults if user did not provide them. The defaults are populated as they were at the creation time.
trafficWeight	integer	Traffic weight assigned to this revision.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

get_detector

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
dataProviderMetadata	object	List of data providers' metadata.
dataset	array	Set of data collections associated with the response.
metadata	object	Metadata of the diagnostics response.
status	object	Status of the diagnostics response.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_revisions

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
active	boolean	Boolean describing if the Revision is Active.
createdTime	string (date-time)	Timestamp describing when the revision was created by controller.
fqdn	string	Fully qualified domain name of the revision.
healthState	string	Current health State of the revision. Known values are: "Healthy", "Unhealthy", and "None". (Healthy, Unhealthy, None)
lastActiveTime	string (date-time)	Timestamp describing when the revision was last active. Only meaningful when revision is inactive.
provisioningError	string	Optional Field - Platform Error Message.
provisioningState	string	Current provisioning State of the revision. Known values are: "Provisioning", "Provisioned", "Failed", "Deprovisioning", and "Deprovisioned". (Provisioning, Provisioned, Failed, Deprovisioning, Deprovisioned)
replicas	integer	Number of pods currently running for this revision.
runningState	string	Current running state of the revision. Known values are: "Running", "Processing", "Stopped", "Degraded", "Failed", and "Unknown". (Running, Processing, Stopped, Degraded, Failed, Unknown)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
template	object	Container App Revision Template with all possible settings and the defaults if user did not provide them. The defaults are populated as they were at the creation time.
trafficWeight	integer	Traffic weight assigned to this revision.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_revision	select	resource_group_name, container_app_name, revision_name, subscription_id		Get a revision of a Container App. Get a revision of a Container App.
get_detector	select	resource_group_name, container_app_name, detector_name, subscription_id		Get a diagnostics result of a Container App. Get a diagnostics result of a Container App.
list_revisions	select	resource_group_name, container_app_name, subscription_id	$filter	Get the Revisions for a given Container App. A synchronous resource action.
list_detectors	exec	resource_group_name, container_app_name, subscription_id		Get the list of diagnostics for a given Container App. Get the list of diagnostics for a given Container App.
get_root	exec	resource_group_name, container_app_name, subscription_id		Get the properties of a Container App. Get the properties of a Container App.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
container_app_name	string	Name of the Container App. Required.
detector_name	string	Name of the detector. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
revision_name	string	Name of the detector. Required.
subscription_id	string
$filter	string	The filter to apply on the operation. Default value is None.

SELECT examples

get_revision

Get a revision of a Container App. Get a revision of a Container App.

SELECT
id,
name,
active,
createdTime,
fqdn,
healthState,
lastActiveTime,
provisioningError,
provisioningState,
replicas,
runningState,
systemData,
template,
trafficWeight,
type
FROM azure.app_containers.container_apps_diagnostics
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND container_app_name = '{{ container_app_name }}' -- required
AND revision_name = '{{ revision_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

get_detector

Get a diagnostics result of a Container App. Get a diagnostics result of a Container App.

SELECT
id,
name,
dataProviderMetadata,
dataset,
metadata,
status,
systemData,
type
FROM azure.app_containers.container_apps_diagnostics
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND container_app_name = '{{ container_app_name }}' -- required
AND detector_name = '{{ detector_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_revisions

Get the Revisions for a given Container App. A synchronous resource action.

SELECT
id,
name,
active,
createdTime,
fqdn,
healthState,
lastActiveTime,
provisioningError,
provisioningState,
replicas,
runningState,
systemData,
template,
trafficWeight,
type
FROM azure.app_containers.container_apps_diagnostics
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND container_app_name = '{{ container_app_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND $filter = '{{ $filter }}'
;

Lifecycle Methods

list_detectors

Get the list of diagnostics for a given Container App. Get the list of diagnostics for a given Container App.

EXEC azure.app_containers.container_apps_diagnostics.list_detectors 
@resource_group_name='{{ resource_group_name }}' --required, 
@container_app_name='{{ container_app_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

get_root

Get the properties of a Container App. Get the properties of a Container App.

EXEC azure.app_containers.container_apps_diagnostics.get_root 
@resource_group_name='{{ resource_group_name }}' --required, 
@container_app_name='{{ container_app_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;