Skip to content

Commit 64a253b

Browse files
author
VSC-Service-Account
committed
1 parent a820e73 commit 64a253b

File tree

138 files changed

+7914
-11
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

138 files changed

+7914
-11
lines changed
Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
### YamlMime:TSTypeAlias
2+
name: AdminKeyKind
3+
uid: '@azure/arm-search.AdminKeyKind'
4+
package: '@azure/arm-search'
5+
summary: Defines values for AdminKeyKind.
6+
fullName: AdminKeyKind
7+
remarks: ''
8+
isDeprecated: false
9+
syntax: |
10+
type AdminKeyKind = "primary" | "secondary"
Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
### YamlMime:TSType
2+
name: AdminKeyResult
3+
uid: '@azure/arm-search.AdminKeyResult'
4+
package: '@azure/arm-search'
5+
summary: >-
6+
Response containing the primary and secondary admin API keys for a given Azure
7+
Cognitive Search service.
8+
fullName: AdminKeyResult
9+
remarks: ''
10+
isDeprecated: false
11+
type: interface
12+
properties:
13+
- name: primaryKey
14+
uid: '@azure/arm-search.AdminKeyResult.primaryKey'
15+
package: '@azure/arm-search'
16+
summary: >-
17+
The primary admin API key of the search service.
18+
19+
NOTE: This property will not be serialized. It can only be populated by
20+
the server.
21+
fullName: primaryKey
22+
remarks: ''
23+
isDeprecated: false
24+
syntax:
25+
content: 'primaryKey?: undefined | string'
26+
return:
27+
description: ''
28+
type: undefined | string
29+
- name: secondaryKey
30+
uid: '@azure/arm-search.AdminKeyResult.secondaryKey'
31+
package: '@azure/arm-search'
32+
summary: >-
33+
The secondary admin API key of the search service.
34+
35+
NOTE: This property will not be serialized. It can only be populated by
36+
the server.
37+
fullName: secondaryKey
38+
remarks: ''
39+
isDeprecated: false
40+
syntax:
41+
content: 'secondaryKey?: undefined | string'
42+
return:
43+
description: ''
44+
type: undefined | string
Lines changed: 84 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,84 @@
1+
### YamlMime:TSType
2+
name: AdminKeys
3+
uid: '@azure/arm-search.AdminKeys'
4+
package: '@azure/arm-search'
5+
summary: Interface representing a AdminKeys.
6+
fullName: AdminKeys
7+
remarks: ''
8+
isDeprecated: false
9+
type: interface
10+
methods:
11+
- name: 'get(string, string, AdminKeysGetOptionalParams)'
12+
uid: '@azure/arm-search.AdminKeys.get'
13+
package: '@azure/arm-search'
14+
summary: >-
15+
Gets the primary and secondary admin API keys for the specified Azure
16+
Cognitive Search service.
17+
remarks: ''
18+
isDeprecated: false
19+
syntax:
20+
content: >-
21+
function get(resourceGroupName: string, searchServiceName: string,
22+
options?: AdminKeysGetOptionalParams): Promise<AdminKeysGetResponse>
23+
parameters:
24+
- id: resourceGroupName
25+
type: string
26+
description: >-
27+
The name of the resource group within the current subscription. You
28+
can
29+
obtain this value from the Azure Resource Manager API or the portal.
30+
- id: searchServiceName
31+
type: string
32+
description: |-
33+
The name of the Azure Cognitive Search service associated with the
34+
specified resource group.
35+
- id: options
36+
type: <xref uid="@azure/arm-search.AdminKeysGetOptionalParams" />
37+
description: |
38+
The options parameters.
39+
return:
40+
description: ''
41+
type: Promise&lt;<xref uid="@azure/arm-search.AdminKeysGetResponse" />&gt;
42+
- name: >-
43+
regenerate(string, string, AdminKeyKind,
44+
AdminKeysRegenerateOptionalParams)
45+
uid: '@azure/arm-search.AdminKeys.regenerate'
46+
package: '@azure/arm-search'
47+
summary: >-
48+
Regenerates either the primary or secondary admin API key. You can only
49+
regenerate one key at a
50+
51+
time.
52+
remarks: ''
53+
isDeprecated: false
54+
syntax:
55+
content: >-
56+
function regenerate(resourceGroupName: string, searchServiceName:
57+
string, keyKind: AdminKeyKind, options?:
58+
AdminKeysRegenerateOptionalParams): Promise<AdminKeysRegenerateResponse>
59+
parameters:
60+
- id: resourceGroupName
61+
type: string
62+
description: >-
63+
The name of the resource group within the current subscription. You
64+
can
65+
obtain this value from the Azure Resource Manager API or the portal.
66+
- id: searchServiceName
67+
type: string
68+
description: |-
69+
The name of the Azure Cognitive Search service associated with the
70+
specified resource group.
71+
- id: keyKind
72+
type: <xref uid="@azure/arm-search.AdminKeyKind" />
73+
description: >-
74+
Specifies which key to regenerate. Valid values include 'primary'
75+
and 'secondary'.
76+
- id: options
77+
type: <xref uid="@azure/arm-search.AdminKeysRegenerateOptionalParams" />
78+
description: |
79+
The options parameters.
80+
return:
81+
description: ''
82+
type: >-
83+
Promise&lt;<xref uid="@azure/arm-search.AdminKeysRegenerateResponse"
84+
/>&gt;
Lines changed: 93 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,93 @@
1+
### YamlMime:TSType
2+
name: AdminKeysGetOptionalParams
3+
uid: '@azure/arm-search.AdminKeysGetOptionalParams'
4+
package: '@azure/arm-search'
5+
summary: Optional parameters.
6+
fullName: AdminKeysGetOptionalParams
7+
remarks: ''
8+
isDeprecated: false
9+
type: interface
10+
properties:
11+
- name: searchManagementRequestOptions
12+
uid: >-
13+
@azure/arm-search.AdminKeysGetOptionalParams.searchManagementRequestOptions
14+
package: '@azure/arm-search'
15+
summary: Parameter group
16+
fullName: searchManagementRequestOptions
17+
remarks: ''
18+
isDeprecated: false
19+
syntax:
20+
content: 'searchManagementRequestOptions?: SearchManagementRequestOptions'
21+
return:
22+
description: ''
23+
type: <xref uid="@azure/arm-search.SearchManagementRequestOptions" />
24+
inheritedProperties:
25+
- name: abortSignal
26+
uid: '@azure/arm-search.AdminKeysGetOptionalParams.abortSignal'
27+
package: '@azure/arm-search'
28+
summary: The signal which can be used to abort requests.
29+
fullName: abortSignal
30+
remarks: ''
31+
isDeprecated: false
32+
syntax:
33+
content: 'abortSignal?: AbortSignalLike'
34+
return:
35+
description: ''
36+
type: AbortSignalLike
37+
inheritanceDescription: <b>Inherited From</b> OperationOptions.abortSignal
38+
- name: onResponse
39+
uid: '@azure/arm-search.AdminKeysGetOptionalParams.onResponse'
40+
package: '@azure/arm-search'
41+
summary: |-
42+
A function to be called each time a response is received from the server
43+
while performing the requested operation.
44+
May be called multiple times.
45+
fullName: onResponse
46+
remarks: ''
47+
isDeprecated: false
48+
syntax:
49+
content: 'onResponse?: RawResponseCallback'
50+
return:
51+
description: ''
52+
type: RawResponseCallback
53+
inheritanceDescription: <b>Inherited From</b> OperationOptions.onResponse
54+
- name: requestOptions
55+
uid: '@azure/arm-search.AdminKeysGetOptionalParams.requestOptions'
56+
package: '@azure/arm-search'
57+
summary: Options used when creating and sending HTTP requests for this operation.
58+
fullName: requestOptions
59+
remarks: ''
60+
isDeprecated: false
61+
syntax:
62+
content: 'requestOptions?: OperationRequestOptions'
63+
return:
64+
description: ''
65+
type: OperationRequestOptions
66+
inheritanceDescription: <b>Inherited From</b> OperationOptions.requestOptions
67+
- name: serializerOptions
68+
uid: '@azure/arm-search.AdminKeysGetOptionalParams.serializerOptions'
69+
package: '@azure/arm-search'
70+
summary: Options to override serialization/de-serialization behavior.
71+
fullName: serializerOptions
72+
remarks: ''
73+
isDeprecated: false
74+
syntax:
75+
content: 'serializerOptions?: SerializerOptions'
76+
return:
77+
description: ''
78+
type: SerializerOptions
79+
inheritanceDescription: <b>Inherited From</b> OperationOptions.serializerOptions
80+
- name: tracingOptions
81+
uid: '@azure/arm-search.AdminKeysGetOptionalParams.tracingOptions'
82+
package: '@azure/arm-search'
83+
summary: Options used when tracing is enabled.
84+
fullName: tracingOptions
85+
remarks: ''
86+
isDeprecated: false
87+
syntax:
88+
content: 'tracingOptions?: OperationTracingOptions'
89+
return:
90+
description: ''
91+
type: OperationTracingOptions
92+
inheritanceDescription: <b>Inherited From</b> OperationOptions.tracingOptions
93+
extends: OperationOptions
Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
### YamlMime:TSTypeAlias
2+
name: AdminKeysGetResponse
3+
uid: '@azure/arm-search.AdminKeysGetResponse'
4+
package: '@azure/arm-search'
5+
summary: Contains response data for the get operation.
6+
fullName: AdminKeysGetResponse
7+
remarks: ''
8+
isDeprecated: false
9+
syntax: |
10+
type AdminKeysGetResponse = AdminKeyResult
Lines changed: 93 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,93 @@
1+
### YamlMime:TSType
2+
name: AdminKeysRegenerateOptionalParams
3+
uid: '@azure/arm-search.AdminKeysRegenerateOptionalParams'
4+
package: '@azure/arm-search'
5+
summary: Optional parameters.
6+
fullName: AdminKeysRegenerateOptionalParams
7+
remarks: ''
8+
isDeprecated: false
9+
type: interface
10+
properties:
11+
- name: searchManagementRequestOptions
12+
uid: >-
13+
@azure/arm-search.AdminKeysRegenerateOptionalParams.searchManagementRequestOptions
14+
package: '@azure/arm-search'
15+
summary: Parameter group
16+
fullName: searchManagementRequestOptions
17+
remarks: ''
18+
isDeprecated: false
19+
syntax:
20+
content: 'searchManagementRequestOptions?: SearchManagementRequestOptions'
21+
return:
22+
description: ''
23+
type: <xref uid="@azure/arm-search.SearchManagementRequestOptions" />
24+
inheritedProperties:
25+
- name: abortSignal
26+
uid: '@azure/arm-search.AdminKeysRegenerateOptionalParams.abortSignal'
27+
package: '@azure/arm-search'
28+
summary: The signal which can be used to abort requests.
29+
fullName: abortSignal
30+
remarks: ''
31+
isDeprecated: false
32+
syntax:
33+
content: 'abortSignal?: AbortSignalLike'
34+
return:
35+
description: ''
36+
type: AbortSignalLike
37+
inheritanceDescription: <b>Inherited From</b> OperationOptions.abortSignal
38+
- name: onResponse
39+
uid: '@azure/arm-search.AdminKeysRegenerateOptionalParams.onResponse'
40+
package: '@azure/arm-search'
41+
summary: |-
42+
A function to be called each time a response is received from the server
43+
while performing the requested operation.
44+
May be called multiple times.
45+
fullName: onResponse
46+
remarks: ''
47+
isDeprecated: false
48+
syntax:
49+
content: 'onResponse?: RawResponseCallback'
50+
return:
51+
description: ''
52+
type: RawResponseCallback
53+
inheritanceDescription: <b>Inherited From</b> OperationOptions.onResponse
54+
- name: requestOptions
55+
uid: '@azure/arm-search.AdminKeysRegenerateOptionalParams.requestOptions'
56+
package: '@azure/arm-search'
57+
summary: Options used when creating and sending HTTP requests for this operation.
58+
fullName: requestOptions
59+
remarks: ''
60+
isDeprecated: false
61+
syntax:
62+
content: 'requestOptions?: OperationRequestOptions'
63+
return:
64+
description: ''
65+
type: OperationRequestOptions
66+
inheritanceDescription: <b>Inherited From</b> OperationOptions.requestOptions
67+
- name: serializerOptions
68+
uid: '@azure/arm-search.AdminKeysRegenerateOptionalParams.serializerOptions'
69+
package: '@azure/arm-search'
70+
summary: Options to override serialization/de-serialization behavior.
71+
fullName: serializerOptions
72+
remarks: ''
73+
isDeprecated: false
74+
syntax:
75+
content: 'serializerOptions?: SerializerOptions'
76+
return:
77+
description: ''
78+
type: SerializerOptions
79+
inheritanceDescription: <b>Inherited From</b> OperationOptions.serializerOptions
80+
- name: tracingOptions
81+
uid: '@azure/arm-search.AdminKeysRegenerateOptionalParams.tracingOptions'
82+
package: '@azure/arm-search'
83+
summary: Options used when tracing is enabled.
84+
fullName: tracingOptions
85+
remarks: ''
86+
isDeprecated: false
87+
syntax:
88+
content: 'tracingOptions?: OperationTracingOptions'
89+
return:
90+
description: ''
91+
type: OperationTracingOptions
92+
inheritanceDescription: <b>Inherited From</b> OperationOptions.tracingOptions
93+
extends: OperationOptions
Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
### YamlMime:TSTypeAlias
2+
name: AdminKeysRegenerateResponse
3+
uid: '@azure/arm-search.AdminKeysRegenerateResponse'
4+
package: '@azure/arm-search'
5+
summary: Contains response data for the regenerate operation.
6+
fullName: AdminKeysRegenerateResponse
7+
remarks: ''
8+
isDeprecated: false
9+
syntax: |
10+
type AdminKeysRegenerateResponse = AdminKeyResult
Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
### YamlMime:TSType
2+
name: AsyncOperationResult
3+
uid: '@azure/arm-search.AsyncOperationResult'
4+
package: '@azure/arm-search'
5+
summary: >-
6+
The details of a long running asynchronous shared private link resource
7+
operation
8+
fullName: AsyncOperationResult
9+
remarks: ''
10+
isDeprecated: false
11+
type: interface
12+
properties:
13+
- name: status
14+
uid: '@azure/arm-search.AsyncOperationResult.status'
15+
package: '@azure/arm-search'
16+
summary: >-
17+
The current status of the long running asynchronous shared private link
18+
resource operation.
19+
fullName: status
20+
remarks: ''
21+
isDeprecated: false
22+
syntax:
23+
content: 'status?: SharedPrivateLinkResourceAsyncOperationResult'
24+
return:
25+
description: ''
26+
type: >-
27+
<xref
28+
uid="@azure/arm-search.SharedPrivateLinkResourceAsyncOperationResult"
29+
/>

0 commit comments

Comments
 (0)