Get-OCIDatacatalogCustomPropertiesList
SYNOPSIS
Invokes DataCatalog service - ListCustomProperties operation.
SYNTAX
Limit
Get-OCIDatacatalogCustomPropertiesList -CatalogId <String> -NamespaceId <String> [-DisplayName <String>] [-DisplayNameContains <String>] [-DataTypes <System.Collections.Generic.List`1[Oci.DatacatalogService.Models.CustomPropertyDataType]>] [-TypeName <System.Collections.Generic.List`1[Oci.DatacatalogService.Requests.ListCustomPropertiesRequest+TypeNameEnum]>] [-LifecycleState <LifecycleState>] [-TimeCreated <DateTime>] [-TimeUpdated <DateTime>] [-CreatedById <String>] [-UpdatedById <String>] [-Fields <System.Collections.Generic.List`1[Oci.DatacatalogService.Requests.ListCustomPropertiesRequest+FieldsEnum]>] [-SortOrder <SortOrderEnum>] [-SortBy <SortByEnum>] [-Limit <Int32>] [-Page <String>] [-OpcRequestId <String>] [-ConfigFile <String>] [-Endpoint <String>] [-NoRetry] [-Profile <String>] [-Region <String>] [-FullResponse] [-TimeOutInMillis <Int32>] [-AuthType <AuthenticationType>] [<CommonParameters>]
AllPages
Get-OCIDatacatalogCustomPropertiesList -CatalogId <String> -NamespaceId <String> [-DisplayName <String>] [-DisplayNameContains <String>] [-DataTypes <System.Collections.Generic.List`1[Oci.DatacatalogService.Models.CustomPropertyDataType]>] [-TypeName <System.Collections.Generic.List`1[Oci.DatacatalogService.Requests.ListCustomPropertiesRequest+TypeNameEnum]>] [-LifecycleState <LifecycleState>] [-TimeCreated <DateTime>] [-TimeUpdated <DateTime>] [-CreatedById <String>] [-UpdatedById <String>] [-Fields <System.Collections.Generic.List`1[Oci.DatacatalogService.Requests.ListCustomPropertiesRequest+FieldsEnum]>] [-SortOrder <SortOrderEnum>] [-SortBy <SortByEnum>] [-Page <String>] [-OpcRequestId <String>] [-All] [-ConfigFile <String>] [-Endpoint <String>] [-NoRetry] [-Profile <String>] [-Region <String>] [-FullResponse] [-TimeOutInMillis <Int32>] [-AuthType <AuthenticationType>] [<CommonParameters>]
DESCRIPTION
Returns a list of custom properties within a data catalog.
PARAMETERS
-All
Fetches all pages of results.
Type: SwitchParameter
Parameter Sets: AllPages
Aliases: None
Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-AuthType
Type of authentication to use for making API requests. Default is Key based Authentication.
Type: AuthenticationType
Parameter Sets: (All)
Aliases: None
Accepted values: ApiKey, InstancePrincipal, SessionToken
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-CatalogId
Unique catalog identifier.
Type: String
Parameter Sets: (All)
Aliases: None
Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-ConfigFile
The path to the config file.
Type: String
Parameter Sets: (All)
Aliases: None
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-CreatedById
OCID of the user who created the resource.
Type: String
Parameter Sets: (All)
Aliases: None
Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-DataTypes
Return the custom properties which has specified data types
Type: System.Collections.Generic.List`1[Oci.DatacatalogService.Models.CustomPropertyDataType]
Parameter Sets: (All)
Aliases: None
Accepted values: UnknownEnumValue, Text, RichText, Boolean, Number, Date
Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-DisplayName
A filter to return only resources that match the entire display name given. The match is not case sensitive.
Type: String
Parameter Sets: (All)
Aliases: None
Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-DisplayNameContains
A filter to return only resources that match display name pattern given. The match is not case sensitive. For Example : /folders?displayNameContains=Cu.* The above would match all folders with display name that starts with "Cu" or has the pattern "Cu" anywhere in between.
Type: String
Parameter Sets: (All)
Aliases: None
Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-Endpoint
The value to use as the service endpoint, including any required API version path.
Type: String
Parameter Sets: (All)
Aliases: None
Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-Fields
Specifies the fields to return in a custom property summary response.
Type: System.Collections.Generic.List`1[Oci.DatacatalogService.Requests.ListCustomPropertiesRequest+FieldsEnum]
Parameter Sets: (All)
Aliases: None
Accepted values: Key, DisplayName, Description, DataType, NamespaceName, LifecycleState, TimeCreated
Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-FullResponse
Output the complete response returned by the API Operation. Using this switch will make this Cmdlet output an object containing response headers in-addition to an optional response body.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: None
Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-LifecycleState
A filter to return only resources that match the specified lifecycle state. The value is case insensitive.
Type: LifecycleState
Parameter Sets: (All)
Aliases: None
Accepted values: UnknownEnumValue, Creating, Active, Inactive, Updating, Deleting, Deleted, Failed, Moving
Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-Limit
The maximum number of items to return.
Type: Int32
Parameter Sets: Limit
Aliases: None
Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-NamespaceId
Unique namespace identifier.
Type: String
Parameter Sets: (All)
Aliases: None
Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-NoRetry
Disable retry logic for calls to services.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: None
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-OpcRequestId
The client request ID for tracing.
Type: String
Parameter Sets: (All)
Aliases: None
Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-Page
The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
Type: String
Parameter Sets: (All)
Aliases: None
Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-Profile
The profile in the config file to load.
Type: String
Parameter Sets: (All)
Aliases: None
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Region
Region-id of the region to make calls against. eg) us-phoenix-1, ap-singapore-1
Type: String
Parameter Sets: (All)
Aliases: None
Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-SortBy
The field to sort by. Only one sort order may be provided. Default order for USAGECOUNT and DISPLAYNAME is Ascending
Type: SortByEnum
Parameter Sets: (All)
Aliases: None
Accepted values: Displayname, Usagecount
Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-SortOrder
The sort order to use, either 'asc' or 'desc'.
Type: SortOrderEnum
Parameter Sets: (All)
Aliases: None
Accepted values: Asc, Desc
Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-TimeCreated
Time that the resource was created. An RFC3339 formatted datetime string.
Type: DateTime
Parameter Sets: (All)
Aliases: None
Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-TimeOutInMillis
Max wait time in milliseconds for the API request to complete. Default is 100000 millis(100 secs).
Type: Int32
Parameter Sets: (All)
Aliases: None
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-TimeUpdated
Time that the resource was updated. An RFC3339 formatted datetime string.
Type: DateTime
Parameter Sets: (All)
Aliases: None
Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-TypeName
A filter to return only resources that match the entire type name given. The match is not case sensitive
Type: System.Collections.Generic.List`1[Oci.DatacatalogService.Requests.ListCustomPropertiesRequest+TypeNameEnum]
Parameter Sets: (All)
Aliases: None
Accepted values: DataAsset, AutonomousDataWarehouse, Hive, Kafka, Mysql, OracleObjectStorage, AutonomousTransactionProcessing, Oracle, Postgresql, MicrosoftAzureSqlDatabase, MicrosoftSqlServer, IbmDb2, DataEntity, LogicalEntity, Table, View, Attribute, Folder, OracleAnalyticsSubjectAreaColumn, OracleAnalyticsLogicalColumn, OracleAnalyticsPhysicalColumn, OracleAnalyticsAnalysisColumn, OracleAnalyticsServer, OracleAnalyticsCloud, OracleAnalyticsSubjectArea, OracleAnalyticsDashboard, OracleAnalyticsBusinessModel, OracleAnalyticsPhysicalDatabase, OracleAnalyticsPhysicalSchema, OracleAnalyticsPresentationTable, OracleAnalyticsLogicalTable, OracleAnalyticsPhysicalTable, OracleAnalyticsAnalysis, DatabaseSchema, Topic, Connection, Glossary, Term, Category, File, Bucket, Message, UnrecognizedFile
Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-UpdatedById
OCID of the user who updated the resource.
Type: String
Parameter Sets: (All)
Aliases: None
Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
OUTPUTS
- Oci.DatacatalogService.Models.CustomPropertyCollection
- Oci.DatacatalogService.Responses.ListCustomPropertiesResponse