SharedPrivateLinkResources interface
Interface representing a SharedPrivateLinkResources.
Methods
| begin |
Initiates the creation or update of a shared private link resource managed by the search service in the given resource group. |
| begin |
Initiates the creation or update of a shared private link resource managed by the search service in the given resource group. |
| begin |
Initiates the deletion of the shared private link resource from the search service. |
| begin |
Initiates the deletion of the shared private link resource from the search service. |
| get(string, string, string, Shared |
Gets the details of the shared private link resource managed by the search service in the given resource group. |
| list |
Gets a list of all shared private link resources managed by the given service. |
Method Details
beginCreateOrUpdate(string, string, string, SharedPrivateLinkResource, SharedPrivateLinkResourcesCreateOrUpdateOptionalParams)
Initiates the creation or update of a shared private link resource managed by the search service in the given resource group.
function beginCreateOrUpdate(resourceGroupName: string, searchServiceName: string, sharedPrivateLinkResourceName: string, sharedPrivateLinkResource: SharedPrivateLinkResource, options?: SharedPrivateLinkResourcesCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<SharedPrivateLinkResource>, SharedPrivateLinkResource>>Parameters
- resourceGroupName
-
string
The name of the resource group within the current subscription. You can obtain this value from the Azure Resource Manager API or the portal.
- searchServiceName
-
string
The name of the Azure Cognitive Search service associated with the specified resource group.
- sharedPrivateLinkResourceName
-
string
The name of the shared private link resource managed by the Azure Cognitive Search service within the specified resource group.
- sharedPrivateLinkResource
- SharedPrivateLinkResource
The definition of the shared private link resource to create or update.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<SharedPrivateLinkResource>, SharedPrivateLinkResource>>
beginCreateOrUpdateAndWait(string, string, string, SharedPrivateLinkResource, SharedPrivateLinkResourcesCreateOrUpdateOptionalParams)
Initiates the creation or update of a shared private link resource managed by the search service in the given resource group.
function beginCreateOrUpdateAndWait(resourceGroupName: string, searchServiceName: string, sharedPrivateLinkResourceName: string, sharedPrivateLinkResource: SharedPrivateLinkResource, options?: SharedPrivateLinkResourcesCreateOrUpdateOptionalParams): Promise<SharedPrivateLinkResource>Parameters
- resourceGroupName
-
string
The name of the resource group within the current subscription. You can obtain this value from the Azure Resource Manager API or the portal.
- searchServiceName
-
string
The name of the Azure Cognitive Search service associated with the specified resource group.
- sharedPrivateLinkResourceName
-
string
The name of the shared private link resource managed by the Azure Cognitive Search service within the specified resource group.
- sharedPrivateLinkResource
- SharedPrivateLinkResource
The definition of the shared private link resource to create or update.
The options parameters.
Returns
Promise<SharedPrivateLinkResource>
beginDelete(string, string, string, SharedPrivateLinkResourcesDeleteOptionalParams)
Initiates the deletion of the shared private link resource from the search service.
function beginDelete(resourceGroupName: string, searchServiceName: string, sharedPrivateLinkResourceName: string, options?: SharedPrivateLinkResourcesDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>Parameters
- resourceGroupName
-
string
The name of the resource group within the current subscription. You can obtain this value from the Azure Resource Manager API or the portal.
- searchServiceName
-
string
The name of the Azure Cognitive Search service associated with the specified resource group.
- sharedPrivateLinkResourceName
-
string
The name of the shared private link resource managed by the Azure Cognitive Search service within the specified resource group.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>
beginDeleteAndWait(string, string, string, SharedPrivateLinkResourcesDeleteOptionalParams)
Initiates the deletion of the shared private link resource from the search service.
function beginDeleteAndWait(resourceGroupName: string, searchServiceName: string, sharedPrivateLinkResourceName: string, options?: SharedPrivateLinkResourcesDeleteOptionalParams): Promise<void>Parameters
- resourceGroupName
-
string
The name of the resource group within the current subscription. You can obtain this value from the Azure Resource Manager API or the portal.
- searchServiceName
-
string
The name of the Azure Cognitive Search service associated with the specified resource group.
- sharedPrivateLinkResourceName
-
string
The name of the shared private link resource managed by the Azure Cognitive Search service within the specified resource group.
The options parameters.
Returns
Promise<void>
get(string, string, string, SharedPrivateLinkResourcesGetOptionalParams)
Gets the details of the shared private link resource managed by the search service in the given resource group.
function get(resourceGroupName: string, searchServiceName: string, sharedPrivateLinkResourceName: string, options?: SharedPrivateLinkResourcesGetOptionalParams): Promise<SharedPrivateLinkResource>Parameters
- resourceGroupName
-
string
The name of the resource group within the current subscription. You can obtain this value from the Azure Resource Manager API or the portal.
- searchServiceName
-
string
The name of the Azure Cognitive Search service associated with the specified resource group.
- sharedPrivateLinkResourceName
-
string
The name of the shared private link resource managed by the Azure Cognitive Search service within the specified resource group.
The options parameters.
Returns
Promise<SharedPrivateLinkResource>
listByService(string, string, SharedPrivateLinkResourcesListByServiceOptionalParams)
Gets a list of all shared private link resources managed by the given service.
function listByService(resourceGroupName: string, searchServiceName: string, options?: SharedPrivateLinkResourcesListByServiceOptionalParams): PagedAsyncIterableIterator<SharedPrivateLinkResource, SharedPrivateLinkResource[], PageSettings>Parameters
- resourceGroupName
-
string
The name of the resource group within the current subscription. You can obtain this value from the Azure Resource Manager API or the portal.
- searchServiceName
-
string
The name of the Azure Cognitive Search service associated with the specified resource group.
The options parameters.