RestApiSecurityRequirement Class

Definition

Namespace:: Microsoft.SemanticKernel.Plugins.OpenApi

Assembly:: Microsoft.SemanticKernel.Plugins.OpenApi.dll

Package:: Microsoft.SemanticKernel.Plugins.OpenApi v1.45.0

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

The REST API security requirement object.

public sealed class RestApiSecurityRequirement : System.Collections.Generic.ICollection<System.Collections.Generic.KeyValuePair<Microsoft.SemanticKernel.Plugins.OpenApi.RestApiSecurityScheme,System.Collections.Generic.IList<string>>>, System.Collections.Generic.IDictionary<Microsoft.SemanticKernel.Plugins.OpenApi.RestApiSecurityScheme,System.Collections.Generic.IList<string>>, System.Collections.Generic.IEnumerable<System.Collections.Generic.KeyValuePair<Microsoft.SemanticKernel.Plugins.OpenApi.RestApiSecurityScheme,System.Collections.Generic.IList<string>>>, System.Collections.Generic.IReadOnlyCollection<System.Collections.Generic.KeyValuePair<Microsoft.SemanticKernel.Plugins.OpenApi.RestApiSecurityScheme,System.Collections.Generic.IList<string>>>, System.Collections.Generic.IReadOnlyDictionary<Microsoft.SemanticKernel.Plugins.OpenApi.RestApiSecurityScheme,System.Collections.Generic.IList<string>>

type RestApiSecurityRequirement = class
    interface IDictionary<RestApiSecurityScheme, IList<string>>
    interface ICollection<KeyValuePair<RestApiSecurityScheme, IList<string>>>
    interface seq<KeyValuePair<RestApiSecurityScheme, IList<string>>>
    interface IEnumerable
    interface IReadOnlyDictionary<RestApiSecurityScheme, IList<string>>
    interface IReadOnlyCollection<KeyValuePair<RestApiSecurityScheme, IList<string>>>

Public NotInheritable Class RestApiSecurityRequirement
Implements ICollection(Of KeyValuePair(Of RestApiSecurityScheme, IList(Of String))), IDictionary(Of RestApiSecurityScheme, IList(Of String)), IEnumerable(Of KeyValuePair(Of RestApiSecurityScheme, IList(Of String))), IReadOnlyCollection(Of KeyValuePair(Of RestApiSecurityScheme, IList(Of String))), IReadOnlyDictionary(Of RestApiSecurityScheme, IList(Of String))

Inheritance: Object
RestApiSecurityRequirement

Implements: ICollection<KeyValuePair<RestApiSecurityScheme,IList<String>>> ICollection<KeyValuePair<TKey,TValue>> IDictionary<RestApiSecurityScheme,IList<String>> IEnumerable<KeyValuePair<RestApiSecurityScheme,IList<String>>> IEnumerable<KeyValuePair<TKey,TValue>> IEnumerable<T> IReadOnlyCollection<KeyValuePair<RestApiSecurityScheme,IList<String>>> IReadOnlyCollection<KeyValuePair<TKey,TValue>> IReadOnlyDictionary<RestApiSecurityScheme,IList<String>> IEnumerable

Properties

Count	Gets the number of elements contained in the RestApiSecurityRequirement.
Item[RestApiSecurityScheme]	Gets or sets the security scheme scopes associated with the specified security scheme.
Keys	Gets an ICollection<T> of all of the security schemes.
Values	Gets an ICollection<T> of all of the security scheme scopes.

Methods

Add(RestApiSecurityScheme, IList<String>)	Adds the specified security scheme to the RestApiSecurityRequirement.
Clear()	Removes all the security schemes from the RestApiSecurityRequirement.
ContainsKey(RestApiSecurityScheme)	Determines whether the RestApiSecurityRequirement contains a specific security scheme.
Remove(RestApiSecurityScheme)	Removes the security scheme with the specified key from the RestApiSecurityRequirement.
TryGetValue(RestApiSecurityScheme, IList<String>)	Get the security scheme scopes associated with the specified security scheme.

Explicit Interface Implementations

ICollection<KeyValuePair<RestApiSecurityScheme,IList<String>>>.Add(KeyValuePair<RestApiSecurityScheme,IList<String>>)	Adds an item to the ICollection<T>.
ICollection<KeyValuePair<RestApiSecurityScheme,IList<String>>>.Contains(KeyValuePair<RestApiSecurityScheme,IList<String>>)	Determines whether the ICollection<T> contains a specific value.
ICollection<KeyValuePair<RestApiSecurityScheme,IList<String>>>.CopyTo(KeyValuePair<RestApiSecurityScheme,IList<String>>[], Int32)	Copies the elements of the ICollection<T> to an Array, starting at a particular Array index.
ICollection<KeyValuePair<RestApiSecurityScheme,IList<String>>>.IsReadOnly	Gets a value indicating whether the ICollection<T> is read-only.
ICollection<KeyValuePair<RestApiSecurityScheme,IList<String>>>.Remove(KeyValuePair<RestApiSecurityScheme,IList<String>>)	Removes the first occurrence of a specific object from the ICollection<T>.
IDictionary<RestApiSecurityScheme,IList<String>>.Add(RestApiSecurityScheme, IList<String>)	Adds an element with the provided key and value to the IDictionary<TKey,TValue>.
IDictionary<RestApiSecurityScheme,IList<String>>.ContainsKey(RestApiSecurityScheme)	Determines whether the IDictionary<TKey,TValue> contains an element with the specified key.
IDictionary<RestApiSecurityScheme,IList<String>>.Item[RestApiSecurityScheme]	Gets or sets the element with the specified key.
IDictionary<RestApiSecurityScheme,IList<String>>.Keys	Gets an ICollection<T> containing the keys of the IDictionary<TKey,TValue>.
IDictionary<RestApiSecurityScheme,IList<String>>.Remove(RestApiSecurityScheme)	Removes the element with the specified key from the IDictionary<TKey,TValue>.
IDictionary<RestApiSecurityScheme,IList<String>>.TryGetValue(RestApiSecurityScheme, IList<String>)	System.Object.System#Collections#Generic#IDictionary{Microsoft#SemanticKernel#Plugins#OpenApi#RestApiSecurityScheme@System#Collections#Generic#IList{System#String}}#TryGetValue(Microsoft.SemanticKernel.Plugins.OpenApi.RestApiSecurityScheme,System.Collections.Generic.IList{System.String}@)
IEnumerable.GetEnumerator()	Returns an enumerator that iterates through a collection.
IEnumerable<KeyValuePair<RestApiSecurityScheme,IList<String>>>.GetEnumerator()	Returns an enumerator that iterates through the collection.
IReadOnlyDictionary<RestApiSecurityScheme,IList<String>>.ContainsKey(RestApiSecurityScheme)	Determines whether the read-only dictionary contains an element that has the specified key.
IReadOnlyDictionary<RestApiSecurityScheme,IList<String>>.Item[RestApiSecurityScheme]	Gets the element that has the specified key in the read-only dictionary.
IReadOnlyDictionary<RestApiSecurityScheme,IList<String>>.Keys	Gets an enumerable collection that contains the keys in the read-only dictionary.
IReadOnlyDictionary<RestApiSecurityScheme,IList<String>>.TryGetValue(RestApiSecurityScheme, IList<String>)	System.Object.System#Collections#Generic#IReadOnlyDictionary{Microsoft#SemanticKernel#Plugins#OpenApi#RestApiSecurityScheme@System#Collections#Generic#IList{System#String}}#TryGetValue(Microsoft.SemanticKernel.Plugins.OpenApi.RestApiSecurityScheme,System.Collections.Generic.IList{System.String}@)
IReadOnlyDictionary<RestApiSecurityScheme,IList<String>>.Values	Gets an enumerable collection that contains the values in the read-only dictionary.

Applies to