Delen via

az keyvault secret

  • Referentie

Geheimen beheren.

Opdracht

Name Description Type Status
az keyvault secret backup

Hiermee maakt u een back-up van het opgegeven geheim.

 Basis GA
az keyvault secret delete

Verwijder alle versies van een geheim.

 Basis Afgeschaft
az keyvault secret download

Download een geheim uit een KeyVault.

 Basis GA
az keyvault secret list

Geheimen weergeven in een opgegeven sleutelkluis.

 Basis GA
az keyvault secret list-deleted

Hiermee worden verwijderde geheimen voor de opgegeven kluis weergegeven.

 Basis GA
az keyvault secret list-versions

Geef alle versies van het opgegeven geheim weer.

 Basis GA
az keyvault secret purge

Hiermee verwijdert u het opgegeven geheim definitief.

 Basis GA
az keyvault secret recover

Hiermee herstelt u het verwijderde geheim naar de nieuwste versie.

 Basis GA
az keyvault secret restore

Hiermee herstelt u een back-up van een geheim naar een kluis.

 Basis GA
az keyvault secret set

Maak een geheim (als deze niet bestaat) of werk een geheim bij in een KeyVault.

 Basis GA
az keyvault secret set-attributes

Hiermee worden de kenmerken bijgewerkt die zijn gekoppeld aan een opgegeven geheim in een bepaalde sleutelkluis.

 Basis GA
az keyvault secret show

Haal een opgegeven geheim op uit een bepaalde sleutelkluis.

 Basis GA
az keyvault secret show-deleted

Hiermee haalt u het opgegeven verwijderde geheim op.

 Basis GA

az keyvault secret backup

Bewerken

Hiermee maakt u een back-up van het opgegeven geheim.

Hiermee wordt aangevraagd dat een back-up van het opgegeven geheim naar de client wordt gedownload. Alle versies van het geheim worden gedownload. Voor deze bewerking is de machtiging geheimen/back-up vereist.

az keyvault secret backup --file
                          [--id]
                          [--name]
                          [--vault-name]

Vereiste parameters

--file -f

Bestand om de geheime inhoud te ontvangen.

Optionele parameters

--id

Id van het geheim. Als u alle andere 'Id'-argumenten hebt opgegeven, moet u deze weglaten.

--name -n

Naam van het geheim. Vereist als --id niet is opgegeven.

--vault-name

Naam van de sleutelkluis. Vereist als --id niet is opgegeven.

Globale parameters
--debug

Vergroot de uitgebreidheid van logboekregistratie om alle logboeken voor foutopsporing weer te geven.

--help -h

Dit Help-bericht weergeven en afsluiten.

--only-show-errors

Alleen fouten weergeven, waarschuwingen onderdrukken.

--output -o

Uitvoerindeling.

Geaccepteerde waarden: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath-queryreeks. Zie http://jmespath.org/ voor meer informatie en voorbeelden.

--subscription

Naam of id van het abonnement. U kunt het standaardabonnement configureren met behulp van az account set -s NAME_OR_ID.

--verbose

Vergroot de uitgebreidheid van logboekregistratie. Gebruik --debug voor volledige foutopsporingslogboeken.

az keyvault secret delete

Bewerken
Afgeschaft

Waarschuwing! Als u beveiliging tegen voorlopig verwijderen hebt ingeschakeld voor deze sleutelkluis, wordt dit geheim verplaatst naar de status Voorlopig verwijderd. U kunt geen geheim maken met dezelfde naam in deze sleutelkluis totdat het geheim is verwijderd uit de status Voorlopig verwijderd. Raadpleeg de volgende documentatie voor aanvullende richtlijnen. https://docs.microsoft.com/azure/key-vault/general/soft-delete-overview

Verwijder alle versies van een geheim.

Vereist geheimen/verwijdermachtigingen. Wanneer deze methode key vault retourneert, is begonnen met het verwijderen van het geheim. Verwijderen kan enkele seconden duren in een kluis waarvoor voorlopig verwijderen is ingeschakeld. Deze methode retourneert daarom een poller waarmee u kunt wachten totdat het verwijderen is voltooid.

az keyvault secret delete [--id]
                          [--name]
                          [--vault-name]

Optionele parameters

--id

Id van het geheim. Als u alle andere 'Id'-argumenten hebt opgegeven, moet u deze weglaten.

--name -n

Naam van het geheim. Vereist als --id niet is opgegeven.

--vault-name

Naam van de sleutelkluis. Vereist als --id niet is opgegeven.

Globale parameters
--debug

Vergroot de uitgebreidheid van logboekregistratie om alle logboeken voor foutopsporing weer te geven.

--help -h

Dit Help-bericht weergeven en afsluiten.

--only-show-errors

Alleen fouten weergeven, waarschuwingen onderdrukken.

--output -o

Uitvoerindeling.

Geaccepteerde waarden: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath-queryreeks. Zie http://jmespath.org/ voor meer informatie en voorbeelden.

--subscription

Naam of id van het abonnement. U kunt het standaardabonnement configureren met behulp van az account set -s NAME_OR_ID.

--verbose

Vergroot de uitgebreidheid van logboekregistratie. Gebruik --debug voor volledige foutopsporingslogboeken.

az keyvault secret download

Bewerken

Download een geheim uit een KeyVault.

az keyvault secret download --file
                            [--encoding {ascii, base64, hex, utf-16be, utf-16le, utf-8}]
                            [--id]
                            [--name]
                            [--vault-name]
                            [--version]

Vereiste parameters

--file -f

Bestand om de geheime inhoud te ontvangen.

Optionele parameters

--encoding -e

Codering van het geheim. Standaard wordt gezocht naar de tag 'file-encoding' in het geheim. Anders wordt uitgegaan van 'utf-8'.

Geaccepteerde waarden: ascii, base64, hex, utf-16be, utf-16le, utf-8
--id

Id van het geheim. Als u alle andere 'Id'-argumenten hebt opgegeven, moet u deze weglaten.

--name -n

Naam van het geheim. Vereist als --id niet is opgegeven.

--vault-name

Naam van de sleutelkluis. Vereist als --id niet is opgegeven.

--version -v

De geheime versie. Als u dit weglaat, wordt de nieuwste versie gebruikt.

Globale parameters
--debug

Vergroot de uitgebreidheid van logboekregistratie om alle logboeken voor foutopsporing weer te geven.

--help -h

Dit Help-bericht weergeven en afsluiten.

--only-show-errors

Alleen fouten weergeven, waarschuwingen onderdrukken.

--output -o

Uitvoerindeling.

Geaccepteerde waarden: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath-queryreeks. Zie http://jmespath.org/ voor meer informatie en voorbeelden.

--subscription

Naam of id van het abonnement. U kunt het standaardabonnement configureren met behulp van az account set -s NAME_OR_ID.

--verbose

Vergroot de uitgebreidheid van logboekregistratie. Gebruik --debug voor volledige foutopsporingslogboeken.

az keyvault secret list

Bewerken

Geheimen weergeven in een opgegeven sleutelkluis.

De bewerking Geheimen ophalen is van toepassing op de hele kluis. Alleen de basisgeheim-id en de bijbehorende kenmerken worden echter opgegeven in het antwoord. Afzonderlijke geheime versies worden niet vermeld in het antwoord. Voor deze bewerking is de machtiging voor geheimen/lijsten vereist.

az keyvault secret list [--id]
                        [--include-managed {false, true}]
                        [--maxresults]
                        [--vault-name]

Optionele parameters

--id

Volledige URI van de kluis. Als u alle andere 'Id'-argumenten hebt opgegeven, moet u deze weglaten.

--include-managed

Beheerde geheimen opnemen. Standaard: onwaar.

Geaccepteerde waarden: false, true
Default value: False
--maxresults

Maximum aantal resultaten dat moet worden geretourneerd op een pagina. Als dit niet is opgegeven, retourneert de service maximaal 25 resultaten.

--vault-name

Naam van de sleutelkluis. Vereist als --id niet is opgegeven.

Globale parameters
--debug

Vergroot de uitgebreidheid van logboekregistratie om alle logboeken voor foutopsporing weer te geven.

--help -h

Dit Help-bericht weergeven en afsluiten.

--only-show-errors

Alleen fouten weergeven, waarschuwingen onderdrukken.

--output -o

Uitvoerindeling.

Geaccepteerde waarden: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath-queryreeks. Zie http://jmespath.org/ voor meer informatie en voorbeelden.

--subscription

Naam of id van het abonnement. U kunt het standaardabonnement configureren met behulp van az account set -s NAME_OR_ID.

--verbose

Vergroot de uitgebreidheid van logboekregistratie. Gebruik --debug voor volledige foutopsporingslogboeken.

az keyvault secret list-deleted

Bewerken

Hiermee worden verwijderde geheimen voor de opgegeven kluis weergegeven.

De bewerking Verwijderde geheimen ophalen retourneert de geheimen die zijn verwijderd voor een kluis die is ingeschakeld voor voorlopig verwijderen. Voor deze bewerking is de machtiging voor geheimen/lijsten vereist.

az keyvault secret list-deleted [--id]
                                [--maxresults]
                                [--vault-name]

Optionele parameters

--id

Volledige URI van de kluis. Als u alle andere 'Id'-argumenten hebt opgegeven, moet u deze weglaten.

--maxresults

Maximum aantal resultaten dat moet worden geretourneerd op een pagina. Als dit niet is opgegeven, retourneert de service maximaal 25 resultaten.

--vault-name

Naam van de sleutelkluis. Vereist als --id niet is opgegeven.

Globale parameters
--debug

Vergroot de uitgebreidheid van logboekregistratie om alle logboeken voor foutopsporing weer te geven.

--help -h

Dit Help-bericht weergeven en afsluiten.

--only-show-errors

Alleen fouten weergeven, waarschuwingen onderdrukken.

--output -o

Uitvoerindeling.

Geaccepteerde waarden: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath-queryreeks. Zie http://jmespath.org/ voor meer informatie en voorbeelden.

--subscription

Naam of id van het abonnement. U kunt het standaardabonnement configureren met behulp van az account set -s NAME_OR_ID.

--verbose

Vergroot de uitgebreidheid van logboekregistratie. Gebruik --debug voor volledige foutopsporingslogboeken.

az keyvault secret list-versions

Bewerken

Geef alle versies van het opgegeven geheim weer.

De volledige geheime id en kenmerken worden opgegeven in het antwoord. Er worden geen waarden geretourneerd voor de geheimen. Voor deze bewerkingen is de machtiging voor geheimen/lijsten vereist.

az keyvault secret list-versions [--id]
                                 [--maxresults]
                                 [--name]
                                 [--vault-name]

Optionele parameters

--id

Id van het geheim. Als u alle andere 'Id'-argumenten hebt opgegeven, moet u deze weglaten.

--maxresults

Maximum aantal resultaten dat moet worden geretourneerd op een pagina. Als dit niet is opgegeven, retourneert de service maximaal 25 resultaten.

--name -n

Naam van het geheim. Vereist als --id niet is opgegeven.

--vault-name

Naam van de sleutelkluis. Vereist als --id niet is opgegeven.

Globale parameters
--debug

Vergroot de uitgebreidheid van logboekregistratie om alle logboeken voor foutopsporing weer te geven.

--help -h

Dit Help-bericht weergeven en afsluiten.

--only-show-errors

Alleen fouten weergeven, waarschuwingen onderdrukken.

--output -o

Uitvoerindeling.

Geaccepteerde waarden: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath-queryreeks. Zie http://jmespath.org/ voor meer informatie en voorbeelden.

--subscription

Naam of id van het abonnement. U kunt het standaardabonnement configureren met behulp van az account set -s NAME_OR_ID.

--verbose

Vergroot de uitgebreidheid van logboekregistratie. Gebruik --debug voor volledige foutopsporingslogboeken.

az keyvault secret purge

Bewerken

Hiermee verwijdert u het opgegeven geheim definitief.

Met de verwijderde geheime bewerking voor opschonen wordt het geheim definitief verwijderd, zonder de mogelijkheid om het te herstellen. Deze bewerking kan alleen worden ingeschakeld voor een kluis met voorlopig verwijderen. Voor deze bewerking is de machtiging voor geheimen/opschonen vereist.

az keyvault secret purge [--id]
                         [--name]
                         [--vault-name]

Optionele parameters

--id

De herstel-id van het geheim. Als u alle andere 'Id'-argumenten hebt opgegeven, moet u deze weglaten.

--name -n

Naam van het geheim. Vereist als --id niet is opgegeven.

--vault-name

Naam van de kluis. Vereist als --id niet is opgegeven.

Globale parameters
--debug

Vergroot de uitgebreidheid van logboekregistratie om alle logboeken voor foutopsporing weer te geven.

--help -h

Dit Help-bericht weergeven en afsluiten.

--only-show-errors

Alleen fouten weergeven, waarschuwingen onderdrukken.

--output -o

Uitvoerindeling.

Geaccepteerde waarden: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath-queryreeks. Zie http://jmespath.org/ voor meer informatie en voorbeelden.

--subscription

Naam of id van het abonnement. U kunt het standaardabonnement configureren met behulp van az account set -s NAME_OR_ID.

--verbose

Vergroot de uitgebreidheid van logboekregistratie. Gebruik --debug voor volledige foutopsporingslogboeken.

az keyvault secret recover

Bewerken

Hiermee herstelt u het verwijderde geheim naar de nieuwste versie.

Hiermee herstelt u het verwijderde geheim in de opgegeven kluis. Deze bewerking kan alleen worden uitgevoerd op een kluis met voorlopig verwijderen. Voor deze bewerking is de machtiging geheimen/herstellen vereist.

az keyvault secret recover [--id]
                           [--name]
                           [--vault-name]

Optionele parameters

--id

De herstel-id van het geheim. Als u alle andere 'Id'-argumenten hebt opgegeven, moet u deze weglaten.

--name -n

Naam van het geheim. Vereist als --id niet is opgegeven.

--vault-name

Naam van de kluis. Vereist als --id niet is opgegeven.

Globale parameters
--debug

Vergroot de uitgebreidheid van logboekregistratie om alle logboeken voor foutopsporing weer te geven.

--help -h

Dit Help-bericht weergeven en afsluiten.

--only-show-errors

Alleen fouten weergeven, waarschuwingen onderdrukken.

--output -o

Uitvoerindeling.

Geaccepteerde waarden: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath-queryreeks. Zie http://jmespath.org/ voor meer informatie en voorbeelden.

--subscription

Naam of id van het abonnement. U kunt het standaardabonnement configureren met behulp van az account set -s NAME_OR_ID.

--verbose

Vergroot de uitgebreidheid van logboekregistratie. Gebruik --debug voor volledige foutopsporingslogboeken.

az keyvault secret restore

Bewerken

Hiermee herstelt u een back-up van een geheim naar een kluis.

Hiermee herstelt u een back-up van een geheim en alle bijbehorende versies naar een kluis. Voor deze bewerking is de machtiging geheimen/herstellen vereist.

az keyvault secret restore --file
                           --vault-name

Vereiste parameters

--file -f

Bestand om de geheime inhoud te ontvangen.

--vault-name

Naam van de kluis.

Globale parameters
--debug

Vergroot de uitgebreidheid van logboekregistratie om alle logboeken voor foutopsporing weer te geven.

--help -h

Dit Help-bericht weergeven en afsluiten.

--only-show-errors

Alleen fouten weergeven, waarschuwingen onderdrukken.

--output -o

Uitvoerindeling.

Geaccepteerde waarden: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath-queryreeks. Zie http://jmespath.org/ voor meer informatie en voorbeelden.

--subscription

Naam of id van het abonnement. U kunt het standaardabonnement configureren met behulp van az account set -s NAME_OR_ID.

--verbose

Vergroot de uitgebreidheid van logboekregistratie. Gebruik --debug voor volledige foutopsporingslogboeken.

az keyvault secret set

Bewerken

Maak een geheim (als deze niet bestaat) of werk een geheim bij in een KeyVault.

az keyvault secret set --name
                       --vault-name
                       [--content-type]
                       [--disabled {false, true}]
                       [--encoding {ascii, base64, hex, utf-16be, utf-16le, utf-8}]
                       [--expires]
                       [--file]
                       [--not-before]
                       [--tags]
                       [--value]

Voorbeelden

Maak een geheim (als deze niet bestaat) of werk een geheim bij in een KeyVault.

az keyvault secret set --name MySecretName --vault-name MyKeyVault --value MyVault

Maak een geheim (als deze niet bestaat) of werk een geheim bij in een KeyVault via een bestand.

az keyvault secret set --name MySecretName --vault-name MyKeyVault --file /path/to/file --encoding MyEncoding

Vereiste parameters

--name -n

Naam van het geheim.

--vault-name

Naam van de kluis.

Optionele parameters

--content-type --description

Beschrijving van de geheime inhoud (bijvoorbeeld wachtwoord, verbindingsreeks, enzovoort).

--disabled

Maak een geheim met de status Uitgeschakeld.

Geaccepteerde waarden: false, true
--encoding -e

Codering van bronbestanden. De waarde wordt opgeslagen als een tag (file-encoding=<val>) en gebruikt tijdens het downloaden om het resulterende bestand automatisch te coderen.

Geaccepteerde waarden: ascii, base64, hex, utf-16be, utf-16le, utf-8
Default value: utf-8
--expires

Vervaldatum UTC-datum/tijd (Y-m-d'T'H:M:S'Z').

--file -f

Bronbestand voor geheim. Gebruik in combinatie met '--encoding'.

--not-before

Geheim is niet bruikbaar voor de opgegeven UTC-datum/tijd (Y-m-d'T'H:M:S'Z').

--tags

Door spaties gescheiden tags: key[=value] [key[=value] ...]. Gebruik '' om bestaande tags te wissen.

--value

Geheime waarde voor tekst zonder opmaak. Kan niet worden gebruikt met '--file' of '--encoding'.

Globale parameters
--debug

Vergroot de uitgebreidheid van logboekregistratie om alle logboeken voor foutopsporing weer te geven.

--help -h

Dit Help-bericht weergeven en afsluiten.

--only-show-errors

Alleen fouten weergeven, waarschuwingen onderdrukken.

--output -o

Uitvoerindeling.

Geaccepteerde waarden: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath-queryreeks. Zie http://jmespath.org/ voor meer informatie en voorbeelden.

--subscription

Naam of id van het abonnement. U kunt het standaardabonnement configureren met behulp van az account set -s NAME_OR_ID.

--verbose

Vergroot de uitgebreidheid van logboekregistratie. Gebruik --debug voor volledige foutopsporingslogboeken.

az keyvault secret set-attributes

Bewerken

Hiermee worden de kenmerken bijgewerkt die zijn gekoppeld aan een opgegeven geheim in een bepaalde sleutelkluis.

De UPDATE-bewerking wijzigt de opgegeven kenmerken van een bestaand opgeslagen geheim. Kenmerken die niet in de aanvraag zijn opgegeven, blijven ongewijzigd. De waarde van een geheim zelf kan niet worden gewijzigd. Voor deze bewerking is de machtiging geheimen/set vereist.

az keyvault secret set-attributes [--content-type]
                                  [--enabled {false, true}]
                                  [--expires]
                                  [--id]
                                  [--name]
                                  [--not-before]
                                  [--tags]
                                  [--vault-name]
                                  [--version]

Optionele parameters

--content-type

Type van de geheime waarde, zoals een wachtwoord.

--enabled

Schakel het geheim in.

Geaccepteerde waarden: false, true
--expires

Vervaldatum UTC-datum/tijd (Y-m-d'T'H:M:S'Z').

--id

Id van het geheim. Als u alle andere 'Id'-argumenten hebt opgegeven, moet u deze weglaten.

--name -n

Naam van het geheim. Vereist als --id niet is opgegeven.

--not-before

Geheim is niet bruikbaar voor de opgegeven UTC-datum/tijd (Y-m-d'T'H:M:S'Z').

--tags

Door spaties gescheiden tags: key[=value] [key[=value] ...]. Gebruik '' om bestaande tags te wissen.

--vault-name

Naam van de sleutelkluis. Vereist als --id niet is opgegeven.

--version -v

De geheime versie. Als u dit weglaat, wordt de nieuwste versie gebruikt.

Globale parameters
--debug

Vergroot de uitgebreidheid van logboekregistratie om alle logboeken voor foutopsporing weer te geven.

--help -h

Dit Help-bericht weergeven en afsluiten.

--only-show-errors

Alleen fouten weergeven, waarschuwingen onderdrukken.

--output -o

Uitvoerindeling.

Geaccepteerde waarden: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath-queryreeks. Zie http://jmespath.org/ voor meer informatie en voorbeelden.

--subscription

Naam of id van het abonnement. U kunt het standaardabonnement configureren met behulp van az account set -s NAME_OR_ID.

--verbose

Vergroot de uitgebreidheid van logboekregistratie. Gebruik --debug voor volledige foutopsporingslogboeken.

az keyvault secret show

Bewerken

Haal een opgegeven geheim op uit een bepaalde sleutelkluis.

De GET-bewerking is van toepassing op elk geheim dat is opgeslagen in Azure Key Vault. Voor deze bewerking zijn de geheimen/het ophalen van machtigingen vereist.

az keyvault secret show [--id]
                        [--name]
                        [--vault-name]
                        [--version]

Optionele parameters

--id

Id van het geheim. Als u alle andere 'Id'-argumenten hebt opgegeven, moet u deze weglaten.

--name -n

Naam van het geheim. Vereist als --id niet is opgegeven.

--vault-name

Naam van de sleutelkluis. Vereist als --id niet is opgegeven.

--version -v

De geheime versie. Als u dit weglaat, wordt de nieuwste versie gebruikt.

Globale parameters
--debug

Vergroot de uitgebreidheid van logboekregistratie om alle logboeken voor foutopsporing weer te geven.

--help -h

Dit Help-bericht weergeven en afsluiten.

--only-show-errors

Alleen fouten weergeven, waarschuwingen onderdrukken.

--output -o

Uitvoerindeling.

Geaccepteerde waarden: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath-queryreeks. Zie http://jmespath.org/ voor meer informatie en voorbeelden.

--subscription

Naam of id van het abonnement. U kunt het standaardabonnement configureren met behulp van az account set -s NAME_OR_ID.

--verbose

Vergroot de uitgebreidheid van logboekregistratie. Gebruik --debug voor volledige foutopsporingslogboeken.

az keyvault secret show-deleted

Bewerken

Hiermee haalt u het opgegeven verwijderde geheim op.

Met de bewerking Verwijderd geheim ophalen wordt het opgegeven verwijderde geheim samen met de bijbehorende kenmerken geretourneerd. Voor deze bewerking zijn de geheimen/het ophalen van machtigingen vereist.

az keyvault secret show-deleted [--id]
                                [--name]
                                [--vault-name]

Optionele parameters

--id

De herstel-id van het geheim. Als u alle andere 'Id'-argumenten hebt opgegeven, moet u deze weglaten.

--name -n

Naam van het geheim. Vereist als --id niet is opgegeven.

--vault-name

Naam van de kluis. Vereist als --id niet is opgegeven.

Globale parameters
--debug

Vergroot de uitgebreidheid van logboekregistratie om alle logboeken voor foutopsporing weer te geven.

--help -h

Dit Help-bericht weergeven en afsluiten.

--only-show-errors

Alleen fouten weergeven, waarschuwingen onderdrukken.

--output -o

Uitvoerindeling.

Geaccepteerde waarden: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath-queryreeks. Zie http://jmespath.org/ voor meer informatie en voorbeelden.

--subscription

Naam of id van het abonnement. U kunt het standaardabonnement configureren met behulp van az account set -s NAME_OR_ID.

--verbose

Vergroot de uitgebreidheid van logboekregistratie. Gebruik --debug voor volledige foutopsporingslogboeken.