Skip to content

Commit f44177f

Browse files
authored
Merge pull request #565 from MicrosoftDocs/backward_compatibilty_docs
Generates docs for aliased cmdlets
2 parents 52a3977 + bf12c75 commit f44177f

File tree

50 files changed

+12040
-1
lines changed

Some content is hidden

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

50 files changed

+12040
-1
lines changed

azure-pipelines/powershell-docs.yml

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -129,6 +129,13 @@ extends:
129129
targetType: 'filePath'
130130
pwsh: true
131131
filePath: scripts/RemoveBoilerPlateCode.ps1
132+
- task: PowerShell@2
133+
displayName: 'Generate missing docs for aliased cmdlets'
134+
continueOnError: false
135+
inputs:
136+
targetType: 'filePath'
137+
pwsh: true
138+
filePath: scripts/GenerateAliasedDocs.ps1
132139
- task: PowerShell@2
133140
displayName: Pushing to github
134141
env:
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,238 @@
1+
---
2+
external help file: Microsoft.Graph.Applications-help.xml
3+
Module Name: Microsoft.Graph.Applications
4+
online version: https://learn.microsoft.com/powershell/module/microsoft.graph.applications/Remove-MgApplicationAppManagementPolicyByRef
5+
schema: 2.0.0
6+
---
7+
8+
# Remove-MgApplicationAppManagementPolicyByRef
9+
10+
## SYNOPSIS
11+
Delete ref of navigation property appManagementPolicies for applications
12+
13+
> [!NOTE]
14+
> To view the beta release of this cmdlet, view [Remove-MgBetaApplicationAppManagementPolicyAppManagementPolicyByRef](/powershell/module/Microsoft.Graph.Beta.Applications/Remove-MgBetaApplicationAppManagementPolicyAppManagementPolicyByRef?view=graph-powershell-beta)
15+
16+
## SYNTAX
17+
18+
### Delete (Default)
19+
```
20+
Remove-MgApplicationAppManagementPolicyByRef -AppManagementPolicyId <String>
21+
-ApplicationId <String> [-IfMatch <String>] [-ResponseHeadersVariable <String>] [-Headers <IDictionary>]
22+
[-PassThru] [-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm] [<CommonParameters>]
23+
```
24+
25+
### DeleteViaIdentity
26+
```
27+
Remove-MgApplicationAppManagementPolicyByRef -InputObject <IApplicationsIdentity>
28+
[-IfMatch <String>] [-ResponseHeadersVariable <String>] [-Headers <IDictionary>] [-PassThru]
29+
[-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm] [<CommonParameters>]
30+
```
31+
32+
## DESCRIPTION
33+
Delete ref of navigation property appManagementPolicies for applications
34+
35+
## PARAMETERS
36+
37+
### -ApplicationId
38+
The unique identifier of application
39+
40+
```yaml
41+
Type: String
42+
Parameter Sets: Delete
43+
Aliases:
44+
45+
Required: True
46+
Position: Named
47+
Default value: None
48+
Accept pipeline input: False
49+
Accept wildcard characters: False
50+
```
51+
52+
### -AppManagementPolicyId
53+
The unique identifier of appManagementPolicy
54+
55+
```yaml
56+
Type: String
57+
Parameter Sets: Delete
58+
Aliases:
59+
60+
Required: True
61+
Position: Named
62+
Default value: None
63+
Accept pipeline input: False
64+
Accept wildcard characters: False
65+
```
66+
67+
### -Headers
68+
Optional headers that will be added to the request.
69+
70+
```yaml
71+
Type: IDictionary
72+
Parameter Sets: (All)
73+
Aliases:
74+
75+
Required: False
76+
Position: Named
77+
Default value: None
78+
Accept pipeline input: True (ByValue)
79+
Accept wildcard characters: False
80+
```
81+
82+
### -IfMatch
83+
ETag
84+
85+
```yaml
86+
Type: String
87+
Parameter Sets: (All)
88+
Aliases:
89+
90+
Required: False
91+
Position: Named
92+
Default value: None
93+
Accept pipeline input: False
94+
Accept wildcard characters: False
95+
```
96+
97+
### -InputObject
98+
Identity Parameter
99+
To construct, see NOTES section for INPUTOBJECT properties and create a hash table.
100+
101+
```yaml
102+
Type: IApplicationsIdentity
103+
Parameter Sets: DeleteViaIdentity
104+
Aliases:
105+
106+
Required: True
107+
Position: Named
108+
Default value: None
109+
Accept pipeline input: True (ByValue)
110+
Accept wildcard characters: False
111+
```
112+
113+
### -PassThru
114+
Returns true when the command succeeds
115+
116+
```yaml
117+
Type: SwitchParameter
118+
Parameter Sets: (All)
119+
Aliases:
120+
121+
Required: False
122+
Position: Named
123+
Default value: False
124+
Accept pipeline input: False
125+
Accept wildcard characters: False
126+
```
127+
128+
### -ProgressAction
129+
{{ Fill ProgressAction Description }}
130+
131+
```yaml
132+
Type: ActionPreference
133+
Parameter Sets: (All)
134+
Aliases: proga
135+
136+
Required: False
137+
Position: Named
138+
Default value: None
139+
Accept pipeline input: False
140+
Accept wildcard characters: False
141+
```
142+
143+
### -ResponseHeadersVariable
144+
Optional Response Headers Variable.
145+
146+
```yaml
147+
Type: String
148+
Parameter Sets: (All)
149+
Aliases: RHV
150+
151+
Required: False
152+
Position: Named
153+
Default value: None
154+
Accept pipeline input: False
155+
Accept wildcard characters: False
156+
```
157+
158+
### -Confirm
159+
Prompts you for confirmation before running the cmdlet.
160+
161+
```yaml
162+
Type: SwitchParameter
163+
Parameter Sets: (All)
164+
Aliases: cf
165+
166+
Required: False
167+
Position: Named
168+
Default value: None
169+
Accept pipeline input: False
170+
Accept wildcard characters: False
171+
```
172+
173+
### -WhatIf
174+
Shows what would happen if the cmdlet runs.
175+
The cmdlet is not run.
176+
177+
```yaml
178+
Type: SwitchParameter
179+
Parameter Sets: (All)
180+
Aliases: wi
181+
182+
Required: False
183+
Position: Named
184+
Default value: None
185+
Accept pipeline input: False
186+
Accept wildcard characters: False
187+
```
188+
189+
### CommonParameters
190+
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).
191+
192+
## INPUTS
193+
194+
### Microsoft.Graph.PowerShell.Models.IApplicationsIdentity
195+
### System.Collections.IDictionary
196+
## OUTPUTS
197+
198+
### System.Boolean
199+
## NOTES
200+
COMPLEX PARAMETER PROPERTIES
201+
202+
To create the parameters described below, construct a hash table containing the appropriate properties.
203+
For information on hash tables, run Get-Help about_Hash_Tables.
204+
205+
INPUTOBJECT `<IApplicationsIdentity>`: Identity Parameter
206+
- `[AppId <String>]`: Alternate key of application
207+
- `[AppManagementPolicyId <String>]`: The unique identifier of appManagementPolicy
208+
- `[AppRoleAssignmentId <String>]`: The unique identifier of appRoleAssignment
209+
- `[ApplicationId <String>]`: The unique identifier of application
210+
- `[ApplicationTemplateId <String>]`: The unique identifier of applicationTemplate
211+
- `[ClaimsMappingPolicyId <String>]`: The unique identifier of claimsMappingPolicy
212+
- `[DelegatedPermissionClassificationId <String>]`: The unique identifier of delegatedPermissionClassification
213+
- `[DirectoryDefinitionId <String>]`: The unique identifier of directoryDefinition
214+
- `[DirectoryObjectId <String>]`: The unique identifier of directoryObject
215+
- `[EndpointId <String>]`: The unique identifier of endpoint
216+
- `[ExtensionPropertyId <String>]`: The unique identifier of extensionProperty
217+
- `[FederatedIdentityCredentialId <String>]`: The unique identifier of federatedIdentityCredential
218+
- `[GroupId <String>]`: The unique identifier of group
219+
- `[HomeRealmDiscoveryPolicyId <String>]`: The unique identifier of homeRealmDiscoveryPolicy
220+
- `[Name <String>]`: Alternate key of federatedIdentityCredential
221+
- `[OAuth2PermissionGrantId <String>]`: The unique identifier of oAuth2PermissionGrant
222+
- `[ServicePrincipalId <String>]`: The unique identifier of servicePrincipal
223+
- `[SynchronizationJobId <String>]`: The unique identifier of synchronizationJob
224+
- `[SynchronizationTemplateId <String>]`: The unique identifier of synchronizationTemplate
225+
- `[TargetDeviceGroupId <String>]`: The unique identifier of targetDeviceGroup
226+
- `[TokenIssuancePolicyId <String>]`: The unique identifier of tokenIssuancePolicy
227+
- `[TokenLifetimePolicyId <String>]`: The unique identifier of tokenLifetimePolicy
228+
- `[UniqueName <String>]`: Alternate key of application
229+
- `[UserId <String>]`: The unique identifier of user
230+
231+
## RELATED LINKS
232+
233+
[https://learn.microsoft.com/powershell/module/microsoft.graph.applications/Remove-MgApplicationAppManagementPolicyByRef](https://learn.microsoft.com/powershell/module/microsoft.graph.applications/Remove-MgApplicationAppManagementPolicyByRef)
234+
235+
236+
237+
238+

0 commit comments

Comments
 (0)