diagnostics

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

Overview

Name	diagnostics
Type	Resource
Id	azure.workload_orchestration.diagnostics

Fields

The following fields are returned by SELECT queries:

get

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.
eTag	string	If eTag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.
extendedLocation	object	:vartype extended_location: ~azure.mgmt.workloadorchestration.models.ExtendedLocation
location	string	The geo-location where the resource lives. Required.
provisioningState	string	The status of the last operation. Known values are: "Succeeded", "Failed", "Canceled", "Initialized", "InProgress", and "Deleting". (Succeeded, Failed, Canceled, Initialized, InProgress, Deleting)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_resource_group

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.
eTag	string	If eTag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.
extendedLocation	object	:vartype extended_location: ~azure.mgmt.workloadorchestration.models.ExtendedLocation
location	string	The geo-location where the resource lives. Required.
provisioningState	string	The status of the last operation. Known values are: "Succeeded", "Failed", "Canceled", "Initialized", "InProgress", and "Deleting". (Succeeded, Failed, Canceled, Initialized, InProgress, Deleting)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_subscription

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.
eTag	string	If eTag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.
extendedLocation	object	:vartype extended_location: ~azure.mgmt.workloadorchestration.models.ExtendedLocation
location	string	The geo-location where the resource lives. Required.
provisioningState	string	The status of the last operation. Known values are: "Succeeded", "Failed", "Canceled", "Initialized", "InProgress", and "Deleting". (Succeeded, Failed, Canceled, Initialized, InProgress, Deleting)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
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	select	resource_group_name, diagnostic_name, subscription_id		Returns details of specified Diagnostic resource.
list_by_resource_group	select	resource_group_name, subscription_id		Returns a collection of Diagnostic resources within the resource group.
list_by_subscription	select	subscription_id		Lists Diagnostics resources within an Azure subscription.
create_or_update	insert	resource_group_name, diagnostic_name, subscription_id, location		Creates new or updates existing Diagnostic resource.
update	update	resource_group_name, diagnostic_name, subscription_id, location		Updates existing Diagnostic resource.
create_or_update	replace	resource_group_name, diagnostic_name, subscription_id, location		Creates new or updates existing Diagnostic resource.
delete	delete	resource_group_name, diagnostic_name, subscription_id		Deletes specified Diagnostic resource.

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
diagnostic_name	string	Name of Diagnostic. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string

SELECT examples

get

Returns details of specified Diagnostic resource.

SELECT
id,
name,
eTag,
extendedLocation,
location,
provisioningState,
systemData,
tags,
type
FROM azure.workload_orchestration.diagnostics
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND diagnostic_name = '{{ diagnostic_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_resource_group

Returns a collection of Diagnostic resources within the resource group.

SELECT
id,
name,
eTag,
extendedLocation,
location,
provisioningState,
systemData,
tags,
type
FROM azure.workload_orchestration.diagnostics
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_subscription

Lists Diagnostics resources within an Azure subscription.

SELECT
id,
name,
eTag,
extendedLocation,
location,
provisioningState,
systemData,
tags,
type
FROM azure.workload_orchestration.diagnostics
WHERE subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Creates new or updates existing Diagnostic resource.

INSERT INTO azure.workload_orchestration.diagnostics (
tags,
location,
properties,
extendedLocation,
resource_group_name,
diagnostic_name,
subscription_id
)
SELECT 
'{{ tags }}',
'{{ location }}' /* required */,
'{{ properties }}',
'{{ extendedLocation }}',
'{{ resource_group_name }}',
'{{ diagnostic_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
eTag,
extendedLocation,
location,
properties,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: diagnostics
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the diagnostics resource.
  - name: diagnostic_name
    value: "{{ diagnostic_name }}"
    description: Required parameter for the diagnostics resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the diagnostics resource.
  - name: tags
    value: "{{ tags }}"
    description: |
      Resource tags.
  - name: location
    value: "{{ location }}"
    description: |
      The geo-location where the resource lives. Required.
  - name: properties
    description: |
      The resource-specific properties for this resource.
    value:
      provisioningState: "{{ provisioningState }}"
  - name: extendedLocation
    description: |
      :vartype extended_location: ~azure.mgmt.workloadorchestration.models.ExtendedLocation
    value:
      name: "{{ name }}"
      type: "{{ type }}"

UPDATE examples

update

Updates existing Diagnostic resource.

UPDATE azure.workload_orchestration.diagnostics
SET 
tags = '{{ tags }}',
location = '{{ location }}',
properties = '{{ properties }}',
extendedLocation = '{{ extendedLocation }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND diagnostic_name = '{{ diagnostic_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND location = '{{ location }}' --required
RETURNING
id,
name,
eTag,
extendedLocation,
location,
properties,
systemData,
tags,
type;

REPLACE examples

create_or_update

Creates new or updates existing Diagnostic resource.

REPLACE azure.workload_orchestration.diagnostics
SET 
tags = '{{ tags }}',
location = '{{ location }}',
properties = '{{ properties }}',
extendedLocation = '{{ extendedLocation }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND diagnostic_name = '{{ diagnostic_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND location = '{{ location }}' --required
RETURNING
id,
name,
eTag,
extendedLocation,
location,
properties,
systemData,
tags,
type;

DELETE examples

delete

Deletes specified Diagnostic resource.

DELETE FROM azure.workload_orchestration.diagnostics
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND diagnostic_name = '{{ diagnostic_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;