Skip to content

Commit 7d1b416

Browse files
NowinskiKNowinskiK
committed
Documentation generated & helper folder with scripts
1 parent 600f6b4 commit 7d1b416

File tree

59 files changed

+6325
-6
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

59 files changed

+6325
-6
lines changed

‎ReleaseNotes.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@
44
- Import functions from powerrti project authored by [Frank Geisler](https://github.com/Frank-Geisler)
55
- Rename project to FabricTools with new guid
66
- Refactoring of few functions
7+
- Documentation generated & helper folder with scripts
78

89
## Version 0.7.0.4:
910
- Fix a bug where the Fabric API didn't have a result URI

‎documentation/Add-FabricWorkspaceRoleAssignment.md‎

Lines changed: 147 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,147 @@
1+
# Add-FabricWorkspaceRoleAssignment
2+
3+
## SYNOPSIS
4+
Adds a role assignment to a user in a workspace.
5+
6+
## SYNTAX
7+
8+
```
9+
Add-FabricWorkspaceRoleAssignment [-WorkspaceId] <String> [-principalId] <String> [-Role] <String>
10+
[-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm] [<CommonParameters>]
11+
```
12+
13+
## DESCRIPTION
14+
Adds a role assignment to a user in a workspace.
15+
The User is identified by the principalId and the role is
16+
identified by the Role parameter.
17+
The Workspace is identified by the WorkspaceId.
18+
19+
## EXAMPLES
20+
21+
### EXAMPLE 1
22+
```
23+
Add-RtiWorkspaceRoleAssignment `
24+
-WorkspaceId '12345678-1234-1234-1234-123456789012' `
25+
-PrincipalId '12345678-1234-1234-1234-123456789012' `
26+
-Role 'Admin'
27+
```
28+
29+
## PARAMETERS
30+
31+
### -principalId
32+
Id of the principal for which the role assignment should be added.
33+
The value for PrincipalId is a GUID.
34+
An example of a GUID is '12345678-1234-1234-1234-123456789012'.
35+
This parameter is mandatory.
36+
At the
37+
moment only principal type 'User' is supported.
38+
39+
```yaml
40+
Type: System.String
41+
Parameter Sets: (All)
42+
Aliases:
43+
44+
Required: True
45+
Position: 2
46+
Default value: None
47+
Accept pipeline input: False
48+
Accept wildcard characters: False
49+
```
50+
51+
### -ProgressAction
52+
{{ Fill ProgressAction Description }}
53+
54+
```yaml
55+
Type: System.Management.Automation.ActionPreference
56+
Parameter Sets: (All)
57+
Aliases: proga
58+
59+
Required: False
60+
Position: Named
61+
Default value: None
62+
Accept pipeline input: False
63+
Accept wildcard characters: False
64+
```
65+
66+
### -Role
67+
The role to assign to the principal.
68+
The value for Role is a string.
69+
An example of a string is 'Admin'.
70+
The values that can be used are 'Admin', 'Contributor', 'Member' and 'Viewer'.
71+
72+
```yaml
73+
Type: System.String
74+
Parameter Sets: (All)
75+
Aliases:
76+
77+
Required: True
78+
Position: 3
79+
Default value: None
80+
Accept pipeline input: False
81+
Accept wildcard characters: False
82+
```
83+
84+
### -WorkspaceId
85+
Id of the Fabric Workspace for which the role assignment should be added.
86+
The value for WorkspaceId is a GUID.
87+
An example of a GUID is '12345678-1234-1234-1234-123456789012'.
88+
This parameter is mandatory.
89+
90+
```yaml
91+
Type: System.String
92+
Parameter Sets: (All)
93+
Aliases: Id
94+
95+
Required: True
96+
Position: 1
97+
Default value: None
98+
Accept pipeline input: False
99+
Accept wildcard characters: False
100+
```
101+
102+
### -Confirm
103+
Prompts you for confirmation before running the cmdlet.
104+
105+
```yaml
106+
Type: System.Management.Automation.SwitchParameter
107+
Parameter Sets: (All)
108+
Aliases: cf
109+
110+
Required: False
111+
Position: Named
112+
Default value: None
113+
Accept pipeline input: False
114+
Accept wildcard characters: False
115+
```
116+
117+
### -WhatIf
118+
Shows what would happen if the cmdlet runs.
119+
The cmdlet is not run.
120+
121+
```yaml
122+
Type: System.Management.Automation.SwitchParameter
123+
Parameter Sets: (All)
124+
Aliases: wi
125+
126+
Required: False
127+
Position: Named
128+
Default value: None
129+
Accept pipeline input: False
130+
Accept wildcard characters: False
131+
```
132+
133+
### CommonParameters
134+
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
135+
136+
## INPUTS
137+
138+
## OUTPUTS
139+
140+
## NOTES
141+
TODO: Add functionallity to add role assignments to groups.
142+
TODO: Add functionallity to add a user by SPN.
143+
144+
## RELATED LINKS
145+
146+
[https://learn.microsoft.com/en-us/rest/api/fabric/core/workspaces/add-workspace-role-assignment?tabs=HTTP](https://learn.microsoft.com/en-us/rest/api/fabric/core/workspaces/add-workspace-role-assignment?tabs=HTTP)
147+

‎documentation/Connect-FabricAccount.md‎

Lines changed: 72 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,72 @@
1+
# Connect-FabricAccount
2+
3+
## SYNOPSIS
4+
Connects to the Fabric WebAPI.
5+
6+
## SYNTAX
7+
8+
```
9+
Connect-FabricAccount [-TenantId] <String> [-ProgressAction <ActionPreference>] [<CommonParameters>]
10+
```
11+
12+
## DESCRIPTION
13+
Connects to the Fabric WebAPI by using the cmdlet Connect-AzAccount.
14+
This function retrieves the authentication token for the Fabric API and sets up the headers for API calls.
15+
16+
## EXAMPLES
17+
18+
### EXAMPLE 1
19+
```
20+
Connect-RTIAccount `
21+
-TenantID '12345678-1234-1234-1234-123456789012'
22+
```
23+
24+
## PARAMETERS
25+
26+
### -ProgressAction
27+
{{ Fill ProgressAction Description }}
28+
29+
```yaml
30+
Type: System.Management.Automation.ActionPreference
31+
Parameter Sets: (All)
32+
Aliases: proga
33+
34+
Required: False
35+
Position: Named
36+
Default value: None
37+
Accept pipeline input: False
38+
Accept wildcard characters: False
39+
```
40+
41+
### -TenantId
42+
The TenantId of the Azure Active Directory tenant you want to connect to
43+
and in which your Fabric Capacity is.
44+
45+
```yaml
46+
Type: System.String
47+
Parameter Sets: (All)
48+
Aliases:
49+
50+
Required: True
51+
Position: 1
52+
Default value: None
53+
Accept pipeline input: False
54+
Accept wildcard characters: False
55+
```
56+
57+
### CommonParameters
58+
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
59+
60+
## INPUTS
61+
62+
## OUTPUTS
63+
64+
## NOTES
65+
Revsion History:
66+
67+
- 2024-12-22 - FGE: Added Verbose Output
68+
69+
## RELATED LINKS
70+
71+
[Connect-AzAccount https://learn.microsoft.com/de-de/powershell/module/az.accounts/connect-azaccount?view=azps-12.4.0]()
72+

‎documentation/Export-FabricItem.md‎

Lines changed: 128 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,128 @@
1+
# Export-FabricItem
2+
3+
## SYNOPSIS
4+
Exports items from a Fabric workspace.
5+
Either all items in a workspace or a specific item.
6+
7+
## SYNTAX
8+
9+
```
10+
Export-FabricItem [[-path] <String>] [[-workspaceId] <String>] [[-filter] <ScriptBlock>] [[-itemID] <String>]
11+
[-ProgressAction <ActionPreference>] [<CommonParameters>]
12+
```
13+
14+
## DESCRIPTION
15+
The Export-FabricItem function exports items from a Fabric workspace to a specified directory.
16+
It can export items of type "Report", "SemanticModel", "SparkJobDefinitionV1" or "Notebook".
17+
If a specific item ID is provided, only that item will be exported.
18+
Otherwise, all items in the workspace will be exported.
19+
20+
## EXAMPLES
21+
22+
### EXAMPLE 1
23+
```
24+
Export-FabricItem -workspaceId "12345678-1234-1234-1234-1234567890AB" -path "C:\ExportedItems"
25+
```
26+
27+
This example exports all items from the Fabric workspace with the specified ID to the "C:\ExportedItems" directory.
28+
29+
### EXAMPLE 2
30+
```
31+
Export-FabricItem -workspaceId "12345678-1234-1234-1234-1234567890AB" -itemID "98765432-4321-4321-4321-9876543210BA" -path "C:\ExportedItems"
32+
```
33+
34+
This example exports the item with the specified ID from the Fabric workspace with the specified ID to the "C:\ExportedItems" directory.
35+
36+
## PARAMETERS
37+
38+
### -filter
39+
A script block used to filter the items to be exported.
40+
Only items that match the filter will be exported.
41+
The default filter includes items of type "Report", "SemanticModel", "SparkJobDefinitionV1" or "Notebook".
42+
43+
```yaml
44+
Type: System.Management.Automation.ScriptBlock
45+
Parameter Sets: (All)
46+
Aliases:
47+
48+
Required: False
49+
Position: 3
50+
Default value: { $_.type -in @("Report", "SemanticModel", "Notebook","SparkJobDefinitionV1") }
51+
Accept pipeline input: False
52+
Accept wildcard characters: False
53+
```
54+
55+
### -itemID
56+
The ID of the specific item to export.
57+
If provided, only that item will be exported.
58+
59+
```yaml
60+
Type: System.String
61+
Parameter Sets: (All)
62+
Aliases:
63+
64+
Required: False
65+
Position: 4
66+
Default value: None
67+
Accept pipeline input: False
68+
Accept wildcard characters: False
69+
```
70+
71+
### -path
72+
The path to the directory where the items will be exported.
73+
The default value is '.\pbipOutput'.
74+
75+
```yaml
76+
Type: System.String
77+
Parameter Sets: (All)
78+
Aliases:
79+
80+
Required: False
81+
Position: 1
82+
Default value: .\pbipOutput
83+
Accept pipeline input: False
84+
Accept wildcard characters: False
85+
```
86+
87+
### -ProgressAction
88+
{{ Fill ProgressAction Description }}
89+
90+
```yaml
91+
Type: System.Management.Automation.ActionPreference
92+
Parameter Sets: (All)
93+
Aliases: proga
94+
95+
Required: False
96+
Position: Named
97+
Default value: None
98+
Accept pipeline input: False
99+
Accept wildcard characters: False
100+
```
101+
102+
### -workspaceId
103+
The ID of the Fabric workspace.
104+
105+
```yaml
106+
Type: System.String
107+
Parameter Sets: (All)
108+
Aliases:
109+
110+
Required: False
111+
Position: 2
112+
Default value: None
113+
Accept pipeline input: False
114+
Accept wildcard characters: False
115+
```
116+
117+
### CommonParameters
118+
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
119+
120+
## INPUTS
121+
122+
## OUTPUTS
123+
124+
## NOTES
125+
This function is based on the Export-FabricItems function written by Rui Romano.
126+
https://github.com/RuiRomano/fabricps-pbip
127+
128+
## RELATED LINKS

0 commit comments

Comments
 (0)