Interface RoleInstances
public interface RoleInstances
Resource collection API of RoleInstances.
-
Method Summary
Modifier and TypeMethodDescriptionGets the information of role instance of vendor network function.com.azure.core.http.rest.Response<RoleInstance>
getWithResponse
(String locationName, String vendorName, String serviceKey, String roleInstanceName, com.azure.core.util.Context context) Gets the information of role instance of vendor network function.com.azure.core.http.rest.PagedIterable<RoleInstance>
Lists the information of role instances of vendor network function.com.azure.core.http.rest.PagedIterable<RoleInstance>
list
(String locationName, String vendorName, String serviceKey, com.azure.core.util.Context context) Lists the information of role instances of vendor network function.void
Restarts a role instance of a vendor network function.void
restart
(String locationName, String vendorName, String serviceKey, String roleInstanceName, com.azure.core.util.Context context) Restarts a role instance of a vendor network function.void
Starts a role instance of a vendor network function.void
start
(String locationName, String vendorName, String serviceKey, String roleInstanceName, com.azure.core.util.Context context) Starts a role instance of a vendor network function.void
Powers off (stop) a role instance of a vendor network function.void
stop
(String locationName, String vendorName, String serviceKey, String roleInstanceName, com.azure.core.util.Context context) Powers off (stop) a role instance of a vendor network function.
-
Method Details
-
start
Starts a role instance of a vendor network function.- Parameters:
locationName
- The Azure region where the network function resource was created by customer.vendorName
- The name of the vendor.serviceKey
- The GUID for the vendor network function.roleInstanceName
- The name of the role instance of the vendor network function.- Throws:
IllegalArgumentException
- thrown if parameters fail the validation.com.azure.core.management.exception.ManagementException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.
-
start
void start(String locationName, String vendorName, String serviceKey, String roleInstanceName, com.azure.core.util.Context context) Starts a role instance of a vendor network function.- Parameters:
locationName
- The Azure region where the network function resource was created by customer.vendorName
- The name of the vendor.serviceKey
- The GUID for the vendor network function.roleInstanceName
- The name of the role instance of the vendor network function.context
- The context to associate with this operation.- Throws:
IllegalArgumentException
- thrown if parameters fail the validation.com.azure.core.management.exception.ManagementException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.
-
stop
Powers off (stop) a role instance of a vendor network function.- Parameters:
locationName
- The Azure region where the network function resource was created by customer.vendorName
- The name of the vendor.serviceKey
- The GUID for the vendor network function.roleInstanceName
- The name of the role instance of the vendor network function.- Throws:
IllegalArgumentException
- thrown if parameters fail the validation.com.azure.core.management.exception.ManagementException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.
-
stop
void stop(String locationName, String vendorName, String serviceKey, String roleInstanceName, com.azure.core.util.Context context) Powers off (stop) a role instance of a vendor network function.- Parameters:
locationName
- The Azure region where the network function resource was created by customer.vendorName
- The name of the vendor.serviceKey
- The GUID for the vendor network function.roleInstanceName
- The name of the role instance of the vendor network function.context
- The context to associate with this operation.- Throws:
IllegalArgumentException
- thrown if parameters fail the validation.com.azure.core.management.exception.ManagementException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.
-
restart
Restarts a role instance of a vendor network function.- Parameters:
locationName
- The Azure region where the network function resource was created by customer.vendorName
- The name of the vendor.serviceKey
- The GUID for the vendor network function.roleInstanceName
- The name of the role instance of the vendor network function.- Throws:
IllegalArgumentException
- thrown if parameters fail the validation.com.azure.core.management.exception.ManagementException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.
-
restart
void restart(String locationName, String vendorName, String serviceKey, String roleInstanceName, com.azure.core.util.Context context) Restarts a role instance of a vendor network function.- Parameters:
locationName
- The Azure region where the network function resource was created by customer.vendorName
- The name of the vendor.serviceKey
- The GUID for the vendor network function.roleInstanceName
- The name of the role instance of the vendor network function.context
- The context to associate with this operation.- Throws:
IllegalArgumentException
- thrown if parameters fail the validation.com.azure.core.management.exception.ManagementException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.
-
getWithResponse
com.azure.core.http.rest.Response<RoleInstance> getWithResponse(String locationName, String vendorName, String serviceKey, String roleInstanceName, com.azure.core.util.Context context) Gets the information of role instance of vendor network function.- Parameters:
locationName
- The Azure region where the network function resource was created by customer.vendorName
- The name of the vendor.serviceKey
- The GUID for the vendor network function.roleInstanceName
- The name of the role instance of the vendor network function.context
- The context to associate with this operation.- Returns:
- the information of role instance of vendor network function along with
Response
. - Throws:
IllegalArgumentException
- thrown if parameters fail the validation.com.azure.core.management.exception.ManagementException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.
-
get
RoleInstance get(String locationName, String vendorName, String serviceKey, String roleInstanceName) Gets the information of role instance of vendor network function.- Parameters:
locationName
- The Azure region where the network function resource was created by customer.vendorName
- The name of the vendor.serviceKey
- The GUID for the vendor network function.roleInstanceName
- The name of the role instance of the vendor network function.- Returns:
- the information of role instance of vendor network function.
- Throws:
IllegalArgumentException
- thrown if parameters fail the validation.com.azure.core.management.exception.ManagementException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.
-
list
com.azure.core.http.rest.PagedIterable<RoleInstance> list(String locationName, String vendorName, String serviceKey) Lists the information of role instances of vendor network function.- Parameters:
locationName
- The Azure region where the network function resource was created by customer.vendorName
- The name of the vendor.serviceKey
- The GUID for the vendor network function.- Returns:
- list of role instances of vendor network function as paginated response with
PagedIterable
. - Throws:
IllegalArgumentException
- thrown if parameters fail the validation.com.azure.core.management.exception.ManagementException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.
-
list
com.azure.core.http.rest.PagedIterable<RoleInstance> list(String locationName, String vendorName, String serviceKey, com.azure.core.util.Context context) Lists the information of role instances of vendor network function.- Parameters:
locationName
- The Azure region where the network function resource was created by customer.vendorName
- The name of the vendor.serviceKey
- The GUID for the vendor network function.context
- The context to associate with this operation.- Returns:
- list of role instances of vendor network function as paginated response with
PagedIterable
. - Throws:
IllegalArgumentException
- thrown if parameters fail the validation.com.azure.core.management.exception.ManagementException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.
-