Rename-AzureRmContext
Benennen Sie einen Azure-Kontext um. Standardmäßig werden Kontexte nach Benutzerkonto und Abonnement benannt.
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
Rename-AzureRmContext
-InputObject <PSAzureContext>
[-Force]
[-PassThru]
[-Scope <ContextModificationScope>]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[-TargetName] <String>
[<CommonParameters>]
Rename-AzureRmContext
[-Force]
[-PassThru]
[-Scope <ContextModificationScope>]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[-SourceName] <String>
[-TargetName] <String>
[<CommonParameters>]
Beschreibung
Benennen Sie einen Azure-Kontext um. Standardmäßig werden Kontexte nach Benutzerkonto und Abonnement benannt.
Beispiele
Umbenennen eines Kontexts mithilfe von benannten Parametern
PS C:\> Rename-AzureRmContext -SourceName "[user1@contoso.org; 12345-6789-2345-3567890]" -TargetName "Work"
Benennen Sie den Kontext für "user1@contoso.org" mit abonnement "12345-6789-2345-3567890" in "Arbeit" um. Nach diesem Befehl können Sie den Kontext mithilfe von "Select-AzureRmContext Work" als Ziel festlegen. Beachten Sie, dass Sie die Werte für "SourceName" mit Tabstoppabschluss durchlaufen können.
Umbenennen eines Kontexts mithilfe von Positionsparametern
PS C:\> Rename-AzureRmContext "My context" "Work"
Benennen Sie den Kontext "Mein Kontext" in "Arbeit" um. Nach diesem Befehl können Sie den Kontext mithilfe von Select-AzureRmContext Work als Ziel festlegen.
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, Mandant und Abonnement, die für die Kommunikation mit Azure verwendet werden
Typ: | IAzureContextContainer |
Aliase: | AzureRmContext, AzureCredential |
Position: | Named |
Standardwert: | None |
Erforderlich: | False |
Pipelineeingabe akzeptieren: | False |
Platzhalterzeichen akzeptieren: | False |
-Force
Benennen Sie den Kontext auch dann um, wenn der Zielkontext bereits vorhanden ist
Typ: | SwitchParameter |
Position: | Named |
Standardwert: | None |
Erforderlich: | False |
Pipelineeingabe akzeptieren: | False |
Platzhalterzeichen akzeptieren: | False |
-InputObject
Ein Kontextobjekt, das normalerweise durch die Pipeline übergeben wird.
Typ: | PSAzureContext |
Position: | Named |
Standardwert: | None |
Erforderlich: | True |
Pipelineeingabe akzeptieren: | True |
Platzhalterzeichen akzeptieren: | False |
-PassThru
Gibt den umbenannten Kontext zurück.
Typ: | SwitchParameter |
Position: | Named |
Standardwert: | None |
Erforderlich: | False |
Pipelineeingabe akzeptieren: | False |
Platzhalterzeichen akzeptieren: | False |
-Scope
Bestimmt den Umfang von Kontextänderungen, z. B. ob Änderungen nur für den aktuellen Prozess gelten, oder für alle sitzungen, die von diesem Benutzer gestartet wurden.
Typ: | ContextModificationScope |
Zulässige Werte: | Process, CurrentUser |
Position: | Named |
Standardwert: | None |
Erforderlich: | False |
Pipelineeingabe akzeptieren: | False |
Platzhalterzeichen akzeptieren: | False |
-SourceName
Der Name des Kontexts
Typ: | String |
Zulässige Werte: | Default |
Position: | 0 |
Standardwert: | None |
Erforderlich: | True |
Pipelineeingabe akzeptieren: | False |
Platzhalterzeichen akzeptieren: | False |
-TargetName
Der neue Name des Kontexts
Typ: | String |
Position: | 1 |
Standardwert: | None |
Erforderlich: | True |
Pipelineeingabe akzeptieren: | False |
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
Parameter: InputObject (ByValue)