Compartilhar via


Tag interface

Interface que representa uma marca.

Métodos

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

Atribuir marca à API.

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

Atribuir marca à Operação.

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

Atribuir marca ao Produto.

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

Cria uma marca.

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

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

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

Desanexe a marca da API.

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

Desanexe a marca da Operação.

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

Desanexe a marca do Produto.

get(string, string, string, TagGetOptionalParams)

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

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

Obter marca associada à API.

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

Obter marca associada à Operação.

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

Obter marca associada ao Produto.

getEntityState(string, string, string, TagGetEntityStateOptionalParams)

Obtém a versão de estado da entidade da marca especificada por seu identificador.

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

Obtém a versão de estado da entidade da marca especificada por seu identificador.

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

Obtém a versão de estado da entidade da marca especificada por seu identificador.

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

Obtém a versão de estado da entidade da marca especificada por seu identificador.

listByApi(string, string, string, TagListByApiOptionalParams)

Lista todas as marcas associadas à API.

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

Lista todas as marcas associadas à Operação.

listByProduct(string, string, string, TagListByProductOptionalParams)

Lista todas as marcas associadas ao Produto.

listByService(string, string, TagListByServiceOptionalParams)

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

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

Atualiza os detalhes da marca especificada por seu identificador.

Detalhes do método

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

Atribuir marca à 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 de API. Deve ser exclusivo na instância atual do serviço de Gerenciamento de API. A revisão não atual tem; rev=n como um sufixo em que n é o número de revisão.

tagId

string

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

options
TagAssignToApiOptionalParams

Os parâmetros de opções.

Retornos

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

Atribuir marca à 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 de API. Deve ser exclusivo na instância atual do serviço de Gerenciamento de API. A revisão não atual tem; rev=n como um sufixo em que n é o número de revisão.

operationId

string

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

tagId

string

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

options
TagAssignToOperationOptionalParams

Os parâmetros de opções.

Retornos

Promise<TagContract>

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

Atribuir marca 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 atual do serviço de Gerenciamento de API.

tagId

string

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

options
TagAssignToProductOptionalParams

Os parâmetros de opções.

Retornos

Promise<TagContract>

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

Cria uma marca.

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 marca. Deve ser exclusivo na instância atual do serviço de Gerenciamento de API.

parameters
TagCreateUpdateParameters

Criar parâmetros.

options
TagCreateOrUpdateOptionalParams

Os parâmetros de opções.

Retornos

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

Exclui uma marca 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 marca. Deve ser exclusivo na instância atual do serviço de Gerenciamento de API.

ifMatch

string

ETag da Entidade. A ETag deve corresponder ao estado da entidade atual da resposta de cabeçalho da solicitação GET ou deve ser * para atualização incondicional.

options
TagDeleteOptionalParams

Os parâmetros de opções.

Retornos

Promise<void>

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

Desanexe a marca 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 de API. Deve ser exclusivo na instância atual do serviço de Gerenciamento de API. A revisão não atual tem; rev=n como um sufixo em que n é o número de revisão.

tagId

string

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

options
TagDetachFromApiOptionalParams

Os parâmetros de opções.

Retornos

Promise<void>

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

Desanexe a marca 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 de API. Deve ser exclusivo na instância atual do serviço de Gerenciamento de API. A revisão não atual tem; rev=n como um sufixo em que n é o número de revisão.

operationId

string

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

tagId

string

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

options
TagDetachFromOperationOptionalParams

Os parâmetros de opções.

Retornos

Promise<void>

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

Desanexe a marca 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 atual do serviço de Gerenciamento de API.

tagId

string

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

options
TagDetachFromProductOptionalParams

Os parâmetros de opções.

Retornos

Promise<void>

get(string, string, string, TagGetOptionalParams)

Obtém os detalhes da marca 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 marca. Deve ser exclusivo na instância atual do serviço de Gerenciamento de API.

options
TagGetOptionalParams

Os parâmetros de opções.

Retornos

Promise<TagGetResponse>

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

Obter marca 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 de API. Deve ser exclusivo na instância atual do serviço de Gerenciamento de API. A revisão não atual tem; rev=n como um sufixo em que n é o número de revisão.

tagId

string

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

options
TagGetByApiOptionalParams

Os parâmetros de opções.

Retornos

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

Obter marca 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 de API. Deve ser exclusivo na instância atual do serviço de Gerenciamento de API. A revisão não atual tem; rev=n como um sufixo em que n é o número de revisão.

operationId

string

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

tagId

string

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

options
TagGetByOperationOptionalParams

Os parâmetros de opções.

Retornos

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

Obter marca 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 atual do serviço de Gerenciamento de API.

tagId

string

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

options
TagGetByProductOptionalParams

Os parâmetros de opções.

Retornos

getEntityState(string, string, string, TagGetEntityStateOptionalParams)

Obtém a versão de estado da entidade da marca 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 marca. Deve ser exclusivo na instância atual do serviço de Gerenciamento de API.

options
TagGetEntityStateOptionalParams

Os parâmetros de opções.

Retornos

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

Obtém a versão de estado da entidade da marca 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 de API. Deve ser exclusivo na instância atual do serviço de Gerenciamento de API. A revisão não atual tem; rev=n como um sufixo em que n é o número de revisão.

tagId

string

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

options
TagGetEntityStateByApiOptionalParams

Os parâmetros de opções.

Retornos

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

Obtém a versão de estado da entidade da marca 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 de API. Deve ser exclusivo na instância atual do serviço de Gerenciamento de API. A revisão não atual tem; rev=n como um sufixo em que n é o número de revisão.

operationId

string

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

tagId

string

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

options
TagGetEntityStateByOperationOptionalParams

Os parâmetros de opções.

Retornos

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

Obtém a versão de estado da entidade da marca 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 atual do serviço de Gerenciamento de API.

tagId

string

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

options
TagGetEntityStateByProductOptionalParams

Os parâmetros de opções.

Retornos

listByApi(string, string, string, TagListByApiOptionalParams)

Lista todas as marcas 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 de API. Deve ser exclusivo na instância atual do serviço de Gerenciamento de API. A revisão não atual tem; rev=n como um sufixo em que n é o número de revisão.

options
TagListByApiOptionalParams

Os parâmetros de opções.

Retornos

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

Lista todas as marcas 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 de API. Deve ser exclusivo na instância atual do serviço de Gerenciamento de API. A revisão não atual tem; rev=n como um sufixo em que n é o número de revisão.

operationId

string

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

options
TagListByOperationOptionalParams

Os parâmetros de opções.

Retornos

listByProduct(string, string, string, TagListByProductOptionalParams)

Lista todas as marcas 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 atual do serviço de Gerenciamento de API.

options
TagListByProductOptionalParams

Os parâmetros de opções.

Retornos

listByService(string, string, TagListByServiceOptionalParams)

Lista uma coleção de marcas 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.

Retornos

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

Atualiza os detalhes da marca 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 marca. Deve ser exclusivo na instância atual do serviço de Gerenciamento de API.

ifMatch

string

ETag da Entidade. A ETag deve corresponder ao estado da entidade atual da resposta de 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.

Retornos