Compartilhar via


sp_add_agent_parameter (Transact-SQL)

Aplica-se a: SQL Server Instância Gerenciada de SQL do Azure

Adiciona um novo parâmetro e seu valor a um perfil de agente. Esse procedimento armazenado é executado no Distribuidor em qualquer banco de dados.

Convenções de sintaxe de Transact-SQL

Sintaxe

sp_add_agent_parameter [ @profile_id = ] profile_id
        , [ @parameter_name = ] 'parameter_name'
        , [ @parameter_value = ] 'parameter_value'
[ ; ]

Argumentos

@profile_id [ = ] profile_id

A ID do perfil da MSagent_profiles tabela no msdb banco de dados. @profile_id é int, sem padrão.

Para descobrir qual tipo de agente esse @profile_id representa, localize o @profile_id na tabela MSagent_profiles e anote o valor do agent_type campo. Os valores são os seguintes:

Valor Descrição
1 Snapshot Agent
2 Agente de Leitor de Log
3 Agente de Distribuição
4 Merge Agent
9 Queue Reader Agent

@parameter_name [ = ] 'parameter_name'

O nome do parâmetro. @parameter_name é sysname, sem padrão. Para obter uma lista de parâmetros já definidos em perfis do sistema, consulte Replication Agent Profiles. Para uma lista completa de parâmetros válidos para cada agente, consulte os seguintes tópicos:

@parameter_value [ = ] 'parameter_value'

O valor a ser atribuído ao parâmetro. @parameter_value é nvarchar(255), sem padrão.

Valores do código de retorno

0 (sucesso) ou 1 (falha).

Comentários

sp_add_agent_parameter é usado na replicação de instantâneo, replicação transacional e replicação de mesclagem.

Permissões

Somente membros da função de servidor fixa sysadmin podem executar sp_add_agent_parameter.