ApiTagDescription interface
Interface que representa uma ApiTagDescription.
Métodos
| create |
Criar/Atualizar a descrição da etiqueta no âmbito da API. |
| delete(string, string, string, string, string, Api |
Elimine a descrição da etiqueta para a API. |
| get(string, string, string, string, Api |
Obter a Descrição da etiqueta no âmbito da API |
| get |
Obtém a versão de estado da entidade da etiqueta especificada pelo respetivo identificador. |
| list |
Lista todas as descrições de Etiquetas no âmbito da API. Modelo semelhante ao swagger – tagDescription é definido ao nível da API, mas a etiqueta pode ser atribuída às Operações |
Detalhes de Método
createOrUpdate(string, string, string, string, TagDescriptionCreateParameters, ApiTagDescriptionCreateOrUpdateOptionalParams)
Criar/Atualizar a descrição da etiqueta no âmbito da API.
function createOrUpdate(resourceGroupName: string, serviceName: string, apiId: string, tagDescriptionId: string, parameters: TagDescriptionCreateParameters, options?: ApiTagDescriptionCreateOrUpdateOptionalParams): Promise<ApiTagDescriptionCreateOrUpdateResponse>Parâmetros
- resourceGroupName
-
string
O nome do grupo de recursos. O nome não é sensível a maiúsculas e minúsculas.
- serviceName
-
string
O nome do serviço Gestão de API.
- apiId
-
string
Identificador de revisão da API. Tem de ser exclusivo na instância de serviço do Gestão de API atual. A revisão não atual tem ;rev=n como um sufixo em que n é o número de revisão.
- tagDescriptionId
-
string
Identificador de descrição da etiqueta. Utilizado ao criar tagDescription para associação de API/Etiqueta. Com base em nomes de API e Etiquetas.
- parameters
- TagDescriptionCreateParameters
Criar parâmetros.
Os parâmetros de opções.
Devoluções
delete(string, string, string, string, string, ApiTagDescriptionDeleteOptionalParams)
Elimine a descrição da etiqueta para a API.
function delete(resourceGroupName: string, serviceName: string, apiId: string, tagDescriptionId: string, ifMatch: string, options?: ApiTagDescriptionDeleteOptionalParams): Promise<void>Parâmetros
- resourceGroupName
-
string
O nome do grupo de recursos. O nome não é sensível a maiúsculas e minúsculas.
- serviceName
-
string
O nome do serviço Gestão de API.
- apiId
-
string
Identificador de revisão da API. Tem de ser exclusivo na instância de serviço do Gestão de API atual. A revisão não atual tem ;rev=n como um sufixo em que n é o número de revisão.
- tagDescriptionId
-
string
Identificador de descrição da etiqueta. Utilizado ao criar tagDescription para associação de API/Etiqueta. Com base em nomes de API e Etiquetas.
- ifMatch
-
string
ETag da Entidade. A ETag deve corresponder ao estado da entidade atual da resposta de cabeçalho do pedido GET ou deve ser * para atualização incondicional.
Os parâmetros de opções.
Devoluções
Promise<void>
get(string, string, string, string, ApiTagDescriptionGetOptionalParams)
Obter a Descrição da etiqueta no âmbito da API
function get(resourceGroupName: string, serviceName: string, apiId: string, tagDescriptionId: string, options?: ApiTagDescriptionGetOptionalParams): Promise<ApiTagDescriptionGetResponse>Parâmetros
- resourceGroupName
-
string
O nome do grupo de recursos. O nome não é sensível a maiúsculas e minúsculas.
- serviceName
-
string
O nome do serviço Gestão de API.
- apiId
-
string
Identificador de revisão da API. Tem de ser exclusivo na instância de serviço do Gestão de API atual. A revisão não atual tem ;rev=n como um sufixo em que n é o número de revisão.
- tagDescriptionId
-
string
Identificador de descrição da etiqueta. Utilizado ao criar tagDescription para associação de API/Etiqueta. Com base em nomes de API e Etiquetas.
Os parâmetros de opções.
Devoluções
Promise<ApiTagDescriptionGetResponse>
getEntityTag(string, string, string, string, ApiTagDescriptionGetEntityTagOptionalParams)
Obtém a versão de estado da entidade da etiqueta especificada pelo respetivo identificador.
function getEntityTag(resourceGroupName: string, serviceName: string, apiId: string, tagDescriptionId: string, options?: ApiTagDescriptionGetEntityTagOptionalParams): Promise<ApiTagDescriptionGetEntityTagHeaders>Parâmetros
- resourceGroupName
-
string
O nome do grupo de recursos. O nome não é sensível a maiúsculas e minúsculas.
- serviceName
-
string
O nome do serviço Gestão de API.
- apiId
-
string
Identificador de revisão da API. Tem de ser exclusivo na instância de serviço do Gestão de API atual. A revisão não atual tem ;rev=n como um sufixo em que n é o número de revisão.
- tagDescriptionId
-
string
Identificador de descrição da etiqueta. Utilizado ao criar tagDescription para associação de API/Etiqueta. Com base em nomes de API e Etiquetas.
Os parâmetros de opções.
Devoluções
Promise<ApiTagDescriptionGetEntityTagHeaders>
listByService(string, string, string, ApiTagDescriptionListByServiceOptionalParams)
Lista todas as descrições de Etiquetas no âmbito da API. Modelo semelhante ao swagger – tagDescription é definido ao nível da API, mas a etiqueta pode ser atribuída às Operações
function listByService(resourceGroupName: string, serviceName: string, apiId: string, options?: ApiTagDescriptionListByServiceOptionalParams): PagedAsyncIterableIterator<TagDescriptionContract, TagDescriptionContract[], PageSettings>Parâmetros
- resourceGroupName
-
string
O nome do grupo de recursos. O nome não é sensível a maiúsculas e minúsculas.
- serviceName
-
string
O nome do serviço Gestão de API.
- apiId
-
string
Identificador de revisão da API. Tem de ser exclusivo na instância de serviço do Gestão de API atual. A revisão não atual tem ;rev=n como um sufixo em que n é o número de revisão.
Os parâmetros de opções.