Certificate interface
Schnittstelle, die ein Zertifikat darstellt.
Methoden
create |
Erstellt oder aktualisiert das Zertifikat für die Authentifizierung beim Back-End |
delete(string, string, string, string, Certificate |
Löscht das angegebene Zertifikat |
get(string, string, string, Certificate |
Ruft die Details des Zertifikats ab, das durch den Bezeichner angegeben wird. |
get |
Ruft die Etag-Version (Entity State) des Zertifikats ab, das durch den Bezeichner angegeben wird. |
list |
Listet eine Auflistung aller Zertifikate in der angegebenen Dienstinstanz auf |
refresh |
Aktualisieren Sie in KeyVault das Zertifikat, das für die Authentifizierung mit dem Back-End verwendet wird. |
Details zur Methode
createOrUpdate(string, string, string, CertificateCreateOrUpdateParameters, CertificateCreateOrUpdateOptionalParams)
Erstellt oder aktualisiert das Zertifikat für die Authentifizierung beim Back-End
function createOrUpdate(resourceGroupName: string, serviceName: string, certificateId: string, parameters: CertificateCreateOrUpdateParameters, options?: CertificateCreateOrUpdateOptionalParams): Promise<CertificateCreateOrUpdateResponse>
Parameter
- resourceGroupName
-
string
Der Name der Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet.
- serviceName
-
string
Der Name des API Management-Diensts.
- certificateId
-
string
Bezeichner der Zertifikatentität. Muss im aktuellen API Management-Dienst instance eindeutig sein.
- parameters
- CertificateCreateOrUpdateParameters
Erstellen oder Aktualisieren von Parametern.
Die Optionsparameter.
Gibt zurück
Promise<CertificateCreateOrUpdateResponse>
delete(string, string, string, string, CertificateDeleteOptionalParams)
Löscht das angegebene Zertifikat
function delete(resourceGroupName: string, serviceName: string, certificateId: string, ifMatch: string, options?: CertificateDeleteOptionalParams): Promise<void>
Parameter
- resourceGroupName
-
string
Der Name der Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet.
- serviceName
-
string
Der Name des API Management-Diensts.
- certificateId
-
string
Bezeichner der Zertifikatentität. Muss im aktuellen API Management-Dienst instance eindeutig sein.
- ifMatch
-
string
ETag der Entität. ETag sollte mit dem aktuellen Entitätsstatus aus der Headerantwort der GET-Anforderung übereinstimmen, oder es sollte * für die bedingungslose Aktualisierung sein.
- options
- CertificateDeleteOptionalParams
Die Optionsparameter.
Gibt zurück
Promise<void>
get(string, string, string, CertificateGetOptionalParams)
Ruft die Details des Zertifikats ab, das durch den Bezeichner angegeben wird.
function get(resourceGroupName: string, serviceName: string, certificateId: string, options?: CertificateGetOptionalParams): Promise<CertificateGetResponse>
Parameter
- resourceGroupName
-
string
Der Name der Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet.
- serviceName
-
string
Der Name des API Management-Diensts.
- certificateId
-
string
Bezeichner der Zertifikatentität. Muss im aktuellen API Management-Dienst instance eindeutig sein.
- options
- CertificateGetOptionalParams
Die Optionsparameter.
Gibt zurück
Promise<CertificateGetResponse>
getEntityTag(string, string, string, CertificateGetEntityTagOptionalParams)
Ruft die Etag-Version (Entity State) des Zertifikats ab, das durch den Bezeichner angegeben wird.
function getEntityTag(resourceGroupName: string, serviceName: string, certificateId: string, options?: CertificateGetEntityTagOptionalParams): Promise<CertificateGetEntityTagHeaders>
Parameter
- resourceGroupName
-
string
Der Name der Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet.
- serviceName
-
string
Der Name des API Management-Diensts.
- certificateId
-
string
Bezeichner der Zertifikatentität. Muss im aktuellen API Management-Dienst instance eindeutig sein.
Die Optionsparameter.
Gibt zurück
Promise<CertificateGetEntityTagHeaders>
listByService(string, string, CertificateListByServiceOptionalParams)
Listet eine Auflistung aller Zertifikate in der angegebenen Dienstinstanz auf
function listByService(resourceGroupName: string, serviceName: string, options?: CertificateListByServiceOptionalParams): PagedAsyncIterableIterator<CertificateContract, CertificateContract[], PageSettings>
Parameter
- resourceGroupName
-
string
Der Name der Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet.
- serviceName
-
string
Der Name des API Management-Diensts.
Die Optionsparameter.
Gibt zurück
refreshSecret(string, string, string, CertificateRefreshSecretOptionalParams)
Aktualisieren Sie in KeyVault das Zertifikat, das für die Authentifizierung mit dem Back-End verwendet wird.
function refreshSecret(resourceGroupName: string, serviceName: string, certificateId: string, options?: CertificateRefreshSecretOptionalParams): Promise<CertificateRefreshSecretResponse>
Parameter
- resourceGroupName
-
string
Der Name der Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet.
- serviceName
-
string
Der Name des API Management-Diensts.
- certificateId
-
string
Bezeichner der Zertifikatentität. Muss im aktuellen API Management-Dienst instance eindeutig sein.
Die Optionsparameter.
Gibt zurück
Promise<CertificateRefreshSecretResponse>