SearchServiceResource Class
Definition
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.
A Class representing a SearchService along with the instance operations that can be performed on it. If you have a ResourceIdentifier you can construct a SearchServiceResource from an instance of ArmClient using the GetSearchServiceResource method. Otherwise you can get one from its parent resource ResourceGroupResource using the GetSearchService method.
public class SearchServiceResource : Azure.ResourceManager.ArmResource, System.ClientModel.Primitives.IJsonModel<Azure.ResourceManager.Search.SearchServiceData>, System.ClientModel.Primitives.IPersistableModel<Azure.ResourceManager.Search.SearchServiceData>
type SearchServiceResource = class
inherit ArmResource
interface IJsonModel<SearchServiceData>
interface IPersistableModel<SearchServiceData>
Public Class SearchServiceResource
Inherits ArmResource
Implements IJsonModel(Of SearchServiceData), IPersistableModel(Of SearchServiceData)
- Inheritance
- Implements
Constructors
SearchServiceResource() |
Initializes a new instance of the SearchServiceResource class for mocking. |
Fields
ResourceType |
Gets the resource type for the operations. |
Properties
Client |
Gets the ArmClient this resource client was created from. (Inherited from ArmResource) |
Data |
Gets the data representing this Feature. |
Diagnostics |
Gets the diagnostic options for this resource client. (Inherited from ArmResource) |
Endpoint |
Gets the base uri for this resource client. (Inherited from ArmResource) |
HasData |
Gets whether or not the current instance has data. |
Id |
Gets the resource identifier. (Inherited from ArmResource) |
Pipeline |
Gets the pipeline for this resource client. (Inherited from ArmResource) |
Methods
AddTag(String, String, CancellationToken) |
Add a tag to the current resource.
|
AddTagAsync(String, String, CancellationToken) |
Add a tag to the current resource.
|
CanUseTagResource(CancellationToken) |
Checks to see if the TagResource API is deployed in the current environment. (Inherited from ArmResource) |
CanUseTagResourceAsync(CancellationToken) |
Checks to see if the TagResource API is deployed in the current environment. (Inherited from ArmResource) |
CreateQueryKey(String, SearchManagementRequestOptions, CancellationToken) |
Generates a new query key for the specified search service. You can create up to 50 query keys per service.
|
CreateQueryKeyAsync(String, SearchManagementRequestOptions, CancellationToken) |
Generates a new query key for the specified search service. You can create up to 50 query keys per service.
|
CreateResourceIdentifier(String, String, String) |
Generate the resource identifier of a SearchServiceResource instance. |
Delete(WaitUntil, SearchManagementRequestOptions, CancellationToken) |
Deletes a search service in the given resource group, along with its associated resources.
|
DeleteAsync(WaitUntil, SearchManagementRequestOptions, CancellationToken) |
Deletes a search service in the given resource group, along with its associated resources.
|
DeleteQueryKey(String, SearchManagementRequestOptions, CancellationToken) |
Deletes the specified query key. Unlike admin keys, query keys are not regenerated. The process for regenerating a query key is to delete and then recreate it.
|
DeleteQueryKeyAsync(String, SearchManagementRequestOptions, CancellationToken) |
Deletes the specified query key. Unlike admin keys, query keys are not regenerated. The process for regenerating a query key is to delete and then recreate it.
|
Get(SearchManagementRequestOptions, CancellationToken) |
Gets the search service with the given name in the given resource group.
|
GetAdminKey(SearchManagementRequestOptions, CancellationToken) |
Gets the primary and secondary admin API keys for the specified Azure AI Search service.
|
GetAdminKeyAsync(SearchManagementRequestOptions, CancellationToken) |
Gets the primary and secondary admin API keys for the specified Azure AI Search service.
|
GetAsync(SearchManagementRequestOptions, CancellationToken) |
Gets the search service with the given name in the given resource group.
|
GetAvailableLocations(CancellationToken) |
Lists all available geo-locations. (Inherited from ArmResource) |
GetAvailableLocationsAsync(CancellationToken) |
Lists all available geo-locations. (Inherited from ArmResource) |
GetManagementLock(String, CancellationToken) |
Get a management lock by scope.
|
GetManagementLockAsync(String, CancellationToken) |
Get a management lock by scope.
|
GetManagementLocks() |
Gets a collection of ManagementLockResources in the ArmResource. (Inherited from ArmResource) |
GetNetworkSecurityPerimeterConfiguration(String, CancellationToken) |
Gets a network security perimeter configuration.
|
GetNetworkSecurityPerimeterConfigurationAsync(String, CancellationToken) |
Gets a network security perimeter configuration.
|
GetNetworkSecurityPerimeterConfigurations() |
Gets a collection of NetworkSecurityPerimeterConfigurationResources in the SearchService. |
GetPolicyAssignment(String, CancellationToken) |
This operation retrieves a single policy assignment, given its name and the scope it was created at.
|
GetPolicyAssignmentAsync(String, CancellationToken) |
This operation retrieves a single policy assignment, given its name and the scope it was created at.
|
GetPolicyAssignments() |
Gets a collection of PolicyAssignmentResources in the ArmResource. (Inherited from ArmResource) |
GetQueryKeysBySearchService(SearchManagementRequestOptions, CancellationToken) |
Returns the list of query API keys for the given Azure AI Search service.
|
GetQueryKeysBySearchServiceAsync(SearchManagementRequestOptions, CancellationToken) |
Returns the list of query API keys for the given Azure AI Search service.
|
GetSearchPrivateEndpointConnection(String, SearchManagementRequestOptions, CancellationToken) |
Gets the details of the private endpoint connection to the search service in the given resource group.
|
GetSearchPrivateEndpointConnectionAsync(String, SearchManagementRequestOptions, CancellationToken) |
Gets the details of the private endpoint connection to the search service in the given resource group.
|
GetSearchPrivateEndpointConnections() |
Gets a collection of SearchPrivateEndpointConnectionResources in the SearchService. |
GetSharedSearchServicePrivateLinkResource(String, SearchManagementRequestOptions, CancellationToken) |
Gets the details of the shared private link resource managed by the search service in the given resource group.
|
GetSharedSearchServicePrivateLinkResourceAsync(String, SearchManagementRequestOptions, CancellationToken) |
Gets the details of the shared private link resource managed by the search service in the given resource group.
|
GetSharedSearchServicePrivateLinkResources() |
Gets a collection of SharedSearchServicePrivateLinkResources in the SearchService. |
GetSupportedPrivateLinkResources(SearchManagementRequestOptions, CancellationToken) |
Gets a list of all supported private link resource types for the given service.
|
GetSupportedPrivateLinkResourcesAsync(SearchManagementRequestOptions, CancellationToken) |
Gets a list of all supported private link resource types for the given service.
|
GetTagResource() |
Gets an object representing a TagResource along with the instance operations that can be performed on it in the ArmResource. (Inherited from ArmResource) |
RegenerateAdminKey(SearchServiceAdminKeyKind, SearchManagementRequestOptions, CancellationToken) |
Regenerates either the primary or secondary admin API key. You can only regenerate one key at a time.
|
RegenerateAdminKeyAsync(SearchServiceAdminKeyKind, SearchManagementRequestOptions, CancellationToken) |
Regenerates either the primary or secondary admin API key. You can only regenerate one key at a time.
|
RemoveTag(String, CancellationToken) |
Removes a tag by key from the resource.
|
RemoveTagAsync(String, CancellationToken) |
Removes a tag by key from the resource.
|
SetTags(IDictionary<String,String>, CancellationToken) |
Replace the tags on the resource with the given set.
|
SetTagsAsync(IDictionary<String,String>, CancellationToken) |
Replace the tags on the resource with the given set.
|
TryGetApiVersion(ResourceType, String) |
Gets the api version override if it has been set for the current client options. (Inherited from ArmResource) |
Update(SearchServicePatch, SearchManagementRequestOptions, CancellationToken) |
Updates an existing search service in the given resource group.
|
UpdateAsync(SearchServicePatch, SearchManagementRequestOptions, CancellationToken) |
Updates an existing search service in the given resource group.
|
Explicit Interface Implementations
IJsonModel<SearchServiceData>.Create(Utf8JsonReader, ModelReaderWriterOptions) |
Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model. |
IJsonModel<SearchServiceData>.Write(Utf8JsonWriter, ModelReaderWriterOptions) |
Writes the model to the provided Utf8JsonWriter. |
IPersistableModel<SearchServiceData>.Create(BinaryData, ModelReaderWriterOptions) |
Converts the provided BinaryData into a model. |
IPersistableModel<SearchServiceData>.GetFormatFromOptions(ModelReaderWriterOptions) |
Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service. |
IPersistableModel<SearchServiceData>.Write(ModelReaderWriterOptions) |
Writes the model into a BinaryData. |
Extension Methods
GetAuthorizationRoleDefinition(ArmResource, ResourceIdentifier, CancellationToken) |
Get role definition by name (GUID).
|
GetAuthorizationRoleDefinitionAsync(ArmResource, ResourceIdentifier, CancellationToken) |
Get role definition by name (GUID).
|
GetAuthorizationRoleDefinitions(ArmResource) |
Gets a collection of AuthorizationRoleDefinitionResources in the ArmResource. MockingTo mock this method, please mock GetAuthorizationRoleDefinitions() instead. |
GetDenyAssignment(ArmResource, String, CancellationToken) |
Get the specified deny assignment.
|
GetDenyAssignmentAsync(ArmResource, String, CancellationToken) |
Get the specified deny assignment.
|
GetDenyAssignments(ArmResource) |
Gets a collection of DenyAssignmentResources in the ArmResource. MockingTo mock this method, please mock GetDenyAssignments() instead. |
GetRoleAssignment(ArmResource, String, String, CancellationToken) |
Get a role assignment by scope and name.
|
GetRoleAssignmentAsync(ArmResource, String, String, CancellationToken) |
Get a role assignment by scope and name.
|
GetRoleAssignments(ArmResource) |
Gets a collection of RoleAssignmentResources in the ArmResource. MockingTo mock this method, please mock GetRoleAssignments() instead. |
GetRoleAssignmentSchedule(ArmResource, String, CancellationToken) |
Get the specified role assignment schedule for a resource scope
|
GetRoleAssignmentScheduleAsync(ArmResource, String, CancellationToken) |
Get the specified role assignment schedule for a resource scope
|
GetRoleAssignmentScheduleInstance(ArmResource, String, CancellationToken) |
Gets the specified role assignment schedule instance.
|
GetRoleAssignmentScheduleInstanceAsync(ArmResource, String, CancellationToken) |
Gets the specified role assignment schedule instance.
|
GetRoleAssignmentScheduleInstances(ArmResource) |
Gets a collection of RoleAssignmentScheduleInstanceResources in the ArmResource. MockingTo mock this method, please mock GetRoleAssignmentScheduleInstances() instead. |
GetRoleAssignmentScheduleRequest(ArmResource, String, CancellationToken) |
Get the specified role assignment schedule request.
|
GetRoleAssignmentScheduleRequestAsync(ArmResource, String, CancellationToken) |
Get the specified role assignment schedule request.
|
GetRoleAssignmentScheduleRequests(ArmResource) |
Gets a collection of RoleAssignmentScheduleRequestResources in the ArmResource. MockingTo mock this method, please mock GetRoleAssignmentScheduleRequests() instead. |
GetRoleAssignmentSchedules(ArmResource) |
Gets a collection of RoleAssignmentScheduleResources in the ArmResource. MockingTo mock this method, please mock GetRoleAssignmentSchedules() instead. |
GetRoleEligibilitySchedule(ArmResource, String, CancellationToken) |
Get the specified role eligibility schedule for a resource scope
|
GetRoleEligibilityScheduleAsync(ArmResource, String, CancellationToken) |
Get the specified role eligibility schedule for a resource scope
|
GetRoleEligibilityScheduleInstance(ArmResource, String, CancellationToken) |
Gets the specified role eligibility schedule instance.
|
GetRoleEligibilityScheduleInstanceAsync(ArmResource, String, CancellationToken) |
Gets the specified role eligibility schedule instance.
|
GetRoleEligibilityScheduleInstances(ArmResource) |
Gets a collection of RoleEligibilityScheduleInstanceResources in the ArmResource. MockingTo mock this method, please mock GetRoleEligibilityScheduleInstances() instead. |
GetRoleEligibilityScheduleRequest(ArmResource, String, CancellationToken) |
Get the specified role eligibility schedule request.
|
GetRoleEligibilityScheduleRequestAsync(ArmResource, String, CancellationToken) |
Get the specified role eligibility schedule request.
|
GetRoleEligibilityScheduleRequests(ArmResource) |
Gets a collection of RoleEligibilityScheduleRequestResources in the ArmResource. MockingTo mock this method, please mock GetRoleEligibilityScheduleRequests() instead. |
GetRoleEligibilitySchedules(ArmResource) |
Gets a collection of RoleEligibilityScheduleResources in the ArmResource. MockingTo mock this method, please mock GetRoleEligibilitySchedules() instead. |
GetRoleManagementPolicies(ArmResource) |
Gets a collection of RoleManagementPolicyResources in the ArmResource. MockingTo mock this method, please mock GetRoleManagementPolicies() instead. |
GetRoleManagementPolicy(ArmResource, String, CancellationToken) |
Get the specified role management policy for a resource scope
|
GetRoleManagementPolicyAssignment(ArmResource, String, CancellationToken) |
Get the specified role management policy assignment for a resource scope
|
GetRoleManagementPolicyAssignmentAsync(ArmResource, String, CancellationToken) |
Get the specified role management policy assignment for a resource scope
|
GetRoleManagementPolicyAssignments(ArmResource) |
Gets a collection of RoleManagementPolicyAssignmentResources in the ArmResource. MockingTo mock this method, please mock GetRoleManagementPolicyAssignments() instead. |
GetRoleManagementPolicyAsync(ArmResource, String, CancellationToken) |
Get the specified role management policy for a resource scope
|
GetSystemAssignedIdentity(ArmResource) |
Gets an object representing a SystemAssignedIdentityResource along with the instance operations that can be performed on it in the ArmResource. MockingTo mock this method, please mock GetSystemAssignedIdentity() instead. |
GetLinkerResource(ArmResource, String, CancellationToken) |
Returns Linker resource for a given name.
|
GetLinkerResourceAsync(ArmResource, String, CancellationToken) |
Returns Linker resource for a given name.
|
GetLinkerResources(ArmResource) |
Gets a collection of LinkerResources in the ArmResource. MockingTo mock this method, please mock GetLinkerResources() instead. |