Docs Home
mso 1.4.0 published on Monday, Apr 14, 2025 by ciscodevnet
mso.Rest
Explore with Pulumi AI
Create Rest Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new Rest(name: string, args: RestArgs, opts?: CustomResourceOptions);@overload
def Rest(resource_name: str,
args: RestArgs,
opts: Optional[ResourceOptions] = None)
@overload
def Rest(resource_name: str,
opts: Optional[ResourceOptions] = None,
path: Optional[str] = None,
payload: Optional[str] = None,
method: Optional[str] = None,
rest_id: Optional[str] = None)func NewRest(ctx *Context, name string, args RestArgs, opts ...ResourceOption) (*Rest, error)public Rest(string name, RestArgs args, CustomResourceOptions? opts = null)type: mso:Rest
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args RestArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args RestArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args RestArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args RestArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args RestArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var restResource = new Mso.Rest("restResource", new()
{
Path = "string",
Payload = "string",
Method = "string",
RestId = "string",
});
example, err := mso.NewRest(ctx, "restResource", &mso.RestArgs{
Path: pulumi.String("string"),
Payload: pulumi.String("string"),
Method: pulumi.String("string"),
RestId: pulumi.String("string"),
})
var restResource = new Rest("restResource", RestArgs.builder()
.path("string")
.payload("string")
.method("string")
.restId("string")
.build());
rest_resource = mso.Rest("restResource",
path="string",
payload="string",
method="string",
rest_id="string")
const restResource = new mso.Rest("restResource", {
path: "string",
payload: "string",
method: "string",
restId: "string",
});
type: mso:Rest
properties:
method: string
path: string
payload: string
restId: string
Rest Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The Rest resource accepts the following input properties:
Outputs
All input properties are implicitly available as output properties. Additionally, the Rest resource produces the following output properties:
- Id string
- The provider-assigned unique ID for this managed resource.
- Id string
- The provider-assigned unique ID for this managed resource.
- id String
- The provider-assigned unique ID for this managed resource.
- id string
- The provider-assigned unique ID for this managed resource.
- id str
- The provider-assigned unique ID for this managed resource.
- id String
- The provider-assigned unique ID for this managed resource.
Look up Existing Rest Resource
Get an existing Rest resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: RestState, opts?: CustomResourceOptions): Rest@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
method: Optional[str] = None,
path: Optional[str] = None,
payload: Optional[str] = None,
rest_id: Optional[str] = None) -> Restfunc GetRest(ctx *Context, name string, id IDInput, state *RestState, opts ...ResourceOption) (*Rest, error)public static Rest Get(string name, Input<string> id, RestState? state, CustomResourceOptions? opts = null)public static Rest get(String name, Output<String> id, RestState state, CustomResourceOptions options)resources: _: type: mso:Rest get: id: ${id}- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
Package Details
- Repository
- mso ciscodevnet/terraform-provider-mso
- License
- Notes
- This Pulumi package is based on the
msoTerraform Provider.