Documentation interface
Interface que representa uma Documentação.
Métodos
| create |
Cria uma nova Documentação ou atualiza uma existente. |
| delete(string, string, string, string, Documentation |
Exclui a documentação especificada de uma API. |
| get(string, string, string, Documentation |
Obtém os detalhes da Documentação especificada por seu identificador. |
| get |
Obtém a versão do estado da entidade (Etag) da Documentação por seu identificador. |
| list |
Lista todas as documentações da instância de serviço de Gerenciamento de API. |
| update(string, string, string, string, Documentation |
Atualiza os detalhes da documentação de uma API especificada por seu identificador. |
Detalhes de Método
createOrUpdate(string, string, string, DocumentationContract, DocumentationCreateOrUpdateOptionalParams)
Cria uma nova Documentação ou atualiza uma existente.
function createOrUpdate(resourceGroupName: string, serviceName: string, documentationId: string, parameters: DocumentationContract, options?: DocumentationCreateOrUpdateOptionalParams): Promise<DocumentationCreateOrUpdateResponse>Parâmetros
- resourceGroupName
-
string
O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.
- serviceName
-
string
O nome do serviço de Gerenciamento de API.
- documentationId
-
string
Identificador da documentação. Deve ser exclusivo na instância de serviço de Gerenciamento de API atual.
- parameters
- DocumentationContract
Crie parâmetros.
Os parâmetros de opções.
Devoluções
Promise<DocumentationCreateOrUpdateResponse>
delete(string, string, string, string, DocumentationDeleteOptionalParams)
Exclui a documentação especificada de uma API.
function delete(resourceGroupName: string, serviceName: string, documentationId: string, ifMatch: string, options?: DocumentationDeleteOptionalParams): Promise<void>Parâmetros
- resourceGroupName
-
string
O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.
- serviceName
-
string
O nome do serviço de Gerenciamento de API.
- documentationId
-
string
Identificador da documentação. Deve ser exclusivo na instância de serviço de Gerenciamento de API atual.
- ifMatch
-
string
ETag da Entidade. O ETag deve corresponder ao estado atual da entidade a partir da resposta do cabeçalho da solicitação GET ou deve ser * para atualização incondicional.
Os parâmetros de opções.
Devoluções
Promise<void>
get(string, string, string, DocumentationGetOptionalParams)
Obtém os detalhes da Documentação especificada por seu identificador.
function get(resourceGroupName: string, serviceName: string, documentationId: string, options?: DocumentationGetOptionalParams): Promise<DocumentationGetResponse>Parâmetros
- resourceGroupName
-
string
O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.
- serviceName
-
string
O nome do serviço de Gerenciamento de API.
- documentationId
-
string
Identificador da documentação. Deve ser exclusivo na instância de serviço de Gerenciamento de API atual.
- options
- DocumentationGetOptionalParams
Os parâmetros de opções.
Devoluções
Promise<DocumentationGetResponse>
getEntityTag(string, string, string, DocumentationGetEntityTagOptionalParams)
Obtém a versão do estado da entidade (Etag) da Documentação por seu identificador.
function getEntityTag(resourceGroupName: string, serviceName: string, documentationId: string, options?: DocumentationGetEntityTagOptionalParams): Promise<DocumentationGetEntityTagHeaders>Parâmetros
- resourceGroupName
-
string
O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.
- serviceName
-
string
O nome do serviço de Gerenciamento de API.
- documentationId
-
string
Identificador da documentação. Deve ser exclusivo na instância de serviço de Gerenciamento de API atual.
Os parâmetros de opções.
Devoluções
Promise<DocumentationGetEntityTagHeaders>
listByService(string, string, DocumentationListByServiceOptionalParams)
Lista todas as documentações da instância de serviço de Gerenciamento de API.
function listByService(resourceGroupName: string, serviceName: string, options?: DocumentationListByServiceOptionalParams): PagedAsyncIterableIterator<DocumentationContract, DocumentationContract[], PageSettings>Parâmetros
- resourceGroupName
-
string
O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.
- serviceName
-
string
O nome do serviço de Gerenciamento de API.
Os parâmetros de opções.
Devoluções
update(string, string, string, string, DocumentationUpdateContract, DocumentationUpdateOptionalParams)
Atualiza os detalhes da documentação de uma API especificada por seu identificador.
function update(resourceGroupName: string, serviceName: string, documentationId: string, ifMatch: string, parameters: DocumentationUpdateContract, options?: DocumentationUpdateOptionalParams): Promise<DocumentationUpdateResponse>Parâmetros
- resourceGroupName
-
string
O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.
- serviceName
-
string
O nome do serviço de Gerenciamento de API.
- documentationId
-
string
Identificador da documentação. Deve ser exclusivo na instância de serviço de Gerenciamento de API atual.
- ifMatch
-
string
ETag da Entidade. O ETag deve corresponder ao estado atual da entidade a partir da resposta do cabeçalho da solicitação GET ou deve ser * para atualização incondicional.
- parameters
- DocumentationUpdateContract
Parâmetros de atualização da documentação.
Os parâmetros de opções.
Devoluções
Promise<DocumentationUpdateResponse>