ManagedHsmKeys interface
Schnittstelle, die einen ManagedHsmKeys darstellt.
Methoden
| create |
Erstellt die erste Version eines neuen Schlüssels, wenn er nicht vorhanden ist. Wenn er bereits vorhanden ist, wird der vorhandene Schlüssel ohne Schreibvorgänge zurückgegeben. Diese API erstellt keine nachfolgenden Versionen und aktualisiert keine vorhandenen Schlüssel. |
| get(string, string, string, Managed |
Ruft die aktuelle Version des angegebenen Schlüssels aus dem angegebenen verwalteten HSM ab. |
| get |
Ruft die angegebene Version des angegebenen Schlüssels im angegebenen verwalteten HSM ab. |
| list(string, string, Managed |
Listet die Schlüssel im angegebenen verwalteten HSM auf. |
| list |
Listet die Schlüssel im angegebenen verwalteten HSM auf. |
Details zur Methode
createIfNotExist(string, string, string, ManagedHsmKeyCreateParameters, ManagedHsmKeysCreateIfNotExistOptionalParams)
Erstellt die erste Version eines neuen Schlüssels, wenn er nicht vorhanden ist. Wenn er bereits vorhanden ist, wird der vorhandene Schlüssel ohne Schreibvorgänge zurückgegeben. Diese API erstellt keine nachfolgenden Versionen und aktualisiert keine vorhandenen Schlüssel.
function createIfNotExist(resourceGroupName: string, name: string, keyName: string, parameters: ManagedHsmKeyCreateParameters, options?: ManagedHsmKeysCreateIfNotExistOptionalParams): Promise<ManagedHsmKey>
Parameter
- resourceGroupName
-
string
Der Name der Ressourcengruppe. Bei dem Namen wird die Groß-/Kleinschreibung nicht beachtet.
- name
-
string
Der Name des verwalteten HSM-Pools innerhalb der angegebenen Ressourcengruppe.
- keyName
-
string
Der Name des zu erstellenden Schlüssels. Der von Ihnen bereitgestellte Wert kann global kopiert werden, um den Dienst auszuführen. Der angegebene Wert sollte keine persönlich identifizierbaren oder vertraulichen Informationen enthalten.
- parameters
- ManagedHsmKeyCreateParameters
Die Parameter, die zum Erstellen des angegebenen Schlüssels verwendet werden.
Die Optionsparameter.
Gibt zurück
Promise<ManagedHsmKey>
get(string, string, string, ManagedHsmKeysGetOptionalParams)
Ruft die aktuelle Version des angegebenen Schlüssels aus dem angegebenen verwalteten HSM ab.
function get(resourceGroupName: string, name: string, keyName: string, options?: ManagedHsmKeysGetOptionalParams): Promise<ManagedHsmKey>
Parameter
- resourceGroupName
-
string
Der Name der Ressourcengruppe. Bei dem Namen wird die Groß-/Kleinschreibung nicht beachtet.
- name
-
string
Der Name des verwalteten HSM-Pools innerhalb der angegebenen Ressourcengruppe.
- keyName
-
string
Der Name des zu erstellenden Schlüssels. Der von Ihnen bereitgestellte Wert kann global kopiert werden, um den Dienst auszuführen. Der angegebene Wert sollte keine persönlich identifizierbaren oder vertraulichen Informationen enthalten.
- options
- ManagedHsmKeysGetOptionalParams
Die Optionsparameter.
Gibt zurück
Promise<ManagedHsmKey>
getVersion(string, string, string, string, ManagedHsmKeysGetVersionOptionalParams)
Ruft die angegebene Version des angegebenen Schlüssels im angegebenen verwalteten HSM ab.
function getVersion(resourceGroupName: string, name: string, keyName: string, keyVersion: string, options?: ManagedHsmKeysGetVersionOptionalParams): Promise<ManagedHsmKey>
Parameter
- resourceGroupName
-
string
Der Name der Ressourcengruppe. Bei dem Namen wird die Groß-/Kleinschreibung nicht beachtet.
- name
-
string
Der Name des verwalteten HSM-Pools innerhalb der angegebenen Ressourcengruppe.
- keyName
-
string
Der Name des zu erstellenden Schlüssels. Der von Ihnen bereitgestellte Wert kann global kopiert werden, um den Dienst auszuführen. Der angegebene Wert sollte keine persönlich identifizierbaren oder vertraulichen Informationen enthalten.
- keyVersion
-
string
Die Version des abzurufenden Schlüssels.
Die Optionsparameter.
Gibt zurück
Promise<ManagedHsmKey>
list(string, string, ManagedHsmKeysListOptionalParams)
Listet die Schlüssel im angegebenen verwalteten HSM auf.
function list(resourceGroupName: string, name: string, options?: ManagedHsmKeysListOptionalParams): PagedAsyncIterableIterator<ManagedHsmKey, ManagedHsmKey[], PageSettings>
Parameter
- resourceGroupName
-
string
Der Name der Ressourcengruppe. Bei dem Namen wird die Groß-/Kleinschreibung nicht beachtet.
- name
-
string
Der Name des verwalteten HSM-Pools innerhalb der angegebenen Ressourcengruppe.
- options
- ManagedHsmKeysListOptionalParams
Die Optionsparameter.
Gibt zurück
listVersions(string, string, string, ManagedHsmKeysListVersionsOptionalParams)
Listet die Schlüssel im angegebenen verwalteten HSM auf.
function listVersions(resourceGroupName: string, name: string, keyName: string, options?: ManagedHsmKeysListVersionsOptionalParams): PagedAsyncIterableIterator<ManagedHsmKey, ManagedHsmKey[], PageSettings>
Parameter
- resourceGroupName
-
string
Der Name der Ressourcengruppe. Bei dem Namen wird die Groß-/Kleinschreibung nicht beachtet.
- name
-
string
Der Name des verwalteten HSM-Pools innerhalb der angegebenen Ressourcengruppe.
- keyName
-
string
Der Name des zu erstellenden Schlüssels. Der von Ihnen bereitgestellte Wert kann global kopiert werden, um den Dienst auszuführen. Der angegebene Wert sollte keine persönlich identifizierbaren oder vertraulichen Informationen enthalten.
Die Optionsparameter.