PrivateEndpointConnections interface
Interface representing a PrivateEndpointConnections.
Methods
| begin |
Update the state of the specified private endpoint connection associated with the service. |
| begin |
Update the state of the specified private endpoint connection associated with the service. |
| begin |
Deletes a private endpoint connection. |
| begin |
Deletes a private endpoint connection. |
| get(string, string, string, Private |
Gets the specified private endpoint connection associated with the service. |
| list |
Lists all private endpoint connections for a service. |
Method Details
beginCreateOrUpdate(string, string, string, PrivateEndpointConnection, PrivateEndpointConnectionsCreateOrUpdateOptionalParams)
Update the state of the specified private endpoint connection associated with the service.
function beginCreateOrUpdate(resourceGroupName: string, resourceName: string, privateEndpointConnectionName: string, properties: PrivateEndpointConnection, options?: PrivateEndpointConnectionsCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<PrivateEndpointConnectionDescription>, PrivateEndpointConnectionDescription>>Parameters
- resourceGroupName
-
string
The name of the resource group that contains the service instance.
- resourceName
-
string
The name of the service instance.
- privateEndpointConnectionName
-
string
The name of the private endpoint connection associated with the Azure resource
- properties
- PrivateEndpointConnection
The private endpoint connection properties.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<PrivateEndpointConnectionDescription>, PrivateEndpointConnectionDescription>>
beginCreateOrUpdateAndWait(string, string, string, PrivateEndpointConnection, PrivateEndpointConnectionsCreateOrUpdateOptionalParams)
Update the state of the specified private endpoint connection associated with the service.
function beginCreateOrUpdateAndWait(resourceGroupName: string, resourceName: string, privateEndpointConnectionName: string, properties: PrivateEndpointConnection, options?: PrivateEndpointConnectionsCreateOrUpdateOptionalParams): Promise<PrivateEndpointConnectionDescription>Parameters
- resourceGroupName
-
string
The name of the resource group that contains the service instance.
- resourceName
-
string
The name of the service instance.
- privateEndpointConnectionName
-
string
The name of the private endpoint connection associated with the Azure resource
- properties
- PrivateEndpointConnection
The private endpoint connection properties.
The options parameters.
Returns
Promise<PrivateEndpointConnectionDescription>
beginDelete(string, string, string, PrivateEndpointConnectionsDeleteOptionalParams)
Deletes a private endpoint connection.
function beginDelete(resourceGroupName: string, resourceName: string, privateEndpointConnectionName: string, options?: PrivateEndpointConnectionsDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>Parameters
- resourceGroupName
-
string
The name of the resource group that contains the service instance.
- resourceName
-
string
The name of the service instance.
- privateEndpointConnectionName
-
string
The name of the private endpoint connection associated with the Azure resource
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>
beginDeleteAndWait(string, string, string, PrivateEndpointConnectionsDeleteOptionalParams)
Deletes a private endpoint connection.
function beginDeleteAndWait(resourceGroupName: string, resourceName: string, privateEndpointConnectionName: string, options?: PrivateEndpointConnectionsDeleteOptionalParams): Promise<void>Parameters
- resourceGroupName
-
string
The name of the resource group that contains the service instance.
- resourceName
-
string
The name of the service instance.
- privateEndpointConnectionName
-
string
The name of the private endpoint connection associated with the Azure resource
The options parameters.
Returns
Promise<void>
get(string, string, string, PrivateEndpointConnectionsGetOptionalParams)
Gets the specified private endpoint connection associated with the service.
function get(resourceGroupName: string, resourceName: string, privateEndpointConnectionName: string, options?: PrivateEndpointConnectionsGetOptionalParams): Promise<PrivateEndpointConnectionDescription>Parameters
- resourceGroupName
-
string
The name of the resource group that contains the service instance.
- resourceName
-
string
The name of the service instance.
- privateEndpointConnectionName
-
string
The name of the private endpoint connection associated with the Azure resource
The options parameters.
Returns
Promise<PrivateEndpointConnectionDescription>
listByService(string, string, PrivateEndpointConnectionsListByServiceOptionalParams)
Lists all private endpoint connections for a service.
function listByService(resourceGroupName: string, resourceName: string, options?: PrivateEndpointConnectionsListByServiceOptionalParams): PagedAsyncIterableIterator<PrivateEndpointConnectionDescription, PrivateEndpointConnectionDescription[], PageSettings>Parameters
- resourceGroupName
-
string
The name of the resource group that contains the service instance.
- resourceName
-
string
The name of the service instance.
The options parameters.