-
Notifications
You must be signed in to change notification settings - Fork 0
Get PpeOdataEntity
Get OData entity metadata from a Power Platform / Dataverse environment.
Get-PpeOdataEntity [-EnvironmentId] <String> [[-Name] <String>] [-AsExcelOutput]
[-ProgressAction <ActionPreference>] [<CommonParameters>]
Retrieves entity metadata from the Dataverse /api/data/v9.2/EntityDefinitions endpoint, returning schema information for each published OData entity.
Results include the entity logical name, collection name, schema name, and whether the entity is a custom entity or managed solution component.
Supports wildcard and exact matching against the LogicalName and EntitySetName fields.
Get-PpeOdataEntity -EnvironmentId "ContosoEnv"
This command retrieves metadata for all OData entities in the environment "ContosoEnv".
Get-PpeOdataEntity -EnvironmentId "ContosoEnv" -Name "account"
This command retrieves metadata for the OData entity named "account" from the environment "ContosoEnv".
Get-PpeOdataEntity -EnvironmentId "ContosoEnv" -Name "*customer*"
This command retrieves metadata for all OData entities whose LogicalName or EntitySetName contains "customer" from the environment "ContosoEnv".
Get-PpeOdataEntity -EnvironmentId "ContosoEnv" -Name "accounts"
This command retrieves metadata for the OData entity with the EntitySetName "accounts" from the environment "ContosoEnv".
The filter matches against both the entity LogicalName and the EntitySetName.
Get-PpeOdataEntity -EnvironmentId "ContosoEnv" -AsExcelOutput
This command retrieves metadata for all OData entities in the environment "ContosoEnv" and exports the results to an Excel file.
The ID of the environment to retrieve OData entity metadata from.
Can be either the environment name or the environment GUID (PPAC).
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseThe value to filter the results by.
Filters against the entity LogicalName and the EntitySetName (OData collection name) fields - any match on either will include the record.
Supports wildcard characters for flexible matching.
Default value is "*", which returns all OData entities.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 2
Default value: *
Accept pipeline input: False
Accept wildcard characters: FalseInstructs the cmdlet to export the retrieved entity metadata to an Excel file.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False{{ Fill ProgressAction Description }}
Type: ActionPreference
Parameter Sets: (All)
Aliases: proga
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseThis cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
Author: Mötz Jensen (@Splaxi)