Certificate interface
Interfaz que representa un certificado.
Métodos
create |
Crea o actualiza el certificado que se usa para la autenticación con el servidor back-end. |
delete(string, string, string, string, Certificate |
Elimina un certificado específico. |
get(string, string, string, Certificate |
Obtiene los detalles del certificado especificado por su identificador. |
get |
Obtiene la versión de estado de entidad (Etag) del certificado especificado por su identificador. |
list |
Enumera una colección de todos los certificados de la instancia de servicio especificada |
refresh |
En KeyVault, actualice el certificado que se usa para la autenticación con el back-end. |
Detalles del método
createOrUpdate(string, string, string, CertificateCreateOrUpdateParameters, CertificateCreateOrUpdateOptionalParams)
Crea o actualiza el certificado que se usa para la autenticación con el servidor back-end.
function createOrUpdate(resourceGroupName: string, serviceName: string, certificateId: string, parameters: CertificateCreateOrUpdateParameters, options?: CertificateCreateOrUpdateOptionalParams): Promise<CertificateCreateOrUpdateResponse>
Parámetros
- resourceGroupName
-
string
Nombre del grupo de recursos. El nombre distingue mayúsculas de minúsculas.
- serviceName
-
string
Nombre del servicio API Management.
- certificateId
-
string
Identificador de la entidad de certificado. Debe ser único en la instancia de servicio de API Management actual.
- parameters
- CertificateCreateOrUpdateParameters
Crear o actualizar parámetros.
Parámetros de opciones.
Devoluciones
Promise<CertificateCreateOrUpdateResponse>
delete(string, string, string, string, CertificateDeleteOptionalParams)
Elimina un certificado específico.
function delete(resourceGroupName: string, serviceName: string, certificateId: string, ifMatch: string, options?: CertificateDeleteOptionalParams): Promise<void>
Parámetros
- resourceGroupName
-
string
Nombre del grupo de recursos. El nombre distingue mayúsculas de minúsculas.
- serviceName
-
string
Nombre del servicio API Management.
- certificateId
-
string
Identificador de la entidad de certificado. Debe ser único en la instancia de servicio de API Management actual.
- ifMatch
-
string
ETag de la entidad. ETag debe coincidir con el estado de entidad actual de la respuesta de encabezado de la solicitud GET o debe ser * para la actualización incondicional.
- options
- CertificateDeleteOptionalParams
Parámetros de opciones.
Devoluciones
Promise<void>
get(string, string, string, CertificateGetOptionalParams)
Obtiene los detalles del certificado especificado por su identificador.
function get(resourceGroupName: string, serviceName: string, certificateId: string, options?: CertificateGetOptionalParams): Promise<CertificateGetResponse>
Parámetros
- resourceGroupName
-
string
Nombre del grupo de recursos. El nombre distingue mayúsculas de minúsculas.
- serviceName
-
string
Nombre del servicio API Management.
- certificateId
-
string
Identificador de la entidad de certificado. Debe ser único en la instancia de servicio de API Management actual.
- options
- CertificateGetOptionalParams
Parámetros de opciones.
Devoluciones
Promise<CertificateGetResponse>
getEntityTag(string, string, string, CertificateGetEntityTagOptionalParams)
Obtiene la versión de estado de entidad (Etag) del certificado especificado por su identificador.
function getEntityTag(resourceGroupName: string, serviceName: string, certificateId: string, options?: CertificateGetEntityTagOptionalParams): Promise<CertificateGetEntityTagHeaders>
Parámetros
- resourceGroupName
-
string
Nombre del grupo de recursos. El nombre distingue mayúsculas de minúsculas.
- serviceName
-
string
Nombre del servicio API Management.
- certificateId
-
string
Identificador de la entidad de certificado. Debe ser único en la instancia de servicio de API Management actual.
Parámetros de opciones.
Devoluciones
Promise<CertificateGetEntityTagHeaders>
listByService(string, string, CertificateListByServiceOptionalParams)
Enumera una colección de todos los certificados de la instancia de servicio especificada
function listByService(resourceGroupName: string, serviceName: string, options?: CertificateListByServiceOptionalParams): PagedAsyncIterableIterator<CertificateContract, CertificateContract[], PageSettings>
Parámetros
- resourceGroupName
-
string
Nombre del grupo de recursos. El nombre distingue mayúsculas de minúsculas.
- serviceName
-
string
Nombre del servicio API Management.
Parámetros de opciones.
Devoluciones
refreshSecret(string, string, string, CertificateRefreshSecretOptionalParams)
En KeyVault, actualice el certificado que se usa para la autenticación con el back-end.
function refreshSecret(resourceGroupName: string, serviceName: string, certificateId: string, options?: CertificateRefreshSecretOptionalParams): Promise<CertificateRefreshSecretResponse>
Parámetros
- resourceGroupName
-
string
Nombre del grupo de recursos. El nombre distingue mayúsculas de minúsculas.
- serviceName
-
string
Nombre del servicio API Management.
- certificateId
-
string
Identificador de la entidad de certificado. Debe ser único en la instancia de servicio de API Management actual.
Parámetros de opciones.
Devoluciones
Promise<CertificateRefreshSecretResponse>