ResourceFile 類別

  • 參考

要下載至計算節點的單一檔案或多個檔案。

繼承
Model
ResourceFile

建構函式

ResourceFile(*, auto_storage_container_name: str = None, storage_container_url: str = None, http_url: str = None, blob_prefix: str = None, file_path: str = None, file_mode: str = None, identity_reference=None, **kwargs)

參數

auto_storage_container_name
str
必要

autoStorageContainerName、storageContainerUrl 和 HTTPUrl 屬性互斥，而且必須指定其中一個屬性。

storage_container_url
str
必要

autoStorageContainerName、storageContainerUrl 和 HTTPUrl 屬性互斥，而且必須指定其中一個屬性。 此 URL 必須可從計算節點讀取且可列出。 有三種方式可取得 Azure 儲存體中容器的這類 URL：包括共用存取簽章 (SAS) 授與容器的讀取和清單許可權、使用具有讀取和列出許可權的受控識別，或設定容器的 ACL 以允許公用存取。

http_url
str
必要

autoStorageContainerName、storageContainerUrl 和 HTTPUrl 屬性互斥，而且必須指定其中一個屬性。 如果 URL 指向 Azure Blob 儲存體，則必須從計算節點讀取。 在 Azure 儲存體中取得 Blob 的這類 URL 有三種方式：包括共用存取簽章 (SAS) 授與 Blob 的讀取權限、使用具有讀取權限的受控識別，或設定 Blob 或其容器的 ACL 以允許公用存取。

blob_prefix
str
必要

只有在使用 autoStorageContainerName 或 storageContainerUrl 時，屬性才有效。 此前置詞可以是部分檔案名或子目錄。 如果未指定前置詞，則會下載容器中的所有檔案。

file_path
str
必要

如果指定 HTTPUrl 屬性，則需要 filePath，並描述將下載檔案的路徑，包括檔案名。 否則，如果指定 autoStorageContainerName 或 storageContainerUrl 屬性，filePath 是選擇性的，而且是要下載檔案的目錄。 在 filePath 做為目錄的情況下，任何已經與輸入資料相關聯的目錄結構都會完整保留，並附加至指定的 filePath 目錄。 指定的相對路徑無法中斷工作的工作目錄，例如使用 '.' (。) 。

file_mode
str
必要

此屬性僅適用于下載至 Linux 計算節點的檔案。 如果針對將下載到 Windows 計算節點的 resourceFile 指定，則會忽略它。 如果未為 Linux 計算節點指定這個屬性，則會將預設值 0770 套用至檔案。

identity_reference
ComputeNodeIdentityReference
必要

用來存取 storageContainerUrl 或 HTTPUrl 所指定之Azure Blob 儲存體的使用者指派身分識別參考。

方法

as_dict

使用 json.dump 傳回可以是 JSONify 的聽寫。

進階用法可以選擇性地使用回呼作為參數：

索引鍵是 Python 中使用的屬性名稱。 Attr_desc是中繼資料的聽寫。 目前包含具有 msrest 類型的 'type'，以及具有 RestAPI 編碼金鑰的 'key'。 Value 是這個 物件中的目前值。

傳回的字串將用來序列化索引鍵。 如果傳回類型是清單，則會將此視為階層式結果聽寫。

請參閱此檔案中的三個範例：

  • attribute_transformer

  • full_restapi_key_transformer

  • last_restapi_key_transformer

如果您想要 XML 序列化，您可以傳遞 kwargs is_xml=True。
deserialize

使用 RestAPI 語法剖析 str 並傳回模型。
enable_additional_properties_sending
from_dict

使用指定的索引鍵擷取器剖析聽寫會傳回模型。

根據預設，請考慮金鑰擷取器 (rest_key_case_insensitive_extractor、attribute_key_case_insensitive_extractor和last_rest_key_case_insensitive_extractor)

is_xml_model
serialize

傳回會從此模型傳送至 Azure 的 JSON。

這是as_dict (full_restapi_key_transformer的別名 ，keep_readonly=False) 。

如果您想要 XML 序列化，您可以傳遞 kwargs is_xml=True。
validate

以遞迴方式驗證此模型，並傳回 ValidationError 的清單。

as_dict

使用 json.dump 傳回可以是 JSONify 的聽寫。

進階用法可以選擇性地使用回呼作為參數：

索引鍵是 Python 中使用的屬性名稱。 Attr_desc是中繼資料的聽寫。 目前包含具有 msrest 類型的 'type'，以及具有 RestAPI 編碼金鑰的 'key'。 Value 是這個 物件中的目前值。

傳回的字串將用來序列化索引鍵。 如果傳回類型是清單，則會將此視為階層式結果聽寫。

請參閱此檔案中的三個範例：

  • attribute_transformer

  • full_restapi_key_transformer

  • last_restapi_key_transformer

如果您想要 XML 序列化，您可以傳遞 kwargs is_xml=True。

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

參數

key_transformer
<xref:function>

按鍵轉換程式函式。

keep_readonly
預設值: True

傳回

聽寫 JSON 相容物件

傳回類型

dict

deserialize

使用 RestAPI 語法剖析 str 並傳回模型。

deserialize(data, content_type=None)

參數

data
str
必要

使用 RestAPI 結構的 str。 根據預設，JSON。

content_type
str
預設值: None

根據預設，如果 XML，請設定 application/xml。

傳回

此模型的實例

例外狀況

DeserializationError if something went wrong

enable_additional_properties_sending 

enable_additional_properties_sending()

from_dict

使用指定的索引鍵擷取器剖析聽寫會傳回模型。

根據預設，請考慮金鑰擷取器 (rest_key_case_insensitive_extractor、attribute_key_case_insensitive_extractor和last_rest_key_case_insensitive_extractor) 

from_dict(data, key_extractors=None, content_type=None)

參數

data
dict
必要

使用 RestAPI 結構的聽寫

content_type
str
預設值: None

根據預設，如果 XML，請設定 application/xml。

key_extractors
預設值: None

傳回

此模型的實例

例外狀況

DeserializationError if something went wrong

is_xml_model 

is_xml_model()

serialize

傳回會從此模型傳送至 Azure 的 JSON。

這是as_dict (full_restapi_key_transformer的別名 ，keep_readonly=False) 。

如果您想要 XML 序列化，您可以傳遞 kwargs is_xml=True。

serialize(keep_readonly=False, **kwargs)

參數

keep_readonly
bool
預設值: False

如果您想要序列化唯讀屬性

傳回

聽寫 JSON 相容物件

傳回類型

dict

validate

以遞迴方式驗證此模型，並傳回 ValidationError 的清單。

validate()

傳回

驗證錯誤清單

傳回類型

list