Find-MgTenantRelationshipTenantInformationByTenantId
Given a tenant ID, search for a tenant and read its tenantInformation. You can use this API to validate tenant information and use the tenantId to configure cross-tenant cross-tenant access settings between you and the tenant.
Note
To view the beta release of this cmdlet, view Find-MgBetaTenantRelationshipTenantInformationByTenantId
Syntax
Find (Default)
Find-MgTenantRelationshipTenantInformationByTenantId
-TenantId <String>
[-ResponseHeadersVariable <String>]
[-Headers <IDictionary>]
[<CommonParameters>]
FindViaIdentity
Find-MgTenantRelationshipTenantInformationByTenantId
-InputObject <IIdentityDirectoryManagementIdentity>
[-ResponseHeadersVariable <String>]
[-Headers <IDictionary>]
[<CommonParameters>]
Description
Given a tenant ID, search for a tenant and read its tenantInformation. You can use this API to validate tenant information and use the tenantId to configure cross-tenant cross-tenant access settings between you and the tenant.
Examples
Example 1: Code snippet
Import-Module Microsoft.Graph.Identity.DirectoryManagement
Find-MgTenantRelationshipTenantInformationByTenantId
This example shows how to use the Find-MgTenantRelationshipTenantInformationByTenantId Cmdlet.
Parameters
-Headers
Optional headers that will be added to the request.
Parameter properties
Type: | IDictionary |
Default value: | None |
Supports wildcards: | False |
DontShow: | False |
Parameter sets
(All)
Position: | Named |
Mandatory: | False |
Value from pipeline: | True |
Value from pipeline by property name: | False |
Value from remaining arguments: | False |
-InputObject
Identity Parameter To construct, see NOTES section for INPUTOBJECT properties and create a hash table.
Parameter properties
Type: | IIdentityDirectoryManagementIdentity |
Default value: | None |
Supports wildcards: | False |
DontShow: | False |
Parameter sets
FindViaIdentity
Position: | Named |
Mandatory: | True |
Value from pipeline: | True |
Value from pipeline by property name: | False |
Value from remaining arguments: | False |
-ResponseHeadersVariable
Optional Response Headers Variable.
Parameter properties
Type: | String |
Default value: | None |
Supports wildcards: | False |
DontShow: | False |
Aliases: | RHV |
Parameter sets
(All)
Position: | Named |
Mandatory: | False |
Value from pipeline: | False |
Value from pipeline by property name: | False |
Value from remaining arguments: | False |
-TenantId
Usage: tenantId='{tenantId}'
Parameter properties
Type: | String |
Default value: | None |
Supports wildcards: | False |
DontShow: | False |
Parameter sets
Find
Position: | Named |
Mandatory: | True |
Value from pipeline: | False |
Value from pipeline by property name: | False |
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.
Inputs
Microsoft.Graph.PowerShell.Models.IIdentityDirectoryManagementIdentity
System.Collections.IDictionary
Outputs
Microsoft.Graph.PowerShell.Models.IMicrosoftGraphTenantInformation
Notes
COMPLEX PARAMETER PROPERTIES
To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables.
INPUTOBJECT <IIdentityDirectoryManagementIdentity>
: Identity Parameter
[AdministrativeUnitId <String>]
: The unique identifier of administrativeUnit[AllowedValueId <String>]
: The unique identifier of allowedValue[AttributeSetId <String>]
: The unique identifier of attributeSet[CommerceSubscriptionId <String>]
: Alternate key of companySubscription[CompanySubscriptionId <String>]
: The unique identifier of companySubscription[ContractId <String>]
: The unique identifier of contract[CustomSecurityAttributeDefinitionId <String>]
: The unique identifier of customSecurityAttributeDefinition[DeviceId <String>]
: The unique identifier of device[DeviceLocalCredentialInfoId <String>]
: The unique identifier of deviceLocalCredentialInfo[DirectoryObjectId <String>]
: The unique identifier of directoryObject[DirectoryRoleId <String>]
: The unique identifier of directoryRole[DirectoryRoleTemplateId <String>]
: The unique identifier of directoryRoleTemplate[DomainDnsRecordId <String>]
: The unique identifier of domainDnsRecord[DomainId <String>]
: The unique identifier of ___domain[DomainName <String>]
: Usage: domainName='{domainName}'[ExtensionId <String>]
: The unique identifier of extension[IdentityProviderBaseId <String>]
: The unique identifier of identityProviderBase[InternalDomainFederationId <String>]
: The unique identifier of internalDomainFederation[OnPremisesDirectorySynchronizationId <String>]
: The unique identifier of onPremisesDirectorySynchronization[OrgContactId <String>]
: The unique identifier of orgContact[OrganizationId <String>]
: The unique identifier of organization[OrganizationalBrandingLocalizationId <String>]
: The unique identifier of organizationalBrandingLocalization[ProfileCardPropertyId <String>]
: The unique identifier of profileCardProperty[RoleTemplateId <String>]
: Alternate key of directoryRole[ScopedRoleMembershipId <String>]
: The unique identifier of scopedRoleMembership[SubscribedSkuId <String>]
: The unique identifier of subscribedSku[TenantId <String>]
: Usage: tenantId='{tenantId}'[UserId <String>]
: The unique identifier of user