Partilhar via


Tag interface

Interface que representa uma Tag.

Métodos

assignToApi(string, string, string, string, TagAssignToApiOptionalParams)

Atribua tag à Api.

assignToOperation(string, string, string, string, string, TagAssignToOperationOptionalParams)

Atribua tag à Operação.

assignToProduct(string, string, string, string, TagAssignToProductOptionalParams)

Atribua tag ao Produto.

createOrUpdate(string, string, string, TagCreateUpdateParameters, TagCreateOrUpdateOptionalParams)

Cria uma tag.

delete(string, string, string, string, TagDeleteOptionalParams)

Exclui a tag específica da instância do serviço de Gerenciamento de API.

detachFromApi(string, string, string, string, TagDetachFromApiOptionalParams)

Desanexe a tag da Api.

detachFromOperation(string, string, string, string, string, TagDetachFromOperationOptionalParams)

Desanexe a tag da Operação.

detachFromProduct(string, string, string, string, TagDetachFromProductOptionalParams)

Desanexe a tag do Produto.

get(string, string, string, TagGetOptionalParams)

Obtém os detalhes da tag especificada por seu identificador.

getByApi(string, string, string, string, TagGetByApiOptionalParams)

Obtenha a tag associada à API.

getByOperation(string, string, string, string, string, TagGetByOperationOptionalParams)

Obter tag associada à Operação.

getByProduct(string, string, string, string, TagGetByProductOptionalParams)

Obter tag associada ao Produto.

getEntityState(string, string, string, TagGetEntityStateOptionalParams)

Obtém a versão do estado da entidade da tag especificada por seu identificador.

getEntityStateByApi(string, string, string, string, TagGetEntityStateByApiOptionalParams)

Obtém a versão do estado da entidade da tag especificada por seu identificador.

getEntityStateByOperation(string, string, string, string, string, TagGetEntityStateByOperationOptionalParams)

Obtém a versão do estado da entidade da tag especificada por seu identificador.

getEntityStateByProduct(string, string, string, string, TagGetEntityStateByProductOptionalParams)

Obtém a versão do estado da entidade da tag especificada por seu identificador.

listByApi(string, string, string, TagListByApiOptionalParams)

Lista todas as tags associadas à API.

listByOperation(string, string, string, string, TagListByOperationOptionalParams)

Lista todas as Tags associadas à Operação.

listByProduct(string, string, string, TagListByProductOptionalParams)

Lista todas as Tags associadas ao Produto.

listByService(string, string, TagListByServiceOptionalParams)

Lista uma coleção de tags definidas em uma instância de serviço.

update(string, string, string, string, TagCreateUpdateParameters, TagUpdateOptionalParams)

Atualiza os detalhes da tag especificada por seu identificador.

Detalhes de Método

assignToApi(string, string, string, string, TagAssignToApiOptionalParams)

Atribua tag à Api.

function assignToApi(resourceGroupName: string, serviceName: string, apiId: string, tagId: string, options?: TagAssignToApiOptionalParams): Promise<TagAssignToApiResponse>

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.

apiId

string

Identificador de revisão da API. Deve ser exclusivo na instância de serviço de Gerenciamento de API atual. Revisão não corrente tem ; rev=n como sufixo onde n é o número de revisão.

tagId

string

Identificador de tag. Deve ser exclusivo na instância de serviço de Gerenciamento de API atual.

options
TagAssignToApiOptionalParams

Os parâmetros de opções.

Devoluções

assignToOperation(string, string, string, string, string, TagAssignToOperationOptionalParams)

Atribua tag à Operação.

function assignToOperation(resourceGroupName: string, serviceName: string, apiId: string, operationId: string, tagId: string, options?: TagAssignToOperationOptionalParams): Promise<TagContract>

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.

apiId

string

Identificador de revisão da API. Deve ser exclusivo na instância de serviço de Gerenciamento de API atual. Revisão não corrente tem ; rev=n como sufixo onde n é o número de revisão.

operationId

string

Identificador de operação dentro de uma API. Deve ser exclusivo na instância de serviço de Gerenciamento de API atual.

tagId

string

Identificador de tag. Deve ser exclusivo na instância de serviço de Gerenciamento de API atual.

options
TagAssignToOperationOptionalParams

Os parâmetros de opções.

Devoluções

Promise<TagContract>

assignToProduct(string, string, string, string, TagAssignToProductOptionalParams)

Atribua tag ao Produto.

function assignToProduct(resourceGroupName: string, serviceName: string, productId: string, tagId: string, options?: TagAssignToProductOptionalParams): Promise<TagContract>

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.

productId

string

Identificador do produto. Deve ser exclusivo na instância de serviço de Gerenciamento de API atual.

tagId

string

Identificador de tag. Deve ser exclusivo na instância de serviço de Gerenciamento de API atual.

options
TagAssignToProductOptionalParams

Os parâmetros de opções.

Devoluções

Promise<TagContract>

createOrUpdate(string, string, string, TagCreateUpdateParameters, TagCreateOrUpdateOptionalParams)

Cria uma tag.

function createOrUpdate(resourceGroupName: string, serviceName: string, tagId: string, parameters: TagCreateUpdateParameters, options?: TagCreateOrUpdateOptionalParams): Promise<TagCreateOrUpdateResponse>

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.

tagId

string

Identificador de tag. Deve ser exclusivo na instância de serviço de Gerenciamento de API atual.

parameters
TagCreateUpdateParameters

Crie parâmetros.

options
TagCreateOrUpdateOptionalParams

Os parâmetros de opções.

Devoluções

delete(string, string, string, string, TagDeleteOptionalParams)

Exclui a tag específica da instância do serviço de Gerenciamento de API.

function delete(resourceGroupName: string, serviceName: string, tagId: string, ifMatch: string, options?: TagDeleteOptionalParams): 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.

tagId

string

Identificador de tag. 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.

options
TagDeleteOptionalParams

Os parâmetros de opções.

Devoluções

Promise<void>

detachFromApi(string, string, string, string, TagDetachFromApiOptionalParams)

Desanexe a tag da Api.

function detachFromApi(resourceGroupName: string, serviceName: string, apiId: string, tagId: string, options?: TagDetachFromApiOptionalParams): 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.

apiId

string

Identificador de revisão da API. Deve ser exclusivo na instância de serviço de Gerenciamento de API atual. Revisão não corrente tem ; rev=n como sufixo onde n é o número de revisão.

tagId

string

Identificador de tag. Deve ser exclusivo na instância de serviço de Gerenciamento de API atual.

options
TagDetachFromApiOptionalParams

Os parâmetros de opções.

Devoluções

Promise<void>

detachFromOperation(string, string, string, string, string, TagDetachFromOperationOptionalParams)

Desanexe a tag da Operação.

function detachFromOperation(resourceGroupName: string, serviceName: string, apiId: string, operationId: string, tagId: string, options?: TagDetachFromOperationOptionalParams): 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.

apiId

string

Identificador de revisão da API. Deve ser exclusivo na instância de serviço de Gerenciamento de API atual. Revisão não corrente tem ; rev=n como sufixo onde n é o número de revisão.

operationId

string

Identificador de operação dentro de uma API. Deve ser exclusivo na instância de serviço de Gerenciamento de API atual.

tagId

string

Identificador de tag. Deve ser exclusivo na instância de serviço de Gerenciamento de API atual.

options
TagDetachFromOperationOptionalParams

Os parâmetros de opções.

Devoluções

Promise<void>

detachFromProduct(string, string, string, string, TagDetachFromProductOptionalParams)

Desanexe a tag do Produto.

function detachFromProduct(resourceGroupName: string, serviceName: string, productId: string, tagId: string, options?: TagDetachFromProductOptionalParams): 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.

productId

string

Identificador do produto. Deve ser exclusivo na instância de serviço de Gerenciamento de API atual.

tagId

string

Identificador de tag. Deve ser exclusivo na instância de serviço de Gerenciamento de API atual.

options
TagDetachFromProductOptionalParams

Os parâmetros de opções.

Devoluções

Promise<void>

get(string, string, string, TagGetOptionalParams)

Obtém os detalhes da tag especificada por seu identificador.

function get(resourceGroupName: string, serviceName: string, tagId: string, options?: TagGetOptionalParams): Promise<TagGetResponse>

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.

tagId

string

Identificador de tag. Deve ser exclusivo na instância de serviço de Gerenciamento de API atual.

options
TagGetOptionalParams

Os parâmetros de opções.

Devoluções

Promise<TagGetResponse>

getByApi(string, string, string, string, TagGetByApiOptionalParams)

Obtenha a tag associada à API.

function getByApi(resourceGroupName: string, serviceName: string, apiId: string, tagId: string, options?: TagGetByApiOptionalParams): Promise<TagGetByApiResponse>

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.

apiId

string

Identificador de revisão da API. Deve ser exclusivo na instância de serviço de Gerenciamento de API atual. Revisão não corrente tem ; rev=n como sufixo onde n é o número de revisão.

tagId

string

Identificador de tag. Deve ser exclusivo na instância de serviço de Gerenciamento de API atual.

options
TagGetByApiOptionalParams

Os parâmetros de opções.

Devoluções

getByOperation(string, string, string, string, string, TagGetByOperationOptionalParams)

Obter tag associada à Operação.

function getByOperation(resourceGroupName: string, serviceName: string, apiId: string, operationId: string, tagId: string, options?: TagGetByOperationOptionalParams): Promise<TagGetByOperationResponse>

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.

apiId

string

Identificador de revisão da API. Deve ser exclusivo na instância de serviço de Gerenciamento de API atual. Revisão não corrente tem ; rev=n como sufixo onde n é o número de revisão.

operationId

string

Identificador de operação dentro de uma API. Deve ser exclusivo na instância de serviço de Gerenciamento de API atual.

tagId

string

Identificador de tag. Deve ser exclusivo na instância de serviço de Gerenciamento de API atual.

options
TagGetByOperationOptionalParams

Os parâmetros de opções.

Devoluções

getByProduct(string, string, string, string, TagGetByProductOptionalParams)

Obter tag associada ao Produto.

function getByProduct(resourceGroupName: string, serviceName: string, productId: string, tagId: string, options?: TagGetByProductOptionalParams): Promise<TagGetByProductResponse>

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.

productId

string

Identificador do produto. Deve ser exclusivo na instância de serviço de Gerenciamento de API atual.

tagId

string

Identificador de tag. Deve ser exclusivo na instância de serviço de Gerenciamento de API atual.

options
TagGetByProductOptionalParams

Os parâmetros de opções.

Devoluções

getEntityState(string, string, string, TagGetEntityStateOptionalParams)

Obtém a versão do estado da entidade da tag especificada por seu identificador.

function getEntityState(resourceGroupName: string, serviceName: string, tagId: string, options?: TagGetEntityStateOptionalParams): Promise<TagGetEntityStateHeaders>

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.

tagId

string

Identificador de tag. Deve ser exclusivo na instância de serviço de Gerenciamento de API atual.

options
TagGetEntityStateOptionalParams

Os parâmetros de opções.

Devoluções

getEntityStateByApi(string, string, string, string, TagGetEntityStateByApiOptionalParams)

Obtém a versão do estado da entidade da tag especificada por seu identificador.

function getEntityStateByApi(resourceGroupName: string, serviceName: string, apiId: string, tagId: string, options?: TagGetEntityStateByApiOptionalParams): Promise<TagGetEntityStateByApiHeaders>

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.

apiId

string

Identificador de revisão da API. Deve ser exclusivo na instância de serviço de Gerenciamento de API atual. Revisão não corrente tem ; rev=n como sufixo onde n é o número de revisão.

tagId

string

Identificador de tag. Deve ser exclusivo na instância de serviço de Gerenciamento de API atual.

options
TagGetEntityStateByApiOptionalParams

Os parâmetros de opções.

Devoluções

getEntityStateByOperation(string, string, string, string, string, TagGetEntityStateByOperationOptionalParams)

Obtém a versão do estado da entidade da tag especificada por seu identificador.

function getEntityStateByOperation(resourceGroupName: string, serviceName: string, apiId: string, operationId: string, tagId: string, options?: TagGetEntityStateByOperationOptionalParams): Promise<TagGetEntityStateByOperationHeaders>

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.

apiId

string

Identificador de revisão da API. Deve ser exclusivo na instância de serviço de Gerenciamento de API atual. Revisão não corrente tem ; rev=n como sufixo onde n é o número de revisão.

operationId

string

Identificador de operação dentro de uma API. Deve ser exclusivo na instância de serviço de Gerenciamento de API atual.

tagId

string

Identificador de tag. Deve ser exclusivo na instância de serviço de Gerenciamento de API atual.

options
TagGetEntityStateByOperationOptionalParams

Os parâmetros de opções.

Devoluções

getEntityStateByProduct(string, string, string, string, TagGetEntityStateByProductOptionalParams)

Obtém a versão do estado da entidade da tag especificada por seu identificador.

function getEntityStateByProduct(resourceGroupName: string, serviceName: string, productId: string, tagId: string, options?: TagGetEntityStateByProductOptionalParams): Promise<TagGetEntityStateByProductHeaders>

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.

productId

string

Identificador do produto. Deve ser exclusivo na instância de serviço de Gerenciamento de API atual.

tagId

string

Identificador de tag. Deve ser exclusivo na instância de serviço de Gerenciamento de API atual.

options
TagGetEntityStateByProductOptionalParams

Os parâmetros de opções.

Devoluções

listByApi(string, string, string, TagListByApiOptionalParams)

Lista todas as tags associadas à API.

function listByApi(resourceGroupName: string, serviceName: string, apiId: string, options?: TagListByApiOptionalParams): PagedAsyncIterableIterator<TagContract, TagContract[], 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.

apiId

string

Identificador de revisão da API. Deve ser exclusivo na instância de serviço de Gerenciamento de API atual. Revisão não corrente tem ; rev=n como sufixo onde n é o número de revisão.

options
TagListByApiOptionalParams

Os parâmetros de opções.

Devoluções

listByOperation(string, string, string, string, TagListByOperationOptionalParams)

Lista todas as Tags associadas à Operação.

function listByOperation(resourceGroupName: string, serviceName: string, apiId: string, operationId: string, options?: TagListByOperationOptionalParams): PagedAsyncIterableIterator<TagContract, TagContract[], 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.

apiId

string

Identificador de revisão da API. Deve ser exclusivo na instância de serviço de Gerenciamento de API atual. Revisão não corrente tem ; rev=n como sufixo onde n é o número de revisão.

operationId

string

Identificador de operação dentro de uma API. Deve ser exclusivo na instância de serviço de Gerenciamento de API atual.

options
TagListByOperationOptionalParams

Os parâmetros de opções.

Devoluções

listByProduct(string, string, string, TagListByProductOptionalParams)

Lista todas as Tags associadas ao Produto.

function listByProduct(resourceGroupName: string, serviceName: string, productId: string, options?: TagListByProductOptionalParams): PagedAsyncIterableIterator<TagContract, TagContract[], 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.

productId

string

Identificador do produto. Deve ser exclusivo na instância de serviço de Gerenciamento de API atual.

options
TagListByProductOptionalParams

Os parâmetros de opções.

Devoluções

listByService(string, string, TagListByServiceOptionalParams)

Lista uma coleção de tags definidas em uma instância de serviço.

function listByService(resourceGroupName: string, serviceName: string, options?: TagListByServiceOptionalParams): PagedAsyncIterableIterator<TagContract, TagContract[], 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.

options
TagListByServiceOptionalParams

Os parâmetros de opções.

Devoluções

update(string, string, string, string, TagCreateUpdateParameters, TagUpdateOptionalParams)

Atualiza os detalhes da tag especificada por seu identificador.

function update(resourceGroupName: string, serviceName: string, tagId: string, ifMatch: string, parameters: TagCreateUpdateParameters, options?: TagUpdateOptionalParams): Promise<TagUpdateResponse>

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.

tagId

string

Identificador de tag. 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
TagCreateUpdateParameters

Atualizar parâmetros.

options
TagUpdateOptionalParams

Os parâmetros de opções.

Devoluções