Remove-GitHubOrganization

SYNOPSIS

Delete an organization

SYNTAX

Remove an organization (Default)

Remove-GitHubOrganization -Name <string> [-Context <Object>] [-WhatIf] [-Confirm]
 [<CommonParameters>]

ArrayInput

Remove-GitHubOrganization -Name <string> -InputObject <GitHubOrganization[]> [-Context <Object>]
 [-WhatIf] [-Confirm] [<CommonParameters>]

ALIASES

This cmdlet has the following aliases, {{Insert list of aliases}}

DESCRIPTION

Deletes an organization and all its repositories. The organization login will be unavailable for 90 days after deletion. Please review the GitHub Terms of Service regarding account deletion before using this endpoint.

EXAMPLES

EXAMPLE 1

Remove-GitHubOrganization -Name 'GitHub'

Deletes the organization 'GitHub' and all its repositories.

PARAMETERS

-Confirm

Prompts you for confirmation before running the cmdlet.

Type: System.Management.Automation.SwitchParameter
DefaultValue: ''
SupportsWildcards: false
Aliases:
- cf
ParameterSets:
- Name: (All)
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-Context

The context to run the command in. Used to get the details for the API call. Can be either a string or a GitHubContext object.

Type: System.Object
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-InputObject

The input object to process. Can be a single or an array of GitHubOrganization objects.

Type: GitHubOrganization[]
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: ArrayInput
  Position: Named
  IsRequired: true
  ValueFromPipeline: true
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-Name

The organization name. The name is not case sensitive.

Type: System.String
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
  Position: Named
  IsRequired: true
  ValueFromPipeline: true
  ValueFromPipelineByPropertyName: true
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-WhatIf

Runs the command in a mode that only reports what would happen without performing the actions.

Type: System.Management.Automation.SwitchParameter
DefaultValue: ''
SupportsWildcards: false
Aliases:
- wi
ParameterSets:
- Name: (All)
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

GitHubOrganization

{{ Fill in the Description }}

System.String

{{ Fill in the Description }}

GitHubOrganization[]

{{ Fill in the Description }}

OUTPUTS

System.Void

{{ Fill in the Description }}

NOTES

Delete an organization

RELATED LINKS