Documentation interface
Interfaz que representa una documentación.
Métodos
| create |
Crea una nueva documentación o actualiza una existente. |
| delete(string, string, string, string, Documentation |
Elimina la documentación especificada de una API. |
| get(string, string, string, Documentation |
Obtiene los detalles de la documentación especificada por su identificador. |
| get |
Obtiene la versión de estado de entidad (Etag) de la documentación por su identificador. |
| list |
Enumera todas las documentación de la instancia de servicio de API Management. |
| update(string, string, string, string, Documentation |
Novedades los detalles de la documentación de una API especificada por su identificador. |
Detalles del método
createOrUpdate(string, string, string, DocumentationContract, DocumentationCreateOrUpdateOptionalParams)
Crea una nueva documentación o actualiza una existente.
function createOrUpdate(resourceGroupName: string, serviceName: string, documentationId: string, parameters: DocumentationContract, options?: DocumentationCreateOrUpdateOptionalParams): Promise<DocumentationCreateOrUpdateResponse>Parámetros
- resourceGroupName
-
string
Nombre del grupo de recursos. El nombre distingue mayúsculas de minúsculas.
- serviceName
-
string
Nombre del servicio API Management.
- documentationId
-
string
Identificador de documentación. Debe ser único en la instancia de servicio de API Management actual.
- parameters
- DocumentationContract
Cree parámetros.
Parámetros de opciones.
Devoluciones
Promise<DocumentationCreateOrUpdateResponse>
delete(string, string, string, string, DocumentationDeleteOptionalParams)
Elimina la documentación especificada de una API.
function delete(resourceGroupName: string, serviceName: string, documentationId: string, ifMatch: string, options?: DocumentationDeleteOptionalParams): 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.
- documentationId
-
string
Identificador de documentación. 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.
Parámetros de opciones.
Devoluciones
Promise<void>
get(string, string, string, DocumentationGetOptionalParams)
Obtiene los detalles de la documentación especificada por su identificador.
function get(resourceGroupName: string, serviceName: string, documentationId: string, options?: DocumentationGetOptionalParams): Promise<DocumentationGetResponse>Parámetros
- resourceGroupName
-
string
Nombre del grupo de recursos. El nombre distingue mayúsculas de minúsculas.
- serviceName
-
string
Nombre del servicio API Management.
- documentationId
-
string
Identificador de documentación. Debe ser único en la instancia de servicio de API Management actual.
- options
- DocumentationGetOptionalParams
Parámetros de opciones.
Devoluciones
Promise<DocumentationGetResponse>
getEntityTag(string, string, string, DocumentationGetEntityTagOptionalParams)
Obtiene la versión de estado de entidad (Etag) de la documentación por su identificador.
function getEntityTag(resourceGroupName: string, serviceName: string, documentationId: string, options?: DocumentationGetEntityTagOptionalParams): Promise<DocumentationGetEntityTagHeaders>Parámetros
- resourceGroupName
-
string
Nombre del grupo de recursos. El nombre distingue mayúsculas de minúsculas.
- serviceName
-
string
Nombre del servicio API Management.
- documentationId
-
string
Identificador de documentación. Debe ser único en la instancia de servicio de API Management actual.
Parámetros de opciones.
Devoluciones
Promise<DocumentationGetEntityTagHeaders>
listByService(string, string, DocumentationListByServiceOptionalParams)
Enumera todas las documentación de la instancia de servicio de API Management.
function listByService(resourceGroupName: string, serviceName: string, options?: DocumentationListByServiceOptionalParams): PagedAsyncIterableIterator<DocumentationContract, DocumentationContract[], 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
update(string, string, string, string, DocumentationUpdateContract, DocumentationUpdateOptionalParams)
Novedades los detalles de la documentación de una API especificada por su identificador.
function update(resourceGroupName: string, serviceName: string, documentationId: string, ifMatch: string, parameters: DocumentationUpdateContract, options?: DocumentationUpdateOptionalParams): Promise<DocumentationUpdateResponse>Parámetros
- resourceGroupName
-
string
Nombre del grupo de recursos. El nombre distingue mayúsculas de minúsculas.
- serviceName
-
string
Nombre del servicio API Management.
- documentationId
-
string
Identificador de documentación. 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.
- parameters
- DocumentationUpdateContract
Parámetros de actualización de documentación.
Parámetros de opciones.
Devoluciones
Promise<DocumentationUpdateResponse>