Get-EntraContract
Gets a contract.
Syntax
Get-EntraContract
[-Top <Int32>]
[-All]
[-Filter <String>]
[-Property <String[]>]
[<CommonParameters>]
Get-EntraContract
-ObjectId <String>
[-All]
[-Property <String[]>]
[<CommonParameters>]
Description
The Get-EntraContract
cmdlet gets a contract information associated to a partner tenant.
The contract object contains the following attributes:
contractType
- type of the contract.
Possible values are:
++ "SyndicationPartner", which indicates a partner that exclusively resells and manages O365 and Intune for this customer. They resell and support their customers. ++ "BreadthPartner", which 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", which 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 alwaysContract
.ObjectId
- the unique identifier for the partnership.
Examples
Example 1: Get all contracts
Connect-Entra -Scopes 'Directory.Read.All'
Get-EntraContract
This command gets all 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 |
-Filter
Specifies an oData v3.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 |
-ObjectId
Specifies the ID of a contract.
Type: | System.String |
Position: | Named |
Default value: | None |
Required: | True |
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 |
Feedback
https://aka.ms/ContentUserFeedback.
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see:Submit and view feedback for