Skip to content

Latest commit

 

History

History
188 lines (139 loc) · 3.84 KB

Find-AnsibleCredentialType.md

File metadata and controls

188 lines (139 loc) · 3.84 KB
external help file Module Name online version schema
Jagabata.psm.dll-Help.xml
Jagabata.psm
2.0.0

Find-AnsibleCredentialType

SYNOPSIS

Retrieve CredentialTypes.

SYNTAX

Find-AnsibleCredentialType [-Kind <CredentialTypeKind[]>] [-OrderBy <String[]>] [-Search <String[]>]
 [-Filter <NameValueCollection>] [-Count <UInt16>] [-Page <UInt32>] [-All] [<CommonParameters>]

DESCRIPTION

Retrieve the list of CredentialTypes.

Implementation of following API:

  • /api/v2/credential_types/

EXAMPLES

Example 1

PS C:\> Find-AnsibleCredentialType

Example 2

PS C:\> Find-AnsibleCredentialType -Kind ssh,vault

Retrieve CredentialTypes for ssh and vault.

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

-Kind

Filter with kind field.

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

Type: CredentialTypeKind[]
Parameter Sets: (All)
Aliases:
Accepted values: ssh, vault, net, scm, cloud, registry, token, insights, external, kubernetes, galaxy, cryptography

Required: False
Position: Named
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

-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

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

None

OUTPUTS

Jagabata.Resources.CredentialType

NOTES

RELATED LINKS

Get-AnsibleCredentialType

Get-AnsibleCredential

Find-AnsibleCredential

New-AnsibleCredentialType

Update-AnsibleCredentialType

Remove-AnsibleCredentialType