sp_update_proxy (Transact-sql)sp_update_proxy (Transact-SQL)

適用対象: yesSQL Server noAzure SQL Database noAzure Synapse Analytics (SQL DW) noParallel Data Warehouse APPLIES TO: yesSQL Server noAzure SQL Database noAzure Synapse Analytics (SQL DW) noParallel Data Warehouse

既存のプロキシのプロパティを変更します。Changes the properties of an existing proxy.

トピック リンク アイコン Transact-SQL 構文表記規則Topic link icon Transact-SQL Syntax Conventions

構文Syntax

  
sp_update_proxy   
    [ @proxy_id = ] id,  
    [ @proxy_name = ] 'proxy_name',  
    [ @credential_name = ] 'credential_name' ,  
    [ @credential_id = ] credential_id ,  
    [ @new_name = ] 'new_name' ,  
    [ @enabled = ] is_enabled ,  
    [ @description = ] 'description'  

引数Arguments

変更するプロキシのプロキシ識別番号を [ @proxy_id = ] id します。[ @proxy_id = ] id The proxy identification number of the proxy to change. Proxy_idint,、既定値は NULL です。The proxy_id is int, with a default of NULL.

変更するプロキシの名前 [ @proxy_name = ] 'proxy_name' ます。[ @proxy_name = ] 'proxy_name' The name of the proxy to change. Proxy_namesysnameで、既定値は NULL です。The proxy_name is sysname, with a default of NULL.

プロキシの新しい資格情報の名前 [ @credential_name = ] 'credential_name' ます。[ @credential_name = ] 'credential_name' The name of the new credential for the proxy. Credential_namesysnameで、既定値は NULL です。The credential_name is sysname, with a default of NULL. Credential_nameまたはcredential_idのいずれかを指定できます。Either credential_name or credential_id may be specified.

プロキシの新しい資格情報の識別番号を [ @credential_id = ] credential_id します。[ @credential_id = ] credential_id The identification number of the new credential for the proxy. Credential_idint,、既定値は NULL です。The credential_id is int, with a default of NULL. Credential_nameまたはcredential_idのいずれかを指定できます。Either credential_name or credential_id may be specified.

プロキシの新しい名前を [ @new_name = ] 'new_name' します。[ @new_name = ] 'new_name' The new name of the proxy. New_namesysnameで、既定値は NULL です。The new_name is sysname, with a default of NULL. このプロシージャを指定すると、プロキシの名前がnew_nameに変更されます。When provided, the procedure changes the name of the proxy to new_name. この引数が NULL の場合、プロキシの名前は変更されません。When this argument is NULL, the name of the proxy remains unchanged.

プロキシが有効になっているかどうか [ @enabled = ] is_enabled ます。[ @enabled = ] is_enabled Is whether the proxy is enabled. Is_enabledフラグはtinyint,、既定値は NULL です。The is_enabled flag is tinyint, with a default of NULL. Is_enabled0の場合、プロキシは有効ではなく、ジョブステップでは使用できません。When is_enabled is 0, the proxy is not enabled, and cannot be used by a job step. この引数が NULL の場合、プロキシの状態は変更されません。When this argument is NULL, the status of the proxy remains unchanged.

プロキシの新しい説明を [ @description = ] 'description' します。[ @description = ] 'description' The new description of the proxy. 説明nvarchar (512) ,、既定値は NULL です。The description is nvarchar(512), with a default of NULL. この引数が NULL の場合、プロキシの説明は変更されません。When this argument is NULL, the description of the proxy remains unchanged.

リターン コードの値Return Code Values

0 (成功) または1 (失敗)0 (success) or 1 (failure)

RemarksRemarks

@proxy_nameまたは @proxy_idのいずれかを指定する必要があります。Either @proxy_name or @proxy_id must be specified. 両方の引数を指定する場合は、両方とも同じプロキシを参照する必要があります。異なるプロキシを参照する場合、ストアド プロシージャは失敗します。If both arguments are specified, the arguments must both refer to the same proxy or the stored procedure fails.

プロキシの資格情報を変更するには、 @credential_nameまたは @credential_idのいずれかを指定する必要があります。Either @credential_name or @credential_id must be specified to change the credential for the proxy. 両方の引数を指定する場合は、両方とも同じ資格情報を参照する必要があります。異なる資格情報を参照する場合、ストアド プロシージャは失敗します。If both arguments are specified, the arguments must refer to the same credential or the stored procedure fails.

このプロシージャでプロキシが変更されますが、プロキシへのアクセスは変更されません。This procedure changes the proxy, but does not change access to the proxy. プロキシへのアクセスを変更するには、 sp_grant_login_to_proxysp_revoke_login_from_proxyを使用します。To change access to a proxy, use sp_grant_login_to_proxy and sp_revoke_login_from_proxy.

アクセス許可Permissions

このプロシージャを実行できるのは、 sysadmin固定セキュリティロールのメンバーだけです。Only members of the sysadmin fixed security role can execute this procedure.

使用例Examples

次の例では、プロキシ Catalog application proxy の enabled の値を 0 に設定します。The following example sets the enabled value for the proxy Catalog application proxy to 0.

USE msdb ;  
GO  
  
EXEC dbo.sp_update_proxy  
    @proxy_name = 'Catalog application proxy',  
    @enabled = 0;  
GO  

参照See Also

ストアドプロシージャ(transact-sql )の SQL Server エージェントSQL Server Agent Stored Procedures (Transact-SQL)
SQL Server エージェントセキュリティ を実装するImplement SQL Server Agent Security
transact-sql ( の) sp_add_proxysp_add_proxy (Transact-SQL)
transact-sql ( の) sp_delete_proxysp_delete_proxy (Transact-SQL)
transact-sql ( の) sp_grant_login_to_proxysp_grant_login_to_proxy (Transact-SQL)
sp_revoke_login_from_proxy (transact-sql)sp_revoke_login_from_proxy (Transact-SQL)