다음을 통해 공유


ShareClient 클래스

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

이 공유의 특정 디렉터리 또는 파일과 관련된 작업의 경우 및 get_file_client 함수를 사용하여 해당 엔터티에 get_directory_client 대한 클라이언트를 검색할 수도 있습니다.

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

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

생성자

ShareClient(account_url: str, share_name: 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_share_url 사용합니다.

share_name
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"은 스토리지 계정 이름이고 "키"는 스토리지 계정 키여야 합니다.
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입니다.

메서드

acquire_lease

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

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

버전 12.5.0의 새로운 기능입니다.

close

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

create_directory

공유에 디렉터리를 만들고 디렉터리와 상호 작용할 클라이언트를 반환합니다.

create_permission_for_share

공유 수준에서 권한(보안 설명자)을 만듭니다.

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

create_share

계정 아래에 새 공유를 만듭니다. 동일한 이름의 공유가 이미 있는 경우 작업이 실패합니다.

create_snapshot

공유의 스냅샷 만듭니다.

스냅샷 특정 시점에 수행되는 공유의 읽기 전용 버전입니다. 읽기, 복사 또는 삭제할 수 있지만 수정할 수는 없습니다. 스냅샷은 특정 시점에 나타나는 공유를 백업하는 방법을 제공합니다.

공유의 스냅샷 스냅샷 가져온 기본 공유와 이름이 같으며, 날짜/시간 값이 추가되어 스냅샷 수행된 시간을 나타냅니다.

delete_directory

삭제할 디렉터리를 표시합니다. 디렉터리가 나중에 가비지 수집 중에 삭제됩니다.

delete_share

삭제할 지정된 공유를 표시합니다. 공유는 나중에 가비지 수집 중에 삭제됩니다.

from_connection_string

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

from_share_url
get_directory_client

지정된 디렉터리와 상호 작용할 클라이언트를 가져옵니다. 디렉터리가 아직 필요하지 않습니다.

get_file_client

지정된 파일과 상호 작용할 클라이언트를 가져옵니다. 파일이 아직 필요하지 않습니다.

get_permission_for_share

지정된 키에 대한 권한(보안 설명자)을 가져옵니다.

이 '권한'은 공유의 파일/디렉터리에 사용할 수 있습니다.

get_share_access_policy

공유에 대한 권한을 가져옵니다. 사용 권한은 공유의 파일에 공개적으로 액세스할 수 있는지 여부를 나타냅니다.

get_share_properties

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

get_share_stats

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

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

list_directories_and_files

공유 아래의 디렉터리 및 파일을 나열합니다.

set_share_access_policy

공유 액세스 서명과 함께 사용할 수 있는 공유 또는 저장된 액세스 정책에 대한 권한을 설정합니다. 권한은 공유의 파일에 공개적으로 액세스할 수 있는지 여부를 나타냅니다.

set_share_metadata

공유에 대한 메타데이터를 설정합니다.

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

set_share_properties

공유 속성을 설정합니다.

버전 12.4.0의 새로운 기능

set_share_quota

공유에 대한 할당량을 설정합니다.

acquire_lease

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

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

버전 12.5.0의 새로운 기능입니다.

acquire_lease(**kwargs: Any) -> ShareLeaseClient

매개 변수

lease_duration
int

임대 기간(초)을 지정하거나 만료되지 않는 임대의 경우 -1을 지정합니다. 가능한 유한 임대 기간은 15~60초 사이입니다. 갱신 또는 변경을 사용하여 임대 기간을 변경할 수 없습니다. 기본값은 -1(무한 임대)입니다.

lease_id
str

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

timeout
int

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

반환

ShareLeaseClient 개체입니다.

반환 형식

예제

공유에 대한 임대 취득.


   share.create_directory("mydir")
   lease = share.acquire_lease()
   share.get_share_properties(lease=lease)
   share.delete_share(lease=lease)

close

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

close()

create_directory

공유에 디렉터리를 만들고 디렉터리와 상호 작용할 클라이언트를 반환합니다.

create_directory(directory_name: str, **kwargs: Any) -> ShareDirectoryClient

매개 변수

directory_name
str
필수

디렉터리의 이름입니다.

metadata

디렉터리에 메타데이터로 연결된 이름-값 쌍입니다.

timeout
int

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

반환

ShareDirectoryClient

반환 형식

create_permission_for_share

공유 수준에서 권한(보안 설명자)을 만듭니다.

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

create_permission_for_share(file_permission: str, **kwargs: Any) -> str

매개 변수

file_permission
str
필수

파일 권한, 이식 가능한 SDDL

timeout
int

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

반환

파일 권한 키

반환 형식

str

create_share

계정 아래에 새 공유를 만듭니다. 동일한 이름의 공유가 이미 있는 경우 작업이 실패합니다.

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

매개 변수

metadata
dict(str,str)

공유와 연결된 이름-값 쌍을 메타데이터로 사용합니다.

quota
int

할당할 할당량입니다.

access_tier

공유의 액세스 계층을 지정합니다. 가능한 값: 'TransactionOptimized', 'Hot', 'Cool'

timeout
int

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

protocols
str 또는 ShareProtocols

공유에서 사용하도록 설정하는 프로토콜입니다. 공유에서 하나의 프로토콜만 사용하도록 설정할 수 있습니다.

root_squash
str 또는 ShareRootSquash

공유에 설정할 루트 스쿼시. NFS 공유에만 유효합니다. 가능한 값은 'NoRootSquash', 'RootSquash', 'AllSquash'입니다.

반환

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

반환 형식

예제

파일 공유를 만듭니다.


   # Create share with Access Tier set to Hot
   share.create_share(access_tier=ShareAccessTier("Hot"))

create_snapshot

공유의 스냅샷 만듭니다.

스냅샷 특정 시점에 수행되는 공유의 읽기 전용 버전입니다. 읽기, 복사 또는 삭제할 수 있지만 수정할 수는 없습니다. 스냅샷은 특정 시점에 나타나는 공유를 백업하는 방법을 제공합니다.

공유의 스냅샷 스냅샷 가져온 기본 공유와 이름이 같으며, 날짜/시간 값이 추가되어 스냅샷 수행된 시간을 나타냅니다.

create_snapshot(**kwargs: Any | None) -> Dict[str, Any]

매개 변수

metadata
dict(str,str)

공유와 연결된 이름-값 쌍을 메타데이터로 사용합니다.

timeout
int

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

반환

공유 업데이트된 속성 받아쓰기(스냅샷 ID, Etag 및 마지막으로 수정됨).

반환 형식

예제

파일 공유의 스냅샷 만듭니다.


   share.create_snapshot()

delete_directory

삭제할 디렉터리를 표시합니다. 디렉터리가 나중에 가비지 수집 중에 삭제됩니다.

delete_directory(directory_name: str, **kwargs: Any) -> None

매개 변수

directory_name
str
필수

디렉터리의 이름입니다.

timeout
int

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

반환 형식

delete_share

삭제할 지정된 공유를 표시합니다. 공유는 나중에 가비지 수집 중에 삭제됩니다.

delete_share(delete_snapshots: bool | None = False, **kwargs) -> None

매개 변수

delete_snapshots
bool
필수

스냅샷을 삭제할지를 나타냅니다.

lease

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

버전 12.5.0의 새로운 기능입니다.

이 키워드(keyword) 인수는 API 버전 '2020-08-04'에서 도입되었습니다.

timeout
int

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

예제

공유 및 스냅샷을 삭제합니다.


   share.delete_share(delete_snapshots=True)

from_connection_string

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

from_connection_string(conn_str: str, share_name: 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
필수

공유의 이름입니다.

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"은 스토리지 계정 이름이고 "키"는 스토리지 계정 키여야 합니다.

반환

공유 클라이언트입니다.

반환 형식

예제

연결 문자열에서 공유 클라이언트를 가져옵니다.


   from azure.storage.fileshare import ShareClient
   share = ShareClient.from_connection_string(self.connection_string, "sharesamples2")

from_share_url

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

매개 변수

share_url
str
필수

공유에 대한 전체 URI입니다.

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"은 스토리지 계정 이름이고 "키"는 스토리지 계정 키여야 합니다.

반환

공유 클라이언트입니다.

반환 형식

get_directory_client

지정된 디렉터리와 상호 작용할 클라이언트를 가져옵니다. 디렉터리가 아직 필요하지 않습니다.

get_directory_client(directory_path: str | None = None) -> ShareDirectoryClient

매개 변수

directory_path
str
기본값: None

지정된 디렉터리의 경로입니다.

반환

디렉터리 클라이언트입니다.

반환 형식

get_file_client

지정된 파일과 상호 작용할 클라이언트를 가져옵니다. 파일이 아직 필요하지 않습니다.

get_file_client(file_path: str) -> ShareFileClient

매개 변수

file_path
str
필수

지정된 파일의 경로입니다.

반환

파일 클라이언트입니다.

반환 형식

get_permission_for_share

지정된 키에 대한 권한(보안 설명자)을 가져옵니다.

이 '권한'은 공유의 파일/디렉터리에 사용할 수 있습니다.

get_permission_for_share(permission_key: str, **kwargs: Any) -> str

매개 변수

permission_key
str
필수

검색할 파일 권한의 키

timeout
int

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

반환

파일 권한(이식 가능한 SDDL)

반환 형식

str

get_share_access_policy

공유에 대한 권한을 가져옵니다. 사용 권한은 공유의 파일에 공개적으로 액세스할 수 있는지 여부를 나타냅니다.

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

매개 변수

timeout
int

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

lease

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

버전 12.5.0의 새로운 기능입니다.

이 키워드(keyword) 인수는 API 버전 '2020-08-04'에서 도입되었습니다.

반환

받아쓰기에서 정책 정보에 액세스합니다.

반환 형식

get_share_properties

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

get_share_properties(**kwargs: Any) -> ShareProperties

매개 변수

timeout
int

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

lease

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

버전 12.5.0의 새로운 기능입니다.

이 키워드(keyword) 인수는 API 버전 '2020-08-04'에서 도입되었습니다.

반환

공유 속성입니다.

반환 형식

예제

공유 속성을 가져옵니다.


   properties = share.get_share_properties()

get_share_stats

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

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

get_share_stats(**kwargs: Any) -> int

매개 변수

timeout
int

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

lease

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

버전 12.5.0의 새로운 기능입니다.

이 키워드(keyword) 인수는 API 버전 '2020-08-04'에서 도입되었습니다.

반환

공유에 저장된 데이터의 대략적 크기(바이트)입니다.

반환 형식

int

list_directories_and_files

공유 아래의 디렉터리 및 파일을 나열합니다.

list_directories_and_files(directory_name: str | None = None, name_starts_with: str | None = None, marker: str | None = None, **kwargs: Any) -> Iterable[Dict[str, str]]

매개 변수

directory_name
str
필수

디렉터리의 이름입니다.

name_starts_with
str
필수

이름을 지정된 접두사로 시작하는 디렉터리만 반환하도록 결과를 필터링합니다.

marker
str
필수

불투명 연속 토큰입니다. 이 값은 이전 생성기 개체의 next_marker 필드에서 검색할 수 있습니다. 지정한 경우 이 생성기는 이 시점에서 결과를 반환하기 시작합니다.

include
list[str]

응답에 포함할 하나 이상의 데이터 세트를 지정하려면 이 매개 변수를 포함합니다. 가능한 str 값은 "timestamps", "Etag", "Attributes", "PermissionKey"입니다.

버전 12.6.0의 새로운 기능

이 키워드(keyword) 인수는 API 버전 '2020-10-02'에서 도입되었습니다.

include_extended_info
bool

true로 설정하면 나열된 결과에 파일 ID가 반환됩니다.

버전 12.6.0의 새로운 기능

이 키워드(keyword) 인수는 API 버전 '2020-10-02'에서 도입되었습니다.

timeout
int

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

반환

dict와 유사한 DirectoryProperties 및 FileProperties의 자동 페이징 반복 가능

반환 형식

예제

공유의 디렉터리 및 파일을 나열합니다.


   # Create a directory in the share
   dir_client = share.create_directory("mydir")

   # Upload a file to the directory
   with open(SOURCE_FILE, "rb") as source_file:
       dir_client.upload_file(file_name="sample", data=source_file)

   # List files in the directory
   my_files = list(share.list_directories_and_files(directory_name="mydir"))
   print(my_files)

set_share_access_policy

공유 액세스 서명과 함께 사용할 수 있는 공유 또는 저장된 액세스 정책에 대한 권한을 설정합니다. 권한은 공유의 파일에 공개적으로 액세스할 수 있는지 여부를 나타냅니다.

set_share_access_policy(signed_identifiers: Dict[str, AccessPolicy], **kwargs: Any) -> Dict[str, str]

매개 변수

signed_identifiers
dict(str, AccessPolicy)
필수

공유와 연결할 액세스 정책 사전입니다. 사전에는 최대 5개의 요소가 포함될 수 있습니다. 빈 사전은 서비스에 설정된 액세스 정책을 지웁 수 있습니다.

timeout
int

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

lease

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

버전 12.5.0의 새로운 기능

이 키워드(keyword) 인수는 API 버전 '2020-08-04'에서 도입되었습니다.

반환

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

반환 형식

set_share_metadata

공유에 대한 메타데이터를 설정합니다.

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

set_share_metadata(metadata: Dict[str, Any], **kwargs: Any) -> Dict[str, Any]

매개 변수

metadata
dict(str, str)
필수

공유와 연결된 이름-값 쌍을 메타데이터로 사용합니다.

timeout
int

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

lease

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

버전 12.5.0의 새로운 기능

이 키워드(keyword) 인수는 API 버전 '2020-08-04'에서 도입되었습니다.

반환

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

반환 형식

예제

공유 메타데이터를 설정합니다.


   data = {'category': 'test'}
   share.set_share_metadata(metadata=data)

set_share_properties

공유 속성을 설정합니다.

버전 12.4.0의 새로운 기능

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

매개 변수

access_tier
str 또는 <xref:azure.storage.fileshare.models.ShareAccessTier>

공유의 액세스 계층을 지정합니다. 가능한 값: 'TransactionOptimized', 'Hot', 'Cool'

quota
int

공유의 최대 크기(GB)를 지정합니다. 0보다 크고 5TB보다 작거나 같아야 합니다.

timeout
int

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

root_squash
str 또는 ShareRootSquash

공유에 설정할 루트 스쿼시. NFS 공유에만 유효합니다. 가능한 값은 'NoRootSquash', 'RootSquash', 'AllSquash'입니다.

lease

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

반환

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

반환 형식

예제

공유 속성을 설정합니다.


   # Set the tier for the first share to Hot
   share1.set_share_properties(access_tier="Hot")
   # Set the quota for the first share to 3
   share1.set_share_properties(quota=3)
   # Set the tier for the second share to Cool and quota to 2
   share2.set_share_properties(access_tier=ShareAccessTier("Cool"), quota=2)

   # Get the shares' properties
   print(share1.get_share_properties().access_tier)
   print(share1.get_share_properties().quota)
   print(share2.get_share_properties().access_tier)
   print(share2.get_share_properties().quota)

set_share_quota

공유에 대한 할당량을 설정합니다.

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

매개 변수

quota
int
필수

공유의 최대 크기(GB)를 지정합니다. 0보다 크고 5TB보다 작거나 같아야 합니다.

timeout
int

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

lease

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

버전 12.5.0의 새로운 기능

이 키워드(keyword) 인수는 API 버전 '2020-08-04'에서 도입되었습니다.

반환

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

반환 형식

예제

공유 할당량을 설정합니다.


   # Set the quota for the share to 1GB
   share.set_share_quota(quota=1)

특성

api_version

요청에 사용되는 Storage API의 버전입니다.

location_mode

클라이언트가 현재 사용 중인 위치 모드입니다.

기본적으로 "기본"입니다. 옵션에는 "기본" 및 "보조"가 포함됩니다.

primary_endpoint

전체 기본 엔드포인트 URL입니다.

primary_hostname

기본 엔드포인트의 호스트 이름입니다.

secondary_endpoint

구성된 경우 전체 보조 엔드포인트 URL입니다.

사용할 수 없는 경우 ValueError가 발생합니다. 보조 호스트 이름을 명시적으로 지정하려면 인스턴스화에 선택적 secondary_hostname 키워드(keyword) 인수를 사용합니다.

예외

secondary_hostname

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

사용할 수 없는 경우 없음이 됩니다. 보조 호스트 이름을 명시적으로 지정하려면 인스턴스화에 선택적 secondary_hostname 키워드(keyword) 인수를 사용합니다.

url

사용되는 경우 SAS 토큰을 포함하여 이 엔터티에 대한 전체 엔드포인트 URL입니다.

이는 기본 엔드포인트이거나 현재 location_mode에 따라 보조 엔드포인트일 수 있습니다. :returns: 사용되는 경우 SAS 토큰을 포함하여 이 엔터티에 대한 전체 엔드포인트 URL입니다. :rtype: str