operator_api_plans

Creates, updates, deletes, gets or lists an operator_api_plans resource.

Overview

Name	operator_api_plans
Type	Resource
Id	azure.programmableconnectivity.operator_api_plans

Fields

The following fields are returned by SELECT queries:

get

Azure operation completed successfully.

Name	Datatype	Description
properties	object	The resource-specific properties for this resource.

list_by_subscription

Azure operation completed successfully.

Name	Datatype	Description
properties	object	The resource-specific properties for this resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, operatorApiPlanName		Get an OperatorApiPlan resource by name.
list_by_subscription	select	subscriptionId	$filter, $top, $skip	List OperatorApiPlan resources by subscription ID.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
operatorApiPlanName	string	APC Gateway Plan Name.
subscriptionId	string (uuid)	The ID of the target subscription. The value must be an UUID.
$filter	string	An optional OData based filter expression to apply on the operation.
$skip	integer (int32)	An optional query parameter which specifies the number of records to be skipped.
$top	integer (int32)	An optional query parameter which specifies the maximum number of records to be returned.

SELECT examples

get

Get an OperatorApiPlan resource by name.

SELECT
properties
FROM azure.programmableconnectivity.operator_api_plans
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND operatorApiPlanName = '{{ operatorApiPlanName }}' -- required
;

list_by_subscription

List OperatorApiPlan resources by subscription ID.

SELECT
properties
FROM azure.programmableconnectivity.operator_api_plans
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND $filter = '{{ $filter }}'
AND $top = '{{ $top }}'
AND $skip = '{{ $skip }}'
;