-
Notifications
You must be signed in to change notification settings - Fork 232
/
azure.ai.ml.entities.AzureBlobDatastore.yml
128 lines (123 loc) · 4 KB
/
azure.ai.ml.entities.AzureBlobDatastore.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
### YamlMime:PythonClass
uid: azure.ai.ml.entities.AzureBlobDatastore
name: AzureBlobDatastore
fullName: azure.ai.ml.entities.AzureBlobDatastore
module: azure.ai.ml.entities
inheritances:
- azure.ai.ml.entities._datastore.datastore.Datastore
summary: Azure blob storage that is linked to an Azure ML workspace.
constructor:
syntax: 'AzureBlobDatastore(*, name: str, account_name: str, container_name: str,
description: str | None = None, tags: Dict | None = None, endpoint: str | None
= None, protocol: str = ''https'', properties: Dict | None = None, credentials:
AccountKeyConfiguration | SasTokenConfiguration | None = None, **kwargs: Any)'
parameters:
- name: name
description: Name of the datastore.
isRequired: true
types:
- <xref:str>
- name: account_name
description: Name of the Azure storage account.
isRequired: true
types:
- <xref:str>
- name: container_name
description: Name of the container.
isRequired: true
types:
- <xref:str>
- name: description
description: Description of the resource.
isRequired: true
types:
- <xref:str>
- name: tags
description: Tag dictionary. Tags can be added, removed, and updated.
isRequired: true
types:
- <xref:dict>[<xref:str>, <xref:str>]
- name: endpoint
description: Endpoint to use to connect with the Azure storage account.
isRequired: true
types:
- <xref:str>
- name: protocol
description: Protocol to use to connect with the Azure storage account.
isRequired: true
types:
- <xref:str>
- name: properties
description: The asset property dictionary.
isRequired: true
types:
- <xref:dict>[<xref:str>, <xref:str>]
- name: credentials
description: Credentials to use for Azure ML workspace to connect to the storage.
isRequired: true
types:
- <xref:typing.Union>[<xref:azure.ai.ml.entities.AccountKeyConfiguration>, <xref:azure.ai.ml.entities.SasTokenConfiguration>]
- name: kwargs
description: A dictionary of additional configuration parameters.
isRequired: true
types:
- <xref:dict>
keywordOnlyParameters:
- name: name
isRequired: true
- name: account_name
isRequired: true
- name: container_name
isRequired: true
- name: description
isRequired: true
- name: tags
isRequired: true
- name: endpoint
isRequired: true
- name: protocol
defaultValue: https
- name: properties
isRequired: true
- name: credentials
isRequired: true
methods:
- uid: azure.ai.ml.entities.AzureBlobDatastore.dump
name: dump
summary: Dump the datastore content into a file in yaml format.
signature: 'dump(dest: str | PathLike | IO, **kwargs: Any) -> None'
parameters:
- name: dest
description: 'The destination to receive this datastore''s content.
Must be either a path to a local file, or an already-open file stream.
If dest is a file path, a new file will be created,
and an exception is raised if the file exists.
If dest is an open file, the file will be written to directly,
and an exception will be raised if the file is not writable.'
isRequired: true
types:
- <xref:typing.Union>[<xref:PathLike>, <xref:str>, <xref:typing.IO>[<xref:typing.AnyStr>]]
attributes:
- uid: azure.ai.ml.entities.AzureBlobDatastore.base_path
name: base_path
summary: The base path of the resource.
return:
description: The base path of the resource.
types:
- <xref:str>
- uid: azure.ai.ml.entities.AzureBlobDatastore.creation_context
name: creation_context
summary: The creation context of the resource.
return:
description: The creation metadata for the resource.
types:
- <xref:typing.Optional>[<xref:azure.ai.ml.entities.SystemData>]
- uid: azure.ai.ml.entities.AzureBlobDatastore.id
name: id
summary: The resource ID.
return:
description: The global ID of the resource, an Azure Resource Manager (ARM) ID.
types:
- <xref:typing.Optional>[<xref:str>]
- uid: azure.ai.ml.entities.AzureBlobDatastore.type
name: type