3.1 KiB
3.1 KiB
| 1 | API_PARAMETER | TYPE | DESCRIPTION |
|---|---|---|---|
| 2 | {accountName} | [string] | Thenameoftheaccount |
| 3 | {categoryGuid} | [string] | Thegloballyuniqueidentifierofthecategory |
| 4 | {classificationName} | [string] | Thenameoftheclassification |
| 5 | {classificationRuleName} | [string] | Nameoftheclassificationrule |
| 6 | {dataSource} | [string] | Specifyadatasource(AzureBlobStorage|aws|AzureDataLakeStorageGen2) |
| 7 | {dataSourceName} | [string] | Nameofthedatasource |
| 8 | {dataSourceType} | [string] | Typeofdatasource |
| 9 | {depth} | [integer] | Thenumberofhopsforlineage[default:3] |
| 10 | {direction} | [string] | Thedirectionofthelineagewhichcouldbe:INPUT:OUTPUT:BOTH[default:BOTH] |
| 11 | {extendedInfo} | [boolean] | Limitswhetherincludesextendedinformation[default:false] |
| 12 | {extInfo} | [boolean] | extInfo[default:false] |
| 13 | {facets-file} | [string] | Filepathtoafacetsjsonfile |
| 14 | {fileType} | [string] | Specifyafiletype(csv|avro|parquet|json|snappy|pptx|docx|xlsx)[default:csv] |
| 15 | {filter-file} | [string] | Filepathtoafilterjsonfile |
| 16 | {glossaryGuid} | [string] | Thegloballyuniqueidentifierforglossary |
| 17 | {glossaryName} | [string] | Thenameoftheglossary |
| 18 | {groupId} | [string] | Thegroupidentifier |
| 19 | {guid} | [string] | GloballyUniqueIdentifier(XXXXXXXXXX-YYYYY-ZZZZZZ-AAAAAAAAAAAAAA]Format |
| 20 | {ignoreRelationships} | [boolean] | Whethertoignorerelationshipattributes[default:false] |
| 21 | {includeTermHierarchy} | [boolean] | Includetermtemplatereferences[default:false] |
| 22 | {includeTermTemplate} | [boolean] | Whethertoincludetermtemplatedef[default:false] |
| 23 | {keyword} | [string] | KeywordsToSearch |
| 24 | {keywords} | [string] | SearchByKeyword |
| 25 | {keyVaultName} | [string] | Nameofthekeyvault |
| 26 | {limit} | [integer] | Thepagesize-bydefaultthereisnopaging[default:1000] |
| 27 | {minExtInfo} | [boolean] | Whethertoreturnminimalinformationforreferredentities[default:false] |
| 28 | {name} | [string] | Thenameoftheattribute |
| 29 | {numberOfDays} | [integer] | Trailingtimeperiodindays[default:30] |
| 30 | {offset} | [integer] | Offsetforpaginationpurpose[default:0] |
| 31 | {operationGuid} | [string] | Thegloballyuniqueidentifierforasyncoperation/job |
| 32 | {payload-file} | [string] | FilepathtoavalidJSONdocument |
| 33 | {privateEndpointConnectionName} | [string] | Thenameoftheprivateendpointconnection |
| 34 | {purviewName} | [string] | AzurePurviewaccountname |
| 35 | {qualifiedName} | [string] | Thequalifiednameoftheentity |
| 36 | {resourceGroupName} | [string] | Thenameoftheresourcegroup |
| 37 | {runId} | [string] | Theuniqueidentifieroftherun |
| 38 | {scanName} | [string] | Nameofthescan |
| 39 | {scanRulesetName} | [string] | Nameofthescanruleset |
| 40 | {scope} | [string] | ThescopeobjectID(egsubIDortenantID) |
| 41 | {scopeTenantId} | [string] | Thescopetenantinwhichthedefaultaccountisset |
| 42 | {scopeType} | [string] | Thescopewherethedefaultaccountisset(TenantorSubscription) |
| 43 | {sort} | [string] | ASCorDESC[default:ASC] |
| 44 | {subscriptionId} | [string] | ThesubscriptionID |
| 45 | {takeTopCount} | [integer] | Specifythemaximumnumberofrecordstoreturn[default:10] |
| 46 | {termGuid} | [string] | Thegloballyuniqueidentifierforglossaryterm |
| 47 | {type} | [string] | Typedefnameassearchfilter(classification|entity|enum|relationship|struct) |
| 48 | {typeDefKey} | [string] | TypedefKey |
| 49 | {typeDefVal} | [string] | TypedefVal |
| 50 | {typeName} | [string] | Thenameofthetype |
| 51 | {width} | [integer] | Thenumberofmaxexpandingwidthinlineage[default:6] |
| 52 | {policyId} | [string] | PolicyIDForAuthZfineGrainedMetadataPolicyAPIs |
| 53 | {collectionName} | [string] | CollectionNameForAuthZfineGrainedMetadataPolicyAPIs |
| 54 | {boolean} | [boolean] | bool[true:false] |