FileService 클래스

SMB(서버 메시지 블록) 프로토콜은 현재 온-프레미스에서 사용되는 기본 파일 공유 프로토콜입니다. Microsoft Azure File 서비스를 사용하면 고객은 SMB 클라이언트 애플리케이션을 다시 작성하지 않고도 Azure의 IaaS(Cloud Infrastructure as a Service) SMB의 가용성과 확장성을 활용할 수 있습니다.

Azure 파일 서비스는 대개 설치, 구성 및 작동이 복잡하고 비용이 많이 드는 기존의 DAS(직접 연결된 저장소) 및 SAN(저장 영역 네트워크) 솔루션 대신 매우 효율적으로 사용할 수 있습니다.

상속

StorageClient

FileService

생성자

FileService(account_name=None, account_key=None, sas_token=None, protocol='https', endpoint_suffix='core.windows.net', request_session=None, connection_string=None, socket_timeout=None)

매개 변수

Name	Description
account_name	str 스토리지 계정 이름입니다. 계정 키로 서명된 요청을 인증하고 스토리지 엔드포인트를 생성하는 데 사용됩니다. 연결 문자열 지정되지 않는 한 필요합니다. 기본값: None
account_key	str 스토리지 계정 키입니다. 공유 키 인증에 사용됩니다. 기본값: None
sas_token	str 계정 키 대신 요청을 인증하는 데 사용할 공유 액세스 서명 토큰입니다. 계정 키와 sas 토큰이 모두 지정된 경우 계정 키를 사용하여 서명합니다. 기본값: None
protocol	str 요청에 사용할 프로토콜입니다. 기본값은 https입니다. 기본값: https
endpoint_suffix	str 계정 이름을 뺀 URL의 호스트 기본 구성 요소입니다. 기본값은 Azure(core.windows.net)입니다. 이를 재정의하여 중국 클라우드(core.chinacloudapi.cn)를 사용합니다. 기본값: core.windows.net
request_session	<xref:requests.Session> http 요청에 사용할 세션 개체입니다. 기본값: None
connection_string	str 지정된 경우 요청 세션 외에 다른 모든 매개 변수를 재정의합니다. 연결 문자열 형식은 을 참조하세요http://azure.microsoft.com/en-us/documentation/articles/storage-configure-connection-string/. 기본값: None
socket_timeout	int 지정된 경우 기본 소켓 시간 제한을 재정의합니다. 지정된 시간 제한은 초 단위입니다. 기본값은 _constants.py DEFAULT_SOCKET_TIMEOUT 참조하세요. 기본값: None

변수

Name	Description
MAX_SINGLE_GET_SIZE	int max_connections 1보다 큰 경우 첫 번째 범위의 크기는 get_file_to_* 메서드에 의해 수행됩니다. 파일이 이보다 작은 경우 더 적은 데이터가 반환됩니다.
MAX_CHUNK_GET_SIZE	int max_connections 1보다 크고 파일이 MAX_SINGLE_GET_SIZE 보다 큰 경우 후속 범위의 크기는 get_file_to_* 메서드에 의해 수행됩니다. 파일의 나머지가 이보다 작으면 더 적은 데이터가 반환됩니다. 이 값이 4MB보다 큰 경우 content_validation 사용하도록 설정하면 오류가 발생합니다. 그러나 content_validation 원하는 경우 4MB보다 큰 크기가 최적일 수 있습니다. 4MB 이하로 설정하는 것은 권장되지 않습니다.
MAX_RANGE_SIZE	int create_file_from_* 메서드에 의해 배치된 범위의 크기입니다. 제공된 데이터가 적으면 더 작은 범위를 배치할 수 있습니다. 서비스에서 지원하는 최대 범위 크기는 4MB입니다.

메서드

abort_copy_file	보류 중인 copy_file 작업을 중단하고 길이가 0이고 전체 메타데이터가 있는 대상 파일을 남깁니다.
clear_range	지정된 범위를 지우고 해당 범위에 대해 저장소에 사용된 공간을 해제합니다.
close_handles	디렉터리 또는 지정된 공유 아래의 파일에서 열린 핸들을 닫을 생성기를 반환합니다. 생성기는 서비스에서 반환하는 연속 토큰을 느리게 따르고 모든 핸들이 닫히면 중지됩니다. 산출된 값은 각 트랜잭션에서 닫힌 핸들 수를 나타냅니다.
copy_file	파일을 비동기적으로 복사합니다. 이 작업은 복사 작업을 검사 또는 중단하는 데 사용할 수 있는 복사 ID를 포함하여 복사 작업 속성 개체를 반환합니다. 파일 서비스는 최상의 노력으로 파일을 복사합니다. 대상 파일이 있으면 덮어씁니다. 복사 작업이 진행되는 동안에는 대상 파일을 수정할 수 없습니다.
create_directory	지정된 공유 또는 부모 디렉터리 아래에 새 디렉터리를 만듭니다. 이름이 같은 디렉터리가 이미 있는 경우 서비스에서 작업이 실패합니다. 기본적으로 예외는 클라이언트에서 삼켜집니다. 예외를 노출하려면 fail_on_exists True를 지정합니다.
create_file	새 파일을 만듭니다. 자동 청크 및 진행률 알림을 사용하여 대용량 파일의 생성 및 업로드를 처리하는 상위 수준 함수는 create_file_from_*를 참조하세요.
create_file_from_bytes	바이트 배열에서 새 파일을 만들거나 자동 청크 및 진행률 알림을 사용하여 기존 파일의 콘텐츠를 업데이트합니다.
create_file_from_path	로컬 파일 경로에서 새 Azure 파일을 만들거나 자동 청크 및 진행률 알림을 사용하여 기존 파일의 콘텐츠를 업데이트합니다.
create_file_from_stream	파일/스트림에서 새 파일을 만들거나 자동 청크 및 진행률 알림을 사용하여 기존 파일의 콘텐츠를 업데이트합니다.
create_file_from_text	str/unicode에서 새 파일을 만들거나 자동 청크 및 진행률 알림을 사용하여 기존 파일의 콘텐츠를 업데이트합니다.
create_permission_for_share	공유 수준에서 권한(보안 설명자)을 만듭니다. 이 '권한'은 공유의 파일/디렉터리에 사용할 수 있습니다. '권한'이 이미 있는 경우 키를 반환하고, 그렇지 않으면 공유 수준에서 새 권한을 만들고 해당 키를 반환합니다. :는 파일 권한 키 :rtype str를 반환합니다.
create_share	지정된 계정 아래에 새 공유를 만듭니다. 동일한 이름의 공유가 이미 있는 경우 서비스에서 작업이 실패합니다. 기본적으로 예외는 클라이언트에 의해 무시됩니다. 예외를 노출하려면 fail_on_exists True를 지정합니다.
delete_directory	지정된 빈 디렉터리를 삭제합니다. 디렉터리는 비어 있어야 삭제할 수 있습니다. 비어 있지 않은 디렉터리를 삭제하려고 하면 실패합니다. 디렉터리가 없으면 서비스에서 작업이 실패합니다. 기본적으로 예외는 클라이언트에서 삼켜집니다. 예외를 노출하려면 fail_not_exist True를 지정합니다.
delete_file	삭제할 지정된 파일을 표시합니다. 나중에 가비지 수집 중에 파일이 삭제됩니다.
delete_share	삭제할 지정된 공유를 표시합니다. 공유가 없으면 서비스에서 작업이 실패합니다. 기본적으로 예외는 클라이언트에서 삼켜집니다. 예외를 노출하려면 fail_not_exist True를 지정합니다.
exists	공유 이름만 지정된 경우 공유가 존재하는지 여부를 나타내는 부울을 반환합니다. directory_name 지정된 경우 디렉터리가 있는지 여부를 나타내는 부울이 반환됩니다. file_name 지정한 경우 파일이 있는지 여부를 나타내는 부울이 반환됩니다.
extract_date_and_request_id
generate_account_shared_access_signature	파일 서비스에 대한 공유 액세스 서명을 생성합니다. 반환된 서명을 FileService의 sas_token 매개 변수와 함께 사용합니다.
generate_file_shared_access_signature	파일에 대한 공유 액세스 서명을 생성합니다. 반환된 서명을 FileService의 sas_token 매개 변수와 함께 사용합니다.
generate_share_shared_access_signature	공유에 대한 공유 액세스 서명을 생성합니다. 반환된 서명을 FileService의 sas_token 매개 변수와 함께 사용합니다.
get_directory_metadata	지정된 디렉터리에 대한 모든 사용자 정의 메타데이터를 반환합니다.
get_directory_properties	지정된 디렉터리에 대한 모든 사용자 정의 메타데이터 및 시스템 속성을 반환합니다. 반환된 데이터에는 디렉터리의 파일 목록이 포함되지 않습니다.
get_file_metadata	지정된 파일에 대한 모든 사용자 정의 메타데이터를 반환합니다.
get_file_properties	파일에 대한 모든 사용자 정의 메타데이터, 표준 HTTP 속성 및 시스템 속성을 반환합니다. 및 메타데이터 받아쓰기를 사용하여 의 FileFileProperties instance 반환합니다.
get_file_service_properties	Azure 스토리지 분석 포함하여 스토리지 계정의 파일 서비스의 속성을 가져옵니다.
get_file_to_bytes	자동 청크 및 진행률 알림을 사용하여 파일을 바이트 배열로 다운로드합니다. 속성, 메타데이터 및 콘텐츠를 사용하여 의 File instance 반환합니다.
get_file_to_path	자동 청크 및 진행률 알림을 사용하여 파일을 파일 경로에 다운로드합니다. 속성 및 메타데이터를 사용하여 File의 instance 반환합니다.
get_file_to_stream	자동 청크 및 진행률 알림을 사용하여 파일을 스트림에 다운로드합니다. 속성 및 메타데이터를 사용하여 의 File instance 반환합니다.
get_file_to_text	자동 청크 및 진행률 알림을 사용하여 파일을 유니코드 텍스트로 다운로드합니다. 속성, 메타데이터 및 콘텐츠를 사용하여 의 File instance 반환합니다.
get_permission_for_share	공유 수준에서 권한(보안 설명자)을 만듭니다. 이 '권한'은 공유의 파일/디렉터리에 사용할 수 있습니다. '권한'이 이미 있는 경우 키를 반환하고, 그렇지 않으면 공유 수준에서 새 권한을 만들고 해당 키를 반환합니다. :는 파일 권한(이식 가능한 SDDL) :rtype str을 반환합니다.
get_share_acl	지정된 공유에 대한 사용 권한을 가져옵니다.
get_share_metadata	지정된 공유에 대한 모든 사용자 정의 메타데이터를 반환합니다.
get_share_properties	지정된 공유에 대한 모든 사용자 정의 메타데이터 및 시스템 속성을 반환합니다. 반환된 데이터에는 공유의 파일 또는 디렉터리 목록이 포함되지 않습니다.
get_share_stats	가장 가까운 기가바이트까지 반올림된 공유에 저장된 데이터의 대략적인 크기를 가져옵니다. 이 값에는 최근에 만든 파일이나 최근에 다시 크기가 조정된 파일이 모두 포함되지 않을 수 있습니다.
get_share_stats_in_bytes	공유에 저장된 데이터의 대략적 크기를 바이트 단위로 가져옵니다. 이 값에는 최근에 만든 파일이나 최근에 다시 크기가 조정된 파일이 모두 포함되지 않을 수 있습니다.
list_directories_and_files	지정된 공유 아래의 디렉터리와 파일을 나열하는 생성기를 반환합니다. 생성기는 서비스에서 반환된 연속 토큰을 지연적으로 따르고 모든 디렉터리와 파일이 반환되거나 num_results 도달하면 중지됩니다. num_results 지정되고 공유에 해당 수의 파일 및 디렉터리보다 많은 경우 생성기는 완료되면 채워진 next_marker 필드를 갖게 됩니다. 이 표식은 더 많은 결과가 필요한 경우 새 생성기를 만드는 데 사용할 수 있습니다.
list_handles	디렉터리 또는 지정된 공유 아래의 파일에서 열린 핸들을 나열하는 생성기를 반환합니다. 생성기는 서비스에서 반환된 연속 토큰을 느리게 따르고 모든 핸들이 반환되거나 num_results 도달하면 중지됩니다. num_results 지정되고 공유에 해당 수의 파일 및 디렉터리보다 많은 경우 생성기는 완료되면 채워진 next_marker 필드를 갖게 됩니다. 이 표식은 더 많은 결과가 필요한 경우 새 생성기를 만드는 데 사용할 수 있습니다.
list_ranges	파일의 유효한 범위를 검색합니다.
list_shares	지정된 계정 아래의 공유를 나열하는 생성기를 반환합니다. 생성기는 서비스에서 반환된 연속 토큰을 느리게 따르고 모든 공유가 반환되거나 num_results 도달하면 중지됩니다. num_results 지정되고 계정에 해당 공유 수보다 많은 경우 생성기는 완료되면 채워진 next_marker 필드를 갖게 됩니다. 이 표식은 더 많은 결과가 필요한 경우 새 생성기를 만드는 데 사용할 수 있습니다.
make_file_url	파일에 액세스하는 URL을 만듭니다.
resize_file	파일의 크기를 지정된 크기로 조정합니다. 지정된 바이트 값이 현재 파일의 크기보다 작으면 지정된 바이트 값을 넘는 모든 범위가 지워집니다.
set_directory_metadata	지정된 디렉터리에 대해 하나 이상의 사용자 정의 이름-값 쌍을 설정합니다. 이 작업을 호출할 때마다 디렉터리에 연결된 기존의 모든 메타데이터가 바뀝니다. 디렉터리에서 모든 메타데이터를 제거하려면 메타데이터 받아쓰기 없이 이 작업을 호출합니다.
set_directory_properties
set_file_metadata	지정된 파일에 대한 사용자 정의 메타데이터를 하나 이상의 이름-값 쌍으로 설정합니다.
set_file_properties	파일의 시스템 속성을 설정합니다. content_settings 대해 하나의 속성이 설정된 경우 모든 속성이 재정의됩니다.
set_file_service_properties	Azure 스토리지 분석 포함하여 스토리지 계정의 파일 서비스의 속성을 설정합니다. 요소(예: HourMetrics)가 없음으로 남아 있으면 해당 기능에 대한 서비스의 기존 설정이 유지됩니다.
set_proxy	HTTP CONNECT 터널링에 대한 프록시 서버 호스트 및 포트를 설정합니다.
set_share_acl	공유 액세스 서명과 함께 사용할 수 있는 지정된 공유 또는 저장된 액세스 정책에 대한 권한을 설정합니다.
set_share_metadata	지정된 공유에 대해 하나 이상의 사용자 정의 이름-값 쌍을 설정합니다. 이 작업을 호출할 때마다 공유에 연결된 기존의 모든 메타데이터가 바뀝니다. 공유에서 모든 메타데이터를 제거하려면 메타데이터 받아쓰기 없이 이 작업을 호출합니다.
set_share_properties	지정된 공유에 대한 서비스 정의 속성을 설정합니다.
snapshot_share	지정된 계정 아래에 기존 공유의 스냅샷 만듭니다.
update_range	요청 본문으로 지정된 바이트를 지정된 범위에 기록합니다.
update_range_from_file_url	한 Azure File 엔드포인트의 바이트를 다른 Azure File 엔드포인트의 지정된 범위에 씁니다.

abort_copy_file

보류 중인 copy_file 작업을 중단하고 길이가 0이고 전체 메타데이터가 있는 대상 파일을 남깁니다.

abort_copy_file(share_name, directory_name, file_name, copy_id, timeout=None)

매개 변수

Name	Description
share_name 필수	str 대상 공유의 이름입니다.
directory_name 필수	str 디렉터리 경로입니다.
file_name 필수	str 대상 파일의 이름입니다.
copy_id 필수	str 원래 copy_file 작업의 copy.id 제공된 복사 식별자입니다.
timeout	int 시간 초과 매개 변수는 초 단위로 표현됩니다. 기본값: None

clear_range

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

clear_range(share_name, directory_name, file_name, start_range, end_range, timeout=None)

매개 변수

Name	Description
share_name 필수	str 기존 공유의 이름입니다.
directory_name 필수	str 디렉터리 경로입니다.
file_name 필수	str 기존 파일의 이름입니다.
start_range 필수	int 파일의 섹션을 지우는 데 사용할 바이트 범위의 시작입니다. 범위의 크기는 최대 4MB입니다. start_range 및 end_range 매개 변수는 포함됩니다. 예: start_range=0, end_range=511은 처음 512바이트의 파일을 다운로드합니다.
end_range 필수	int 파일의 섹션을 지우는 데 사용할 바이트 범위의 끝입니다. 범위의 크기는 최대 4MB입니다. start_range 및 end_range 매개 변수는 포함됩니다. 예: start_range=0, end_range=511은 처음 512바이트의 파일을 다운로드합니다.
timeout	int 시간 초과 매개 변수는 초 단위로 표현됩니다. 기본값: None

close_handles

디렉터리 또는 지정된 공유 아래의 파일에서 열린 핸들을 닫을 생성기를 반환합니다. 생성기는 서비스에서 반환하는 연속 토큰을 느리게 따르고 모든 핸들이 닫히면 중지됩니다. 산출된 값은 각 트랜잭션에서 닫힌 핸들 수를 나타냅니다.

close_handles(share_name, directory_name=None, file_name=None, recursive=None, handle_id=None, marker=None, snapshot=None, timeout=None)

매개 변수

Name	Description
share_name 필수	str 기존 공유의 이름입니다.
directory_name	str 디렉터리 경로입니다. 기본값: None
file_name	str 기존 파일의 이름입니다. 기본값: None
recursive	bool 작업이 URI, 해당 파일, 해당 하위 디렉터리 및 해당 파일에 지정된 디렉터리에 적용되어야 하는지 여부를 지정하는 부울입니다. 기본값: None
handle_id	str 필수 사항입니다. 닫을 파일 또는 디렉터리에서 열린 핸들 ID를 지정합니다. Astrix('*')는 모든 핸들을 지정하는 와일드카드입니다. 기본값: None
marker	str 불투명 연속 토큰입니다. 이 값은 핸들 닫기를 완료하지 않은 경우 이전 생성기 개체의 next_marker 필드에서 검색할 수 있습니다. 지정된 경우 이 생성기는 이전 생성기가 중지된 지점에서 핸들을 닫기 시작합니다. 기본값: None
snapshot	str 해당하는 경우 스냅샷 버전을 나타내는 문자열입니다. 기본값: None
timeout	int 시간 초과 매개 변수는 초 단위로 표현됩니다. 기본값: None

copy_file

파일을 비동기적으로 복사합니다. 이 작업은 복사 작업을 검사 또는 중단하는 데 사용할 수 있는 복사 ID를 포함하여 복사 작업 속성 개체를 반환합니다. 파일 서비스는 최상의 노력으로 파일을 복사합니다.

대상 파일이 있으면 덮어씁니다. 복사 작업이 진행되는 동안에는 대상 파일을 수정할 수 없습니다.

copy_file(share_name, directory_name, file_name, copy_source, metadata=None, timeout=None)

매개 변수

Name	Description
share_name 필수	str 대상 공유의 이름입니다. 공유가 있어야 합니다.
directory_name 필수	str 대상 디렉터리의 이름입니다. 디렉터리가 있어야 합니다.
file_name 필수	str 대상 파일의 이름입니다. 대상 파일이 있으면 덮어씁니다. 그렇지 않으면 만들어집니다.
copy_source 필수	str Azure 파일 또는 Blob을 지정하는 최대 2KB 길이의 URL입니다. 값은 요청 URI에 표시되므로 URL 인코딩해야 합니다. 원본이 다른 계정에 있는 경우 원본은 공용이거나 공유 액세스 서명을 통해 인증되어야 합니다. 원본이 공용인 경우 인증이 필요하지 않습니다. 예: https://myaccount.file.core.windows.net/myshare/mydir/myfilehttps://otheraccount.file.core.windows.net/myshare/mydir/myfile?sastoken
metadata	dict(str, str)<xref:./> 파일 내에서 메타데이터로 연결된 이름-값 쌍입니다. 이름-값 쌍이 지정되지 않은 경우 작업은 원본 Blob 또는 파일의 메타데이터를 대상 파일로 복사합니다. 하나 이상의 이름-값 쌍을 지정하면 대상 파일이 지정된 메타데이터로 만들어지고 메타데이터가 원본 Blob 또는 파일에서 복사되지 않습니다. 기본값: None
timeout	int 시간 초과 매개 변수는 초 단위로 표현됩니다. 기본값: None

반환

형식	Description
CopyProperties	상태, 원본 및 ID와 같은 작업 속성을 복사합니다.

create_directory

지정된 공유 또는 부모 디렉터리 아래에 새 디렉터리를 만듭니다. 이름이 같은 디렉터리가 이미 있는 경우 서비스에서 작업이 실패합니다. 기본적으로 예외는 클라이언트에서 삼켜집니다. 예외를 노출하려면 fail_on_exists True를 지정합니다.

create_directory(share_name, directory_name, metadata=None, fail_on_exist=False, timeout=None, file_permission=None, smb_properties=<azure.storage.file.models.SMBProperties object>)

매개 변수

Name	Description
share_name 필수	str 기존 공유의 이름입니다.
directory_name 필수	str 부모 디렉터리에 대한 경로를 포함하여 만들 디렉터리의 이름입니다.
metadata	dict(str, str)<xref::> 공유와 메타데이터로 연결할 name_value 쌍이 있는 받아쓰기입니다. 예:{'Category':'test'} 기본값: None
fail_on_exist	bool 디렉터리가 있을 때 예외를 throw할지 여부를 지정합니다. False(기본값). 기본값: False
file_permission	str 파일 권한, 이식 가능한 SDDL 기본값: None
smb_properties	SMBProperties SMB 관련 파일 속성 설정
timeout	int 시간 초과 매개 변수는 초 단위로 표현됩니다. 기본값: None

반환

형식	Description
bool	디렉터리가 만들어지면 True이고, 디렉터리가 이미 있으면 False입니다.

create_file

새 파일을 만듭니다.

자동 청크 및 진행률 알림을 사용하여 대용량 파일의 생성 및 업로드를 처리하는 상위 수준 함수는 create_file_from_*를 참조하세요.

create_file(share_name, directory_name, file_name, content_length, content_settings=None, metadata=None, timeout=None, file_permission=None, smb_properties=<azure.storage.file.models.SMBProperties object>)

매개 변수

Name	Description
share_name 필수	str 기존 공유의 이름입니다.
directory_name 필수	str 디렉터리 경로입니다.
file_name 필수	str 만들거나 업데이트할 파일의 이름입니다.
content_length 필수	int 파일의 길이(바이트)입니다.
content_settings	ContentSettings 파일 속성을 설정하는 데 사용되는 ContentSettings 개체입니다. 기본값: None
metadata	dict(str, str) 파일 내에서 메타데이터로 연결된 이름-값 쌍입니다. 기본값: None
file_permission	str 파일 권한, 이식 가능한 SDDL 기본값: None
smb_properties	SMBProperties SMB 관련 파일 속성 설정
timeout	int 시간 초과 매개 변수는 초 단위로 표현됩니다. 기본값: None

create_file_from_bytes

바이트 배열에서 새 파일을 만들거나 자동 청크 및 진행률 알림을 사용하여 기존 파일의 콘텐츠를 업데이트합니다.

create_file_from_bytes(share_name, directory_name, file_name, file, index=0, count=None, content_settings=None, metadata=None, validate_content=False, progress_callback=None, max_connections=2, timeout=None, file_permission=None, smb_properties=<azure.storage.file.models.SMBProperties object>)

매개 변수

Name	Description
share_name 필수	str 기존 공유의 이름입니다.
directory_name 필수	str 디렉터리 경로입니다.
file_name 필수	str 만들거나 업데이트할 파일의 이름입니다.
file 필수	str 파일의 콘텐츠를 바이트 배열로 지정합니다.
index	int 바이트 배열에서 인덱스 시작 기본값: 0
count	int 업로드할 바이트 수입니다. 인덱스에서 시작하는 모든 바이트를 업로드하려면 없음 또는 음수 값으로 설정합니다. 기본값: None
content_settings	ContentSettings 파일 속성을 설정하는 데 사용되는 ContentSettings 개체입니다. 기본값: None
metadata	dict(str, str) 파일 내에서 메타데이터로 연결된 이름-값 쌍입니다. 기본값: None
validate_content	bool true이면 파일의 각 범위에 대한 MD5 해시를 계산합니다. 스토리지 서비스는 전송된 해시와 함께 도착한 콘텐츠의 해시를 확인합니다. 이는 https 대신 https(기본값)를 사용하여 이미 유효성을 검사하는 경우 와이어에서 비트플립을 검색하는 데 주로 유용합니다. 이 MD5 해시는 파일과 함께 저장되지 않습니다. 기본값: False
progress_callback	<xref:func>(<xref:current>, <xref:total>) 현재가 지금까지 전송된 바이트 수이고 합계가 파일 크기인 서명 함수(현재, 합계)를 사용한 진행률에 대한 콜백 또는 총 크기를 알 수 없는 경우 없음입니다. 기본값: None
max_connections	int 사용할 최대 병렬 연결 수입니다. 기본값: 2
file_permission	str 파일 권한, 이식 가능한 SDDL 기본값: None
smb_properties	SMBProperties SMB 관련 파일 속성 설정
timeout	int 시간 초과 매개 변수는 초 단위로 표현됩니다. 이 메서드는 Azure 서비스를 여러 번 호출할 수 있으며 시간 제한은 각 호출에 개별적으로 적용됩니다. 기본값: None

create_file_from_path

로컬 파일 경로에서 새 Azure 파일을 만들거나 자동 청크 및 진행률 알림을 사용하여 기존 파일의 콘텐츠를 업데이트합니다.

create_file_from_path(share_name, directory_name, file_name, local_file_path, content_settings=None, metadata=None, validate_content=False, progress_callback=None, max_connections=2, file_permission=None, smb_properties=<azure.storage.file.models.SMBProperties object>, timeout=None)

매개 변수

Name	Description
share_name 필수	str 기존 공유의 이름입니다.
directory_name 필수	str 디렉터리 경로입니다.
file_name 필수	str 만들거나 업데이트할 파일의 이름입니다.
local_file_path 필수	str 파일 콘텐츠로 업로드할 로컬 파일의 경로입니다.
content_settings	ContentSettings 파일 속성을 설정하는 데 사용되는 ContentSettings 개체입니다. 기본값: None
metadata	dict(str, str) 파일 내에서 메타데이터로 연결된 이름-값 쌍입니다. 기본값: None
validate_content	bool true이면 파일의 각 범위에 대한 MD5 해시를 계산합니다. 스토리지 서비스는 전송된 해시와 함께 도착한 콘텐츠의 해시를 확인합니다. 이는 https 대신 https(기본값)를 사용하여 이미 유효성을 검사하는 경우 와이어에서 비트플립을 검색하는 데 주로 유용합니다. 이 MD5 해시는 파일과 함께 저장되지 않습니다. 기본값: False
progress_callback	<xref:func>(<xref:current>, <xref:total>) 현재가 지금까지 전송된 바이트 수이고 합계가 파일 크기인 서명 함수(현재, 합계)를 사용한 진행률에 대한 콜백 또는 총 크기를 알 수 없는 경우 없음입니다. 기본값: None
max_connections	int 사용할 최대 병렬 연결 수입니다. 기본값: 2
file_permission	str 파일 권한, 이식 가능한 SDDL 기본값: None
smb_properties	SMBProperties SMB 관련 파일 속성 설정
timeout	int 시간 초과 매개 변수는 초 단위로 표현됩니다. 이 메서드는 Azure 서비스를 여러 번 호출할 수 있으며 시간 제한은 각 호출에 개별적으로 적용됩니다. 기본값: None

create_file_from_stream

파일/스트림에서 새 파일을 만들거나 자동 청크 및 진행률 알림을 사용하여 기존 파일의 콘텐츠를 업데이트합니다.

create_file_from_stream(share_name, directory_name, file_name, stream, count, content_settings=None, metadata=None, validate_content=False, progress_callback=None, max_connections=2, timeout=None, file_permission=None, smb_properties=<azure.storage.file.models.SMBProperties object>)

매개 변수

Name	Description
share_name 필수	str 기존 공유의 이름입니다.
directory_name 필수	str 디렉터리 경로입니다.
file_name 필수	str 만들거나 업데이트할 파일의 이름입니다.
stream 필수	IOBase 파일 콘텐츠로 업로드할 파일/스트림을 열었습니다.
count 필수	int 스트림에서 읽을 바이트 수입니다. 이는 필수 요소이며, 개수를 알 수 없는 경우 파일을 만들 수 없습니다.
content_settings	ContentSettings 파일 속성을 설정하는 데 사용되는 ContentSettings 개체입니다. 기본값: None
metadata	dict(str, str) 파일 내에서 메타데이터로 연결된 이름-값 쌍입니다. 기본값: None
validate_content	bool true이면 파일의 각 범위에 대한 MD5 해시를 계산합니다. 스토리지 서비스는 전송된 해시와 함께 도착한 콘텐츠의 해시를 확인합니다. 이는 https 대신 https(기본값)를 사용하여 이미 유효성을 검사하는 경우 와이어에서 비트플립을 검색하는 데 주로 유용합니다. 이 MD5 해시는 파일과 함께 저장되지 않습니다. 기본값: False
progress_callback	<xref:func>(<xref:current>, <xref:total>) 현재가 지금까지 전송된 바이트 수이고 합계가 파일 크기인 서명 함수(현재, 합계)를 사용한 진행률에 대한 콜백 또는 총 크기를 알 수 없는 경우 없음입니다. 기본값: None
max_connections	int 사용할 최대 병렬 연결 수입니다. 병렬 업로드를 사용하려면 스트림을 검색할 수 있어야 합니다. 기본값: 2
file_permission	str 파일 권한, 이식 가능한 SDDL 기본값: None
smb_properties	SMBProperties SMB 관련 파일 속성 설정
timeout	int 시간 초과 매개 변수는 초 단위로 표현됩니다. 이 메서드는 Azure 서비스를 여러 번 호출할 수 있으며 시간 제한은 각 호출에 개별적으로 적용됩니다. 기본값: None

create_file_from_text

str/unicode에서 새 파일을 만들거나 자동 청크 및 진행률 알림을 사용하여 기존 파일의 콘텐츠를 업데이트합니다.

create_file_from_text(share_name, directory_name, file_name, text, encoding='utf-8', content_settings=None, metadata=None, validate_content=False, timeout=None, file_permission=None, smb_properties=<azure.storage.file.models.SMBProperties object>)

매개 변수

Name	Description
share_name 필수	str 기존 공유의 이름입니다.
directory_name 필수	str 디렉터리 경로입니다.
file_name 필수	str 만들거나 업데이트할 파일의 이름입니다.
text 필수	str 파일에 업로드할 텍스트입니다.
encoding	str 텍스트를 바이트로 변환하는 데 사용할 Python 인코딩입니다. 기본값: utf-8
content_settings	ContentSettings 파일 속성을 설정하는 데 사용되는 ContentSettings 개체입니다. 기본값: None
metadata	dict(str, str) 파일 내에서 메타데이터로 연결된 이름-값 쌍입니다. 기본값: None
validate_content	bool true이면 파일의 각 범위에 대한 MD5 해시를 계산합니다. 스토리지 서비스는 전송된 해시와 함께 도착한 콘텐츠의 해시를 확인합니다. 이는 https 대신 https(기본값)를 사용하여 이미 유효성을 검사하는 경우 와이어에서 비트플립을 검색하는 데 주로 유용합니다. 이 MD5 해시는 파일과 함께 저장되지 않습니다. 기본값: False
file_permission	str 파일 권한, 이식 가능한 SDDL 기본값: None
smb_properties	SMBProperties SMB 관련 파일 속성 설정
timeout	int 시간 초과 매개 변수는 초 단위로 표현됩니다. 이 메서드는 Azure 서비스를 여러 번 호출할 수 있으며 시간 제한은 각 호출에 개별적으로 적용됩니다. 기본값: None

create_permission_for_share

공유 수준에서 권한(보안 설명자)을 만듭니다. 이 '권한'은 공유의 파일/디렉터리에 사용할 수 있습니다. '권한'이 이미 있는 경우 키를 반환하고, 그렇지 않으면 공유 수준에서 새 권한을 만들고 해당 키를 반환합니다.

:는 파일 권한 키 :rtype str를 반환합니다.

create_permission_for_share(share_name, file_permission, timeout=None)

매개 변수

Name	Description
share_name 필수	공유 이름입니다.
file_permission 필수	파일 권한, 이식 가능한 SDDL
timeout	시간 초과 매개 변수는 초 단위로 표현됩니다. 기본값: None

create_share

지정된 계정 아래에 새 공유를 만듭니다. 동일한 이름의 공유가 이미 있는 경우 서비스에서 작업이 실패합니다. 기본적으로 예외는 클라이언트에 의해 무시됩니다. 예외를 노출하려면 fail_on_exists True를 지정합니다.

create_share(share_name, metadata=None, quota=None, fail_on_exist=False, timeout=None)

매개 변수

Name	Description
share_name 필수	str 만들 공유의 이름입니다.
metadata	dict(str, str) 공유와 메타데이터로 연결할 name_value 쌍이 있는 받아쓰기입니다. 예:{'Category':'test'} 기본값: None
quota	int 공유의 최대 크기(GB)를 지정합니다. 0보다 커야 하고 5TB(5120)보다 작거나 같아야 합니다. 기본값: None
fail_on_exist	bool 공유가 있을 때 예외를 throw할지 여부를 지정합니다. False(기본값). 기본값: False
timeout	int 시간 초과 매개 변수는 초 단위로 표현됩니다. 기본값: None

반환

형식	Description
bool	공유가 만들어지면 True이고, 공유가 이미 있는 경우 False입니다.

delete_directory

지정된 빈 디렉터리를 삭제합니다. 디렉터리는 비어 있어야 삭제할 수 있습니다. 비어 있지 않은 디렉터리를 삭제하려고 하면 실패합니다.

디렉터리가 없으면 서비스에서 작업이 실패합니다. 기본적으로 예외는 클라이언트에서 삼켜집니다. 예외를 노출하려면 fail_not_exist True를 지정합니다.

delete_directory(share_name, directory_name, fail_not_exist=False, timeout=None)

매개 변수

Name	Description
share_name 필수	str 기존 공유의 이름입니다.
directory_name 필수	str 부모 디렉터리의 경로를 포함하여 삭제할 디렉터리의 이름입니다.
fail_not_exist	bool 디렉터리가 없을 때 예외를 throw할지 여부를 지정합니다. 기본값: False
timeout	int 시간 초과 매개 변수는 초 단위로 표현됩니다. 기본값: None

반환

형식	Description
bool	디렉터리가 삭제되면 True이고, 그렇지 않으면 False입니다.

delete_file

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

delete_file(share_name, directory_name, file_name, timeout=None)

매개 변수

Name	Description
share_name 필수	str 기존 공유의 이름입니다.
directory_name 필수	str 디렉터리 경로입니다.
file_name 필수	str 기존 파일의 이름입니다.
timeout	int 시간 초과 매개 변수는 초 단위로 표현됩니다. 기본값: None

delete_share

삭제할 지정된 공유를 표시합니다. 공유가 없으면 서비스에서 작업이 실패합니다. 기본적으로 예외는 클라이언트에서 삼켜집니다. 예외를 노출하려면 fail_not_exist True를 지정합니다.

delete_share(share_name, fail_not_exist=False, timeout=None, snapshot=None, delete_snapshots=None)

매개 변수

Name	Description
share_name 필수	str 삭제할 공유의 이름입니다.
fail_not_exist	bool 공유가 없을 때 예외를 throw할지 여부를 지정합니다. False(기본값). 기본값: False
timeout	int 시간 초과 매개 변수는 초 단위로 표현됩니다. 기본값: None
snapshot	str 해당하는 경우 스냅샷 버전을 나타내는 문자열입니다. 특정 스냅샷만 삭제하려면 이 인수를 지정합니다. delete_snapshots 지정한 경우 None이어야 합니다. 기본값: None
delete_snapshots	DeleteSnapshot 스냅샷이 있는 공유를 삭제하려면 DeleteSnapshot.Include로 지정해야 합니다. 기본값: None

반환

형식	Description
bool	True이면 공유가 삭제되고 False 공유가 존재하지 않습니다.

exists

공유 이름만 지정된 경우 공유가 존재하는지 여부를 나타내는 부울을 반환합니다. directory_name 지정된 경우 디렉터리가 있는지 여부를 나타내는 부울이 반환됩니다. file_name 지정한 경우 파일이 있는지 여부를 나타내는 부울이 반환됩니다.

exists(share_name, directory_name=None, file_name=None, timeout=None, snapshot=None)

매개 변수

Name	Description
share_name 필수	str 공유의 이름입니다.
directory_name	str 디렉터리의 경로입니다. 기본값: None
file_name	str 파일의 이름입니다. 기본값: None
timeout	int 시간 초과 매개 변수는 초 단위로 표현됩니다. 기본값: None
snapshot	str 해당하는 경우 스냅샷 버전을 나타내는 문자열입니다. 기본값: None

반환

형식	Description
bool	리소스가 있는지 여부를 나타내는 부울입니다.

extract_date_and_request_id

static extract_date_and_request_id(retry_context)

매개 변수

Name	Description
retry_context 필수

generate_account_shared_access_signature

파일 서비스에 대한 공유 액세스 서명을 생성합니다. 반환된 서명을 FileService의 sas_token 매개 변수와 함께 사용합니다.

generate_account_shared_access_signature(resource_types, permission, expiry, start=None, ip=None, protocol=None)

매개 변수

Name	Description
resource_types 필수	<xref:ResourceTypes> 계정 SAS를 사용하여 액세스할 수 있는 리소스 유형을 지정합니다.
permission 필수	<xref:AccountPermissions> 공유 액세스 서명과 연결된 권한입니다. 사용자는 이러한 권한으로 허용된 작업만 수행할 수 있도록 제한됩니다. 이 필드를 포함하는 저장된 액세스 정책을 참조하는 ID가 제공되지 않는 한 필요합니다. 이 필드는 연결된 저장된 액세스 정책에 지정된 경우 생략되어야 합니다.
expiry 필수	datetime 또는 str 공유 액세스 서명이 유효하지 않은 시간입니다. 이 필드를 포함하는 저장된 액세스 정책을 참조하는 ID가 제공되지 않는 한 필요합니다. 이 필드는 연결된 저장된 액세스 정책에 지정된 경우 생략되어야 합니다. Azure는 항상 값을 UTC로 변환합니다. 날짜가 표준 시간대 정보 없이 전달되는 경우 UTC로 간주됩니다.
start	datetime 또는 str 공유 액세스 서명이 유효한 시간입니다. 생략되는 경우 이 호출의 시작 시간은 저장소 서비스가 요청을 받는 시간으로 간주됩니다. Azure는 항상 값을 UTC로 변환합니다. 날짜가 표준 시간대 정보 없이 전달되는 경우 UTC로 간주됩니다. 기본값: None
ip	str 요청을 수락할 IP 주소 또는 IP 주소 범위를 지정합니다. 요청이 시작된 IP 주소가 SAS 토큰에 지정된 IP 주소 또는 주소 범위와 일치하지 않으면 요청이 인증되지 않습니다. 예를 들어 SAS에서 sip=168.1.5.65 또는 sip=168.1.5.60-168.1.5.70을 지정하면 요청이 해당 IP 주소로 제한됩니다. 기본값: None
protocol	str 요청이 허용되는 프로토콜을 지정합니다. 가능한 값은 HTTPS 및 HTTP(https,http) 또는 HTTPS 전용(https)입니다. 기본값은 https,http입니다. HTTP만은 허용되는 값이 아닙니다. 기본값: None

반환

형식	Description
str	sas(공유 액세스 서명) 토큰입니다.

generate_file_shared_access_signature

파일에 대한 공유 액세스 서명을 생성합니다. 반환된 서명을 FileService의 sas_token 매개 변수와 함께 사용합니다.

generate_file_shared_access_signature(share_name, directory_name=None, file_name=None, permission=None, expiry=None, start=None, id=None, ip=None, protocol=None, cache_control=None, content_disposition=None, content_encoding=None, content_language=None, content_type=None)

매개 변수

Name	Description
share_name 필수	str 공유 이름입니다.
directory_name	str 디렉터리의 이름입니다. 디렉터리에 대해 SAS 토큰을 만들 수 없으므로 이 매개 변수는 file_name 제공된 경우에만 있어야 합니다. 기본값: None
file_name	str 파일의 이름입니다. 기본값: None
permission	FilePermissions 공유 액세스 서명과 연결된 권한입니다. 사용자는 이러한 권한으로 허용된 작업만 수행할 수 있도록 제한됩니다. 사용 권한은 읽기, 만들기, 쓰기, 삭제, 목록 순서를 지정해야 합니다. 이 필드를 포함하는 저장된 액세스 정책을 참조하는 ID가 제공되지 않는 한 필요합니다. 이 필드는 연결된 저장된 액세스 정책에 지정된 경우 생략되어야 합니다. 기본값: None
expiry	datetime 또는 str 공유 액세스 서명이 유효하지 않은 시간입니다. 이 필드를 포함하는 저장된 액세스 정책을 참조하는 ID가 제공되지 않는 한 필요합니다. 이 필드는 연결된 저장된 액세스 정책에 지정된 경우 생략되어야 합니다. Azure는 항상 값을 UTC로 변환합니다. 날짜가 표준 시간대 정보 없이 전달되는 경우 UTC로 간주됩니다. 기본값: None
start	datetime 또는 str 공유 액세스 서명이 유효한 시간입니다. 생략되는 경우 이 호출의 시작 시간은 저장소 서비스가 요청을 받는 시간으로 간주됩니다. Azure는 항상 값을 UTC로 변환합니다. 날짜가 표준 시간대 정보 없이 전달되는 경우 UTC로 간주됩니다. 기본값: None
id	str 저장된 액세스 정책과 상관 관계가 있는 최대 64자 길이의 고유 값입니다. 저장된 액세스 정책을 만들려면 set_file_service_properties 사용합니다. 기본값: None
ip	str 요청을 수락할 IP 주소 또는 IP 주소 범위를 지정합니다. 요청이 시작된 IP 주소가 SAS 토큰에 지정된 IP 주소 또는 주소 범위와 일치하지 않으면 요청이 인증되지 않습니다. 예를 들어 SAS에서 sip=168.1.5.65 또는 sip=168.1.5.60-168.1.5.70을 지정하면 요청이 해당 IP 주소로 제한됩니다. 기본값: None
protocol	str 요청이 허용되는 프로토콜을 지정합니다. 가능한 값은 HTTPS 및 HTTP(https,http) 또는 HTTPS 전용(https)입니다. 기본값은 https,http입니다. HTTP만은 허용되는 값이 아닙니다. 기본값: None
cache_control	str 이 공유 액세스 서명을 사용하여 리소스에 액세스할 때 Cache-Control 대한 응답 헤더 값입니다. 기본값: None
content_disposition	str 이 공유 액세스 서명을 사용하여 리소스에 액세스할 때 Content-Disposition에 대한 응답 헤더 값입니다. 기본값: None
content_encoding	str 이 공유 액세스 서명을 사용하여 리소스에 액세스할 때 Content-Encoding에 대한 응답 헤더 값입니다. 기본값: None
content_language	str 이 공유 액세스 서명을 사용하여 리소스에 액세스할 때 Content-Language에 대한 응답 헤더 값입니다. 기본값: None
content_type	str 이 공유 액세스 서명을 사용하여 리소스에 액세스할 때 Content-Type에 대한 응답 헤더 값입니다. 기본값: None

반환

형식	Description
str	sas(공유 액세스 서명) 토큰입니다.

generate_share_shared_access_signature

공유에 대한 공유 액세스 서명을 생성합니다. 반환된 서명을 FileService의 sas_token 매개 변수와 함께 사용합니다.

generate_share_shared_access_signature(share_name, permission=None, expiry=None, start=None, id=None, ip=None, protocol=None, cache_control=None, content_disposition=None, content_encoding=None, content_language=None, content_type=None)

매개 변수

Name	Description
share_name 필수	str 공유 이름입니다.
permission	SharePermissions 공유 액세스 서명과 연결된 권한입니다. 사용자는 이러한 권한으로 허용된 작업만 수행할 수 있도록 제한됩니다. 사용 권한은 읽기, 만들기, 쓰기, 삭제, 목록 순서로 지정되어야 합니다. 이 필드를 포함하는 저장된 액세스 정책을 참조하는 ID가 지정되지 않는 한 필요합니다. 이 필드는 연결된 저장된 액세스 정책에 지정된 경우 생략되어야 합니다. 기본값: None
expiry	datetime 또는 str 공유 액세스 서명이 유효하지 않은 시간입니다. 이 필드를 포함하는 저장된 액세스 정책을 참조하는 ID가 지정되지 않는 한 필요합니다. 이 필드는 연결된 저장된 액세스 정책에 지정된 경우 생략되어야 합니다. Azure는 항상 값을 UTC로 변환합니다. 날짜가 표준 시간대 정보 없이 전달되는 경우 UTC로 간주됩니다. 기본값: None
start	datetime 또는 str 공유 액세스 서명이 유효한 시간입니다. 생략되는 경우 이 호출의 시작 시간은 저장소 서비스가 요청을 받는 시간으로 간주됩니다. Azure는 항상 값을 UTC로 변환합니다. 날짜가 표준 시간대 정보 없이 전달되는 경우 UTC로 간주됩니다. 기본값: None
id	str 저장된 액세스 정책과 상관 관계가 있는 최대 64자 길이의 고유 값입니다. 저장된 액세스 정책을 만들려면 를 사용합니다 set_share_acl. 기본값: None
ip	str 요청을 수락할 IP 주소 또는 IP 주소 범위를 지정합니다. 요청이 시작된 IP 주소가 SAS 토큰에 지정된 IP 주소 또는 주소 범위와 일치하지 않으면 요청이 인증되지 않습니다. 예를 들어 SAS에서 sip=168.1.5.65 또는 sip=168.1.5.60-168.1.5.70을 지정하면 요청이 해당 IP 주소로 제한됩니다. 기본값: None
protocol	str 요청이 허용되는 프로토콜을 지정합니다. 가능한 값은 HTTPS 및 HTTP(https,http) 또는 HTTPS 전용(https)입니다. 기본값은 https,http입니다. HTTP만은 허용되는 값이 아닙니다. 기본값: None
cache_control	str 이 공유 액세스 서명을 사용하여 리소스에 액세스할 때 Cache-Control 대한 응답 헤더 값입니다. 기본값: None
content_disposition	str 이 공유 액세스 서명을 사용하여 리소스에 액세스할 때 Content-Disposition에 대한 응답 헤더 값입니다. 기본값: None
content_encoding	str 이 공유 액세스 서명을 사용하여 리소스에 액세스할 때 Content-Encoding에 대한 응답 헤더 값입니다. 기본값: None
content_language	str 이 공유 액세스 서명을 사용하여 리소스에 액세스할 때 Content-Language에 대한 응답 헤더 값입니다. 기본값: None
content_type	str 이 공유 액세스 서명을 사용하여 리소스에 액세스할 때 Content-Type에 대한 응답 헤더 값입니다. 기본값: None

반환

형식	Description
str	공유 액세스 서명(sas) 토큰입니다.

get_directory_metadata

지정된 디렉터리에 대한 모든 사용자 정의 메타데이터를 반환합니다.

get_directory_metadata(share_name, directory_name, timeout=None, snapshot=None)

매개 변수

Name	Description
share_name 필수	str 기존 공유의 이름입니다.
directory_name 필수	str 디렉터리 경로입니다.
timeout	int 시간 초과 매개 변수는 초 단위로 표현됩니다. 기본값: None
snapshot	str 해당하는 경우 스냅샷 버전을 나타내는 문자열입니다. 기본값: None

반환

형식	Description
dict(str, str)	디렉터리 메타데이터 이름, 값 쌍을 나타내는 사전입니다.

get_directory_properties

지정된 디렉터리에 대한 모든 사용자 정의 메타데이터 및 시스템 속성을 반환합니다. 반환된 데이터에는 디렉터리의 파일 목록이 포함되지 않습니다.

get_directory_properties(share_name, directory_name, timeout=None, snapshot=None)

매개 변수

Name	Description
share_name 필수	str 기존 공유의 이름입니다.
directory_name 필수	str 기존 디렉터리의 경로입니다.
timeout	int 시간 초과 매개 변수는 초 단위로 표현됩니다. 기본값: None
snapshot	str 해당하는 경우 스냅샷 버전을 나타내는 문자열입니다. 기본값: None

반환

형식	Description
Directory	디렉터리 개체 내의 지정된 디렉터리에 대한 속성입니다.

get_file_metadata

지정된 파일에 대한 모든 사용자 정의 메타데이터를 반환합니다.

get_file_metadata(share_name, directory_name, file_name, timeout=None, snapshot=None)

매개 변수

Name	Description
share_name 필수	str 기존 공유의 이름입니다.
directory_name 필수	str 디렉터리 경로입니다.
file_name 필수	str 기존 파일의 이름입니다.
timeout	int 시간 초과 매개 변수는 초 단위로 표현됩니다. 기본값: None
snapshot	str 해당하는 경우 스냅샷 버전을 나타내는 문자열입니다. 기본값: None

반환

형식	Description
dict(str, str)	파일 메타데이터 이름, 값 쌍을 나타내는 사전입니다.

get_file_properties

파일에 대한 모든 사용자 정의 메타데이터, 표준 HTTP 속성 및 시스템 속성을 반환합니다. 및 메타데이터 받아쓰기를 사용하여 의 FileFileProperties instance 반환합니다.

get_file_properties(share_name, directory_name, file_name, timeout=None, snapshot=None)

매개 변수

Name	Description
share_name 필수	str 기존 공유의 이름입니다.
directory_name 필수	str 디렉터리 경로입니다.
file_name 필수	str 기존 파일의 이름입니다.
timeout	int 시간 초과 매개 변수는 초 단위로 표현됩니다. 기본값: None
snapshot	str 해당하는 경우 스냅샷 버전을 나타내는 문자열입니다. 기본값: None

반환

형식	Description
File	속성 및 메타데이터를 포함하는 파일 개체입니다.

get_file_service_properties

Azure 스토리지 분석 포함하여 스토리지 계정의 파일 서비스의 속성을 가져옵니다.

get_file_service_properties(timeout=None)

매개 변수

Name	Description
timeout	int 시간 초과 매개 변수는 초 단위로 표현됩니다. 기본값: None

반환

형식	Description
ServiceProperties	파일 서비스 속성입니다.

get_file_to_bytes

자동 청크 및 진행률 알림을 사용하여 파일을 바이트 배열로 다운로드합니다. 속성, 메타데이터 및 콘텐츠를 사용하여 의 File instance 반환합니다.

get_file_to_bytes(share_name, directory_name, file_name, start_range=None, end_range=None, validate_content=False, progress_callback=None, max_connections=2, timeout=None, snapshot=None)

매개 변수

Name	Description
share_name 필수	str 기존 공유의 이름입니다.
directory_name 필수	str 디렉터리 경로입니다.
file_name 필수	str 기존 파일의 이름입니다.
start_range	int 파일의 섹션을 다운로드하는 데 사용할 바이트 범위의 시작입니다. end_range 지정되지 않으면 start_range 이후의 모든 바이트가 다운로드됩니다. start_range 및 end_range 매개 변수는 포함됩니다. 예: start_range=0, end_range=511은 처음 512바이트의 파일을 다운로드합니다. 기본값: None
end_range	int 파일의 섹션을 다운로드하는 데 사용할 바이트 범위의 끝입니다. end_range 제공된 경우 start_range 제공해야 합니다. start_range 및 end_range 매개 변수는 포함됩니다. 예: start_range=0, end_range=511은 처음 512바이트의 파일을 다운로드합니다. 기본값: None
validate_content	bool true로 설정하면 파일의 검색된 각 부분에 대해 MD5 해시의 유효성을 검사합니다. 이는 https 대신 https(기본값)를 사용하여 이미 유효성을 검사하는 경우 와이어에서 비트플립을 검색하는 데 주로 유용합니다. 서비스는 청크 4MB 이하의 트랜잭션 MD5만 반환하므로 첫 번째 가져오기 요청은 자체 크기가 됩니다. 자기 대신 MAX_CHUNK_GET_SIZE. MAX_SINGLE_GET_SIZE. 자체인 경우. MAX_CHUNK_GET_SIZE 4MB 이상으로 설정되었으면 오류가 throw됩니다. MD5를 컴퓨팅하는 데 처리 시간이 걸리고 청크 크기 감소로 인해 더 많은 요청을 수행해야 하므로 대기 시간이 약간 증가할 수 있습니다. 기본값: False
progress_callback	<xref:func>(<xref:current>, <xref:total>) 시그니처 함수(현재, 합계)를 사용한 진행률에 대한 콜백입니다. 여기서 current는 지금까지 전송된 바이트 수이고 total은 알려진 경우 파일의 크기입니다. 기본값: None
max_connections	int 2 이상으로 설정하면 첫 번째 자체에 대해 초기 가져오기가 수행됩니다. 파일의 MAX_SINGLE_GET_SIZE 바이트입니다. 전체 파일인 경우 메서드는 이 시점에서 를 반환합니다. 그렇지 않은 경우 max_connections 동일한 스레드 수를 사용하여 나머지 데이터를 병렬로 다운로드합니다. 각 청크는 자체 크기입니다. MAX_CHUNK_GET_SIZE. 1로 설정하면 단일 대규모 가져오기 요청이 수행됩니다. 일반적으로 권장되지는 않지만, 스레드가 거의 사용되지 않거나, 네트워크 요청이 매우 비싸거나, 검색할 수 없는 스트림이 병렬 다운로드를 방지하는 경우 사용할 수 있습니다. 원자성을 적용하기 위해 파일을 동시에 수정하거나 max_connections 1보다 큰 경우 빈 파일에 추가 요청이 필요하기 때문에 많은 파일이 비어 있어야 하는 경우에도 유용할 수 있습니다. 기본값: 2
timeout	int 시간 초과 매개 변수는 초 단위로 표현됩니다. 이 메서드는 Azure 서비스를 여러 번 호출할 수 있으며 시간 제한은 각 호출에 개별적으로 적용됩니다. 기본값: None
snapshot	str 해당하는 경우 스냅샷 버전을 나타내는 문자열입니다. 기본값: None

반환

형식	Description
File	속성, 콘텐츠 및 메타데이터가 있는 파일입니다.

get_file_to_path

자동 청크 및 진행률 알림을 사용하여 파일을 파일 경로에 다운로드합니다. 속성 및 메타데이터를 사용하여 File의 instance 반환합니다.

get_file_to_path(share_name, directory_name, file_name, file_path, open_mode='wb', start_range=None, end_range=None, validate_content=False, progress_callback=None, max_connections=2, timeout=None, snapshot=None)

매개 변수

Name	Description
share_name 필수	str 기존 공유의 이름입니다.
directory_name 필수	str 디렉터리 경로입니다.
file_name 필수	str 기존 파일의 이름입니다.
file_path 필수	str 쓸 파일의 경로입니다.
open_mode	str 파일을 열 때 사용할 모드입니다. 추가만 open_mode 지정하면 병렬 다운로드가 방지됩니다. 따라서 이 open_mode 사용되는 경우 max_connections 1로 설정해야 합니다. 기본값: wb
start_range	int 파일의 섹션을 다운로드하는 데 사용할 바이트 범위의 시작입니다. end_range 지정되지 않으면 start_range 이후의 모든 바이트가 다운로드됩니다. start_range 및 end_range 매개 변수는 포함됩니다. 예: start_range=0, end_range=511은 처음 512바이트의 파일을 다운로드합니다. 기본값: None
end_range	int 파일의 섹션을 다운로드하는 데 사용할 바이트 범위의 끝입니다. end_range 제공된 경우 start_range 제공해야 합니다. start_range 및 end_range 매개 변수는 포함됩니다. 예: start_range=0, end_range=511은 처음 512바이트의 파일을 다운로드합니다. 기본값: None
validate_content	bool true로 설정하면 파일의 검색된 각 부분에 대해 MD5 해시의 유효성을 검사합니다. 이는 https 대신 https(기본값)를 사용하여 이미 유효성을 검사하는 경우 와이어에서 비트플립을 검색하는 데 주로 유용합니다. 서비스는 청크 4MB 이하의 트랜잭션 MD5만 반환하므로 첫 번째 가져오기 요청은 자체 크기가 됩니다. 자기 대신 MAX_CHUNK_GET_SIZE. MAX_SINGLE_GET_SIZE. 자체인 경우. MAX_CHUNK_GET_SIZE 4MB 이상으로 설정되었으면 오류가 throw됩니다. MD5를 컴퓨팅하는 데 처리 시간이 걸리고 청크 크기 감소로 인해 더 많은 요청을 수행해야 하므로 대기 시간이 약간 증가할 수 있습니다. 기본값: False
progress_callback	<xref:func>(<xref:current>, <xref:total>) 시그니처 함수(현재, 합계)를 사용한 진행률에 대한 콜백입니다. 여기서 current는 지금까지 전송된 바이트 수이고 total은 알려진 경우 파일의 크기입니다. 기본값: None
max_connections	int 2 이상으로 설정하면 첫 번째 자체에 대해 초기 가져오기가 수행됩니다. 파일의 MAX_SINGLE_GET_SIZE 바이트입니다. 전체 파일인 경우 메서드는 이 시점에서 를 반환합니다. 그렇지 않은 경우 max_connections 동일한 스레드 수를 사용하여 나머지 데이터를 병렬로 다운로드합니다. 각 청크는 자체 크기입니다. MAX_CHUNK_GET_SIZE. 1로 설정하면 단일 대규모 가져오기 요청이 수행됩니다. 일반적으로 권장되지는 않지만, 스레드가 거의 사용되지 않거나, 네트워크 요청이 매우 비싸거나, 검색할 수 없는 스트림이 병렬 다운로드를 방지하는 경우 사용할 수 있습니다. 원자성을 적용하기 위해 파일을 동시에 수정하거나 max_connections 1보다 큰 경우 빈 파일에 추가 요청이 필요하기 때문에 많은 파일이 비어 있어야 하는 경우에도 유용할 수 있습니다. 기본값: 2
timeout	int 시간 초과 매개 변수는 초 단위로 표현됩니다. 이 메서드는 Azure 서비스를 여러 번 호출할 수 있으며 시간 제한은 각 호출에 개별적으로 적용됩니다. 기본값: None
snapshot	str 해당하는 경우 스냅샷 버전을 나타내는 문자열입니다. 기본값: None

반환

형식	Description
File	속성 및 메타데이터가 있는 파일입니다.

get_file_to_stream

자동 청크 및 진행률 알림을 사용하여 파일을 스트림에 다운로드합니다. 속성 및 메타데이터를 사용하여 의 File instance 반환합니다.

get_file_to_stream(share_name, directory_name, file_name, stream, start_range=None, end_range=None, validate_content=False, progress_callback=None, max_connections=2, timeout=None, snapshot=None)

매개 변수

Name	Description
share_name 필수	str 기존 공유의 이름입니다.
directory_name 필수	str 디렉터리 경로입니다.
file_name 필수	str 기존 파일의 이름입니다.
stream 필수	IOBase 쓸 파일/스트림을 열었습니다.
start_range	int 파일의 섹션을 다운로드하는 데 사용할 바이트 범위의 시작입니다. end_range 지정되지 않으면 start_range 이후의 모든 바이트가 다운로드됩니다. start_range 및 end_range 매개 변수는 포함됩니다. 예: start_range=0, end_range=511은 처음 512바이트의 파일을 다운로드합니다. 기본값: None
end_range	int 파일의 섹션을 다운로드하는 데 사용할 바이트 범위의 끝입니다. end_range 제공된 경우 start_range 제공해야 합니다. start_range 및 end_range 매개 변수는 포함됩니다. 예: start_range=0, end_range=511은 처음 512바이트의 파일을 다운로드합니다. 기본값: None
validate_content	bool true로 설정하면 파일의 검색된 각 부분에 대해 MD5 해시의 유효성을 검사합니다. 이는 https 대신 https(기본값)를 사용하여 이미 유효성을 검사하는 경우 와이어에서 비트플립을 검색하는 데 주로 유용합니다. 서비스는 청크 4MB 이하의 트랜잭션 MD5만 반환하므로 첫 번째 가져오기 요청은 자체 크기가 됩니다. 자기 대신 MAX_CHUNK_GET_SIZE. MAX_SINGLE_GET_SIZE. 자체인 경우. MAX_CHUNK_GET_SIZE 4MB 이상으로 설정되었으면 오류가 throw됩니다. MD5를 컴퓨팅하는 데 처리 시간이 걸리고 청크 크기 감소로 인해 더 많은 요청을 수행해야 하므로 대기 시간이 약간 증가할 수 있습니다. 기본값: False
progress_callback	<xref:func>(<xref:current>, <xref:total>) 시그니처 함수(현재, 합계)를 사용한 진행률에 대한 콜백입니다. 여기서 current는 지금까지 전송된 바이트 수이고 total은 알려진 경우 파일의 크기입니다. 기본값: None
max_connections	int 2 이상으로 설정하면 첫 번째 자체에 대해 초기 가져오기가 수행됩니다. 파일의 MAX_SINGLE_GET_SIZE 바이트입니다. 전체 파일인 경우 메서드는 이 시점에서 를 반환합니다. 그렇지 않은 경우 max_connections 동일한 스레드 수를 사용하여 나머지 데이터를 병렬로 다운로드합니다. 각 청크는 자체 크기입니다. MAX_CHUNK_GET_SIZE. 1로 설정하면 단일 대규모 가져오기 요청이 수행됩니다. 일반적으로 권장되지는 않지만, 스레드가 거의 사용되지 않거나, 네트워크 요청이 매우 비싸거나, 검색할 수 없는 스트림이 병렬 다운로드를 방지하는 경우 사용할 수 있습니다. 원자성을 적용하기 위해 파일을 동시에 수정하거나 max_connections 1보다 큰 경우 빈 파일에 추가 요청이 필요하기 때문에 많은 파일이 비어 있어야 하는 경우에도 유용할 수 있습니다. 기본값: 2
timeout	int 시간 초과 매개 변수는 초 단위로 표현됩니다. 이 메서드는 Azure 서비스를 여러 번 호출할 수 있으며 시간 제한은 각 호출에 개별적으로 적용됩니다. 기본값: None
snapshot	str 해당하는 경우 스냅샷 버전을 나타내는 문자열입니다. 기본값: None

반환

형식	Description
File	속성 및 메타데이터가 있는 파일입니다.

get_file_to_text

자동 청크 및 진행률 알림을 사용하여 파일을 유니코드 텍스트로 다운로드합니다. 속성, 메타데이터 및 콘텐츠를 사용하여 의 File instance 반환합니다.

get_file_to_text(share_name, directory_name, file_name, encoding='utf-8', start_range=None, end_range=None, validate_content=False, progress_callback=None, max_connections=2, timeout=None, snapshot=None)

매개 변수

Name	Description
share_name 필수	str 기존 공유의 이름입니다.
directory_name 필수	str 디렉터리 경로입니다.
file_name 필수	str 기존 파일의 이름입니다.
encoding	str 파일 데이터를 디코딩할 때 사용할 Python 인코딩입니다. 기본값: utf-8
start_range	int 파일의 섹션을 다운로드하는 데 사용할 바이트 범위의 시작입니다. end_range 지정되지 않으면 start_range 이후의 모든 바이트가 다운로드됩니다. start_range 및 end_range 매개 변수는 포함됩니다. 예: start_range=0, end_range=511은 처음 512바이트의 파일을 다운로드합니다. 기본값: None
end_range	int 파일의 섹션을 다운로드하는 데 사용할 바이트 범위의 끝입니다. end_range 제공된 경우 start_range 제공해야 합니다. start_range 및 end_range 매개 변수는 포함됩니다. 예: start_range=0, end_range=511은 처음 512바이트의 파일을 다운로드합니다. 기본값: None
validate_content	bool true로 설정하면 파일의 검색된 각 부분에 대해 MD5 해시의 유효성을 검사합니다. 이는 https 대신 https(기본값)를 사용하여 이미 유효성을 검사하는 경우 와이어에서 비트플립을 검색하는 데 주로 유용합니다. 서비스는 청크 4MB 이하의 트랜잭션 MD5만 반환하므로 첫 번째 가져오기 요청은 자체 크기가 됩니다. 자기 대신 MAX_CHUNK_GET_SIZE. MAX_SINGLE_GET_SIZE. 자체인 경우. MAX_CHUNK_GET_SIZE 4MB 이상으로 설정되었으면 오류가 throw됩니다. MD5를 컴퓨팅하는 데 처리 시간이 걸리고 청크 크기 감소로 인해 더 많은 요청을 수행해야 하므로 대기 시간이 약간 증가할 수 있습니다. 기본값: False
progress_callback	<xref:func>(<xref:current>, <xref:total>) 시그니처 함수(현재, 합계)를 사용한 진행률에 대한 콜백입니다. 여기서 current는 지금까지 전송된 바이트 수이고 total은 알려진 경우 파일의 크기입니다. 기본값: None
max_connections	int 2 이상으로 설정하면 첫 번째 자체에 대해 초기 가져오기가 수행됩니다. 파일의 MAX_SINGLE_GET_SIZE 바이트입니다. 전체 파일인 경우 메서드는 이 시점에서 를 반환합니다. 그렇지 않은 경우 max_connections 동일한 스레드 수를 사용하여 나머지 데이터를 병렬로 다운로드합니다. 각 청크는 자체 크기입니다. MAX_CHUNK_GET_SIZE. 1로 설정하면 단일 대규모 가져오기 요청이 수행됩니다. 일반적으로 권장되지는 않지만, 스레드가 거의 사용되지 않거나, 네트워크 요청이 매우 비싸거나, 검색할 수 없는 스트림이 병렬 다운로드를 방지하는 경우 사용할 수 있습니다. 원자성을 적용하기 위해 파일을 동시에 수정하거나 max_connections 1보다 큰 경우 빈 파일에 추가 요청이 필요하기 때문에 많은 파일이 비어 있어야 하는 경우에도 유용할 수 있습니다. 기본값: 2
timeout	int 시간 초과 매개 변수는 초 단위로 표현됩니다. 이 메서드는 Azure 서비스를 여러 번 호출할 수 있으며 시간 제한은 각 호출에 개별적으로 적용됩니다. 기본값: None
snapshot	str 해당하는 경우 스냅샷 버전을 나타내는 문자열입니다. 기본값: None

반환

형식	Description
File	속성, 콘텐츠 및 메타데이터가 있는 파일입니다.

get_permission_for_share

공유 수준에서 권한(보안 설명자)을 만듭니다. 이 '권한'은 공유의 파일/디렉터리에 사용할 수 있습니다. '권한'이 이미 있는 경우 키를 반환하고, 그렇지 않으면 공유 수준에서 새 권한을 만들고 해당 키를 반환합니다.

:는 파일 권한(이식 가능한 SDDL) :rtype str을 반환합니다.

get_permission_for_share(share_name, file_permission_key, timeout=None)

매개 변수

Name	Description
share_name 필수	공유 이름입니다.
file_permission_key 필수	검색할 파일 권한의 키
timeout	시간 초과 매개 변수는 초 단위로 표현됩니다. 기본값: None

get_share_acl

지정된 공유에 대한 사용 권한을 가져옵니다.

get_share_acl(share_name, timeout=None)

매개 변수

Name	Description
share_name 필수	str 기존 공유의 이름입니다.
timeout	int 시간 초과 매개 변수는 초 단위로 표현됩니다. 기본값: None

반환

형식	Description
dict(str, AccessPolicy)	공유와 연결된 액세스 정책의 사전입니다.

get_share_metadata

지정된 공유에 대한 모든 사용자 정의 메타데이터를 반환합니다.

get_share_metadata(share_name, timeout=None, snapshot=None)

매개 변수

Name	Description
share_name 필수	str 기존 공유의 이름입니다.
timeout	int 시간 초과 매개 변수는 초 단위로 표현됩니다. 기본값: None
snapshot	str 해당하는 경우 스냅샷 버전을 나타내는 문자열입니다. 기본값: None

반환

형식	Description
dict(str, str)	공유 메타데이터 이름, 값 쌍을 나타내는 사전입니다.

get_share_properties

지정된 공유에 대한 모든 사용자 정의 메타데이터 및 시스템 속성을 반환합니다. 반환된 데이터에는 공유의 파일 또는 디렉터리 목록이 포함되지 않습니다.

get_share_properties(share_name, timeout=None, snapshot=None)

매개 변수

Name	Description
share_name 필수	str 기존 공유의 이름입니다.
timeout	int 시간 초과 매개 변수는 초 단위로 표현됩니다. 기본값: None
snapshot	str 해당하는 경우 스냅샷 버전을 나타내는 문자열입니다. 기본값: None

반환

형식	Description
Share	속성 및 메타데이터를 노출하는 공유입니다.

get_share_stats

가장 가까운 기가바이트까지 반올림된 공유에 저장된 데이터의 대략적인 크기를 가져옵니다.

이 값에는 최근에 만든 파일이나 최근에 다시 크기가 조정된 파일이 모두 포함되지 않을 수 있습니다.

get_share_stats(share_name, timeout=None)

매개 변수

Name	Description
share_name 필수	str 기존 공유의 이름입니다.
timeout	int 시간 초과 매개 변수는 초 단위로 표현됩니다. 기본값: None

반환

형식	Description
int	공유에 저장된 데이터의 대략적 크기입니다.

get_share_stats_in_bytes

공유에 저장된 데이터의 대략적 크기를 바이트 단위로 가져옵니다.

이 값에는 최근에 만든 파일이나 최근에 다시 크기가 조정된 파일이 모두 포함되지 않을 수 있습니다.

get_share_stats_in_bytes(share_name, timeout=None)

매개 변수

Name	Description
share_name 필수	str 기존 공유의 이름입니다.
timeout	int 시간 초과 매개 변수는 초 단위로 표현됩니다. 기본값: None

반환

형식	Description
int	공유에 저장된 데이터의 대략적 크기입니다.

list_directories_and_files

지정된 공유 아래의 디렉터리와 파일을 나열하는 생성기를 반환합니다. 생성기는 서비스에서 반환된 연속 토큰을 지연적으로 따르고 모든 디렉터리와 파일이 반환되거나 num_results 도달하면 중지됩니다.

num_results 지정되고 공유에 해당 수의 파일 및 디렉터리보다 많은 경우 생성기는 완료되면 채워진 next_marker 필드를 갖게 됩니다. 이 표식은 더 많은 결과가 필요한 경우 새 생성기를 만드는 데 사용할 수 있습니다.

list_directories_and_files(share_name, directory_name=None, num_results=None, marker=None, timeout=None, prefix=None, snapshot=None)

매개 변수

Name	Description
share_name 필수	str 기존 공유의 이름입니다.
directory_name	str 디렉터리 경로입니다. 기본값: None
num_results	int 모든 디렉터리 요소를 포함하여 반환할 최대 파일 수를 지정합니다. 요청이 num_results 지정하지 않거나 5,000보다 큰 값을 지정하는 경우 서버는 최대 5,000개의 항목을 반환합니다. num_results 0보다 작거나 같은 값으로 설정하면 오류 응답 코드 400(잘못된 요청)이 발생합니다. 기본값: None
marker	str 불투명 연속 토큰입니다. 이 값은 num_results 지정되고 생성기가 결과 열거를 완료한 경우 이전 생성기 개체의 next_marker 필드에서 검색할 수 있습니다. 지정된 경우 이 생성기는 이전 생성기가 중지된 지점에서 결과를 반환하기 시작합니다. 기본값: None
timeout	int 시간 초과 매개 변수는 초 단위로 표현됩니다. 기본값: None
prefix	str 지정된 접두사를 사용하여 파일 및/또는 디렉터리만 나열합니다. 기본값: None
snapshot	str 해당하는 경우 스냅샷 버전을 나타내는 문자열입니다. 기본값: None

list_handles

디렉터리 또는 지정된 공유 아래의 파일에서 열린 핸들을 나열하는 생성기를 반환합니다. 생성기는 서비스에서 반환된 연속 토큰을 느리게 따르고 모든 핸들이 반환되거나 num_results 도달하면 중지됩니다.

num_results 지정되고 공유에 해당 수의 파일 및 디렉터리보다 많은 경우 생성기는 완료되면 채워진 next_marker 필드를 갖게 됩니다. 이 표식은 더 많은 결과가 필요한 경우 새 생성기를 만드는 데 사용할 수 있습니다.

list_handles(share_name, directory_name=None, file_name=None, recursive=None, max_results=None, marker=None, snapshot=None, timeout=None)

매개 변수

Name	Description
share_name 필수	str 기존 공유의 이름입니다.
directory_name	str 디렉터리 경로입니다. 기본값: None
file_name	str 기존 파일의 이름입니다. 기본값: None
recursive	bool 작업이 URI, 해당 파일, 해당 하위 디렉터리 및 해당 파일에 지정된 디렉터리에 적용되어야 하는지 여부를 지정하는 부울입니다. 기본값: None
max_results	int 반환할 파일 및/또는 디렉터리에서 수행되는 최대 핸들 수를 지정합니다. 요청이 max_results 지정하지 않거나 5,000보다 큰 값을 지정하는 경우 서버는 최대 5,000개의 항목을 반환합니다. max_results 0보다 작거나 같은 값으로 설정하면 오류 응답 코드 400(잘못된 요청)이 발생합니다. 기본값: None
marker	str 불투명 연속 토큰입니다. 이 값은 max_results 지정되고 해당 생성기가 결과 열거를 완료한 경우 이전 생성기 개체의 next_marker 필드에서 검색할 수 있습니다. 지정된 경우 이 생성기는 이전 생성기가 중지된 지점에서 결과를 반환하기 시작합니다. 기본값: None
snapshot	str 해당하는 경우 스냅샷 버전을 나타내는 문자열입니다. 기본값: None
timeout	int 시간 초과 매개 변수는 초 단위로 표현됩니다. 기본값: None

list_ranges

파일의 유효한 범위를 검색합니다.

list_ranges(share_name, directory_name, file_name, start_range=None, end_range=None, timeout=None, snapshot=None)

매개 변수

Name	Description
share_name 필수	str 기존 공유의 이름입니다.
directory_name 필수	str 디렉터리 경로입니다.
file_name 필수	str 기존 파일의 이름입니다.
start_range	int 범위를 나열할 바이트의 시작 오프셋을 지정합니다. start_range 및 end_range 매개 변수는 포함됩니다. 예: start_range=0, end_range=511은 처음 512바이트의 파일을 다운로드합니다. 기본값: None
end_range	int 범위를 나열할 바이트의 끝 오프셋을 지정합니다. start_range 및 end_range 매개 변수는 포함됩니다. 예: start_range=0, end_range=511은 처음 512바이트의 파일을 다운로드합니다. 기본값: None
timeout	int 시간 초과 매개 변수는 초 단위로 표현됩니다. 기본값: None
snapshot	str 해당하는 경우 스냅샷 버전을 나타내는 문자열입니다. 기본값: None

반환

형식	Description
<xref:a> list <xref:of> FileRange	유효한 범위 목록

list_shares

지정된 계정 아래의 공유를 나열하는 생성기를 반환합니다. 생성기는 서비스에서 반환된 연속 토큰을 느리게 따르고 모든 공유가 반환되거나 num_results 도달하면 중지됩니다.

num_results 지정되고 계정에 해당 공유 수보다 많은 경우 생성기는 완료되면 채워진 next_marker 필드를 갖게 됩니다. 이 표식은 더 많은 결과가 필요한 경우 새 생성기를 만드는 데 사용할 수 있습니다.

list_shares(prefix=None, marker=None, num_results=None, include_metadata=False, timeout=None, include_snapshots=False)

매개 변수

Name	Description
prefix	str 이름을 지정된 접두사로 시작하는 공유만 반환하도록 결과를 필터링합니다. 기본값: None
num_results	int 반환할 최대 공유 수를 지정합니다. 기본값: None
include_metadata	bool 공유 메타데이터가 응답에 반환되도록 지정합니다. 기본값: False
marker	str 불투명 연속 토큰입니다. 이 값은 num_results 지정되고 생성기가 결과 열거를 완료한 경우 이전 생성기 개체의 next_marker 필드에서 검색할 수 있습니다. 지정된 경우 이 생성기는 이전 생성기가 중지된 지점에서 결과를 반환하기 시작합니다. 기본값: None
timeout	int 시간 초과 매개 변수는 초 단위로 표현됩니다. 기본값: None
include_snapshots	bool 공유 스냅샷이 응답에 반환되도록 지정합니다. 기본값: False

make_file_url

파일에 액세스하는 URL을 만듭니다.

make_file_url(share_name, directory_name, file_name, protocol=None, sas_token=None)

매개 변수

Name	Description
share_name 필수	str 공유 이름입니다.
directory_name 필수	str 디렉터리 경로입니다.
file_name 필수	str 파일의 이름입니다.
protocol	str 사용할 프로토콜: 'http' 또는 'https'. 지정하지 않으면 FileService가 초기화될 때 지정된 프로토콜을 사용합니다. 기본값: None
sas_token	str generate_shared_access_signature 사용하여 만든 공유 액세스 서명 토큰입니다. 기본값: None

반환

형식	Description
str	파일 액세스 URL입니다.

resize_file

파일의 크기를 지정된 크기로 조정합니다. 지정된 바이트 값이 현재 파일의 크기보다 작으면 지정된 바이트 값을 넘는 모든 범위가 지워집니다.

resize_file(share_name, directory_name, file_name, content_length, timeout=None)

매개 변수

Name	Description
share_name 필수	str 기존 공유의 이름입니다.
directory_name 필수	str 디렉터리 경로입니다.
file_name 필수	str 기존 파일의 이름입니다.
content_length 필수	int 파일 크기를 조정할 길이입니다.
timeout	int 시간 초과 매개 변수는 초 단위로 표현됩니다. 기본값: None

set_directory_metadata

지정된 디렉터리에 대해 하나 이상의 사용자 정의 이름-값 쌍을 설정합니다. 이 작업을 호출할 때마다 디렉터리에 연결된 기존의 모든 메타데이터가 바뀝니다. 디렉터리에서 모든 메타데이터를 제거하려면 메타데이터 받아쓰기 없이 이 작업을 호출합니다.

set_directory_metadata(share_name, directory_name, metadata=None, timeout=None)

매개 변수

Name	Description
share_name 필수	str 기존 공유의 이름입니다.
directory_name 필수	str 디렉터리 경로입니다.
metadata	dict(str, str)<xref:./> 디렉터리에 메타데이터로 연결할 이름-값 쌍을 포함하는 받아쓰기입니다. 예: {'category':'test'} 기본값: None
timeout	int 시간 초과 매개 변수는 초 단위로 표현됩니다. 기본값: None

set_directory_properties

set_directory_properties(share_name, directory_name, file_permission=None, smb_properties=<azure.storage.file.models.SMBProperties object>, timeout=None)

매개 변수

Name	Description
share_name 필수	공유 이름
directory_name 필수	디렉터리 이름
file_permission	str 파일 권한, 이식 가능한 SDDL 기본값: None
smb_properties	SMBProperties SMB 관련 파일 속성 설정
timeout	int 시간 초과 매개 변수는 초 단위로 표현됩니다. 기본값: None

set_file_metadata

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

set_file_metadata(share_name, directory_name, file_name, metadata=None, timeout=None)

매개 변수

Name	Description
share_name 필수	str 기존 공유의 이름입니다.
directory_name 필수	str 디렉터리 경로입니다.
file_name 필수	str 기존 파일의 이름입니다.
metadata	dict(str, str) 이름 및 값 쌍을 포함하는 Dict입니다. 이 작업을 호출할 때마다 파일에 연결된 기존의 모든 메타데이터가 바뀝니다. 파일에서 모든 메타데이터를 제거하려면 메타데이터 헤더 없이 이 작업을 호출하세요. 기본값: None
timeout	int 시간 초과 매개 변수는 초 단위로 표현됩니다. 기본값: None

set_file_properties

파일의 시스템 속성을 설정합니다. content_settings 대해 하나의 속성이 설정된 경우 모든 속성이 재정의됩니다.

set_file_properties(share_name, directory_name, file_name, content_settings, timeout=None, file_permission=None, smb_properties=<azure.storage.file.models.SMBProperties object>)

매개 변수

Name	Description
share_name 필수	str 기존 공유의 이름입니다.
directory_name 필수	str 디렉터리 경로입니다.
file_name 필수	str 기존 파일의 이름입니다.
content_settings 필수	ContentSettings 파일 속성을 설정하는 데 사용되는 ContentSettings 개체입니다.
file_permission	str 파일 권한, 이식 가능한 SDDL 기본값: None
smb_properties	SMBProperties SMB 관련 파일 속성 설정
timeout	int 시간 초과 매개 변수는 초 단위로 표현됩니다. 기본값: None

set_file_service_properties

Azure 스토리지 분석 포함하여 스토리지 계정의 파일 서비스의 속성을 설정합니다. 요소(예: HourMetrics)가 없음으로 남아 있으면 해당 기능에 대한 서비스의 기존 설정이 유지됩니다.

set_file_service_properties(hour_metrics=None, minute_metrics=None, cors=None, timeout=None)

매개 변수

Name	Description
hour_metrics	<xref:Metrics> 시간 메트릭 설정은 파일에 대한 시간별 집계에서 API별로 그룹화된 요청 통계의 요약을 제공합니다. 기본값: None
minute_metrics	<xref:Metrics> 분 메트릭 설정은 파일에 대한 각 분에 대한 요청 통계를 제공합니다. 기본값: None
cors	list(CorsRule) 목록에 최대 5개의 CorsRule 요소를 포함할 수 있습니다. 빈 목록을 지정하면 모든 CORS 규칙이 삭제되고 서비스에 대해 CORS가 비활성화됩니다. 기본값: None
timeout	int 시간 초과 매개 변수는 초 단위로 표현됩니다. 기본값: None

set_proxy

HTTP CONNECT 터널링에 대한 프록시 서버 호스트 및 포트를 설정합니다.

set_proxy(host, port, user=None, password=None)

매개 변수

Name	Description
host 필수	str 프록시의 주소입니다. 예: '192.168.0.100'
port 필수	int 프록시의 포트입니다. 예: 6000
user	str 프록시 권한 부여를 위한 사용자입니다. 기본값: None
password	str 프록시 권한 부여에 대한 암호입니다. 기본값: None

set_share_acl

공유 액세스 서명과 함께 사용할 수 있는 지정된 공유 또는 저장된 액세스 정책에 대한 권한을 설정합니다.

set_share_acl(share_name, signed_identifiers=None, timeout=None)

매개 변수

Name	Description
share_name 필수	str 기존 공유의 이름입니다.
signed_identifiers	dict(str, AccessPolicy) 공유와 연결할 액세스 정책 사전입니다. 사전에는 최대 5개의 요소가 포함될 수 있습니다. 빈 사전은 서비스에 설정된 액세스 정책을 지웁히게 됩니다. 기본값: None
timeout	int 시간 초과 매개 변수는 초 단위로 표현됩니다. 기본값: None

set_share_metadata

지정된 공유에 대해 하나 이상의 사용자 정의 이름-값 쌍을 설정합니다. 이 작업을 호출할 때마다 공유에 연결된 기존의 모든 메타데이터가 바뀝니다. 공유에서 모든 메타데이터를 제거하려면 메타데이터 받아쓰기 없이 이 작업을 호출합니다.

set_share_metadata(share_name, metadata=None, timeout=None)

매개 변수

Name	Description
share_name 필수	str 기존 공유의 이름입니다.
metadata	dict(str, str) 공유와 메타데이터로 연결할 이름-값 쌍을 포함하는 받아쓰기입니다. 예: {'category':'test'} 기본값: None
timeout	int 시간 초과 매개 변수는 초 단위로 표현됩니다. 기본값: None

set_share_properties

지정된 공유에 대한 서비스 정의 속성을 설정합니다.

set_share_properties(share_name, quota, timeout=None)

매개 변수

Name	Description
share_name 필수	str 기존 공유의 이름입니다.
quota 필수	int 공유의 최대 크기(GB)를 지정합니다. 0보다 크고 5TB(5120GB)보다 작거나 같아야 합니다.
timeout	int 시간 초과 매개 변수는 초 단위로 표현됩니다. 기본값: None

snapshot_share

지정된 계정 아래에 기존 공유의 스냅샷 만듭니다.

snapshot_share(share_name, metadata=None, quota=None, timeout=None)

매개 변수

Name	Description
share_name 필수	str 스냅샷 만들 공유의 이름입니다.
metadata	<xref:<xref:a dict> of <xref:str to str:>> 공유와 메타데이터로 연결할 name_value 쌍이 있는 받아쓰기입니다. 예:{'Category':'test'} 기본값: None
quota	int 공유의 최대 크기(GB)를 지정합니다. 0보다 커야 하고 5TB(5120)보다 작거나 같아야 합니다. 기본값: None
timeout	int 시간 초과 매개 변수는 초 단위로 표현됩니다. 기본값: None

반환

형식	Description
Share	스냅샷 속성

update_range

요청 본문으로 지정된 바이트를 지정된 범위에 기록합니다.

update_range(share_name, directory_name, file_name, data, start_range, end_range, validate_content=False, timeout=None)

매개 변수

Name	Description
share_name 필수	str 기존 공유의 이름입니다.
directory_name 필수	str 디렉터리 경로입니다.
file_name 필수	str 기존 파일의 이름입니다.
data 필수	bytes 범위의 내용입니다.
start_range 필수	int 파일의 섹션을 업데이트하는 데 사용할 바이트 범위의 시작입니다. 범위의 크기는 최대 4MB입니다. start_range 및 end_range 매개 변수는 포함됩니다. 예: start_range=0, end_range=511은 처음 512바이트의 파일을 다운로드합니다.
end_range 필수	int 파일의 섹션을 업데이트하는 데 사용할 바이트 범위의 끝입니다. 범위의 크기는 최대 4MB입니다. start_range 및 end_range 매개 변수는 포함됩니다. 예: start_range=0, end_range=511은 처음 512바이트의 파일을 다운로드합니다.
validate_content	bool true이면 페이지 콘텐츠의 MD5 해시를 계산합니다. 스토리지 서비스는 전송된 해시와 함께 도착한 콘텐츠의 해시를 확인합니다. 이는 https 대신 https(기본값)를 사용하여 이미 유효성을 검사하는 경우 와이어에서 비트플립을 검색하는 데 주로 유용합니다. 이 MD5 해시는 파일과 함께 저장되지 않습니다. 기본값: False
timeout	int 시간 초과 매개 변수는 초 단위로 표현됩니다. 기본값: None

update_range_from_file_url

한 Azure File 엔드포인트의 바이트를 다른 Azure File 엔드포인트의 지정된 범위에 씁니다.

update_range_from_file_url(share_name, directory_name, file_name, start_range, end_range, source, source_start_range, timeout=None)

매개 변수

Name	Description
share_name 필수	str 기존 공유의 이름입니다.
directory_name 필수	str 디렉터리 경로입니다.
file_name 필수	str 기존 파일의 이름입니다.
start_range 필수	int 파일의 섹션을 업데이트하는 데 사용할 바이트 범위의 시작입니다. 범위의 크기는 최대 4MB입니다. start_range 및 end_range 매개 변수는 포함됩니다. 예: start_range=0, end_range=511은 처음 512바이트의 파일을 다운로드합니다.
end_range 필수	int 파일의 섹션을 업데이트하는 데 사용할 바이트 범위의 끝입니다. 범위의 크기는 최대 4MB입니다. start_range 및 end_range 매개 변수는 포함됩니다. 예: start_range=0, end_range=511은 처음 512바이트의 파일을 다운로드합니다.
source 필수	str Azure 파일 또는 Blob을 지정하는 최대 2KB의 URL입니다. 값은 요청 URI에 표시되므로 URL 인코딩해야 합니다. 원본이 다른 계정에 있는 경우 원본은 공용이거나 공유 액세스 서명을 통해 인증되어야 합니다. 원본이 공용인 경우 인증이 필요하지 않습니다. 예: https://myaccount.file.core.windows.net/myshare/mydir/myfilehttps://otheraccount.file.core.windows.net/myshare/mydir/myfile?sastoken
source_start_range 필수	int 파일의 섹션을 업데이트하는 데 사용할 바이트 범위의 시작입니다. 범위의 크기는 최대 4MB입니다. start_range 및 end_range 매개 변수는 포함됩니다. 예: start_range=0, end_range=511은 처음 512바이트의 파일을 다운로드합니다.
timeout	int 시간 초과 매개 변수는 초 단위로 표현됩니다. 기본값: None

특성

protocol

request_session

socket_timeout

MAX_CHUNK_GET_SIZE

MAX_CHUNK_GET_SIZE = 8388608

MAX_RANGE_SIZE

MAX_RANGE_SIZE = 4194304

MAX_SINGLE_GET_SIZE

MAX_SINGLE_GET_SIZE = 33554432