-
Notifications
You must be signed in to change notification settings - Fork 180
/
Peerings.yml
175 lines (174 loc) · 6.45 KB
/
Peerings.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
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
### YamlMime:TSType
name: Peerings
uid: '@azure/arm-peering.Peerings'
package: '@azure/arm-peering'
summary: Interface representing a Peerings.
fullName: Peerings
remarks: ''
isDeprecated: false
type: interface
methods:
- name: >-
createOrUpdate(string, string, Peering,
PeeringsCreateOrUpdateOptionalParams)
uid: '@azure/arm-peering.Peerings.createOrUpdate'
package: '@azure/arm-peering'
summary: >-
Creates a new peering or updates an existing peering with the specified
name under the given
subscription and resource group.
remarks: ''
isDeprecated: false
syntax:
content: >-
function createOrUpdate(resourceGroupName: string, peeringName: string,
peering: Peering, options?: PeeringsCreateOrUpdateOptionalParams):
Promise<Peering>
parameters:
- id: resourceGroupName
type: string
description: The name of the resource group.
- id: peeringName
type: string
description: The name of the peering.
- id: peering
type: <xref uid="@azure/arm-peering.Peering" />
description: The properties needed to create or update a peering.
- id: options
type: >-
<xref uid="@azure/arm-peering.PeeringsCreateOrUpdateOptionalParams"
/>
description: The options parameters.
return:
description: ''
type: Promise<<xref uid="@azure/arm-peering.Peering" />>
- name: delete(string, string, PeeringsDeleteOptionalParams)
uid: '@azure/arm-peering.Peerings.delete'
package: '@azure/arm-peering'
summary: >-
Deletes an existing peering with the specified name under the given
subscription and resource group.
remarks: ''
isDeprecated: false
syntax:
content: >-
function delete(resourceGroupName: string, peeringName: string,
options?: PeeringsDeleteOptionalParams): Promise<void>
parameters:
- id: resourceGroupName
type: string
description: The name of the resource group.
- id: peeringName
type: string
description: The name of the peering.
- id: options
type: <xref uid="@azure/arm-peering.PeeringsDeleteOptionalParams" />
description: The options parameters.
return:
description: ''
type: Promise<void>
- name: get(string, string, PeeringsGetOptionalParams)
uid: '@azure/arm-peering.Peerings.get'
package: '@azure/arm-peering'
summary: >-
Gets an existing peering with the specified name under the given
subscription and resource group.
remarks: ''
isDeprecated: false
syntax:
content: >-
function get(resourceGroupName: string, peeringName: string, options?:
PeeringsGetOptionalParams): Promise<Peering>
parameters:
- id: resourceGroupName
type: string
description: The name of the resource group.
- id: peeringName
type: string
description: The name of the peering.
- id: options
type: <xref uid="@azure/arm-peering.PeeringsGetOptionalParams" />
description: The options parameters.
return:
description: ''
type: Promise<<xref uid="@azure/arm-peering.Peering" />>
- name: listByResourceGroup(string, PeeringsListByResourceGroupOptionalParams)
uid: '@azure/arm-peering.Peerings.listByResourceGroup'
package: '@azure/arm-peering'
summary: Lists all of the peerings under the given subscription and resource group.
remarks: ''
isDeprecated: false
syntax:
content: >-
function listByResourceGroup(resourceGroupName: string, options?:
PeeringsListByResourceGroupOptionalParams):
PagedAsyncIterableIterator<Peering, Peering[], PageSettings>
parameters:
- id: resourceGroupName
type: string
description: The name of the resource group.
- id: options
type: >-
<xref
uid="@azure/arm-peering.PeeringsListByResourceGroupOptionalParams"
/>
description: The options parameters.
return:
description: ''
type: >-
<xref uid="@azure/core-paging.PagedAsyncIterableIterator" /><<xref
uid="@azure/arm-peering.Peering" />, <xref
uid="@azure/arm-peering.Peering" />[], <xref
uid="@azure/core-paging.PageSettings" />>
- name: listBySubscription(PeeringsListBySubscriptionOptionalParams)
uid: '@azure/arm-peering.Peerings.listBySubscription'
package: '@azure/arm-peering'
summary: Lists all of the peerings under the given subscription.
remarks: ''
isDeprecated: false
syntax:
content: >-
function listBySubscription(options?:
PeeringsListBySubscriptionOptionalParams):
PagedAsyncIterableIterator<Peering, Peering[], PageSettings>
parameters:
- id: options
type: >-
<xref
uid="@azure/arm-peering.PeeringsListBySubscriptionOptionalParams" />
description: The options parameters.
return:
description: ''
type: >-
<xref uid="@azure/core-paging.PagedAsyncIterableIterator" /><<xref
uid="@azure/arm-peering.Peering" />, <xref
uid="@azure/arm-peering.Peering" />[], <xref
uid="@azure/core-paging.PageSettings" />>
- name: update(string, string, ResourceTags, PeeringsUpdateOptionalParams)
uid: '@azure/arm-peering.Peerings.update'
package: '@azure/arm-peering'
summary: >-
Updates tags for a peering with the specified name under the given
subscription and resource group.
remarks: ''
isDeprecated: false
syntax:
content: >-
function update(resourceGroupName: string, peeringName: string, tags:
ResourceTags, options?: PeeringsUpdateOptionalParams): Promise<Peering>
parameters:
- id: resourceGroupName
type: string
description: The name of the resource group.
- id: peeringName
type: string
description: The name of the peering.
- id: tags
type: <xref uid="@azure/arm-peering.ResourceTags" />
description: The resource tags.
- id: options
type: <xref uid="@azure/arm-peering.PeeringsUpdateOptionalParams" />
description: The options parameters.
return:
description: ''
type: Promise<<xref uid="@azure/arm-peering.Peering" />>