Connect-AipService

  • Referens
Modul:
AIPService

Ansluter till Azure Information Protection.

Syntax

Connect-AipService
       [-Credential <PSCredential>]
       [-TenantId <Guid>]
       [<CommonParameters>]
Connect-AipService
       [-AccessToken <String>]
       [-TenantId <Guid>]
       [<CommonParameters>]
Connect-AipService
       [-EnvironmentName <AzureRmEnvironment>]
       [<CommonParameters>]

Description

Cmdleten Connect-AipService ansluter dig till Azure Information Protection så att du sedan kan köra administrativa kommandon för skyddstjänsten för din klientorganisation. Den här cmdleten kan också användas av ett partnerföretag som hanterar din klientorganisation.

Du måste köra den här cmdleten innan du kan köra de andra cmdletarna i den här modulen.

Om du vill ansluta till Azure Information Protection använder du ett konto som är något av följande:

  • En global administratör för din Office 365 klientorganisation.
  • En global administratör för din Azure AD klientorganisation. Det här kontot kan dock inte vara ett Microsoft-konto (MSA) eller från en annan Azure-klientorganisation.
  • Ett användarkonto från din klientorganisation som har beviljats administratörsbehörighet till Azure Information Protection med hjälp av cmdleten Add-AipServiceRoleBasedAdministrator.
  • En Azure AD administratörsroll för Azure Information Protection-administratör, efterlevnadsadministratör eller administratör för efterlevnadsdata.

Tips

Om du inte uppmanas att ange dina autentiseringsuppgifter och ett felmeddelande visas, till exempel Om du inte kan använda den här funktionen utan autentiseringsuppgifter, kontrollerar du att Internet Explorer har konfigurerats för att använda integrerad Windows-autentisering.

Om den här inställningen inte är aktiverad aktiverar du den, startar om Internet Explorer och försöker sedan autentisering igen till Information Protection-tjänsten.

Exempel

Exempel 1: Anslut till Azure Information Protection och uppmanas att ange ditt användarnamn och andra autentiseringsuppgifter

PS C:\> Connect-AipService

Det här kommandot ansluter till skyddstjänsten från Azure Information Protection. Det här är det enklaste sättet att ansluta till tjänsten genom att köra cmdleten utan parametrar.

Du uppmanas att ange ditt användarnamn och lösenord. Om ditt konto har konfigurerats för att använda multifaktorautentisering uppmanas du att ange din alternativa autentiseringsmetod och sedan ansluta till tjänsten.

Om ditt konto är konfigurerat för att använda multifaktorautentisering måste du använda den här metoden för att ansluta till Azure Information Protection.

Exempel 2: Ansluta till Azure Information Protection med lagrade autentiseringsuppgifter

PS C:\>$AdminCredentials = Get-Credential "Admin@aadrm.contoso.com"
PS C:\> Connect-AipService -Credential $AdminCredentials

Det första kommandot skapar ett PSCredential-objekt och lagrar ditt angivna användarnamn och lösenord i variabeln $AdminCredentials . När du kör det här kommandot uppmanas du att ange lösenordet för det användarnamn som du har angett.

Det andra kommandot ansluter till Azure Information Protection med hjälp av autentiseringsuppgifterna som lagras i $AdminCredentials. Om du kopplar från tjänsten och återansluter medan variabeln fortfarande används kör du bara det andra kommandot igen.

Exempel 3: Ansluta till Azure Information Protection med en token

PS C:\ > Add-Type -Path "C:\Program Files\WindowsPowerShell\Modules\AIPService\1.0.0.1\Microsoft.IdentityModel.Clients.ActiveDirectory.dll"
PS C:\ > $clientId='90f610bf-206d-4950-b61d-37fa6fd1b224';
PS C:\ > $resourceId = 'https://api.aadrm.com/';
PS C:\ > $userName='admin@contoso.com';
PS C:\ > $password='Passw0rd!';
PS C:\ > $authority = "https://login.microsoftonline.com/common";
PS C:\ > $authContext = New-Object Microsoft.IdentityModel.Clients.ActiveDirectory.AuthenticationContext($authority);
PS C:\ > $userCreds = New-Object Microsoft.IdentityModel.Clients.ActiveDirectory.UserPasswordCredential($userName, $password);
PS C:\ > $authResult = [Microsoft.IdentityModel.Clients.ActiveDirectory.AuthenticationContextIntegratedAuthExtensions]::AcquireTokenAsync($authContext, $resourceId, $clientId, $userCreds).Result;
PS C:\ > Import-Module AIPService
PS C:\> Connect-AipService -AccessToken $authResult.AccessToken

Det här exemplet visar hur du kan ansluta till Azure Information Protection med hjälp av parametern AccessToken, som gör att du kan autentisera utan att fråga. Den här anslutningsmetoden kräver att du anger klient-ID 90f610bf-206d-4950-b61d-37fa6fd1b224 och resurs-ID *https://api.aadrm.com/*. När anslutningen är öppen kan du sedan köra de administrativa kommandon från den här modulen som du behöver.

När du har bekräftat att dessa kommandon resulterar i att ansluta till Azure Information Protection kan du köra dem icke-interaktivt, till exempel från ett skript.

Observera att för illustrationsändamål använder det här exemplet användarnamnet admin@contoso.com för med lösenordet för Passw0rd! I en produktionsmiljö när du använder den här anslutningsmetoden icke-interaktivt använder du ytterligare metoder för att skydda lösenordet så att det inte lagras i klartext. Använd till exempel kommandot ConvertTo-SecureString eller använd Key Vault för att lagra lösenordet som en hemlighet.

Exempel 4: Ansluta till Azure Information Protection med klientcertifikat via autentisering med tjänstens huvudnamn

PS C:\ > $Thumbprint = 'XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX'
PS C:\ > $TenantId = 'yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyy'
PS C:\ > $ApplicationId = '00000000-0000-0000-0000-00000000'
PS C:\> Connect-AipService -CertificateThumbprint $Thumbprint -ApplicationId $ApplicationId -TenantId $TenantId -ServicePrincipal

Det här exemplet ansluter till ett Azure-konto med certifikatbaserad autentisering av tjänstens huvudnamn. Tjänstens huvudnamn som används för autentisering måste skapas med det angivna certifikatet.

Förutsättningar för det här exemplet:

  • Du måste uppdatera AIPService PowerShell-modulen till version 1.0.05 eller senare.
  • Om du vill aktivera autentisering med tjänstens huvudnamn måste du lägga till läs-API-behörigheter (Application.Read.All) i tjänstens huvudnamn.

Mer information finns i Nödvändiga API-behörigheter – Microsoft Information Protection SDK och Använd Azure PowerShell för att skapa ett huvudnamn för tjänsten med ett certifikat.

Exempel 5: Ansluta till Azure Information Protection med klienthemlighet via autentisering med tjänstens huvudnamn

PS C:\ > $TenantId = 'yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyy'
PS C:\ > $ApplicationId = '00000000-0000-0000-0000-00000000'
PS C:\ > $Credential = New-Object -TypeName System.Management.Automation.PSCredential -ArgumentList $ApplicationId, $SecuredPassword
PS C:\ > Connect-AipService -Credential $Credential -TenantId $TenantId -ServicePrincipal

I det här exemplet:

  • Det första kommandot frågar efter autentiseringsuppgifter för tjänstens huvudnamn och lagrar dem i variabeln $Credential . När du befordras anger du ditt program-ID för användarnamnet och hemligheten för tjänstens huvudnamn som lösenord.
  • Det andra kommandot ansluter till den angivna Azure-klienten med autentiseringsuppgifterna för tjänstens huvudnamn som lagras i variabeln $Credential . Switch-parametern ServicePrincipal anger att kontot autentiseras som tjänstens huvudnamn.

Om du vill aktivera autentisering med tjänstens huvudnamn måste du lägga till läs-API-behörigheter (Application.Read.All) i tjänstens huvudnamn. Mer information finns i Nödvändiga API-behörigheter – Microsoft Information Protection SDK.

Parametrar

-AccessToken

Använd den här parametern för att ansluta till Azure Information Protection med hjälp av en token som du hämtar från Azure Active Directory med klient-ID 90f610bf-206d-4950-b61d-37fa6fd1b224 och resurs-IDhttps://api.aadrm.com/. Med den här anslutningsmetoden kan du logga in på Azure Information Protection icke-interaktivt.

Om du vill hämta åtkomsttoken kontrollerar du att det konto som du använder från din klientorganisation inte använder multifaktorautentisering (MFA). Se exempel 3 för hur du kan göra detta.

Du kan inte använda den här parametern med parametern Credential .

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

-ApplicationID

Anger program-ID för tjänstens huvudnamn.

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

-CertificateThumbprint

Anger tumavtrycket för certifikatet för ett X.509-certifikat för en digital offentlig nyckel för ett huvudnamn för tjänsten som har behörighet att utföra den angivna åtgärden.

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

-Credential

Anger ett PSCredential-objekt . Om du vill hämta ett PSCredential-objekt använder du cmdleten Get-Credential . För mer information ange Get-Help Get-Cmdlet.

Cmdleten uppmanar dig att ange ett lösenord.

Du kan inte använda den här parametern med parametern AccessToken och inte använda den om ditt konto har konfigurerats för att använda multifaktorautentisering (MFA).

Type:PSCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-EnvironmentName

Anger Azure-instansen för nationella moln. Giltiga värden är:

  • AzureCloud: Kommersiellt erbjudande för Azure
  • AzureChinaCloud: Azure drivs av 21Vianet
  • AzureUSGovernment: Azure Government

Mer information om hur du använder Azure Information Protection med Azure Government finns i Tjänstbeskrivning för Azure Information Protection Premium Premium Government.

Type:AzureRmEnvironment
Accepted values:AzureCloud, AzureChinaCloud, AzureUSGovernment
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ServicePrincipal

Anger att cmdleten anger autentisering av tjänstens huvudnamn.

Tjänstens huvudnamn måste skapas med den angivna hemligheten.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-TenantId

Anger klientorganisationens GUID. Cmdleten ansluter till Azure Information Protection för den klientorganisation som du anger med GUID.

Om du inte anger den här parametern ansluter cmdleten till den klientorganisation som ditt konto tillhör.

Type:Guid
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False