ShareFileClient 클래스

참조

특정 파일과 상호 작용하는 클라이언트이지만 해당 파일은 아직 존재하지 않을 수 있습니다.

추가 선택적 구성을 보려면 여기를 클릭하세요.

상속: azure.storage.fileshare._shared.base_client.StorageAccountHostsMixin

ShareFileClient

생성자

ShareFileClient(account_url: str, share_name: str, file_path: str, snapshot: str | Dict[str, Any] | None = None, credential: str | Dict[str, str] | AzureNamedKeyCredential | AzureSasCredential | TokenCredential | None = None, *, token_intent: Literal['backup'] | None = None, **kwargs: Any)

매개 변수

account_url: str

필수

스토리지 계정에 대한 URI입니다. 파일에 대한 전체 URI가 지정된 클라이언트를 만들려면 classmethod를 from_file_url 사용합니다.

share_name: str

필수

파일의 공유 이름입니다.

file_path: str

필수

상호 작용할 파일의 파일 경로입니다. 지정된 경우 이 값은 파일 URL에 지정된 파일 값을 재정의합니다.

snapshot: str

기본값: None

작동할 선택적 파일 스냅샷. 스냅샷 ID 문자열 또는 에서 create_snapshot반환된 응답일 수 있습니다.

credential

기본값: None

인증할 자격 증명입니다. 계정 URL에 이미 SAS 토큰이 있는 경우 선택 사항입니다. 값은 SAS 토큰 문자열, azure.core.credentials의 AzureSasCredential 또는 AzureNamedKeyCredential의 instance, 계정 공유 액세스 키 또는 azure.identity에서 TokenCredentials 클래스의 instance 수 있습니다. 리소스 URI에 이미 SAS 토큰이 포함된 경우 명시적 자격 증명을 위해 무시됩니다.

충돌하는 SAS 토큰이 ValueError를 발생시키는 AzureSasCredential의 경우를 제외하고 AzureNamedKeyCredential의 instance 사용하는 경우 "name"은 스토리지 계정 이름이고 "키"는 스토리지 계정 키여야 합니다.

token_intent: Literal['backup']

인증 에 TokenCredential 을 사용할 때 필요하고 다른 형식의 인증에는 무시됩니다. TokenCredential 인증을 사용할 때 모든 요청에 대한 의도를 지정합니다. 가능한 값은 다음과 같습니다.

backup - 요청이 백업/관리자 유형 작업을 위한 것임을 지정합니다. 즉, 모든 파일/디렉터리 ACL이 무시되고 전체 권한이 부여됩니다. 사용자에게 필요한 RBAC 권한도 있어야 합니다.

allow_trailing_dot: bool

true이면 후행 점이 대상 URI에서 트리밍되지 않습니다.

allow_source_trailing_dot: bool

true이면 후행 점이 원본 URI에서 트리밍되지 않습니다.

api_version: str

요청에 사용할 Storage API 버전입니다. 기본값은 현재 SDK와 호환되는 최신 서비스 버전입니다. 이전 버전으로 설정하면 기능 호환성이 저하될 수 있습니다.

버전 12.1.0의 새로운 기능

secondary_hostname: str

보조 엔드포인트의 호스트 이름입니다.

max_range_size: int

파일 업로드에 사용되는 최대 범위 크기입니다. 기본값은 4*1024*1024입니다.

audience: str

Azure Active Directory 인증에 대한 토큰을 요청할 때 사용할 대상 그룹입니다. 자격 증명이 TokenCredential 형식인 경우에만 효과가 있습니다. 값은 (기본값) 또는 https://.file.core.windows.net 수 https://storage.azure.com/ 있습니다.

메서드

abort_copy	진행 중인 복사 작업을 중단합니다. 이렇게 하면 길이가 0이고 전체 메타데이터가 있는 대상 파일이 남습니다. 복사 작업이 이미 종료된 경우 오류가 발생합니다.
acquire_lease	새로운 임대를 요청합니다. 파일에 활성 임대가 없는 경우 파일 서비스는 Blob에 임대를 만들고 새 임대를 반환합니다.
clear_range	지정된 범위를 지우고 해당 범위에 대해 저장소에 사용된 공간을 해제합니다.
close	이 방법은 클라이언트가 연 소켓을 닫는 것입니다. 컨텍스트 관리자와 함께 사용할 때 사용할 필요가 없습니다.
close_all_handles	열려 있는 파일 핸들을 닫습니다. 이 작업은 서비스가 열려 있는 모든 핸들을 닫을 때까지 차단됩니다.
close_handle	열린 파일 핸들을 닫습니다.
create_file	새 파일을 만듭니다. 콘텐츠가 없는 파일만 초기화합니다.
delete_file	삭제할 지정된 파일을 표시합니다. 나중에 가비지 수집 중에 파일이 삭제됩니다.
download_file	StorageStreamDownloader에 파일을 다운로드합니다. readall() 메서드를 사용하여 모든 콘텐츠를 읽거나 readinto()를 사용하여 파일을 스트림으로 다운로드해야 합니다. chunks()를 사용하면 사용자가 청크의 콘텐츠를 반복할 수 있는 반복기가 반환됩니다.
from_connection_string	연결 문자열에서 ShareFileClient를 만듭니다.
from_file_url	특정 파일과 상호 작용하는 클라이언트이지만 해당 파일은 아직 존재하지 않을 수 있습니다.
get_file_properties	파일에 대한 모든 사용자 정의 메타데이터, 표준 HTTP 속성 및 시스템 속성을 반환합니다.
get_ranges	파일 또는 파일의 스냅샷 유효한 페이지 범위 목록을 반환합니다.
get_ranges_diff	파일 또는 파일의 스냅샷 유효한 페이지 범위 목록을 반환합니다. 버전 12.6.0의 새로운 기능
list_handles	파일에 대한 핸들을 나열합니다.
rename_file	원본 파일의 이름을 바꿉니다. :p aramtype file_attributes:~azure.storage.fileshare.NTFSAttributes 또는 str :키워드(keyword) file_creation_time: 파일의 생성 시간입니다. :p aramtype file_creation_time:~datetime.datetime 또는 str :키워드(keyword) file_last_write_time: 파일의 마지막 쓰기 시간입니다. :p aramtype file_last_write_time:~datetime.datetime 또는 str :키워드(keyword) file_change_time: 파일의 시간을 변경합니다. 지정하지 않으면 변경 시간이 현재 날짜/시간으로 설정됩니다. 버전 12.8.0의 새로운 기능: 이 매개 변수는 API 버전 '2021-06-08'에서 도입되었습니다.
resize_file	파일의 크기를 지정된 크기로 조정합니다.
set_file_metadata	지정된 파일에 대한 사용자 정의 메타데이터를 하나 이상의 이름-값 쌍으로 설정합니다. 이 작업을 호출할 때마다 파일에 연결된 기존의 모든 메타데이터가 바뀝니다. 파일에서 모든 메타데이터를 제거하려면 메타데이터 받아쓰기 없이 이 작업을 호출합니다.
set_http_headers	파일에서 HTTP 헤더를 설정합니다.
start_copy_from_url	원본 URL에서 클라이언트가 참조하는 파일로 데이터 복사를 시작합니다. 이 복사 작업의 상태 get_properties 메서드를 사용하여 찾을 수 있습니다.
upload_file	새 파일을 업로드합니다. param data: 파일의 콘텐츠입니다. param int length: 파일의 길이(바이트)입니다. 최대 크기(최대 1TiB)를 지정합니다. param file_attributes: 파일 및 디렉터리에 대한 파일 시스템 특성입니다. 설정하지 않으면 기본값은 "None"이 되고 특성은 "보관"으로 설정됩니다. 다음은 var 형식이 str인 경우의 예입니다. '임시\|보관'. file_attributes 값은 대/소문자를 구분하지 않습니다. type file_attributes: str 또는 ~azure.storage.fileshare.NTFSAttributes param file_creation_time: 파일의 생성 시간 기본값: 지금. type file_creation_time: str 또는 ~datetime.datetime param file_last_write_time: 파일의 마지막 쓰기 시간 기본값: 지금. type file_last_write_time: str 또는 ~datetime.datetime param file_permission: 지정한 경우 디렉터리/파일에 대한 권한(보안 설명자)을 설정해야 합니다. 사용 권한 크기가 <= 8KB인 경우 이 헤더를 사용할 수 있습니다. 그렇지 않으면 x-ms-file-permission-key 헤더를 사용해야 합니다. 기본값: 상속합니다. SDDL이 입력으로 지정된 경우 소유자, 그룹 및 dacl이 있어야 합니다. 참고: x-ms-file-permission 또는 x-ms-file-permission-key 중 하나만 지정해야 합니다. 형식 file_permission: str param permission_key: 디렉터리/파일에 대해 설정할 권한의 키입니다. 참고: x-ms-file-permission 또는 x-ms-file-permission-key 중 하나만 지정해야 합니다. type permission_key: str
upload_range	파일에 바이트 범위를 업로드합니다.
upload_range_from_url	한 Azure File 엔드포인트의 바이트를 다른 Azure File 엔드포인트의 지정된 범위에 씁니다.

abort_copy

진행 중인 복사 작업을 중단합니다.

이렇게 하면 길이가 0이고 전체 메타데이터가 있는 대상 파일이 남습니다. 복사 작업이 이미 종료된 경우 오류가 발생합니다.

abort_copy(copy_id: str | FileProperties, **kwargs: Any) -> None

매개 변수

copy_id: str 또는 FileProperties

필수

중단할 복사 작업입니다. ID 또는 FileProperties의 instance 수 있습니다.

lease: ShareLeaseClient 또는 str

파일에 활성 임대가 있는 경우 필요합니다. 값은 ShareLeaseClient 개체이거나 임대 ID를 문자열로 사용할 수 있습니다.

버전 12.1.0의 새로운 기능

timeout: int

작업에 대한 서버 쪽 시간 제한을 초 단위로 설정합니다. 자세한 내용은 https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations 를 참조하세요. 이 값은 클라이언트에서 추적되거나 유효성이 검사되지 않습니다. 클라이언트 쪽 네트워크 시간 제한을 구성하려면 여기를 참조 하세요.

반환 형식

None

acquire_lease

새로운 임대를 요청합니다.

파일에 활성 임대가 없는 경우 파일 서비스는 Blob에 임대를 만들고 새 임대를 반환합니다.

acquire_lease(lease_id: str | None = None, **kwargs: Any) -> ShareLeaseClient

매개 변수

lease_id: str

필수

GUID 문자열 형식의 제안된 임대 ID입니다. 제안된 임대 ID가 올바른 형식이 아닌 경우 파일 서비스는 400(잘못된 요청)을 반환합니다.

timeout: int

반환

ShareLeaseClient 개체입니다.

반환 형식

ShareLeaseClient

예제

파일에서 임대를 획득합니다.


   source_file.create_file(1024)
   lease = source_file.acquire_lease()
   source_file.upload_file(b'hello world', lease=lease)

   lease.release()

clear_range

지정된 범위를 지우고 해당 범위에 대해 저장소에 사용된 공간을 해제합니다.

clear_range(offset: int, length: int, **kwargs) -> Dict[str, Any]

매개 변수

offset: int

필수

파일의 섹션을 지우는 데 사용할 바이트 범위의 시작입니다. 범위의 크기는 최대 4MB입니다.

length: int

필수

파일의 섹션을 지우는 데 사용할 바이트 수입니다. 범위의 크기는 최대 4MB입니다.

lease: ShareLeaseClient 또는 str

파일에 활성 임대가 있는 경우 필요합니다. 값은 ShareLeaseClient 개체이거나 임대 ID를 문자열로 사용할 수 있습니다.

버전 12.1.0의 새로운 기능

timeout: int

반환

파일 업데이트 속성 받아쓰기(Etag 및 마지막으로 수정됨).

반환 형식

Dict[str, Any]

close

이 방법은 클라이언트가 연 소켓을 닫는 것입니다. 컨텍스트 관리자와 함께 사용할 때 사용할 필요가 없습니다.

close()

close_all_handles

열려 있는 파일 핸들을 닫습니다.

이 작업은 서비스가 열려 있는 모든 핸들을 닫을 때까지 차단됩니다.

close_all_handles(**kwargs: Any) -> Dict[str, int]

매개 변수

timeout: int

반환

닫힌 핸들 수(지정된 핸들을 찾을 수 없는 경우 0일 수 있음)와 dict에서 핸들 수를 닫지 못했습니다.

반환 형식

dict[str, int]

close_handle

열린 파일 핸들을 닫습니다.

close_handle(handle: str | Handle, **kwargs: Any) -> Dict[str, int]

매개 변수

handle: str 또는 Handle

필수

닫을 특정 핸들입니다.

timeout: int

반환

닫힌 핸들 수(지정된 핸들을 찾을 수 없는 경우 0일 수 있음)와 dict에서 핸들 수를 닫지 못했습니다.

반환 형식

dict[str, int]

create_file

새 파일을 만듭니다.

콘텐츠가 없는 파일만 초기화합니다.

create_file(size: int, file_attributes: str | NTFSAttributes = 'none', file_creation_time: str | datetime | None = 'now', file_last_write_time: str | datetime | None = 'now', file_permission: str | None = None, permission_key: str | None = None, **kwargs: Any) -> Dict[str, Any]

매개 변수

size: int

필수

파일의 최대 크기(최대 1TB)를 지정합니다.

file_attributes: NTFSAttributes

필수

파일 및 디렉터리에 대한 파일 시스템 특성입니다. 설정하지 않으면 기본값은 "None"이 되고 특성은 "보관"으로 설정됩니다. 다음은 var 형식이 str인 경우의 예입니다. '임시|보관'. file_attributes 값은 대/소문자를 구분하지 않습니다.

file_creation_time: str 또는 datetime

필수

파일의 생성 시간 기본값: 지금.

file_last_write_time: str 또는 datetime

필수

파일의 마지막 쓰기 시간 기본값: 지금.

file_permission: str

필수

지정된 경우 디렉터리/파일에 대한 사용 권한(보안 설명자)을 설정해야 합니다. 사용 권한 크기가 <= 8KB인 경우 이 헤더를 사용할 수 있습니다. 그렇지 않으면 x-ms-file-permission-key 헤더를 사용해야 합니다. 기본값: 상속합니다. SDDL이 입력으로 지정된 경우 소유자, 그룹 및 dacl이 있어야 합니다. 참고: x-ms-file-permission 또는 x-ms-file-permission-key 중 하나만 지정해야 합니다.

permission_key: str

필수

디렉터리/파일에 대해 설정할 권한의 키입니다. 참고: x-ms-file-permission 또는 x-ms-file-permission-key 중 하나만 지정해야 합니다.

file_change_time: str 또는 datetime

파일의 시간을 변경합니다. 지정하지 않으면 변경 시간이 현재 날짜/시간으로 설정됩니다.

버전 12.8.0의 새로운 기능: 이 매개 변수는 API 버전 '2021-06-08'에서 도입되었습니다.

content_settings: ContentSettings

파일 속성을 설정하는 데 사용되는 ContentSettings 개체입니다. 콘텐츠 형식, 인코딩, 언어, 처리, md5 및 캐시 제어를 설정하는 데 사용됩니다.

metadata: dict(str,str)

파일 내에서 메타데이터로 연결된 이름-값 쌍입니다.

lease: ShareLeaseClient 또는 str

파일에 활성 임대가 있는 경우 필요합니다. 값은 ShareLeaseClient 개체 또는 임대 ID를 문자열로 사용할 수 있습니다.

버전 12.1.0의 새로운 기능.

timeout: int

반환

파일 업데이트 속성 받아쓰기(Etag 및 마지막으로 수정됨).

반환 형식

dict(str, Any)

예제

파일을 만듭니다.


   # Create and allocate bytes for the file (no content added yet)
   my_allocated_file.create_file(size=100)

delete_file

삭제할 지정된 파일을 표시합니다. 나중에 가비지 수집 중에 파일이 삭제됩니다.

delete_file(**kwargs: Any) -> None

매개 변수

lease: ShareLeaseClient 또는 str

파일에 활성 임대가 있는 경우 필요합니다. 값은 ShareLeaseClient 개체 또는 임대 ID를 문자열로 사용할 수 있습니다.

버전 12.1.0의 새로운 기능.

timeout: int

반환 형식

None

예제

파일을 삭제합니다.


   my_file.delete_file()

download_file

StorageStreamDownloader에 파일을 다운로드합니다. readall() 메서드를 사용하여 모든 콘텐츠를 읽거나 readinto()를 사용하여 파일을 스트림으로 다운로드해야 합니다. chunks()를 사용하면 사용자가 청크의 콘텐츠를 반복할 수 있는 반복기가 반환됩니다.

download_file(offset: int | None = None, length: int | None = None, **kwargs: Any) -> StorageStreamDownloader

매개 변수

offset: int

필수

파일의 섹션을 다운로드하는 데 사용할 바이트 범위의 시작입니다. 길이가 제공되면 설정해야 합니다.

length: int

필수

스트림에서 읽을 바이트 수입니다. 선택 사항이지만 최적의 성능을 위해 제공해야 합니다.

max_concurrency: int

사용할 최대 병렬 연결 수입니다.

validate_content: bool

true이면 파일의 각 청크에 대한 MD5 해시를 계산합니다. 스토리지 서비스는 전송된 해시와 함께 도착한 콘텐츠의 해시를 확인합니다. 이는 https 대신 https(기본값)를 사용하여 이미 유효성을 검사하는 경우 와이어에서 비트플립을 검색하는 데 주로 유용합니다. 이 MD5 해시는 파일과 함께 저장되지 않습니다. 또한 사용하도록 설정하면 MD5 해시를 계산하려면 전체 블록을 버퍼링해야 하므로 메모리 효율적인 업로드 알고리즘이 사용되지 않습니다. 이렇게 하면 메모리 효율적인 알고리즘의 목적이 무효화됩니다.

lease: ShareLeaseClient 또는 str

파일에 활성 임대가 있는 경우 필요합니다. 값은 ShareLeaseClient 개체 또는 임대 ID를 문자열로 사용할 수 있습니다.

버전 12.1.0의 새로운 기능.

progress_hook: Callable[[int, int], None]

장기 실행 다운로드의 진행률을 추적하는 콜백입니다. 서명은 function(current: int, total: int)입니다. 여기서 current는 지금까지 전송된 바이트 수이고 합계는 다운로드의 총 크기입니다.

timeout: int

반환

스트리밍 개체(StorageStreamDownloader)

반환 형식

<xref:azure.storage.fileshare.StorageStreamDownloader>

예제

파일을 다운로드합니다.


   with open(DEST_FILE, "wb") as data:
       stream = my_file.download_file()
       data.write(stream.readall())

from_connection_string

연결 문자열에서 ShareFileClient를 만듭니다.

from_connection_string(conn_str: str, share_name: str, file_path: str, snapshot: str | Dict[str, Any] | None = None, credential: str | Dict[str, str] | AzureNamedKeyCredential | AzureSasCredential | TokenCredential | None = None, **kwargs: Any) -> Self

매개 변수

conn_str: str

필수

Azure Storage 계정에 대한 연결 문자열.

share_name: str

필수

공유의 이름입니다.

file_path: str

필수

파일 경로입니다.

snapshot: str

기본값: None

작동할 선택적 파일 스냅샷. 스냅샷 ID 문자열 또는 에서 create_snapshot반환된 응답일 수 있습니다.

credential

기본값: None

인증할 자격 증명입니다. 계정 URL에 이미 SAS 토큰이 있는 경우 선택 사항입니다. 값은 SAS 토큰 문자열, azure.core.credentials에서 AzureSasCredential 또는 AzureNamedKeyCredential의 instance, 계정 공유 액세스 키 또는 azure.identity에서 TokenCredentials 클래스의 instance 수 있습니다. 리소스 URI에 이미 SAS 토큰이 포함된 경우 명시적 자격 증명을 위해 무시됩니다.

충돌하는 SAS 토큰이 ValueError를 발생시키는 AzureSasCredential의 경우를 제외하고. AzureNamedKeyCredential의 instance 사용하는 경우 "name"은 스토리지 계정 이름이고 "키"는 스토리지 계정 키여야 합니다.

audience: str

반환

파일 클라이언트입니다.

반환 형식

ShareFileClient

예제

연결 문자열 사용하여 파일 클라이언트를 만듭니다.


   from azure.storage.fileshare import ShareFileClient
   file = ShareFileClient.from_connection_string(
       self.connection_string,
       share_name="helloworld2",
       file_path="myfile")

from_file_url

특정 파일과 상호 작용하는 클라이언트이지만 해당 파일은 아직 존재하지 않을 수 있습니다.

from_file_url(file_url: str, snapshot: str | Dict[str, Any] | None = None, credential: str | Dict[str, str] | AzureNamedKeyCredential | AzureSasCredential | TokenCredential | None = None, **kwargs: Any) -> Self

매개 변수

file_url: str

필수

파일에 대한 전체 URI입니다.

snapshot: str

기본값: None

작동할 선택적 파일 스냅샷. 스냅샷 ID 문자열 또는 에서 create_snapshot반환된 응답일 수 있습니다.

credential

기본값: None

충돌하는 SAS 토큰이 ValueError를 발생시키는 AzureSasCredential의 경우를 제외하고. AzureNamedKeyCredential의 instance 사용하는 경우 "name"은 스토리지 계정 이름이고 "키"는 스토리지 계정 키여야 합니다.

audience: str

반환

파일 클라이언트입니다.

반환 형식

ShareFileClient

get_file_properties

파일에 대한 모든 사용자 정의 메타데이터, 표준 HTTP 속성 및 시스템 속성을 반환합니다.

get_file_properties(**kwargs: Any) -> FileProperties

매개 변수

lease: ShareLeaseClient 또는 str

파일에 활성 임대가 있는 경우 필요합니다. 값은 ShareLeaseClient 개체 또는 임대 ID를 문자열로 사용할 수 있습니다.

버전 12.1.0의 새로운 기능.

timeout: int

반환

FileProperties

반환 형식

FileProperties

get_ranges

파일 또는 파일의 스냅샷 유효한 페이지 범위 목록을 반환합니다.

get_ranges(offset: int | None = None, length: int | None = None, **kwargs: Any) -> List[Dict[str, int]]

매개 변수

offset: int

필수

범위를 가져올 바이트의 시작 오프셋을 지정합니다.

length: int

필수

범위를 가져오는 데 사용할 바이트 수입니다.

lease: ShareLeaseClient 또는 str

파일에 활성 임대가 있는 경우 필요합니다. 값은 ShareLeaseClient 개체이거나 임대 ID를 문자열로 사용할 수 있습니다.

버전 12.1.0의 새로운 기능

timeout: int

반환

유효한 범위 목록입니다.

반환 형식

List[dict[str, int]]

get_ranges_diff

파일 또는 파일의 스냅샷 유효한 페이지 범위 목록을 반환합니다.

버전 12.6.0의 새로운 기능

get_ranges_diff(previous_sharesnapshot: str | Dict[str, Any], offset: int | None = None, length: int | None = None, **kwargs: Any) -> Tuple[List[Dict[str, int]], List[Dict[str, int]]]

매개 변수

offset: int

필수

범위를 가져올 바이트의 시작 오프셋을 지정합니다.

length: int

필수

범위를 가져오는 데 사용할 바이트 수입니다.

previous_sharesnapshot: str

필수

최신 스냅샷 또는 현재 파일과 비교할 이전 파일 스냅샷 지정하는 불투명 DateTime 값이 포함된 스냅샷 diff 매개 변수입니다.

lease: ShareLeaseClient 또는 str

파일에 활성 임대가 있는 경우 필요합니다. 값은 ShareLeaseClient 개체이거나 임대 ID를 문자열로 사용할 수 있습니다.

timeout: int

반환

'start' 및 'end' 키가 있는 사전으로 파일 범위의 두 목록으로 구성된 튜플입니다. 첫 번째 요소는 채워진 파일 범위이고, 두 번째 요소는 파일 범위를 지웁니다.

반환 형식

tuple(list(dict(str, str), list(dict(str, str))

list_handles

파일에 대한 핸들을 나열합니다.

list_handles(**kwargs: Any) -> ItemPaged[Handle]

매개 변수

timeout: int

반환

핸들의 자동 페이징 반복 가능

반환 형식

ItemPaged[Handle]

rename_file

원본 파일의 이름을 바꿉니다.

:p aramtype file_attributes:~azure.storage.fileshare.NTFSAttributes 또는 str :키워드(keyword) file_creation_time:

파일의 생성 시간입니다.

:p aramtype file_creation_time:~datetime.datetime 또는 str :키워드(keyword) file_last_write_time:

파일의 마지막 쓰기 시간입니다.

:p aramtype file_last_write_time:~datetime.datetime 또는 str :키워드(keyword) file_change_time:

파일의 시간을 변경합니다. 지정하지 않으면 변경 시간이 현재 날짜/시간으로 설정됩니다.

버전 12.8.0의 새로운 기능: 이 매개 변수는 API 버전 '2021-06-08'에서 도입되었습니다.

rename_file(new_name: str, **kwargs: Any) -> ShareFileClient

매개 변수

content_type: str

새 파일의 콘텐츠 형식입니다.

버전 12.8.0의 새로운 기능: 이 매개 변수는 API 버전 '2021-06-08'에서 도입되었습니다.

metadata: Dict[str,str]

파일 스토리지 개체와 연결할 이름-값 쌍입니다.

source_lease: ShareLeaseClient 또는 str

원본 파일에 활성 임대가 있는 경우 필요합니다. 값은 ShareLeaseClient 개체이거나 임대 ID를 문자열로 사용할 수 있습니다.

destination_lease: ShareLeaseClient 또는 str

대상 파일에 활성 임대가 있는 경우 필요합니다. 값은 ShareLeaseClient 개체이거나 임대 ID를 문자열로 사용할 수 있습니다.

반환

새 파일 클라이언트입니다.

반환 형식

ShareFileClient

resize_file

파일의 크기를 지정된 크기로 조정합니다.

resize_file(size: int, **kwargs: Any) -> Dict[str, Any]

매개 변수

size: int

필수

파일 크기를 바이트 단위로 조정할 크기

lease: ShareLeaseClient 또는 str

파일에 활성 임대가 있는 경우 필요합니다. 값은 ShareLeaseClient 개체이거나 임대 ID를 문자열로 사용할 수 있습니다.

버전 12.1.0의 새로운 기능

timeout: int

반환

파일 업데이트 속성 받아쓰기(Etag 및 마지막으로 수정됨).

반환 형식

Dict[str, Any]

set_file_metadata

지정된 파일에 대한 사용자 정의 메타데이터를 하나 이상의 이름-값 쌍으로 설정합니다.

이 작업을 호출할 때마다 파일에 연결된 기존의 모든 메타데이터가 바뀝니다. 파일에서 모든 메타데이터를 제거하려면 메타데이터 받아쓰기 없이 이 작업을 호출합니다.

set_file_metadata(metadata: Dict[str, Any] | None = None, **kwargs: Any) -> Dict[str, Any]

매개 변수

metadata: dict(str, str)

필수

파일 내에서 메타데이터로 연결된 이름-값 쌍입니다.

lease: ShareLeaseClient 또는 str

파일에 활성 임대가 있는 경우 필요합니다. 값은 ShareLeaseClient 개체이거나 임대 ID를 문자열로 사용할 수 있습니다.

버전 12.1.0의 새로운 기능

timeout: int

반환

파일 업데이트 속성 받아쓰기(Etag 및 마지막으로 수정됨).

반환 형식

dict(str, Any)

set_http_headers

파일에서 HTTP 헤더를 설정합니다.

set_http_headers(content_settings: ContentSettings, file_attributes: str | NTFSAttributes = 'preserve', file_creation_time: str | datetime | None = 'preserve', file_last_write_time: str | datetime | None = 'preserve', file_permission: str | None = None, permission_key: str | None = None, **kwargs: Any) -> Dict[str, Any]

매개 변수

content_settings: ContentSettings

필수

파일 속성을 설정하는 데 사용되는 ContentSettings 개체입니다. 콘텐츠 형식, 인코딩, 언어, 처리, md5 및 캐시 제어를 설정하는 데 사용됩니다.

file_attributes: NTFSAttributes

필수

파일 및 디렉터리에 대한 파일 시스템 특성입니다. 설정되지 않은 경우 는 기존 값의 보존을 나타냅니다. 다음은 var 형식이 str인 경우의 예입니다. '임시|보관'

file_creation_time: str 또는 datetime

필수

기본값: 유지 파일에 대한 만들기 시간입니다.

file_last_write_time: str 또는 datetime

필수

파일의 마지막 쓰기 시간 기본값: 유지.

file_permission: str

필수

지정된 경우 디렉터리/파일에 대한 사용 권한(보안 설명자)을 설정해야 합니다. 사용 권한 크기가 <= 8KB이면 이 헤더를 사용할 수 있습니다. 그렇지 않으면 x-ms-file-permission-key 헤더를 사용해야 합니다. 기본값: 상속합니다. SDDL이 입력으로 지정된 경우 소유자, 그룹 및 dacl이 있어야 합니다. 참고: x-ms-file-permission 또는 x-ms-file-permission-key 중 하나만 지정해야 합니다.

permission_key: str

필수

디렉터리/파일에 대해 설정할 권한의 키입니다. 참고: x-ms-file-permission 또는 x-ms-file-permission-key 중 하나만 지정해야 합니다.

file_change_time: str 또는 datetime

파일의 시간을 변경합니다. 지정하지 않으면 변경 시간이 현재 날짜/시간으로 설정됩니다.

버전 12.8.0의 새로운 기능: 이 매개 변수는 API 버전 '2021-06-08'에서 도입되었습니다.

lease: ShareLeaseClient 또는 str

파일에 활성 임대가 있는 경우 필요합니다. 값은 ShareLeaseClient 개체이거나 임대 ID를 문자열로 사용할 수 있습니다.

버전 12.1.0의 새로운 기능

timeout: int

반환

파일 업데이트 속성 받아쓰기(Etag 및 마지막으로 수정됨).

반환 형식

dict(str, Any)

start_copy_from_url

원본 URL에서 클라이언트가 참조하는 파일로 데이터 복사를 시작합니다.

이 복사 작업의 상태 get_properties 메서드를 사용하여 찾을 수 있습니다.

start_copy_from_url(source_url: str, **kwargs: Any) -> Any

매개 변수

source_url: str

필수

원본 파일의 URL을 지정합니다.

file_permission: str

지정된 경우 디렉터리/파일에 대한 사용 권한(보안 설명자)을 설정해야 합니다. 이 값을 "원본"으로 설정하여 원본 파일에서 보안 설명자를 복사할 수 있습니다. 그렇지 않으면 이 값을 사용하여 원본 값을 재정의합니다. 설정하지 않으면 권한 값이 대상 파일의 부모 디렉터리에서 상속됩니다. 사용 권한 크기가 = 8KB이 <면 이 설정을 사용할 수 있으며, 그렇지 않으면 permission_key 사용해야 합니다. SDDL이 입력으로 지정된 경우 소유자, 그룹 및 dacl이 있어야 합니다. 참고: file_permission 또는 permission_key 중 하나만 지정해야 합니다.