Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update WebApiSkill Model with authResourceId #16592

Draft
wants to merge 6 commits into
base: main
Choose a base branch
from
Draft

Update WebApiSkill Model with authResourceId #16592

Changes from 5 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
34ad7f4
Update WebApiSkill Model with authResourceId
andrea-mccool Oct 28, 2021
a279e67
Add authIdentity to definitions
andrea-mccool Dec 15, 2021
0524cd8
auth identity
andrea-mccool Dec 15, 2021
bf6cefb
Update Descriptions
andrea-mccool Dec 17, 2021
62eae94
parameters and descriptions
andrea-mccool Mar 15, 2022
27a5db1
updates
andrea-mccool Mar 18, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions specification/search/data-plane/Azure.Search/preview/2021-04-30-Preview/searchservice.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7584,6 +7584,11 @@
"x-nullable": false
},
"description": "A list of additional projections to perform during indexing."
},
"identity": {
"$ref": "#/definitions/SearchIndexerDataIdentity",
"x-nullable": true,
"description": "The managed identity used for connections to Azure Storage when writing knowledge store projections. If the connection string indicates an identity and it's not specified, the system-assigned managed identity is used. On updates to the indexer, if the identity is unspecified, the value remains unchanged. If set to \"none\", the value of this property is cleared."
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

line 7591 - In the first sentence, can you mention 'user-assigned managed identity? i.e., "The user-assigned managed identity used for connections". In the second sentence, could you include a reference to ResourceId so that it meshes better with our managed identity docs? The amendment would be "If the connection string indicates an identity (ResourceId) and it's not specified"

}
},
"required": [
Expand Down Expand Up @@ -8469,6 +8474,16 @@
"format": "int32",
"x-nullable": true,
"description": "If set, the number of parallel calls that can be made to the Web API."
},
"authResourceId": {
"type": "string",
"x-nullable": true,
"description": "If set, indicates that this skill should use managed identity. This will be used as the resource id for indicating the scope of the authentication token."
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

line 8481. I think this description is too light. I had to go back to our old email threads to understand what this is supposed to be. What do you think about this:

"Applies to custom skills that connect to external code in an Azure function or some other application that provides the transformations. This value should be the application ID created for the function or app when it was registered with Azure Active Directory. When specified, the custom skill connects to the function or app using a managed ID (either system or user-assigned) of the search service and the access token of the function or app."

ID should either be capitalized or spelled out as "identifier".

},
"authIdentity": {
"$ref": "#/definitions/SearchIndexerDataIdentity",
"x-nullable": true,
"description": "The managed identity used for outbound connections. If the connection string indicates an identity and it's not specified, the system-assigned managed identity is used. On updates to the indexer, if the identity is unspecified, the value remains unchanged. If set to \"none\", the value of this property is cleared."
}
},
"required": [
Expand Down Expand Up @@ -9809,6 +9824,11 @@
"type": "boolean",
"x-nullable": true,
"description": "Specifies whether incremental reprocessing is enabled."
},
"identity": {
"$ref": "#/definitions/SearchIndexerDataIdentity",
"x-nullable": true,
"description": "The managed identity used for connections to the enrichment cache. If the connection string indicates an identity and it's not specified, the system-assigned managed identity is used. On updates to the indexer, if the identity is unspecified, the value remains unchanged. If set to \"none\", the value of this property is cleared."
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

line 9831 - In the first sentence, can you mention 'user-assigned managed identity? i.e., "The user-assigned managed identity used for connections". In the second sentence, could you include a reference to ResourceId so that it meshes better with our managed identity docs? The amendment would be "If the connection string indicates an identity (ResourceId) and it's not specified"

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also, any chance this is also used for debug sessions?? If it's the same code, you should add an "and debug session" after "enrichment cache".

}
}
},
Expand Down