Share via

KeyClient 클래스

  • 참조

자격 증명 모음의 키를 관리하기 위한 상위 수준 인터페이스입니다.

상속
azure.keyvault.keys._shared.client_base.KeyVaultClientBase
KeyClient

생성자

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

매개 변수

vault_url
str
필수

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

credential
TokenCredential
필수

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

api_version
ApiVersion

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

verify_challenge_resource
bool

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

메서드

backup_key

Azure Key Vault 사용할 수 있는 보호된 형식으로 키를 백업합니다.

키/백업 권한이 필요합니다.

이는 한 자격 증명 모음에서 다른 자격 증명 모음으로 키를 복사할 수 있도록 하기 위한 것입니다. 두 자격 증명 모음은 모두 동일한 Azure 구독에서 소유해야 합니다. 또한 백업/복원은 지정학적 경계를 넘어 수행할 수 없습니다. 예를 들어 미국 지역의 자격 증명 모음에서 백업을 EU 지역의 자격 증명 모음으로 복원할 수 없습니다.
begin_delete_key

키 및 해당 암호화 자료의 모든 버전을 삭제합니다.

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

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

키/복구 권한이 필요합니다.

이 메서드가 반환될 때 Key Vault 키를 복구하기 시작했습니다. 복구에는 몇 초 정도 걸릴 수 있습니다. 따라서 이 메서드는 복구가 완료되기를 기다릴 수 있는 폴러를 반환합니다. 다른 작업에서 복구된 키를 즉시 사용하려는 경우에만 대기가 필요합니다.
close

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

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

새 타원 곡선 키를 만들거나 가 이미 사용 중인 경우 name 새 버전의 키를 만듭니다.

키/만들기 권한이 필요합니다.
create_key

키를 만들거나 가 이미 사용 중인 경우 name 새 버전의 키를 만듭니다.

키/만들기 권한이 필요합니다.
create_oct_key

새 8진수 시퀀스(대칭) 키를 만들거나 가 사용 중인 경우 name 새 버전의 키를 만듭니다.

키/만들기 권한이 필요합니다.
create_rsa_key

새 RSA 키를 만들거나 이미 사용 중인 경우 name 새 버전의 키를 만듭니다.

키/만들기 권한이 필요합니다.
get_cryptography_client

CryptographyClient 지정된 키에 대한 를 가져옵니다.
get_deleted_key

삭제된 키를 가져옵니다. 일시 삭제가 사용하도록 설정된 자격 증명 모음에서만 가능합니다.

키/가져오기 권한이 필요합니다.
get_key

키의 특성을 가져와서 비대칭 키인 경우 공개 자료를 가져옵니다.

키/가져오기 권한이 필요합니다.
get_key_rotation_policy

Key Vault 키의 회전 정책을 가져옵니다.
get_random_bytes

관리되는 HSM에서 요청된 임의 바이트 수를 가져옵니다.
import_key

외부에서 만든 키를 가져옵니다.

키/가져오기 권한이 필요합니다. 가 이미 사용 중인 경우 name 키를 새 버전으로 가져옵니다.
list_deleted_keys

각 의 공개 부분을 포함하여 삭제된 모든 키를 나열합니다. 일시 삭제가 사용하도록 설정된 자격 증명 모음에서만 가능합니다.

키/목록 권한이 필요합니다.
list_properties_of_key_versions

키 버전의 식별자 및 속성을 나열합니다.

키/목록 권한이 필요합니다.
list_properties_of_keys

자격 증명 모음에 있는 모든 키의 식별자 및 속성을 나열합니다.

키/목록 권한이 필요합니다.
purge_deleted_key

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

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

키/제거 권한이 필요합니다.
release_key

키를 해제합니다.

릴리스 키 작업은 모든 키 형식에 적용할 수 있습니다. 대상 키는 내보낼 수 있는 것으로 표시되어야 합니다. 이 작업을 수행하려면 키/릴리스 권한이 필요합니다.
restore_key_backup

자격 증명 모음에 키 백업을 복원합니다.

키/복원 권한이 필요합니다.

이렇게 하면 이름, 특성 및 액세스 제어 정책을 사용하여 키의 모든 버전을 가져옵니다. 키 이름이 이미 사용 중인 경우 복원에 실패합니다. 또한 대상 자격 증명 모음은 원본 자격 증명 모음과 동일한 Microsoft Azure 구독에서 소유해야 합니다.
rotate_key

키의 새 버전을 생성하여 키 정책에 따라 키를 회전합니다.

이 작업을 수행하려면 키/회전 권한이 필요합니다.
send_request

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

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

키의 속성을 변경합니다(암호화 자료가 아님).

키/업데이트 권한이 필요합니다.
update_key_rotation_policy

Key Vault 키의 회전 정책을 업데이트.

이 작업을 수행하려면 키/업데이트 권한이 필요합니다.

backup_key

Azure Key Vault 사용할 수 있는 보호된 형식으로 키를 백업합니다.

키/백업 권한이 필요합니다.

이는 한 자격 증명 모음에서 다른 자격 증명 모음으로 키를 복사할 수 있도록 하기 위한 것입니다. 두 자격 증명 모음은 모두 동일한 Azure 구독에서 소유해야 합니다. 또한 백업/복원은 지정학적 경계를 넘어 수행할 수 없습니다. 예를 들어 미국 지역의 자격 증명 모음에서 백업을 EU 지역의 자격 증명 모음으로 복원할 수 없습니다.

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

매개 변수

name
str
필수

백업할 키의 이름

반환 형식

bytes

예외

ResourceNotFoundError

키가 없으면

HttpResponseError

기타 오류의 경우

begin_delete_key

키 및 해당 암호화 자료의 모든 버전을 삭제합니다.

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

begin_delete_key(name: str, **kwargs) -> LROPoller[DeletedKey]

매개 변수

name
str
필수

삭제할 키의 이름입니다.

반환

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

반환 형식

LROPoller[DeletedKey]

예외

ResourceNotFoundError

키가 없으면

HttpResponseError

기타 오류의 경우

begin_recover_deleted_key

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

키/복구 권한이 필요합니다.

이 메서드가 반환될 때 Key Vault 키를 복구하기 시작했습니다. 복구에는 몇 초 정도 걸릴 수 있습니다. 따라서 이 메서드는 복구가 완료되기를 기다릴 수 있는 폴러를 반환합니다. 다른 작업에서 복구된 키를 즉시 사용하려는 경우에만 대기가 필요합니다.

begin_recover_deleted_key(name: str, **kwargs) -> LROPoller[KeyVaultKey]

매개 변수

name
str
필수

복구할 삭제된 키의 이름

반환

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

반환 형식

LROPoller[KeyVaultKey]

예외

HttpResponseError

close

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

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

close() -> None

예외

ResourceNotFoundError

키가 없으면

HttpResponseError

기타 오류의 경우

create_ec_key

새 타원 곡선 키를 만들거나 가 이미 사용 중인 경우 name 새 버전의 키를 만듭니다.

키/만들기 권한이 필요합니다.

create_ec_key(name: str, **kwargs) -> KeyVaultKey

매개 변수

name
str
필수

새 키의 이름입니다.

curve
KeyCurveName 또는 str 또는 None

타원 곡선 이름입니다. 기본값은 NIST P-256 타원 곡선입니다.

key_operations
list[KeyOperation 또는 str] 또는 None

허용되는 키 작업

hardware_protected
bool 또는 None

하드웨어 보안 모듈에서 키를 만들어야 하는지 여부입니다. 기본값은 False입니다.

enabled
bool 또는 None

키를 사용할 수 있는지 여부입니다.

tags
dict[str, str] 또는 None

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

not_before
datetime 또는 None

UTC의 키 날짜 이전이 아님

expires_on
datetime 또는 None

키의 만료 날짜(UTC)

exportable
bool 또는 None

프라이빗 키를 내보낼 수 있는지 여부입니다.

release_policy
KeyReleasePolicy 또는 None

키를 내보낼 수 있는 정책 규칙입니다.

반환

만든 키

반환 형식

KeyVaultKey

예외

HttpResponseError

create_key

키를 만들거나 가 이미 사용 중인 경우 name 새 버전의 키를 만듭니다.

키/만들기 권한이 필요합니다.

create_key(name: str, key_type: str | KeyType, **kwargs) -> KeyVaultKey

매개 변수

name
str
필수

새 키의 이름입니다.

key_type
KeyType 또는 str
필수

만들 키의 유형

size
int 또는 None

키 크기(비트)입니다. RSA 및 대칭 키에만 적용됩니다. 또는 create_oct_key 를 대신 사용하는 create_rsa_key 것이 좋습니다.

curve
KeyCurveName 또는 str 또는 None

타원 곡선 이름입니다. 타원 곡선 키에만 적용됩니다. 기본값은 NIST P-256 타원 곡선입니다. 타원 곡선 키를 만들려면 대신 를 사용하는 create_ec_key 것이 좋습니다.

public_exponent
int 또는 None

사용할 RSA 공용 지수입니다. 관리형 HSM에서 만든 RSA 키에만 적용됩니다.

key_operations
list[KeyOperation 또는 str] 또는 None

허용되는 키 작업

enabled
bool 또는 None

키를 사용할 수 있는지 여부입니다.

tags
dict[str, str] 또는 None

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

not_before
datetime 또는 None

UTC의 키 날짜 이전이 아님

expires_on
datetime 또는 None

키의 만료 날짜(UTC)

exportable
bool 또는 None

프라이빗 키를 내보낼 수 있는지 여부입니다.

release_policy
KeyReleasePolicy 또는 None

키를 내보낼 수 있는 정책 규칙입니다.

반환

만든 키

반환 형식

KeyVaultKey

예외

HttpResponseError

create_oct_key

새 8진수 시퀀스(대칭) 키를 만들거나 가 사용 중인 경우 name 새 버전의 키를 만듭니다.

키/만들기 권한이 필요합니다.

create_oct_key(name: str, **kwargs) -> KeyVaultKey

매개 변수

name
str
필수

새 키의 이름입니다.

size
int 또는 None

키 크기(예: 128, 192 또는 256)입니다.

key_operations
list[KeyOperation 또는 str] 또는 None

허용되는 키 작업.

hardware_protected
bool 또는 None

하드웨어 보안 모듈에서 키를 만들어야 하는지 여부입니다. 기본값은 False입니다.

enabled
bool 또는 None

키를 사용할 수 있는지 여부입니다.

tags
dict[str, str] 또는 None

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

not_before
datetime 또는 None

UTC의 키 날짜 이전이 아님

expires_on
datetime 또는 None

키의 만료 날짜(UTC)

exportable
bool 또는 None

키를 내보낼 수 있는지 여부입니다.

release_policy
KeyReleasePolicy 또는 None

키를 내보낼 수 있는 정책 규칙입니다.

반환

만든 키

반환 형식

KeyVaultKey

예외

HttpResponseError

create_rsa_key

새 RSA 키를 만들거나 이미 사용 중인 경우 name 새 버전의 키를 만듭니다.

키/만들기 권한이 필요합니다.

create_rsa_key(name: str, **kwargs) -> KeyVaultKey

매개 변수

name
str
필수

새 키의 이름입니다.

size
int 또는 None

키 크기(예: 2048, 3072 또는 4096)입니다.

public_exponent
int 또는 None

사용할 RSA 공용 지수입니다. 관리형 HSM에서 만든 RSA 키에만 적용됩니다.

hardware_protected
bool 또는 None

하드웨어 보안 모듈에서 키를 만들어야 하는지 여부입니다. 기본값은 False입니다.

key_operations
list[KeyOperation 또는 str] 또는 None

허용되는 키 작업

enabled
bool 또는 None

키를 사용할 수 있는지 여부입니다.

tags
dict[str, str] 또는 None

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

not_before
datetime 또는 None

UTC에서 키의 날짜 이전이 아님

expires_on
datetime 또는 None

UTC로 된 키의 만료 날짜

exportable
bool 또는 None

프라이빗 키를 내보낼 수 있는지 여부입니다.

release_policy
KeyReleasePolicy 또는 None

키를 내보낼 수 있는 정책 규칙입니다.

반환

만든 키

반환 형식

KeyVaultKey

예외

HttpResponseError

get_cryptography_client

CryptographyClient 지정된 키에 대한 를 가져옵니다.

get_cryptography_client(key_name: str, **kwargs) -> CryptographyClient

매개 변수

key_name
str
필수

암호화 작업을 수행하는 데 사용되는 키의 이름입니다.

key_version
str

암호화 작업을 수행하는 데 사용되는 키의 선택적 버전입니다.

반환

CryptographyClient 이 KeyClient와 동일한 옵션, 자격 증명 및 HTTP 클라이언트를 사용하는 입니다.

반환 형식

CryptographyClient

예외

ResourceNotFoundError

키가 없으면

HttpResponseError

기타 오류의 경우

get_deleted_key

삭제된 키를 가져옵니다. 일시 삭제가 사용하도록 설정된 자격 증명 모음에서만 가능합니다.

키/가져오기 권한이 필요합니다.

get_deleted_key(name: str, **kwargs) -> DeletedKey

매개 변수

name
str
필수

키의 이름

반환

삭제된 키

반환 형식

DeletedKey

예외

ResourceNotFoundError

키가 없으면

HttpResponseError

기타 오류의 경우

get_key

키의 특성을 가져와서 비대칭 키인 경우 공개 자료를 가져옵니다.

키/가져오기 권한이 필요합니다.

get_key(name: str, version: str | None = None, **kwargs) -> KeyVaultKey

매개 변수

name
str
필수

가져올 키의 이름입니다.

version
str 또는 None
필수

(선택 사항) 가져올 키의 특정 버전입니다. 지정하지 않으면 키의 최신 버전을 가져옵니다.

반환 형식

KeyVaultKey

예외

ResourceNotFoundError

키가 없으면

HttpResponseError

기타 오류의 경우

get_key_rotation_policy

Key Vault 키의 회전 정책을 가져옵니다.

get_key_rotation_policy(key_name: str, **kwargs) -> KeyRotationPolicy

매개 변수

key_name
str
필수

키의 이름입니다.

반환

키 회전 정책입니다.

반환 형식

KeyRotationPolicy

예외

*azure.core.exceptions.HttpResponseError*

get_random_bytes

관리되는 HSM에서 요청된 임의 바이트 수를 가져옵니다.

get_random_bytes(count: int, **kwargs) -> bytes

매개 변수

count
int
필수

요청된 임의 바이트 수입니다.

반환

임의 바이트입니다.

반환 형식

bytes

예외

ValueError

임의 바이트가 1개 미만이 요청되면

HttpResponseError

기타 오류의 경우

import_key

외부에서 만든 키를 가져옵니다.

키/가져오기 권한이 필요합니다. 가 이미 사용 중인 경우 name 키를 새 버전으로 가져옵니다.

import_key(name: str, key: JsonWebKey, **kwargs) -> KeyVaultKey

매개 변수

name
str
필수

가져온 키의 이름

key
JsonWebKey
필수

가져올 JSON 웹 키

hardware_protected
bool 또는 None

하드웨어 보안 모듈에서 키를 백업해야 하는지 여부

enabled
bool 또는 None

키를 사용할 수 있는지 여부입니다.

tags
dict[str, str] 또는 None

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

not_before
datetime 또는 None

UTC에서 키의 날짜 이전이 아님

expires_on
datetime 또는 None

UTC로 된 키의 만료 날짜

exportable
bool 또는 None

프라이빗 키를 내보낼 수 있는지 여부입니다.

release_policy
KeyReleasePolicy 또는 None

키를 내보낼 수 있는 정책 규칙입니다.

반환

가져온 키

반환 형식

KeyVaultKey

예외

HttpResponseError

list_deleted_keys

각 의 공개 부분을 포함하여 삭제된 모든 키를 나열합니다. 일시 삭제가 사용하도록 설정된 자격 증명 모음에서만 가능합니다.

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

list_deleted_keys(**kwargs) -> ItemPaged[DeletedKey]

반환

삭제된 키의 반복기

반환 형식

ItemPaged[DeletedKey]

예외

ResourceNotFoundError

키가 없으면

HttpResponseError

기타 오류의 경우

list_properties_of_key_versions

키 버전의 식별자 및 속성을 나열합니다.

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

list_properties_of_key_versions(name: str, **kwargs) -> ItemPaged[KeyProperties]

매개 변수

name
str
필수

키의 이름

반환

암호화 자료가 없는 키의 반복기

반환 형식

ItemPaged[KeyProperties]

예외

ResourceNotFoundError

키가 없으면

HttpResponseError

기타 오류의 경우

list_properties_of_keys

자격 증명 모음에 있는 모든 키의 식별자 및 속성을 나열합니다.

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

list_properties_of_keys(**kwargs) -> ItemPaged[KeyProperties]

반환

암호화 자료 또는 버전 정보가 없는 키의 반복기

반환 형식

ItemPaged[KeyProperties]

예외

ResourceNotFoundError

키가 없으면

HttpResponseError

기타 오류의 경우

purge_deleted_key

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

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

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

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

매개 변수

name
str
필수

제거할 삭제된 키의 이름입니다.

반환

없음

예외

HttpResponseError

예제


   # if the vault has soft-delete enabled, purge permanently deletes a deleted key
   # (with soft-delete disabled, begin_delete_key is permanent)
   key_client.purge_deleted_key("key-name")

release_key

키를 해제합니다.

릴리스 키 작업은 모든 키 형식에 적용할 수 있습니다. 대상 키는 내보낼 수 있는 것으로 표시되어야 합니다. 이 작업을 수행하려면 키/릴리스 권한이 필요합니다.

release_key(name: str, target_attestation_token: str, **kwargs) -> ReleaseKeyResult

매개 변수

name
str
필수

가져올 키의 이름입니다.

target_attestation_token
str
필수

키 릴리스의 대상에 대한 증명 어설션입니다.

version
str 또는 None

릴리스할 키의 특정 버전입니다. 지정되지 않은 경우 최신 버전이 릴리스됩니다.

algorithm
str 또는 KeyExportEncryptionAlgorithm 또는 None

릴리스된 키 자료를 보호하는 데 사용할 암호화 알고리즘입니다.

nonce
str 또는 None

새로 고침을 위해 클라이언트에서 제공하는 nonce입니다.

반환

키 릴리스의 결과입니다.

반환 형식

ReleaseKeyResult

예외

HttpResponseError

restore_key_backup

자격 증명 모음에 키 백업을 복원합니다.

키/복원 권한이 필요합니다.

이렇게 하면 이름, 특성 및 액세스 제어 정책을 사용하여 키의 모든 버전을 가져옵니다. 키 이름이 이미 사용 중인 경우 복원에 실패합니다. 또한 대상 자격 증명 모음은 원본 자격 증명 모음과 동일한 Microsoft Azure 구독에서 소유해야 합니다.

restore_key_backup(backup: bytes, **kwargs) -> KeyVaultKey

매개 변수

backup
bytes
필수

에서 반환한 키 백업 backup_key

반환

복원된 키

반환 형식

KeyVaultKey

예외

ResourceExistsError

백업된 키의 이름이 이미 사용 중인 경우

HttpResponseError

기타 오류의 경우

rotate_key

키의 새 버전을 생성하여 키 정책에 따라 키를 회전합니다.

이 작업을 수행하려면 키/회전 권한이 필요합니다.

rotate_key(name: str, **kwargs) -> KeyVaultKey

매개 변수

name
str
필수

회전할 키의 이름입니다.

반환

회전된 키의 새 버전입니다.

반환 형식

KeyVaultKey

예외

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

기타 오류의 경우

update_key_properties

키의 속성을 변경합니다(암호화 자료가 아님).

키/업데이트 권한이 필요합니다.

update_key_properties(name: str, version: str | None = None, **kwargs) -> KeyVaultKey

매개 변수

name
str
필수

업데이트할 키의 이름

version
str 또는 None
필수

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

key_operations
list[KeyOperation 또는 str] 또는 None

허용되는 키 작업

enabled
bool 또는 None

키를 사용할 수 있는지 여부입니다.

tags
dict[str, str] 또는 None

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

not_before
datetime 또는 None

UTC의 키 날짜 이전이 아님

expires_on
datetime 또는 None

키의 만료 날짜(UTC)

release_policy
KeyReleasePolicy 또는 None

키를 내보낼 수 있는 정책 규칙입니다.

반환

업데이트된 키

반환 형식

KeyVaultKey

예외

ResourceNotFoundError

키가 없으면

HttpResponseError

기타 오류의 경우

update_key_rotation_policy

Key Vault 키의 회전 정책을 업데이트.

이 작업을 수행하려면 키/업데이트 권한이 필요합니다.

update_key_rotation_policy(key_name: str, policy: KeyRotationPolicy, **kwargs) -> KeyRotationPolicy

매개 변수

key_name
str
필수

지정된 자격 증명 모음에 있는 키의 이름입니다.

policy
KeyRotationPolicy
필수

키에 대한 새 회전 정책입니다.

lifetime_actions
list[KeyRotationLifetimeAction]

키의 수명 동안 Key Vault 수행할 작업입니다. 그러면 제공된 의 수명 작업이 재정의됩니다 policy.

expires_in
str

ISO 8601 기간으로 정의된 새 키 버전에 적용되는 정책의 만료 시간입니다. 예를 들어 90일은 "P90D", 3개월은 "P3M", 48시간은 "PT48H"입니다. ISO 8601 기간에 대한 자세한 내용은 Wikipedia 를 참조하세요. 그러면 제공된 의 만료 시간이 재정의됩니다 policy.

반환

업데이트된 회전 정책입니다.

반환 형식

KeyRotationPolicy

예외

HttpResponseError

특성

vault_url