Get-EntraContract

Reference

Module:: Microsoft.Graph.Entra

Gets a contract.

Syntax

Get-EntraContract
   [-Top <Int32>]
   [-All]
   [-Filter <String>]
   [-Property <String[]>]
   [<CommonParameters>]

Get-EntraContract
   -ContractId <String>
   [-All]
   [-Property <String[]>]
   [<CommonParameters>]

Description

The Get-EntraContract cmdlet gets a contract information associated to a partner tenant.

In delegated scenarios with work or school accounts, the Directory Readers role is the only least privileged role that supports this operation for the signed-in user

Examples

Example 1: Get all contracts in the directory

Connect-Entra -Scopes 'Directory.Read.All'
Get-EntraContract

This command gets all contracts in the Microsoft Entra ID.

Example 2: Get top two contracts in the directory

Connect-Entra -Scopes 'Directory.Read.All'
Get-EntraContract -Top 2

This command gets top two contracts in the Microsoft Entra ID.

Parameters

-All

List all pages.

Type:	System.Management.Automation.SwitchParameter
Position:	Named
Default value:	False
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-ContractId

Specifies the ID of a contract.

Type:	System.String
Aliases:	ObjectId
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-Filter

Specifies an OData v4.0 filter statement. This parameter controls which objects are returned.

Type:	System.String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-Property

Specifies properties to be returned.

Type:	System.String[]
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Top

Specifies the maximum number of records to return.

Type:	System.Int32
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

Notes

The contract object contains the following attributes:

contractType - type of the contract.

Possible values are:

SyndicationPartner - indicates a partner that exclusively resells and manages O365 and Intune for this customer. They resell and support their customers. BreadthPartner - indicates that the partner has the ability to provide administrative support for this customer. However the partner isn't allowed to resell to the customer. ResellerPartner - indicates a partner that is similar to a syndication partner, except that it doesn't have exclusive access to a tenant. In the syndication case, the customer can't buy additional direct subscriptions from Microsoft or from other partners.

customerContextId - unique identifier for the customer tenant referenced by this partnership.

Corresponds to the ObjectId property of the customer tenant's TenantDetail object.

defaultDomainName - a copy of the customer tenant's default domain name. The copy is made when the partnership with the customer is established. It isn't automatically updated if the customer tenant's default domain name changes.

deletionTimestamp - this property isn't valid for contracts and always returns null.

displayName - a copy of the customer tenant's display name. The copy is made when the partnership with the customer is established. It isn't automatically updated if the customer tenant's display name changes.

objectType - a string that identifies the object type. The value is always Contract.

ContractId - the unique identifier for the partnership.

Share via