SecretClient 클래스

참조

자격 증명 모음의 비밀을 관리하기 위한 개략적인 인터페이스입니다.

상속: azure.keyvault.secrets._shared.client_base.KeyVaultClientBase

SecretClient

생성자

SecretClient(vault_url: str, credential: TokenCredential, **kwargs)

매개 변수

vault_url: str

필수

클라이언트가 액세스할 자격 증명 모음의 URL입니다. 이를 자격 증명 모음의 "DNS 이름"이라고도 합니다. 이 URL이 유효한 Key Vault 리소스를 참조하는지 확인해야 합니다. 자세한 내용은 https://aka.ms/azsdk/blog/vault-uri를 참조하세요.

credential: TokenCredential

필수

자격 증명 모음에 대한 액세스 토큰을 제공할 수 있는 개체(예: 의 자격 증명) identity

api_version: ApiVersion

사용할 서비스 API의 버전입니다. 기본값은 가장 최근으로 설정됩니다.

verify_challenge_resource: bool

인증 챌린지 리소스가 Key Vault 도메인과 일치하는지 여부를 확인합니다. 기본값은 True입니다.

메서드

backup_secret	Azure Key Vault 사용할 수 있는 보호된 형식으로 비밀을 백업합니다. 비밀/백업 권한이 필요합니다.
begin_delete_secret	비밀의 모든 버전을 삭제합니다. 비밀/삭제 권한이 필요합니다. 이 메서드가 반환될 때 Key Vault 비밀을 삭제하기 시작했습니다. 일시 삭제를 사용하도록 설정된 자격 증명 모음에서 삭제하는 데 몇 초 정도 걸릴 수 있습니다. 따라서 이 메서드는 삭제가 완료되기를 기다릴 수 있는 폴러를 반환합니다.
begin_recover_deleted_secret	삭제된 비밀을 최신 버전으로 복구합니다. 일시 삭제가 사용하도록 설정된 자격 증명 모음에서만 가능합니다. 비밀/복구 권한이 필요합니다. 자격 증명 모음에 일시 삭제를 사용하도록 설정 begin_delete_secret 하지 않은 경우 는 영구적이며 이 메서드는 오류를 반환합니다. 삭제되지 않은 비밀을 복구하려고 하면 오류가 반환됩니다. 이 메서드가 반환되면 Key Vault 비밀을 복구하기 시작했습니다. 복구에는 몇 초 정도 걸릴 수 있습니다. 따라서 이 메서드는 복구가 완료되기를 기다릴 수 있는 폴러를 반환합니다. 다른 작업에서 복구된 비밀을 즉시 사용하려는 경우에만 대기가 필요합니다.
close	클라이언트에서 연 소켓을 닫습니다. 클라이언트를 컨텍스트 관리자로 사용할 때는 이 메서드를 호출할 필요가 없습니다.
get_deleted_secret	삭제된 비밀을 가져옵니다. 일시 삭제가 사용하도록 설정된 자격 증명 모음에서만 가능합니다. 비밀/가져오기 권한이 필요합니다.
get_secret	비밀을 가져옵니다. 암호/가져오기 권한이 필요합니다.
list_deleted_secrets	삭제된 모든 비밀을 나열합니다. 일시 삭제가 사용하도록 설정된 자격 증명 모음에서만 가능합니다. 비밀/목록 권한이 필요합니다.
list_properties_of_secret_versions	해당 값을 제외한 모든 버전의 비밀에 대한 속성을 나열합니다. 비밀/목록 권한이 필요합니다. 목록 항목에는 비밀 값이 포함되지 않습니다. 를 사용하여 get_secret 비밀의 값을 가져옵니다.
list_properties_of_secrets	자격 증명 모음에 있는 모든 비밀의 식별자 및 특성을 나열합니다. 비밀/목록 권한이 필요합니다. 목록 항목에는 비밀 값이 포함되지 않습니다. 를 사용하여 get_secret 비밀의 값을 가져옵니다.
purge_deleted_secret	삭제된 비밀을 영구적으로 삭제합니다. 일시 삭제가 사용하도록 설정된 자격 증명 모음에서만 가능합니다. 복구할 가능성 없이 지정된 비밀을 되돌릴 수 없는 삭제를 수행합니다. 이 '제거 가능'을 recovery_level 지정하지 않으면 작업을 사용할 수 없습니다. 이 메서드는 앞에 비밀을 scheduled_purge_date제거하는 데만 필요합니다. 비밀/제거 권한이 필요합니다.
restore_secret_backup	백업된 비밀을 복원합니다. 비밀/복원 권한이 필요합니다.
send_request	클라이언트의 기존 파이프라인을 사용하여 네트워크 요청을 실행합니다. 요청 URL은 자격 증명 모음 URL을 기준으로 할 수 있습니다. 요청에 사용되는 서비스 API 버전은 달리 지정하지 않는 한 클라이언트의 버전과 동일합니다. 응답이 오류인 경우 이 메서드는 발생하지 않습니다. 예외를 발생하려면 반환된 응답 개체에서 raise_for_status() 를 호출합니다. 이 메서드를 사용하여 사용자 지정 요청을 보내는 방법에 대한 자세한 내용은 을 참조하세요 https://aka.ms/azsdk/dpcodegen/python/send_request.
set_secret	비밀 값을 설정합니다. 이름이 사용 중인 경우 새 버전의 비밀을 만듭니다. 그렇지 않은 경우 새 비밀을 만듭니다. 비밀/설정 권한이 필요합니다.
update_secret_properties	해당 값이 아닌 비밀의 속성을 업데이트합니다. 비밀/설정 권한이 필요합니다. 이 메서드는 비밀의 속성(예: 암호 사용 여부)을 업데이트하지만 비밀의 값을 변경할 수는 없습니다. 를 사용하여 set_secret 비밀의 값을 변경합니다.

backup_secret

Azure Key Vault 사용할 수 있는 보호된 형식으로 비밀을 백업합니다. 비밀/백업 권한이 필요합니다.

backup_secret(name: str, **kwargs) -> bytes

매개 변수

name: str

필수

백업할 비밀의 이름

반환 형식

bytes

예외

ResourceNotFoundError

비밀이 없으면

HttpResponseError

기타 오류의 경우

begin_delete_secret

비밀의 모든 버전을 삭제합니다. 비밀/삭제 권한이 필요합니다.

이 메서드가 반환될 때 Key Vault 비밀을 삭제하기 시작했습니다. 일시 삭제를 사용하도록 설정된 자격 증명 모음에서 삭제하는 데 몇 초 정도 걸릴 수 있습니다. 따라서 이 메서드는 삭제가 완료되기를 기다릴 수 있는 폴러를 반환합니다.

begin_delete_secret(name: str, **kwargs) -> LROPoller[DeletedSecret]

매개 변수

name: str

필수

삭제할 비밀의 이름입니다.

반환

삭제 작업에 대한 폴러입니다. 폴러의 결과 메서드는 삭제가 DeletedSecret 완료 될 때까지 기다리지 않고 를 반환합니다. 자격 증명 모음에 일시 삭제가 사용하도록 설정되어 있고 를 사용하여 비밀을 purge_deleted_secret영구적으로 삭제하려는 경우 먼저 폴러의 대기 메서드를 호출합니다. 삭제가 완료될 때까지 차단됩니다. 대기 메서드에는 비밀/가져오기 권한이 필요합니다.

반환 형식

LROPoller[DeletedSecret]

예외

ResourceNotFoundError

비밀이 없으면

HttpResponseError

기타 오류의 경우

begin_recover_deleted_secret

삭제된 비밀을 최신 버전으로 복구합니다. 일시 삭제가 사용하도록 설정된 자격 증명 모음에서만 가능합니다.

비밀/복구 권한이 필요합니다. 자격 증명 모음에 일시 삭제를 사용하도록 설정 begin_delete_secret 하지 않은 경우 는 영구적이며 이 메서드는 오류를 반환합니다. 삭제되지 않은 비밀을 복구하려고 하면 오류가 반환됩니다. 이 메서드가 반환되면 Key Vault 비밀을 복구하기 시작했습니다. 복구에는 몇 초 정도 걸릴 수 있습니다. 따라서 이 메서드는 복구가 완료되기를 기다릴 수 있는 폴러를 반환합니다. 다른 작업에서 복구된 비밀을 즉시 사용하려는 경우에만 대기가 필요합니다.

begin_recover_deleted_secret(name: str, **kwargs) -> LROPoller[SecretProperties]

매개 변수

name: str

필수

복구할 삭제된 비밀의 이름

반환

복구 작업에 대한 폴러입니다. 폴러의 결과 메서드는 복구가 완료될 때까지 기다리지 않고 복구된 비밀을 SecretProperties 반환합니다. 복구된 비밀을 즉시 사용하려면 비밀이 사용할 준비가 될 때까지 차단하는 폴러의 대기 메서드를 호출합니다. 대기 메서드에는 비밀/가져오기 권한이 필요합니다.

반환 형식

LROPoller[SecretProperties]

예외

HttpResponseError

close

클라이언트에서 연 소켓을 닫습니다.

클라이언트를 컨텍스트 관리자로 사용할 때는 이 메서드를 호출할 필요가 없습니다.

close() -> None

예외

ResourceNotFoundError

비밀이 없으면

HttpResponseError

기타 오류의 경우

get_deleted_secret

삭제된 비밀을 가져옵니다. 일시 삭제가 사용하도록 설정된 자격 증명 모음에서만 가능합니다. 비밀/가져오기 권한이 필요합니다.

get_deleted_secret(name: str, **kwargs) -> DeletedSecret

매개 변수

name: str

필수

삭제된 비밀의 이름

반환 형식

DeletedSecret

예외

ResourceNotFoundError

삭제된 비밀이 없으면

HttpResponseError

기타 오류의 경우

get_secret

비밀을 가져옵니다. 암호/가져오기 권한이 필요합니다.

get_secret(name: str, version: str | None = None, **kwargs) -> KeyVaultSecret

매개 변수

name: str

필수

비밀의 이름

version: str

필수

(선택 사항) 가져올 비밀의 버전입니다. 지정되지 않은 경우 최신 버전을 가져옵니다.

반환 형식

KeyVaultSecret

예외

ResourceNotFoundError

비밀이 없으면

HttpResponseError

기타 오류의 경우

list_deleted_secrets

삭제된 모든 비밀을 나열합니다. 일시 삭제가 사용하도록 설정된 자격 증명 모음에서만 가능합니다.

비밀/목록 권한이 필요합니다.

list_deleted_secrets(**kwargs) -> ItemPaged[DeletedSecret]

반환

삭제된 비밀의 반복기(해당 값 제외)

반환 형식

ItemPaged[DeletedSecret]

예외

ResourceNotFoundError

비밀이 없으면

HttpResponseError

기타 오류의 경우

list_properties_of_secret_versions

해당 값을 제외한 모든 버전의 비밀에 대한 속성을 나열합니다. 비밀/목록 권한이 필요합니다.

목록 항목에는 비밀 값이 포함되지 않습니다. 를 사용하여 get_secret 비밀의 값을 가져옵니다.

list_properties_of_secret_versions(name: str, **kwargs) -> ItemPaged[SecretProperties]

매개 변수

name: str

필수

비밀의 이름

반환

해당 값을 제외한 비밀의 반복기

반환 형식

ItemPaged[SecretProperties]

예외

ResourceNotFoundError

비밀이 없으면

HttpResponseError

기타 오류의 경우

list_properties_of_secrets

자격 증명 모음에 있는 모든 비밀의 식별자 및 특성을 나열합니다. 비밀/목록 권한이 필요합니다.

목록 항목에는 비밀 값이 포함되지 않습니다. 를 사용하여 get_secret 비밀의 값을 가져옵니다.

list_properties_of_secrets(**kwargs) -> ItemPaged[SecretProperties]

반환

해당 값을 제외한 비밀의 반복기

반환 형식

ItemPaged[SecretProperties]

예외

ResourceNotFoundError

비밀이 없으면

HttpResponseError

기타 오류의 경우

purge_deleted_secret

삭제된 비밀을 영구적으로 삭제합니다. 일시 삭제가 사용하도록 설정된 자격 증명 모음에서만 가능합니다.

복구할 가능성 없이 지정된 비밀을 되돌릴 수 없는 삭제를 수행합니다. 이 '제거 가능'을 recovery_level 지정하지 않으면 작업을 사용할 수 없습니다. 이 메서드는 앞에 비밀을 scheduled_purge_date제거하는 데만 필요합니다.

비밀/제거 권한이 필요합니다.

purge_deleted_secret(name: str, **kwargs) -> None

매개 변수

name: str

필수

삭제할 삭제된 비밀의 이름

반환

없음

예외

HttpResponseError

예제


   # if the vault has soft-delete enabled, purge permanently deletes the secret
   # (with soft-delete disabled, begin_delete_secret is permanent)
   secret_client.purge_deleted_secret("secret-name")

restore_secret_backup

백업된 비밀을 복원합니다. 비밀/복원 권한이 필요합니다.

restore_secret_backup(backup: bytes, **kwargs) -> SecretProperties

매개 변수

backup: bytes

필수

에서 반환한 비밀 백업 backup_secret

반환

복원된 비밀

반환 형식

SecretProperties

예외

ResourceExistsError

비밀의 이름이 이미 사용 중이면

HttpResponseError

기타 오류의 경우

send_request

클라이언트의 기존 파이프라인을 사용하여 네트워크 요청을 실행합니다.

요청 URL은 자격 증명 모음 URL을 기준으로 할 수 있습니다. 요청에 사용되는 서비스 API 버전은 달리 지정하지 않는 한 클라이언트의 버전과 동일합니다. 응답이 오류인 경우 이 메서드는 발생하지 않습니다. 예외를 발생하려면 반환된 응답 개체에서 raise_for_status() 를 호출합니다. 이 메서드를 사용하여 사용자 지정 요청을 보내는 방법에 대한 자세한 내용은 을 참조하세요 https://aka.ms/azsdk/dpcodegen/python/send_request.

send_request(request: HttpRequest, *, stream: bool = False, **kwargs) -> HttpResponse

매개 변수

request: HttpRequest

필수

만들려는 네트워크 요청입니다.

stream: bool

응답 페이로드가 스트리밍될지 여부입니다. 기본값은 False입니다.

반환

네트워크 호출의 응답입니다. 응답에 대한 오류 처리는 수행하지 않습니다.

반환 형식

HttpResponse

예외

ResourceNotFoundError

비밀이 없으면

HttpResponseError

기타 오류의 경우

set_secret

비밀 값을 설정합니다. 이름이 사용 중인 경우 새 버전의 비밀을 만듭니다. 그렇지 않은 경우 새 비밀을 만듭니다.

비밀/설정 권한이 필요합니다.

set_secret(name: str, value: str, **kwargs) -> KeyVaultSecret

매개 변수

name: str

필수

비밀의 이름

value: str

필수

비밀의 값

enabled: bool

비밀을 사용할 수 있는지 여부입니다.

tags: Dict[str, str] 또는 None

키/값 쌍 형식의 애플리케이션 특정 메타데이터입니다.

content_type: str

비밀의 형식을 나타내는 임의의 문자열(예: 'password')

not_before: datetime

비밀 날짜(UTC) 이전이 아님

expires_on: datetime

비밀의 만료 날짜(UTC)

반환 형식

KeyVaultSecret

예외

HttpResponseError

update_secret_properties

해당 값이 아닌 비밀의 속성을 업데이트합니다. 비밀/설정 권한이 필요합니다.

이 메서드는 비밀의 속성(예: 암호 사용 여부)을 업데이트하지만 비밀의 값을 변경할 수는 없습니다. 를 사용하여 set_secret 비밀의 값을 변경합니다.

update_secret_properties(name: str, version: str | None = None, **kwargs) -> SecretProperties

매개 변수

name: str

필수

비밀의 이름

version: str

필수

(선택 사항) 업데이트할 비밀의 버전입니다. 지정하지 않으면 최신 버전이 업데이트됩니다.

enabled: bool

비밀을 사용할 수 있는지 여부입니다.

tags: Dict[str, str] 또는 None

키/값 쌍 형식의 애플리케이션 특정 메타데이터입니다.

content_type: str

비밀의 형식을 나타내는 임의의 문자열(예: 'password')

not_before: datetime

비밀 날짜(UTC) 이전이 아님

expires_on: datetime

비밀의 만료 날짜(UTC)

반환 형식

SecretProperties

예외

ResourceNotFoundError

비밀이 없으면

HttpResponseError

기타 오류의 경우

다음을 통해 공유

SecretClient 클래스

생성자

매개 변수

메서드

backup_secret

매개 변수

반환 형식

예외

begin_delete_secret

매개 변수

반환

반환 형식

예외

begin_recover_deleted_secret

매개 변수

반환

반환 형식

예외

close

예외

get_deleted_secret

매개 변수

반환 형식

예외

get_secret

매개 변수

반환 형식

예외

list_deleted_secrets

반환

반환 형식

예외

list_properties_of_secret_versions

매개 변수

반환

반환 형식

예외

list_properties_of_secrets

반환

반환 형식

예외

purge_deleted_secret

매개 변수

반환

예외

예제

restore_secret_backup

매개 변수

반환

반환 형식

예외

send_request

매개 변수

반환

반환 형식

예외

set_secret

매개 변수

반환 형식

예외

update_secret_properties

매개 변수

반환 형식

예외

특성

vault_url

추가 리소스