Certificate interface

Paquet:

@azure/arm-apimanagement

Interface représentant un certificat.

Méthodes

createOrUpdate(string, string, string, CertificateCreateOrUpdateParameters, CertificateCreateOrUpdateOptionalParams)	Crée ou met à jour le certificat utilisé pour l’authentification avec le serveur principal.
delete(string, string, string, string, CertificateDeleteOptionalParams)	Supprime un certificat spécifique.
get(string, string, string, CertificateGetOptionalParams)	Obtient les détails du certificat spécifié par son identificateur.
getEntityTag(string, string, string, CertificateGetEntityTagOptionalParams)	Obtient la version de l’état de l’entité (Etag) du certificat spécifié par son identificateur.
listByService(string, string, CertificateListByServiceOptionalParams)	Répertorie une collection de tous les certificats dans l’instance de service spécifiée.
refreshSecret(string, string, string, CertificateRefreshSecretOptionalParams)	À partir de KeyVault, actualisez le certificat utilisé pour l’authentification auprès du serveur principal.

Détails de la méthode

createOrUpdate(string, string, string, CertificateCreateOrUpdateParameters, CertificateCreateOrUpdateOptionalParams)

Crée ou met à jour le certificat utilisé pour l’authentification avec le serveur principal.

function createOrUpdate(resourceGroupName: string, serviceName: string, certificateId: string, parameters: CertificateCreateOrUpdateParameters, options?: CertificateCreateOrUpdateOptionalParams): Promise<CertificateCreateOrUpdateResponse>

Paramètres

resourceGroupName

string

Nom du groupe de ressources. Le nom ne respecte pas la casse.

serviceName

string

Nom du service Gestion des API.

certificateId

string

Identificateur de l’entité de certificat. Doit être unique dans le instance de service Gestion des API actuel.

parameters

CertificateCreateOrUpdateParameters

Créer ou mettre à jour des paramètres.

options

CertificateCreateOrUpdateOptionalParams

Paramètres d’options.

Retours

Promise<CertificateCreateOrUpdateResponse>

delete(string, string, string, string, CertificateDeleteOptionalParams)

Supprime un certificat spécifique.

function delete(resourceGroupName: string, serviceName: string, certificateId: string, ifMatch: string, options?: CertificateDeleteOptionalParams): Promise<void>

Paramètres

resourceGroupName

string

Nom du groupe de ressources. Le nom ne respecte pas la casse.

serviceName

string

Nom du service Gestion des API.

certificateId

string

Identificateur de l’entité de certificat. Doit être unique dans le instance de service Gestion des API actuel.

ifMatch

string

ETag de l’entité. ETag doit correspondre à l’état actuel de l’entité à partir de la réponse d’en-tête de la requête GET ou il doit être * pour la mise à jour inconditionnelle.

options

CertificateDeleteOptionalParams

Paramètres d’options.

Retours

Promise<void>

get(string, string, string, CertificateGetOptionalParams)

Obtient les détails du certificat spécifié par son identificateur.

function get(resourceGroupName: string, serviceName: string, certificateId: string, options?: CertificateGetOptionalParams): Promise<CertificateGetResponse>

Paramètres

resourceGroupName

string

Nom du groupe de ressources. Le nom ne respecte pas la casse.

serviceName

string

Nom du service Gestion des API.

certificateId

string

Identificateur de l’entité de certificat. Doit être unique dans le instance de service Gestion des API actuel.

options

CertificateGetOptionalParams

Paramètres d’options.

Retours

Promise<CertificateGetResponse>

getEntityTag(string, string, string, CertificateGetEntityTagOptionalParams)

Obtient la version de l’état de l’entité (Etag) du certificat spécifié par son identificateur.

function getEntityTag(resourceGroupName: string, serviceName: string, certificateId: string, options?: CertificateGetEntityTagOptionalParams): Promise<CertificateGetEntityTagHeaders>

Paramètres

resourceGroupName

string

Nom du groupe de ressources. Le nom ne respecte pas la casse.

serviceName

string

Nom du service Gestion des API.

certificateId

string

Identificateur de l’entité de certificat. Doit être unique dans le instance de service Gestion des API actuel.

options

CertificateGetEntityTagOptionalParams

Paramètres d’options.

Retours

Promise<CertificateGetEntityTagHeaders>

listByService(string, string, CertificateListByServiceOptionalParams)

Répertorie une collection de tous les certificats dans l’instance de service spécifiée.

function listByService(resourceGroupName: string, serviceName: string, options?: CertificateListByServiceOptionalParams): PagedAsyncIterableIterator<CertificateContract, CertificateContract[], PageSettings>

Paramètres

resourceGroupName

string

Nom du groupe de ressources. Le nom ne respecte pas la casse.

serviceName

string

Nom du service Gestion des API.

options

CertificateListByServiceOptionalParams

Paramètres d’options.

Retours

PagedAsyncIterableIterator<CertificateContract, CertificateContract[], PageSettings>

refreshSecret(string, string, string, CertificateRefreshSecretOptionalParams)

À partir de KeyVault, actualisez le certificat utilisé pour l’authentification auprès du serveur principal.

function refreshSecret(resourceGroupName: string, serviceName: string, certificateId: string, options?: CertificateRefreshSecretOptionalParams): Promise<CertificateRefreshSecretResponse>

Paramètres

resourceGroupName

string

Nom du groupe de ressources. Le nom ne respecte pas la casse.

serviceName

string

Nom du service Gestion des API.

certificateId

string

Identificateur de l’entité de certificat. Doit être unique dans le instance de service Gestion des API actuel.

options

CertificateRefreshSecretOptionalParams

Paramètres d’options.

Retours

Promise<CertificateRefreshSecretResponse>