Get-EntraContract
Gets a contract.
Syntax
GetQuery (Default)
Get-EntraContract
[-Top <Int32>]
[-All]
[-Filter <String>]
[-Property <String[]>]
[<CommonParameters>]
GetById
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. You can use -Limit as an alias for -Top.
Parameters
-All
List all pages.
Parameter properties
| Type: | System.Management.Automation.SwitchParameter |
| Default value: | False |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-ContractId
Specifies the ID of a contract.
Parameter properties
| Type: | System.String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | ObjectId |
Parameter sets
GetById
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | True |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | False |
-Filter
Specifies an OData v4.0 filter statement. This parameter controls which objects are returned.
Parameter properties
| Type: | System.String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
GetQuery
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | True |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | False |
-Property
Specifies properties to be returned.
Parameter properties
| Type: | System.String[] |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | Select |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Top
Specifies the maximum number of records to return.
Parameter properties
| Type: | System.Int32 |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | Limit |
Parameter sets
GetQuery
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | True |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | False |
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.
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.