diff --git a/module/EntraBeta/AdditionalFunctions/Get-EntraBetaPartnerInformation.ps1 b/module/EntraBeta/AdditionalFunctions/Get-EntraBetaPartnerInformation.ps1 index 34e4d9c40..f43623d5a 100644 --- a/module/EntraBeta/AdditionalFunctions/Get-EntraBetaPartnerInformation.ps1 +++ b/module/EntraBeta/AdditionalFunctions/Get-EntraBetaPartnerInformation.ps1 @@ -3,32 +3,6 @@ # ------------------------------------------------------------------------------ function Get-EntraBetaPartnerInformation { - <# - .SYNOPSIS - Retrieves company-level information for partners. - - .DESCRIPTION - The Get-EntraBetaPartnerInformation cmdlet is used to retrieve partner-specific information. This cmdlet should only be used for partner tenants. - - .PARAMETER TenantId - The unique ID of the tenant to perform the operation on. If this is not provided, then the value will default to the tenant of the current user. This parameter is only applicable to partner users. - - .PARAMETER - This cmdlet supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable, OutBuffer, PipelineVariable, and OutVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). - - - .OUTPUTS - The cmdlet will return the following company level information: - - CompanyType: The type of this company (can be partner or regular tenant) - - DapEnabled: Flag to determine if the partner has delegated admin privileges. - - PartnerCompanyName: The name of the company - - PartnerSupportTelephones: Support Telephone numbers for the partner. - - PartnerSupportEmails: Support E-Mail address for the partner. - - PartnerCommerceUrl: URL for the partner's commerce web site. - - PartnerSupportUrl: URL for the Partner's support website. - - PartnerHelpUrl: URL for the partner's help web site. - - #> [CmdletBinding(DefaultParameterSetName = 'GetQuery')] param ( [Parameter(ParameterSetName = "GetById", ValueFromPipelineByPropertyName = $true)][System.Guid] $TenantId diff --git a/module/docs/entra-powershell-beta/Microsoft.Graph.Entra.Beta/Get-EntraBetaPartnerInformation.md b/module/docs/entra-powershell-beta/Microsoft.Graph.Entra.Beta/Get-EntraBetaPartnerInformation.md index e21c58522..fadf8ae26 100644 --- a/module/docs/entra-powershell-beta/Microsoft.Graph.Entra.Beta/Get-EntraBetaPartnerInformation.md +++ b/module/docs/entra-powershell-beta/Microsoft.Graph.Entra.Beta/Get-EntraBetaPartnerInformation.md @@ -1,4 +1,14 @@ --- +title: Get-EntraBetaPartnerInformation +description: This article provides details on the Get-EntraBetaPartnerInformation command. + +ms.topic: reference +ms.date: 09/25/2024 +ms.author: eunicewaweru +ms.reviewer: stevemutungi +manager: CelesteDG +author: msewaweru + external help file: Microsoft.Graph.Entra.Beta-help.xml Module Name: Microsoft.Graph.Entra.Beta online version: https://learn.microsoft.com/powershell/module/Microsoft.Graph.Entra.Beta/Get-EntraBetaPartnerInformation @@ -9,42 +19,86 @@ schema: 2.0.0 # Get-EntraBetaPartnerInformation ## Synopsis + Retrieves company-level information for partners. ## Syntax ### GetQuery (Default) -``` -Get-EntraBetaPartnerInformation [] + +```powershell +Get-EntraBetaPartnerInformation + [] ``` ### GetById -``` -Get-EntraBetaPartnerInformation [-TenantId ] [] + +```powershell +Get-EntraBetaPartnerInformation + [-TenantId ] + [] ``` ## Description -The Get-EntraBetaPartnerInformation cmdlet is used to retrieve partner-specific information. + +The `Get-EntraBetaPartnerInformation` cmdlet is used to retrieve partner-specific information. This cmdlet should only be used for partner tenants. ## Examples -### Example 1 +### Example 1: Retrieve partner information + +```powershell +Connect-Entra -Scopes 'Organization.Read.All' +Get-EntraBetaPartnerInformation +``` + +```Output +PartnerCompanyName : Contoso +companyType : +PartnerSupportTelephones : {12123, +1911} +PartnerSupportEmails : {} +PartnerHelpUrl : http://www.help.contoso.com +PartnerCommerceUrl : +ObjectID : bbbbbbbb-1111-2222-3333-cccccccccccc +PartnerSupportUrl : +``` + +This command retrieves partner-specific information. + +### Example 2: Retrieve partner information with specific TenantId + ```powershell -PS C:\> {{ Add example code here }} +Connect-Entra -Scopes 'Organization.Read.All' +$tenantId = (Get-EntraContext).TenantId +Get-EntraBetaPartnerInformation -TenantId $tenantId +``` + +```Output +PartnerCompanyName : Contoso +companyType : +PartnerSupportTelephones : {12123, +1911} +PartnerSupportEmails : {} +PartnerHelpUrl : http://www.help.contoso.com +PartnerCommerceUrl : +ObjectID : bbbbbbbb-1111-2222-3333-cccccccccccc +PartnerSupportUrl : ``` -{{ Add example description here }} +This command retrieves partner-specific information. + +`-TenantId` Parameter specifies unique ID of the tenant to perform the operation on. ## Parameters ### -TenantId + The unique ID of the tenant to perform the operation on. If this is not provided, then the value will default to the tenant of the current user. This parameter is only applicable to partner users. ```yaml -Type: Guid +Type: System.String Parameter Sets: GetById Aliases: @@ -56,21 +110,26 @@ 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](https://go.microsoft.com/fwlink/?LinkID=113216). + +This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVariable`, `-InformationAction`, `-InformationVariable`, `-OutVariable`, `-OutBuffer`, `-PipelineVariable`, `-Verbose`, `-WarningAction`, and `-WarningVariable`. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). ## Inputs ## Outputs -### The cmdlet will return the following company level information: -### - CompanyType: The type of this company (can be partner or regular tenant) -### - DapEnabled: Flag to determine if the partner has delegated admin privileges. -### - PartnerCompanyName: The name of the company -### - PartnerSupportTelephones: Support Telephone numbers for the partner. -### - PartnerSupportEmails: Support E-Mail address for the partner. -### - PartnerCommerceUrl: URL for the partner's commerce web site. -### - PartnerSupportUrl: URL for the Partner's support website. -### - PartnerHelpUrl: URL for the partner's help web site. +### Company level information outputs + +- CompanyType: The type of this company (can be partner or regular tenant) +- DapEnabled: Flag to determine if the partner has delegated admin privileges +- PartnerCompanyName: The name of the company +- PartnerSupportTelephones: Support Telephone numbers for the partner +- PartnerSupportEmails: Support E-Mail address for the partner +- PartnerCommerceUrl: URL for the partner's commerce web site +- PartnerSupportUrl: URL for the Partner's support website +- PartnerHelpUrl: URL for the partner's help web site + ## Notes ## Related Links + +[Set-EntraBetaPartnerInformation](Set-EntraBetaPartnerInformation.md) diff --git a/module/docs/entra-powershell-v1.0/Microsoft.Graph.Entra/Get-EntraPartnerInformation.md b/module/docs/entra-powershell-v1.0/Microsoft.Graph.Entra/Get-EntraPartnerInformation.md index af3c40254..c2338d2a4 100644 --- a/module/docs/entra-powershell-v1.0/Microsoft.Graph.Entra/Get-EntraPartnerInformation.md +++ b/module/docs/entra-powershell-v1.0/Microsoft.Graph.Entra/Get-EntraPartnerInformation.md @@ -2,9 +2,8 @@ title: Get-EntraPartnerInformation description: This article provides details on the Get-EntraPartnerInformation command. - ms.topic: reference -ms.date: 06/26/2024 +ms.date: 09/25/2024 ms.author: eunicewaweru ms.reviewer: stevemutungi manager: CelesteDG @@ -20,56 +19,86 @@ schema: 2.0.0 # Get-EntraPartnerInformation ## Synopsis + Retrieves company-level information for partners. ## Syntax ### GetQuery (Default) + ```powershell -Get-EntraPartnerInformation +Get-EntraPartnerInformation [] ``` ### GetById + ```powershell -Get-EntraPartnerInformation - [-TenantId ] +Get-EntraPartnerInformation + [-TenantId ] [] ``` ## Description -The Get-EntraBetaPartnerInformation cmdlet is used to retrieve partner-specific information. + +The `Get-EntraPartnerInformation` cmdlet is used to retrieve partner-specific information. This cmdlet should only be used for partner tenants. ## Examples ### Example 1: Retrieve partner information + ```powershell -PS C:\> Get-EntraPartnerInformation +Connect-Entra -Scopes 'Organization.Read.All' +Get-EntraPartnerInformation ``` -```output +```Output PartnerCompanyName : Contoso companyType : PartnerSupportTelephones : {12123, +1911} PartnerSupportEmails : {} PartnerHelpUrl : http://www.help.contoso.com PartnerCommerceUrl : -ObjectID : d5aec55f-2d12-4442-8d2f-ccca95d4390e +ObjectID : bbbbbbbb-1111-2222-3333-cccccccccccc PartnerSupportUrl : ``` This command retrieves partner-specific information. +### Example 2: Retrieve partner information with specific TenantId + +```powershell +Connect-Entra -Scopes 'Organization.Read.All' +$tenantId = (Get-EntraContext).TenantId +Get-EntraPartnerInformation -TenantId $tenantId +``` + +```Output +PartnerCompanyName : Contoso +companyType : +PartnerSupportTelephones : {12123, +1911} +PartnerSupportEmails : {} +PartnerHelpUrl : http://www.help.contoso.com +PartnerCommerceUrl : +ObjectID : bbbbbbbb-1111-2222-3333-cccccccccccc +PartnerSupportUrl : +``` + +This command retrieves partner-specific information. + +`-TenantId` Parameter specifies unique ID of the tenant to perform the operation on. + ## Parameters ### -TenantId + The unique ID of the tenant to perform the operation on. -If this isn't provided, then the value defaults to the tenant of the current user. +If this is not provided, then the value will default to the tenant of the current user. This parameter is only applicable to partner users. ```yaml -Type: Guid +Type: System.String Parameter Sets: GetById Aliases: @@ -81,20 +110,26 @@ 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](https://go.microsoft.com/fwlink/?LinkID=113216). + +This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVariable`, `-InformationAction`, `-InformationVariable`, `-OutVariable`, `-OutBuffer`, `-PipelineVariable`, `-Verbose`, `-WarningAction`, and `-WarningVariable`. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). ## Inputs ## Outputs -### The cmdlet returns the following company level information: -### - CompanyType: The type of this company (can be partner or regular tenant) -### - PartnerCompanyName: The name of the company -### - PartnerSupportTelephones: Support Telephone numbers for the partner. -### - PartnerSupportEmails: Support E-Mail address for the partner. -### - PartnerCommerceUrl: URL for the partner's commerce web site. -### - PartnerSupportUrl: URL for the Partner's support website. -### - PartnerHelpUrl: URL for the partner's help web site. +### Company level information outputs + +- CompanyType: The type of this company (can be partner or regular tenant) +- DapEnabled: Flag to determine if the partner has delegated admin privileges +- PartnerCompanyName: The name of the company +- PartnerSupportTelephones: Support Telephone numbers for the partner +- PartnerSupportEmails: Support E-Mail address for the partner +- PartnerCommerceUrl: URL for the partner's commerce web site +- PartnerSupportUrl: URL for the Partner's support website +- PartnerHelpUrl: URL for the partner's help web site + ## Notes ## Related Links + +[Set-EntraPartnerInformation](Set-EntraPartnerInformation.md)