Freigeben über

Remove-AzureRmADSpCredential

  • Referenz
Modul:
AzureRM.Resources

Entfernt eine Anmeldeinformation aus einem Dienstprinzipal.

Warnung

Das AzureRM PowerShell-Modul ist seit dem 29. Februar 2024 offiziell veraltet. Benutzern wird empfohlen, von AzureRM zum Az PowerShell-Modul zu migrieren, um weiterhin Support und Updates zu erhalten.

Obwohl das AzureRM-Modul weiterhin funktioniert, wird es nicht mehr Standard tained oder unterstützt, wobei eine fortgesetzte Verwendung nach Ermessen und Risiko des Benutzers erfolgt. Weitere Informationen zum Übergang zum Az-Modul finden Sie in unseren Migrationsressourcen.

Syntax

Remove-AzureRmADSpCredential
      -ObjectId <Guid>
      [-KeyId <Guid>]
      [-PassThru]
      [-Force]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Remove-AzureRmADSpCredential
      -ServicePrincipalName <String>
      [-KeyId <Guid>]
      [-PassThru]
      [-Force]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Remove-AzureRmADSpCredential
      -DisplayName <String>
      [-PassThru]
      [-Force]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Remove-AzureRmADSpCredential
      -ServicePrincipalObject <PSADServicePrincipal>
      [-KeyId <Guid>]
      [-PassThru]
      [-Force]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Beschreibung

Das Cmdlet Remove-AzureRmADSpCredential kann verwendet werden, um einen Anmeldeinformationsschlüssel aus einem Dienstprinzipal zu entfernen, wenn eine Kompromittierung oder der Ablauf des Rollovers von Anmeldeinformationenschlüsseln erfolgt. Der Dienstprinzipal wird durch Angeben der Objekt-ID oder des Dienstprinzipalnamens (Service Principal Name, SPN) identifiziert. Die zu entfernenden Anmeldeinformationen werden durch die Schlüssel-ID identifiziert, wenn eine einzelne Anmeldeinformation entfernt werden soll, oder mit einem "Alle"-Schalter, um alle anmeldeinformationen zu löschen, die dem Dienstprinzipal zugeordnet sind.

Beispiele

Beispiel 1 : Entfernen einer bestimmten Anmeldeinformationen aus einem Dienstprinzipal

PS C:\> Remove-AzureRmADSpCredential -ObjectId 7663d3fb-6f86-4352-9e6d-cf9d50d5ee82 -KeyId 9044423a-60a3-45ac-9ab1-09534157ebb

Entfernt die Anmeldeinformationen mit der Schlüssel-ID "9044423a-60a3-45ac-9ab1-09534157ebb" aus dem Dienstprinzipal mit objekt-ID "7663d3fb-6f86-4352-9e6d-cf9d50d5e82".

Beispiel 2 : Entfernen aller Anmeldeinformationen aus einem Dienstprinzipal

PS C:\> Remove-AzureRmADSpCredential -ServicePrincipalName http://test123

Entfernt alle Anmeldeinformationen aus dem Dienstprinzipal mit dem SPN "http://test123".

Beispiel 3 : Entfernen aller Anmeldeinformationen aus einem Dienstprinzipal mithilfe von Piping

PS C:\> Get-AzureRmADServicePrincipal -ObjectId 7663d3fb-6f86-4352-9e6d-cf9d50d5ee82 | Remove-AzureRmADSpCredential

Ruft den Dienstprinzipal mit der Objekt-ID '7663d3fb-6f86-4352-9e6d-cf9d50d5ee82' ab und weist diese an das Cmdlet Remove-AzureRmADSpCredential auf, um alle Anmeldeinformationen aus diesem Dienstprinzipal zu entfernen.

Parameter

-Confirm

Hiermit werden Sie vor der Ausführung des Cmdlets zur Bestätigung aufgefordert.

Typ:SwitchParameter
Aliase:cf
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

-DefaultProfile

Anmeldeinformationen, Konto, Mandant und Abonnement für die Kommunikation mit Azure

Typ:IAzureContextContainer
Aliase:AzureRmContext, AzureCredential
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

-DisplayName

Der Anzeigename des Dienstprinzipals.

Typ:String
Position:Named
Standardwert:None
Erforderlich:True
Pipelineeingabe akzeptieren:True
Platzhalterzeichen akzeptieren:False

-Force

Wechseln Sie ohne Bestätigung, um Anmeldeinformationen zu löschen.

Typ:SwitchParameter
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

-KeyId

Gibt den zu entfernenden Anmeldeinformationsschlüssel an. Die Schlüssel-IDs für einen Dienstprinzipal können mithilfe des Cmdlets "Get-AzureRmADSpCredential" abgerufen werden.

Typ:Guid
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:True
Platzhalterzeichen akzeptieren:False

-ObjectId

Die Objekt-ID des Dienstprinzipals, aus dem die Anmeldeinformationen entfernt werden sollen.

Typ:Guid
Position:Named
Standardwert:None
Erforderlich:True
Pipelineeingabe akzeptieren:True
Platzhalterzeichen akzeptieren:False

-PassThru

Wenn der Befehl erfolgreich war, wird "true" zurückgegeben.

Typ:SwitchParameter
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

-ServicePrincipalName

Der Name (SPN) des Dienstprinzipals, aus dem die Anmeldeinformationen entfernt werden sollen.

Typ:String
Position:Named
Standardwert:None
Erforderlich:True
Pipelineeingabe akzeptieren:True
Platzhalterzeichen akzeptieren:False

-ServicePrincipalObject

Das Dienstprinzipalobjekt, aus dem die Anmeldeinformationen entfernt werden sollen.

Typ:PSADServicePrincipal
Position:Named
Standardwert:None
Erforderlich:True
Pipelineeingabe akzeptieren:True
Platzhalterzeichen akzeptieren:False

-WhatIf

Zeigt, was geschieht, wenn das Cmdlet ausgeführt wird. Das Cmdlet wird nicht ausgeführt.

Typ:SwitchParameter
Aliase:wi
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

Eingaben

Guid

String

PSADServicePrincipal

Parameter: ServicePrincipalObject (ByValue)

Ausgaben

Boolean