Get-GitHubEnterprise¶

SYNOPSIS¶

Retrieves details about a GitHub Enterprise instance by name (slug).

SYNTAX¶

Get-GitHubEnterprise [-Name] <String> [[-Context] <Object>] [-ProgressAction <ActionPreference>]
 [<CommonParameters>]

DESCRIPTION¶

This function retrieves detailed information about a GitHub Enterprise instance, including its avatar, billing details, storage usage, creation date, and other metadata based on the provided name (slug). It returns an object of type GitHubEnterprise populated with this information.

EXAMPLES¶

EXAMPLE 1¶

Get-GitHubEnterprise -Name 'my-enterprise'

Output:

Name              : My Enterprise
Slug              : my-enterprise
URL               : https://github.com/enterprises/my-enterprise
CreatedAt         : 2022-01-01T00:00:00Z
ViewerIsAdmin     : True

Retrieves details about the GitHub Enterprise instance named 'my-enterprise'.

PARAMETERS¶

-Name¶

The name (slug) of the GitHub Enterprise instance to retrieve.

Type: String
Parameter Sets: (All)
Aliases: Slug

Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-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: Object
Parameter Sets: (All)
Aliases:

Required: False
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ProgressAction¶

Type: ActionPreference
Parameter Sets: (All)
Aliases: proga

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters¶

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

INPUTS¶

OUTPUTS¶

GitHubEnterprise¶

NOTES¶

An object containing detailed information about the GitHub Enterprise instance, including billing info, URLs, and metadata.

https://psmodule.io/GitHub/Functions/Enterprise/Get-GitHubEnterprise/