sp_update_proxy (Transact-SQL)
既存のプロキシのプロパティを変更します。
構文
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'
引数
[ @proxy_id= ] id
変更するプロキシのプロキシ識別番号を指定します。proxy_id のデータ型は int で、既定値は NULL です。
[ @proxy_name= ] 'proxy_name'
変更するプロキシの名前を指定します。proxy_name のデータ型は sysname で、既定値は NULL です。
[ @credential_name = ] 'credential_name'
プロキシの新しい資格情報の名前を指定します。credential_name のデータ型は sysname で、既定値は NULL です。credential_name または credential_id のいずれかを指定できます。
[ @credential_id = ] credential_id
プロキシの新しい資格情報の識別番号を指定します。credential_id のデータ型は int で、既定値は NULL です。credential_name または credential_id のいずれかを指定できます。
[ @new_name= ] 'new_name'
プロキシの新しい名前を指定します。new_name のデータ型は sysname で、既定値は NULL です。指定した場合は、このプロシージャによってプロキシの名前が new_name に変更されます。この引数が NULL の場合、プロキシの名前は変更されません。
[ @enabled = ] is_enabled
プロキシが有効かどうかを指定します。is_enabled フラグのデータ型は tinyint で、既定値は NULL です。is_enabled が 0 の場合、プロキシは有効でなく、ジョブ ステップで使用できません。この引数が NULL の場合、プロキシの状態は変更されません。
[ @description = ] 'description'
プロキシの新しい説明を指定します。description のデータ型は nvarchar(512) で、既定値は NULL です。この引数が NULL の場合、プロキシの説明は変更されません。
解説
@proxy_name または @proxy_id のいずれかを指定する必要があります。両方の引数を指定する場合は、両方とも同じプロキシを参照する必要があります。異なるプロキシを参照する場合、ストアド プロシージャは失敗します。
プロキシの資格情報を変更するには、@credential_name または @credential_id を指定する必要があります。両方の引数を指定する場合は、両方とも同じ資格情報を参照する必要があります。異なる資格情報を参照する場合、ストアド プロシージャは失敗します。
このプロシージャでプロキシが変更されますが、プロキシへのアクセスは変更されません。プロキシへのアクセスを変更するには、sp_grant_login_to_proxy および sp_revoke_login_from_proxy を使用します。
権限
このプロシージャを実行できるのは、sysadmin 固定セキュリティ ロールのメンバだけです。
戻り値
0 (成功) または 1 (失敗)
例
次の例では、プロキシ Catalog application proxy
の enabled の値を 0
に設定します。
USE msdb ;
GO
EXEC dbo.sp_update_proxy
@proxy_name = 'Catalog application proxy',
@enabled = 0;
GO
参照
関連項目
sp_add_proxy (Transact-SQL)
sp_delete_proxy (Transact-SQL)
sp_grant_login_to_proxy (Transact-SQL)
sp_revoke_login_from_proxy (Transact-SQL)