Skip to content

Latest commit

 

History

History
236 lines (181 loc) · 5.45 KB

Find-AnsibleNotificationTemplateForError.md

File metadata and controls

236 lines (181 loc) · 5.45 KB
external help file Module Name online version schema
Jagabata.psm.dll-Help.xml
Jagabata.psm
2.0.0

Find-AnsibleNotificationTemplateForError

SYNOPSIS

Retrieve Error NotificationTemplates.

SYNTAX

AssociatedWith (Default)

Find-AnsibleNotificationTemplateForError [-Type] <ResourceType> [-Id] <UInt64> [-OrderBy <String[]>]
 [-Search <String[]>] [-Filter <NameValueCollection>] [-Count <UInt16>] [-Page <UInt32>] [-All]
 [<CommonParameters>]

PipelineInput

Find-AnsibleNotificationTemplateForError -Resource <IResource> [-OrderBy <String[]>] [-Search <String[]>]
 [-Filter <NameValueCollection>] [-Count <UInt16>] [-Page <UInt32>] [-All] [<CommonParameters>]

DESCRIPTION

Retrieve the list of Error NotificationTemplates enabled in the Organization or Template (JobTemplate, WorkflowJobTemplate, Project, InventorySource or SystemJobTemplate).

Implementation of following API:

  • /api/v2/organizations/{id}/notification_templates_error/
  • /api/v2/job_templates/{id}/notification_templates_error/
  • /api/v2/workflow_job_templates/{id}/notification_templates_error/
  • /api/v2/projects/{id}/notification_templates_error/
  • /api/v2/inventory_sources/{id}/notification_templates_error/
  • /api/v2/system_job_templates/{id}/notification_templates_error/

EXAMPLES

Example 1

PS C:\> Find-AnsibleNotificationTemplateForError -Type Organization -Id 1

Retrieve Error NotificationTemplates enabled in the Organization of ID 1.

PARAMETERS

-All

Retrieve resources from all pages.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Count

Number to retrieve per page.

Type: UInt16
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: 20
Accept pipeline input: False
Accept wildcard characters: False

-Filter

Filtering various fields.

For examples:

  • name__icontains=test: "name" field contains "test" (case-insensitive).
  • "name_ in=test,demo", created _gt=2024-01-01: "name" field is "test" or "demo" and created after 2024-01-01.
  • @{ Name = "name"; Value = "test"; Type = "Contains"; Not = $true }: "name" field NOT contains "test"

For more details, see about_Jagabata.psm_Filter_parameter.

Type: NameValueCollection
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Id

Datebase ID of the target resource. Use in conjection with the -Type parameter.

Type: UInt64
Parameter Sets: AssociatedWith
Aliases:

Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-OrderBy

Retrieve list in the specified orders. Use ! prefix to sort in reverse. Multiple sorting fields are available by separating with a comma(,).

Default value: id (ascending order of ID)

Type: String[]
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: ["id"]
Accept pipeline input: False
Accept wildcard characters: False

-Page

Page number.

Type: UInt32
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: 1
Accept pipeline input: False
Accept wildcard characters: False

-Resource

Resource object to which the search target associated with.

The resource is accepted following types:

  • Organization
  • Project
  • InventorySource
  • JobTemplate
  • SystemJobTemplate
  • WorkflowJobTemplate
Type: IResource
Parameter Sets: PipelineInput
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-Search

Search words. (case-insensitive)

Target fields: name, description

Multiple words are available by separating with a comma(,).

Type: String[]
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Type

Resource type name of the target. Use in conjection with the -Id parameter.

Type: ResourceType
Parameter Sets: AssociatedWith
Aliases:
Accepted values: Organization, Project, InventorySource, JobTemplate, SystemJobTemplate, WorkflowJobTemplate

Required: True
Position: 0
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

Jagabata.Resources.IResource

Resource object to which the search target associated with. See: -Resource parameter.

OUTPUTS

Jagabata.Resources.NotificationTemplate

NOTES

RELATED LINKS

Get-AnsibleNotificationTemplate

Find-AnsibleNotificationTemplate

Find-AnsibleNotificationTemplateApproval

Find-AnsibleNotificationTemplateForStarted

Find-AnsibleNotificationTemplateForSuccess