internal/v1.0-beta/Remove-MgSite.ps1
|
# ---------------------------------------------------------------------------------- # # Copyright Microsoft Corporation # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. # You may obtain a copy of the License at # http://www.apache.org/licenses/LICENSE-2.0 # Unless required by applicable law or agreed to in writing, software # distributed under the License is distributed on an "AS IS" BASIS, # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. # See the License for the specific language governing permissions and # limitations under the License. # ---------------------------------------------------------------------------------- <# .Synopsis Delete entity from sites .Description Delete entity from sites .Example PS C:\> {{ Add code here }} {{ Add output here }} .Example PS C:\> {{ Add code here }} {{ Add output here }} .Inputs Microsoft.Graph.PowerShell.Models.ISitesIdentity .Outputs System.Boolean .Notes COMPLEX PARAMETER PROPERTIES To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. INPUTOBJECT <ISitesIdentity>: Identity Parameter [ColumnDefinitionId <String>]: key: id of columnDefinition [ColumnLinkId <String>]: key: id of columnLink [ContentTypeId <String>]: key: id of contentType [DriveId <String>]: key: id of drive [EndDateTime <String>]: Usage: endDateTime={endDateTime} [GroupId <String>]: key: id of group [IncludePersonalNotebooks <Boolean?>]: Usage: includePersonalNotebooks={includePersonalNotebooks} [Interval <String>]: Usage: interval={interval} [ListId <String>]: key: id of list [ListId1 <String>]: Usage: listId={listId} [ListItemId <String>]: key: id of listItem [ListItemVersionId <String>]: key: id of listItemVersion [NotebookId <String>]: key: id of notebook [OnenotePageId <String>]: key: id of onenotePage [OnenoteSectionId <String>]: key: id of onenoteSection [Path <String>]: Usage: path={path} [PermissionId <String>]: key: id of permission [SiteId <String>]: key: id of site [SiteId1 <String>]: key: id of site [SitePageId <String>]: key: id of sitePage [StartDateTime <String>]: Usage: startDateTime={startDateTime} [SubscriptionId <String>]: key: id of subscription [UserId <String>]: key: id of user .Link https://docs.microsoft.com/en-us/powershell/module/microsoft.graph.sites/remove-mgsite #> function Remove-MgSite { [OutputType([System.Boolean])] [CmdletBinding(DefaultParameterSetName='Delete3', PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')] [Microsoft.Graph.PowerShell.Profile('v1.0-beta')] param( [Parameter(ParameterSetName='Delete3', Mandatory)] [Microsoft.Graph.PowerShell.Category('Path')] [System.String] # key: id of site ${SiteId}, [Parameter(ParameterSetName='DeleteViaIdentity3', Mandatory, ValueFromPipeline)] [Microsoft.Graph.PowerShell.Category('Path')] [Microsoft.Graph.PowerShell.Models.ISitesIdentity] # Identity Parameter # To construct, see NOTES section for INPUTOBJECT properties and create a hash table. ${InputObject}, [Parameter()] [Microsoft.Graph.PowerShell.Category('Header')] [System.String] # ETag ${IfMatch}, [Parameter(DontShow)] [Microsoft.Graph.PowerShell.Category('Runtime')] [System.Management.Automation.SwitchParameter] # Wait for .NET debugger to attach ${Break}, [Parameter(DontShow)] [ValidateNotNull()] [Microsoft.Graph.PowerShell.Category('Runtime')] [Microsoft.Graph.PowerShell.Runtime.SendAsyncStep[]] # SendAsync Pipeline Steps to be appended to the front of the pipeline ${HttpPipelineAppend}, [Parameter(DontShow)] [ValidateNotNull()] [Microsoft.Graph.PowerShell.Category('Runtime')] [Microsoft.Graph.PowerShell.Runtime.SendAsyncStep[]] # SendAsync Pipeline Steps to be prepended to the front of the pipeline ${HttpPipelinePrepend}, [Parameter()] [Microsoft.Graph.PowerShell.Category('Runtime')] [System.Management.Automation.SwitchParameter] # Returns true when the command succeeds ${PassThru}, [Parameter(DontShow)] [Microsoft.Graph.PowerShell.Category('Runtime')] [System.Uri] # The URI for the proxy server to use ${Proxy}, [Parameter(DontShow)] [ValidateNotNull()] [Microsoft.Graph.PowerShell.Category('Runtime')] [System.Management.Automation.PSCredential] # Credentials for a proxy server to use for the remote call ${ProxyCredential}, [Parameter(DontShow)] [Microsoft.Graph.PowerShell.Category('Runtime')] [System.Management.Automation.SwitchParameter] # Use the default credentials for the proxy ${ProxyUseDefaultCredentials} ) begin { try { $outBuffer = $null if ($PSBoundParameters.TryGetValue('OutBuffer', [ref]$outBuffer)) { $PSBoundParameters['OutBuffer'] = 1 } $parameterSet = $PSCmdlet.ParameterSetName $mapping = @{ Delete3 = 'Microsoft.Graph.Sites.private\Remove-MgSite_Delete3'; DeleteViaIdentity3 = 'Microsoft.Graph.Sites.private\Remove-MgSite_DeleteViaIdentity3'; } $wrappedCmd = $ExecutionContext.InvokeCommand.GetCommand(($mapping[$parameterSet]), [System.Management.Automation.CommandTypes]::Cmdlet) $scriptCmd = {& $wrappedCmd @PSBoundParameters} $steppablePipeline = $scriptCmd.GetSteppablePipeline($MyInvocation.CommandOrigin) $steppablePipeline.Begin($PSCmdlet) } catch { throw } } process { try { $steppablePipeline.Process($_) } catch { throw } } end { try { $steppablePipeline.End() } catch { throw } } } |