-
Notifications
You must be signed in to change notification settings - Fork 180
/
Containers.yml
119 lines (117 loc) · 4.24 KB
/
Containers.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
### YamlMime:TSType
name: Containers
uid: '@azure/arm-containerinstance.Containers'
package: '@azure/arm-containerinstance'
summary: Interface representing a Containers.
fullName: Containers
remarks: ''
isDeprecated: false
type: interface
methods:
- name: attach(string, string, string, ContainersAttachOptionalParams)
uid: '@azure/arm-containerinstance.Containers.attach'
package: '@azure/arm-containerinstance'
summary: >-
Attach to the output stream of a specific container instance in a
specified resource group and
container group.
remarks: ''
isDeprecated: false
syntax:
content: >-
function attach(resourceGroupName: string, containerGroupName: string,
containerName: string, options?: ContainersAttachOptionalParams):
Promise<ContainerAttachResponse>
parameters:
- id: resourceGroupName
type: string
description: The name of the resource group.
- id: containerGroupName
type: string
description: The name of the container group.
- id: containerName
type: string
description: The name of the container instance.
- id: options
type: >-
<xref
uid="@azure/arm-containerinstance.ContainersAttachOptionalParams" />
description: The options parameters.
return:
description: ''
type: >-
Promise<<xref
uid="@azure/arm-containerinstance.ContainerAttachResponse" />>
- name: >-
executeCommand(string, string, string, ContainerExecRequest,
ContainersExecuteCommandOptionalParams)
uid: '@azure/arm-containerinstance.Containers.executeCommand'
package: '@azure/arm-containerinstance'
summary: >-
Executes a command for a specific container instance in a specified
resource group and container
group.
remarks: ''
isDeprecated: false
syntax:
content: >-
function executeCommand(resourceGroupName: string, containerGroupName:
string, containerName: string, containerExecRequest:
ContainerExecRequest, options?: ContainersExecuteCommandOptionalParams):
Promise<ContainerExecResponse>
parameters:
- id: resourceGroupName
type: string
description: The name of the resource group.
- id: containerGroupName
type: string
description: The name of the container group.
- id: containerName
type: string
description: The name of the container instance.
- id: containerExecRequest
type: <xref uid="@azure/arm-containerinstance.ContainerExecRequest" />
description: The request for the exec command.
- id: options
type: >-
<xref
uid="@azure/arm-containerinstance.ContainersExecuteCommandOptionalParams"
/>
description: The options parameters.
return:
description: ''
type: >-
Promise<<xref
uid="@azure/arm-containerinstance.ContainerExecResponse" />>
- name: listLogs(string, string, string, ContainersListLogsOptionalParams)
uid: '@azure/arm-containerinstance.Containers.listLogs'
package: '@azure/arm-containerinstance'
summary: >-
Get the logs for a specified container instance in a specified resource
group and container group.
remarks: ''
isDeprecated: false
syntax:
content: >-
function listLogs(resourceGroupName: string, containerGroupName: string,
containerName: string, options?: ContainersListLogsOptionalParams):
Promise<Logs>
parameters:
- id: resourceGroupName
type: string
description: The name of the resource group.
- id: containerGroupName
type: string
description: The name of the container group.
- id: containerName
type: string
description: The name of the container instance.
- id: options
type: >-
<xref
uid="@azure/arm-containerinstance.ContainersListLogsOptionalParams"
/>
description: The options parameters.
return:
description: ''
type: Promise<<xref uid="@azure/arm-containerinstance.Logs" />>