Share via


SearchServiceResource Class

Definition

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
SearchServiceResource
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.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}
  • Operation Id: Services_Get
  • Default Api Version: 2024-03-01-preview
  • Resource: SearchServiceResource
AddTagAsync(String, String, CancellationToken)

Add a tag to the current resource.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}
  • Operation Id: Services_Get
  • Default Api Version: 2024-03-01-preview
  • Resource: SearchServiceResource
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.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}/createQueryKey/{name}
  • Operation Id: QueryKeys_Create
  • Default Api Version: 2024-03-01-preview
CreateQueryKeyAsync(String, SearchManagementRequestOptions, CancellationToken)

Generates a new query key for the specified search service. You can create up to 50 query keys per service.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}/createQueryKey/{name}
  • Operation Id: QueryKeys_Create
  • Default Api Version: 2024-03-01-preview
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.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}
  • Operation Id: Services_Delete
  • Default Api Version: 2024-03-01-preview
  • Resource: SearchServiceResource
DeleteAsync(WaitUntil, SearchManagementRequestOptions, CancellationToken)

Deletes a search service in the given resource group, along with its associated resources.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}
  • Operation Id: Services_Delete
  • Default Api Version: 2024-03-01-preview
  • Resource: SearchServiceResource
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.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}/deleteQueryKey/{key}
  • Operation Id: QueryKeys_Delete
  • Default Api Version: 2024-03-01-preview
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.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}/deleteQueryKey/{key}
  • Operation Id: QueryKeys_Delete
  • Default Api Version: 2024-03-01-preview
Get(SearchManagementRequestOptions, CancellationToken)

Gets the search service with the given name in the given resource group.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}
  • Operation Id: Services_Get
  • Default Api Version: 2024-03-01-preview
  • Resource: SearchServiceResource
GetAdminKey(SearchManagementRequestOptions, CancellationToken)

Gets the primary and secondary admin API keys for the specified Azure AI Search service.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}/listAdminKeys
  • Operation Id: AdminKeys_Get
  • Default Api Version: 2024-03-01-preview
GetAdminKeyAsync(SearchManagementRequestOptions, CancellationToken)

Gets the primary and secondary admin API keys for the specified Azure AI Search service.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}/listAdminKeys
  • Operation Id: AdminKeys_Get
  • Default Api Version: 2024-03-01-preview
GetAsync(SearchManagementRequestOptions, CancellationToken)

Gets the search service with the given name in the given resource group.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}
  • Operation Id: Services_Get
  • Default Api Version: 2024-03-01-preview
  • Resource: SearchServiceResource
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.

  • Request Path: /{scope}/providers/Microsoft.Authorization/locks/{lockName}
  • Operation Id: ManagementLocks_GetByScope
  • Default Api Version: 2020-05-01
  • Resource: ManagementLockResource
(Inherited from ArmResource)
GetManagementLockAsync(String, CancellationToken)

Get a management lock by scope.

  • Request Path: /{scope}/providers/Microsoft.Authorization/locks/{lockName}
  • Operation Id: ManagementLocks_GetByScope
  • Default Api Version: 2020-05-01
  • Resource: ManagementLockResource
(Inherited from ArmResource)
GetManagementLocks()

Gets a collection of ManagementLockResources in the ArmResource.

(Inherited from ArmResource)
GetNetworkSecurityPerimeterConfiguration(String, CancellationToken)

Gets a network security perimeter configuration.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}/networkSecurityPerimeterConfigurations/{nspConfigName}
  • Operation Id: NetworkSecurityPerimeterConfigurations_Get
  • Default Api Version: 2024-03-01-preview
  • Resource: NetworkSecurityPerimeterConfigurationResource
GetNetworkSecurityPerimeterConfigurationAsync(String, CancellationToken)

Gets a network security perimeter configuration.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}/networkSecurityPerimeterConfigurations/{nspConfigName}
  • Operation Id: NetworkSecurityPerimeterConfigurations_Get
  • Default Api Version: 2024-03-01-preview
  • Resource: NetworkSecurityPerimeterConfigurationResource
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.

  • Request Path: /{scope}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName}
  • Operation Id: PolicyAssignments_Get
  • Default Api Version: 2022-06-01
  • Resource: PolicyAssignmentResource
(Inherited from ArmResource)
GetPolicyAssignmentAsync(String, CancellationToken)

This operation retrieves a single policy assignment, given its name and the scope it was created at.

  • Request Path: /{scope}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName}
  • Operation Id: PolicyAssignments_Get
  • Default Api Version: 2022-06-01
  • Resource: PolicyAssignmentResource
(Inherited from ArmResource)
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.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}/listQueryKeys
  • Operation Id: QueryKeys_ListBySearchService
  • Default Api Version: 2024-03-01-preview
GetQueryKeysBySearchServiceAsync(SearchManagementRequestOptions, CancellationToken)

Returns the list of query API keys for the given Azure AI Search service.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}/listQueryKeys
  • Operation Id: QueryKeys_ListBySearchService
  • Default Api Version: 2024-03-01-preview
GetSearchPrivateEndpointConnection(String, SearchManagementRequestOptions, CancellationToken)

Gets the details of the private endpoint connection to the search service in the given resource group.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}/privateEndpointConnections/{privateEndpointConnectionName}
  • Operation Id: PrivateEndpointConnections_Get
  • Default Api Version: 2024-03-01-preview
  • Resource: SearchPrivateEndpointConnectionResource
GetSearchPrivateEndpointConnectionAsync(String, SearchManagementRequestOptions, CancellationToken)

Gets the details of the private endpoint connection to the search service in the given resource group.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}/privateEndpointConnections/{privateEndpointConnectionName}
  • Operation Id: PrivateEndpointConnections_Get
  • Default Api Version: 2024-03-01-preview
  • Resource: SearchPrivateEndpointConnectionResource
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.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}/sharedPrivateLinkResources/{sharedPrivateLinkResourceName}
  • Operation Id: SharedPrivateLinkResources_Get
  • Default Api Version: 2024-03-01-preview
  • Resource: SharedSearchServicePrivateLinkResource
GetSharedSearchServicePrivateLinkResourceAsync(String, SearchManagementRequestOptions, CancellationToken)

Gets the details of the shared private link resource managed by the search service in the given resource group.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}/sharedPrivateLinkResources/{sharedPrivateLinkResourceName}
  • Operation Id: SharedPrivateLinkResources_Get
  • Default Api Version: 2024-03-01-preview
  • Resource: SharedSearchServicePrivateLinkResource
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.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}/privateLinkResources
  • Operation Id: PrivateLinkResources_ListSupported
  • Default Api Version: 2024-03-01-preview
GetSupportedPrivateLinkResourcesAsync(SearchManagementRequestOptions, CancellationToken)

Gets a list of all supported private link resource types for the given service.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}/privateLinkResources
  • Operation Id: PrivateLinkResources_ListSupported
  • Default Api Version: 2024-03-01-preview
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.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}/regenerateAdminKey/{keyKind}
  • Operation Id: AdminKeys_Regenerate
  • Default Api Version: 2024-03-01-preview
RegenerateAdminKeyAsync(SearchServiceAdminKeyKind, SearchManagementRequestOptions, CancellationToken)

Regenerates either the primary or secondary admin API key. You can only regenerate one key at a time.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}/regenerateAdminKey/{keyKind}
  • Operation Id: AdminKeys_Regenerate
  • Default Api Version: 2024-03-01-preview
RemoveTag(String, CancellationToken)

Removes a tag by key from the resource.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}
  • Operation Id: Services_Get
  • Default Api Version: 2024-03-01-preview
  • Resource: SearchServiceResource
RemoveTagAsync(String, CancellationToken)

Removes a tag by key from the resource.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}
  • Operation Id: Services_Get
  • Default Api Version: 2024-03-01-preview
  • Resource: SearchServiceResource
SetTags(IDictionary<String,String>, CancellationToken)

Replace the tags on the resource with the given set.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}
  • Operation Id: Services_Get
  • Default Api Version: 2024-03-01-preview
  • Resource: SearchServiceResource
SetTagsAsync(IDictionary<String,String>, CancellationToken)

Replace the tags on the resource with the given set.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}
  • Operation Id: Services_Get
  • Default Api Version: 2024-03-01-preview
  • Resource: SearchServiceResource
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.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}
  • Operation Id: Services_Update
  • Default Api Version: 2024-03-01-preview
  • Resource: SearchServiceResource
UpdateAsync(SearchServicePatch, SearchManagementRequestOptions, CancellationToken)

Updates an existing search service in the given resource group.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}
  • Operation Id: Services_Update
  • Default Api Version: 2024-03-01-preview
  • Resource: SearchServiceResource

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).

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleDefinitions/{roleDefinitionId}
  • Operation Id: RoleDefinitions_Get
  • Default Api Version: 2022-04-01
  • Resource: AuthorizationRoleDefinitionResource
GetAuthorizationRoleDefinitionAsync(ArmResource, ResourceIdentifier, CancellationToken)

Get role definition by name (GUID).

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleDefinitions/{roleDefinitionId}
  • Operation Id: RoleDefinitions_Get
  • Default Api Version: 2022-04-01
  • Resource: AuthorizationRoleDefinitionResource
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.

  • Request Path: /{scope}/providers/Microsoft.Authorization/denyAssignments/{denyAssignmentId}
  • Operation Id: DenyAssignments_Get
  • Default Api Version: 2022-04-01
  • Resource: DenyAssignmentResource
GetDenyAssignmentAsync(ArmResource, String, CancellationToken)

Get the specified deny assignment.

  • Request Path: /{scope}/providers/Microsoft.Authorization/denyAssignments/{denyAssignmentId}
  • Operation Id: DenyAssignments_Get
  • Default Api Version: 2022-04-01
  • Resource: DenyAssignmentResource
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.

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleAssignments/{roleAssignmentName}
  • Operation Id: RoleAssignments_Get
  • Default Api Version: 2022-04-01
  • Resource: RoleAssignmentResource
GetRoleAssignmentAsync(ArmResource, String, String, CancellationToken)

Get a role assignment by scope and name.

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleAssignments/{roleAssignmentName}
  • Operation Id: RoleAssignments_Get
  • Default Api Version: 2022-04-01
  • Resource: RoleAssignmentResource
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

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleAssignmentSchedules/{roleAssignmentScheduleName}
  • Operation Id: RoleAssignmentSchedules_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleAssignmentScheduleResource
GetRoleAssignmentScheduleAsync(ArmResource, String, CancellationToken)

Get the specified role assignment schedule for a resource scope

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleAssignmentSchedules/{roleAssignmentScheduleName}
  • Operation Id: RoleAssignmentSchedules_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleAssignmentScheduleResource
GetRoleAssignmentScheduleInstance(ArmResource, String, CancellationToken)

Gets the specified role assignment schedule instance.

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleAssignmentScheduleInstances/{roleAssignmentScheduleInstanceName}
  • Operation Id: RoleAssignmentScheduleInstances_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleAssignmentScheduleInstanceResource
GetRoleAssignmentScheduleInstanceAsync(ArmResource, String, CancellationToken)

Gets the specified role assignment schedule instance.

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleAssignmentScheduleInstances/{roleAssignmentScheduleInstanceName}
  • Operation Id: RoleAssignmentScheduleInstances_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleAssignmentScheduleInstanceResource
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.

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleAssignmentScheduleRequests/{roleAssignmentScheduleRequestName}
  • Operation Id: RoleAssignmentScheduleRequests_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleAssignmentScheduleRequestResource
GetRoleAssignmentScheduleRequestAsync(ArmResource, String, CancellationToken)

Get the specified role assignment schedule request.

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleAssignmentScheduleRequests/{roleAssignmentScheduleRequestName}
  • Operation Id: RoleAssignmentScheduleRequests_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleAssignmentScheduleRequestResource
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

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleEligibilitySchedules/{roleEligibilityScheduleName}
  • Operation Id: RoleEligibilitySchedules_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleEligibilityScheduleResource
GetRoleEligibilityScheduleAsync(ArmResource, String, CancellationToken)

Get the specified role eligibility schedule for a resource scope

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleEligibilitySchedules/{roleEligibilityScheduleName}
  • Operation Id: RoleEligibilitySchedules_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleEligibilityScheduleResource
GetRoleEligibilityScheduleInstance(ArmResource, String, CancellationToken)

Gets the specified role eligibility schedule instance.

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleEligibilityScheduleInstances/{roleEligibilityScheduleInstanceName}
  • Operation Id: RoleEligibilityScheduleInstances_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleEligibilityScheduleInstanceResource
GetRoleEligibilityScheduleInstanceAsync(ArmResource, String, CancellationToken)

Gets the specified role eligibility schedule instance.

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleEligibilityScheduleInstances/{roleEligibilityScheduleInstanceName}
  • Operation Id: RoleEligibilityScheduleInstances_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleEligibilityScheduleInstanceResource
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.

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleEligibilityScheduleRequests/{roleEligibilityScheduleRequestName}
  • Operation Id: RoleEligibilityScheduleRequests_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleEligibilityScheduleRequestResource
GetRoleEligibilityScheduleRequestAsync(ArmResource, String, CancellationToken)

Get the specified role eligibility schedule request.

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleEligibilityScheduleRequests/{roleEligibilityScheduleRequestName}
  • Operation Id: RoleEligibilityScheduleRequests_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleEligibilityScheduleRequestResource
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

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleManagementPolicies/{roleManagementPolicyName}
  • Operation Id: RoleManagementPolicies_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleManagementPolicyResource
GetRoleManagementPolicyAssignment(ArmResource, String, CancellationToken)

Get the specified role management policy assignment for a resource scope

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleManagementPolicyAssignments/{roleManagementPolicyAssignmentName}
  • Operation Id: RoleManagementPolicyAssignments_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleManagementPolicyAssignmentResource
GetRoleManagementPolicyAssignmentAsync(ArmResource, String, CancellationToken)

Get the specified role management policy assignment for a resource scope

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleManagementPolicyAssignments/{roleManagementPolicyAssignmentName}
  • Operation Id: RoleManagementPolicyAssignments_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleManagementPolicyAssignmentResource
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

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleManagementPolicies/{roleManagementPolicyName}
  • Operation Id: RoleManagementPolicies_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleManagementPolicyResource
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.

  • Request Path: /{resourceUri}/providers/Microsoft.ServiceLinker/linkers/{linkerName}
  • Operation Id: Linker_Get
GetLinkerResourceAsync(ArmResource, String, CancellationToken)

Returns Linker resource for a given name.

  • Request Path: /{resourceUri}/providers/Microsoft.ServiceLinker/linkers/{linkerName}
  • Operation Id: Linker_Get
GetLinkerResources(ArmResource)

Gets a collection of LinkerResources in the ArmResource. MockingTo mock this method, please mock GetLinkerResources() instead.

Applies to