Skip to content

Latest commit

 

History

History
132 lines (104 loc) · 3.78 KB

Get-AzureADContract.md

File metadata and controls

132 lines (104 loc) · 3.78 KB
Raw
external help file Module Name online version schema
Microsoft.Open.AzureAD16.Graph.PowerShell.dll-Help.xml
AzureAD
2.0.0

Get-AzureADContract

SYNOPSIS

Gets a contract.

SYNTAX

GetQuery (Default)

Get-AzureADContract [-All <Boolean>] [-Top <Int32>] [-Filter <String>] [<CommonParameters>]

GetById

Get-AzureADContract -ObjectId <String> [-All <Boolean>] [<CommonParameters>]

DESCRIPTION

The Get-AzureADContract cmdlet gets a contract from Azure Active Directory. This cmdlet returns a contract object for each contract that is selected by the request. 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 is not 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 cannot buy additional direct subscriptions from Microsoft or from other partners.

  • customerContextId - The 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 is not automatically updated if the customer tenant's default domain name changes.
  • deletionTimestamp - This property is not 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 is not automatically updated if the customer tenant's display name changes.
  • objectType - A string that identifies the object type. The value is always "Contract".
  • objectId - The unique identifier for the partnership.

EXAMPLES

Example 1: Get all contracts in the directory

Get-AzureADContract

This command gets all contracts in the directory.

PARAMETERS

-All

If true, return all contracts. If false, return the number of objects specified by the Top parameter

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: False

-Filter

Specifies an oData v3.0 filter statement. This parameter controls which objects are returned.

Type: String
Parameter Sets: GetQuery
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: False

-ObjectId

Specifies the ID of a contract.

Type: String
Parameter Sets: GetById
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: False

-Top

Specifies the maximum number of records to return.

Type: Int32
Parameter Sets: GetQuery
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName, ByValue)
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

NOTES

RELATED LINKS