This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.77.0 published on Thursday, Dec 12, 2024 by Pulumi
azure-native.apimanagement.getWorkspaceApiOperation
Explore with Pulumi AI
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.77.0 published on Thursday, Dec 12, 2024 by Pulumi
Gets the details of the API Operation specified by its identifier. Azure REST API version: 2022-09-01-preview.
Other available API versions: 2023-03-01-preview, 2023-05-01-preview, 2023-09-01-preview, 2024-05-01, 2024-06-01-preview.
Using getWorkspaceApiOperation
Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.
function getWorkspaceApiOperation(args: GetWorkspaceApiOperationArgs, opts?: InvokeOptions): Promise<GetWorkspaceApiOperationResult>
function getWorkspaceApiOperationOutput(args: GetWorkspaceApiOperationOutputArgs, opts?: InvokeOptions): Output<GetWorkspaceApiOperationResult>
def get_workspace_api_operation(api_id: Optional[str] = None,
operation_id: Optional[str] = None,
resource_group_name: Optional[str] = None,
service_name: Optional[str] = None,
workspace_id: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetWorkspaceApiOperationResult
def get_workspace_api_operation_output(api_id: Optional[pulumi.Input[str]] = None,
operation_id: Optional[pulumi.Input[str]] = None,
resource_group_name: Optional[pulumi.Input[str]] = None,
service_name: Optional[pulumi.Input[str]] = None,
workspace_id: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetWorkspaceApiOperationResult]
func LookupWorkspaceApiOperation(ctx *Context, args *LookupWorkspaceApiOperationArgs, opts ...InvokeOption) (*LookupWorkspaceApiOperationResult, error)
func LookupWorkspaceApiOperationOutput(ctx *Context, args *LookupWorkspaceApiOperationOutputArgs, opts ...InvokeOption) LookupWorkspaceApiOperationResultOutput
> Note: This function is named LookupWorkspaceApiOperation
in the Go SDK.
public static class GetWorkspaceApiOperation
{
public static Task<GetWorkspaceApiOperationResult> InvokeAsync(GetWorkspaceApiOperationArgs args, InvokeOptions? opts = null)
public static Output<GetWorkspaceApiOperationResult> Invoke(GetWorkspaceApiOperationInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetWorkspaceApiOperationResult> getWorkspaceApiOperation(GetWorkspaceApiOperationArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
function: azure-native:apimanagement:getWorkspaceApiOperation
arguments:
# arguments dictionary
The following arguments are supported:
- Api
Id string - API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.
- Operation
Id string - Operation identifier within an API. Must be unique in the current API Management service instance.
- Resource
Group stringName - The name of the resource group. The name is case insensitive.
- Service
Name string - The name of the API Management service.
- Workspace
Id string - Workspace identifier. Must be unique in the current API Management service instance.
- Api
Id string - API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.
- Operation
Id string - Operation identifier within an API. Must be unique in the current API Management service instance.
- Resource
Group stringName - The name of the resource group. The name is case insensitive.
- Service
Name string - The name of the API Management service.
- Workspace
Id string - Workspace identifier. Must be unique in the current API Management service instance.
- api
Id String - API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.
- operation
Id String - Operation identifier within an API. Must be unique in the current API Management service instance.
- resource
Group StringName - The name of the resource group. The name is case insensitive.
- service
Name String - The name of the API Management service.
- workspace
Id String - Workspace identifier. Must be unique in the current API Management service instance.
- api
Id string - API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.
- operation
Id string - Operation identifier within an API. Must be unique in the current API Management service instance.
- resource
Group stringName - The name of the resource group. The name is case insensitive.
- service
Name string - The name of the API Management service.
- workspace
Id string - Workspace identifier. Must be unique in the current API Management service instance.
- api_
id str - API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.
- operation_
id str - Operation identifier within an API. Must be unique in the current API Management service instance.
- resource_
group_ strname - The name of the resource group. The name is case insensitive.
- service_
name str - The name of the API Management service.
- workspace_
id str - Workspace identifier. Must be unique in the current API Management service instance.
- api
Id String - API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.
- operation
Id String - Operation identifier within an API. Must be unique in the current API Management service instance.
- resource
Group StringName - The name of the resource group. The name is case insensitive.
- service
Name String - The name of the API Management service.
- workspace
Id String - Workspace identifier. Must be unique in the current API Management service instance.
getWorkspaceApiOperation Result
The following output properties are available:
- Display
Name string - Operation Name.
- Id string
- Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
- Method string
- A Valid HTTP Operation Method. Typical Http Methods like GET, PUT, POST but not limited by only them.
- Name string
- The name of the resource
- Type string
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- Url
Template string - Relative URL template identifying the target resource for this operation. May include parameters. Example: /customers/{cid}/orders/{oid}/?date={date}
- Description string
- Description of the operation. May include HTML formatting tags.
- Policies string
- Operation Policies
- Request
Pulumi.
Azure Native. Api Management. Outputs. Request Contract Response - An entity containing request details.
- Responses
List<Pulumi.
Azure Native. Api Management. Outputs. Response Contract Response> - Array of Operation responses.
- Template
Parameters List<Pulumi.Azure Native. Api Management. Outputs. Parameter Contract Response> - Collection of URL template parameters.
- Display
Name string - Operation Name.
- Id string
- Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
- Method string
- A Valid HTTP Operation Method. Typical Http Methods like GET, PUT, POST but not limited by only them.
- Name string
- The name of the resource
- Type string
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- Url
Template string - Relative URL template identifying the target resource for this operation. May include parameters. Example: /customers/{cid}/orders/{oid}/?date={date}
- Description string
- Description of the operation. May include HTML formatting tags.
- Policies string
- Operation Policies
- Request
Request
Contract Response - An entity containing request details.
- Responses
[]Response
Contract Response - Array of Operation responses.
- Template
Parameters []ParameterContract Response - Collection of URL template parameters.
- display
Name String - Operation Name.
- id String
- Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
- method String
- A Valid HTTP Operation Method. Typical Http Methods like GET, PUT, POST but not limited by only them.
- name String
- The name of the resource
- type String
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- url
Template String - Relative URL template identifying the target resource for this operation. May include parameters. Example: /customers/{cid}/orders/{oid}/?date={date}
- description String
- Description of the operation. May include HTML formatting tags.
- policies String
- Operation Policies
- request
Request
Contract Response - An entity containing request details.
- responses
List<Response
Contract Response> - Array of Operation responses.
- template
Parameters List<ParameterContract Response> - Collection of URL template parameters.
- display
Name string - Operation Name.
- id string
- Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
- method string
- A Valid HTTP Operation Method. Typical Http Methods like GET, PUT, POST but not limited by only them.
- name string
- The name of the resource
- type string
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- url
Template string - Relative URL template identifying the target resource for this operation. May include parameters. Example: /customers/{cid}/orders/{oid}/?date={date}
- description string
- Description of the operation. May include HTML formatting tags.
- policies string
- Operation Policies
- request
Request
Contract Response - An entity containing request details.
- responses
Response
Contract Response[] - Array of Operation responses.
- template
Parameters ParameterContract Response[] - Collection of URL template parameters.
- display_
name str - Operation Name.
- id str
- Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
- method str
- A Valid HTTP Operation Method. Typical Http Methods like GET, PUT, POST but not limited by only them.
- name str
- The name of the resource
- type str
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- url_
template str - Relative URL template identifying the target resource for this operation. May include parameters. Example: /customers/{cid}/orders/{oid}/?date={date}
- description str
- Description of the operation. May include HTML formatting tags.
- policies str
- Operation Policies
- request
Request
Contract Response - An entity containing request details.
- responses
Sequence[Response
Contract Response] - Array of Operation responses.
- template_
parameters Sequence[ParameterContract Response] - Collection of URL template parameters.
- display
Name String - Operation Name.
- id String
- Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
- method String
- A Valid HTTP Operation Method. Typical Http Methods like GET, PUT, POST but not limited by only them.
- name String
- The name of the resource
- type String
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- url
Template String - Relative URL template identifying the target resource for this operation. May include parameters. Example: /customers/{cid}/orders/{oid}/?date={date}
- description String
- Description of the operation. May include HTML formatting tags.
- policies String
- Operation Policies
- request Property Map
- An entity containing request details.
- responses List<Property Map>
- Array of Operation responses.
- template
Parameters List<Property Map> - Collection of URL template parameters.
Supporting Types
ParameterContractResponse
- Name string
- Parameter name.
- Type string
- Parameter type.
- Default
Value string - Default parameter value.
- Description string
- Parameter description.
- Examples
Dictionary<string, Pulumi.
Azure Native. Api Management. Inputs. Parameter Example Contract Response> - Exampled defined for the parameter.
- Required bool
- Specifies whether parameter is required or not.
- Schema
Id string - Schema identifier.
- Type
Name string - Type name defined by the schema.
- Values List<string>
- Parameter values.
- Name string
- Parameter name.
- Type string
- Parameter type.
- Default
Value string - Default parameter value.
- Description string
- Parameter description.
- Examples
map[string]Parameter
Example Contract Response - Exampled defined for the parameter.
- Required bool
- Specifies whether parameter is required or not.
- Schema
Id string - Schema identifier.
- Type
Name string - Type name defined by the schema.
- Values []string
- Parameter values.
- name String
- Parameter name.
- type String
- Parameter type.
- default
Value String - Default parameter value.
- description String
- Parameter description.
- examples
Map<String,Parameter
Example Contract Response> - Exampled defined for the parameter.
- required Boolean
- Specifies whether parameter is required or not.
- schema
Id String - Schema identifier.
- type
Name String - Type name defined by the schema.
- values List<String>
- Parameter values.
- name string
- Parameter name.
- type string
- Parameter type.
- default
Value string - Default parameter value.
- description string
- Parameter description.
- examples
{[key: string]: Parameter
Example Contract Response} - Exampled defined for the parameter.
- required boolean
- Specifies whether parameter is required or not.
- schema
Id string - Schema identifier.
- type
Name string - Type name defined by the schema.
- values string[]
- Parameter values.
- name str
- Parameter name.
- type str
- Parameter type.
- default_
value str - Default parameter value.
- description str
- Parameter description.
- examples
Mapping[str, Parameter
Example Contract Response] - Exampled defined for the parameter.
- required bool
- Specifies whether parameter is required or not.
- schema_
id str - Schema identifier.
- type_
name str - Type name defined by the schema.
- values Sequence[str]
- Parameter values.
- name String
- Parameter name.
- type String
- Parameter type.
- default
Value String - Default parameter value.
- description String
- Parameter description.
- examples Map<Property Map>
- Exampled defined for the parameter.
- required Boolean
- Specifies whether parameter is required or not.
- schema
Id String - Schema identifier.
- type
Name String - Type name defined by the schema.
- values List<String>
- Parameter values.
ParameterExampleContractResponse
- Description string
- Long description for the example
- External
Value string - A URL that points to the literal example
- Summary string
- Short description for the example
- Value object
- Example value. May be a primitive value, or an object.
- Description string
- Long description for the example
- External
Value string - A URL that points to the literal example
- Summary string
- Short description for the example
- Value interface{}
- Example value. May be a primitive value, or an object.
- description String
- Long description for the example
- external
Value String - A URL that points to the literal example
- summary String
- Short description for the example
- value Object
- Example value. May be a primitive value, or an object.
- description string
- Long description for the example
- external
Value string - A URL that points to the literal example
- summary string
- Short description for the example
- value any
- Example value. May be a primitive value, or an object.
- description str
- Long description for the example
- external_
value str - A URL that points to the literal example
- summary str
- Short description for the example
- value Any
- Example value. May be a primitive value, or an object.
- description String
- Long description for the example
- external
Value String - A URL that points to the literal example
- summary String
- Short description for the example
- value Any
- Example value. May be a primitive value, or an object.
RepresentationContractResponse
- Content
Type string - Specifies a registered or custom content type for this representation, e.g. application/xml.
- Examples
Dictionary<string, Pulumi.
Azure Native. Api Management. Inputs. Parameter Example Contract Response> - Exampled defined for the representation.
- Form
Parameters List<Pulumi.Azure Native. Api Management. Inputs. Parameter Contract Response> - Collection of form parameters. Required if 'contentType' value is either 'application/x-www-form-urlencoded' or 'multipart/form-data'..
- Schema
Id string - Schema identifier. Applicable only if 'contentType' value is neither 'application/x-www-form-urlencoded' nor 'multipart/form-data'.
- Type
Name string - Type name defined by the schema. Applicable only if 'contentType' value is neither 'application/x-www-form-urlencoded' nor 'multipart/form-data'.
- Content
Type string - Specifies a registered or custom content type for this representation, e.g. application/xml.
- Examples
map[string]Parameter
Example Contract Response - Exampled defined for the representation.
- Form
Parameters []ParameterContract Response - Collection of form parameters. Required if 'contentType' value is either 'application/x-www-form-urlencoded' or 'multipart/form-data'..
- Schema
Id string - Schema identifier. Applicable only if 'contentType' value is neither 'application/x-www-form-urlencoded' nor 'multipart/form-data'.
- Type
Name string - Type name defined by the schema. Applicable only if 'contentType' value is neither 'application/x-www-form-urlencoded' nor 'multipart/form-data'.
- content
Type String - Specifies a registered or custom content type for this representation, e.g. application/xml.
- examples
Map<String,Parameter
Example Contract Response> - Exampled defined for the representation.
- form
Parameters List<ParameterContract Response> - Collection of form parameters. Required if 'contentType' value is either 'application/x-www-form-urlencoded' or 'multipart/form-data'..
- schema
Id String - Schema identifier. Applicable only if 'contentType' value is neither 'application/x-www-form-urlencoded' nor 'multipart/form-data'.
- type
Name String - Type name defined by the schema. Applicable only if 'contentType' value is neither 'application/x-www-form-urlencoded' nor 'multipart/form-data'.
- content
Type string - Specifies a registered or custom content type for this representation, e.g. application/xml.
- examples
{[key: string]: Parameter
Example Contract Response} - Exampled defined for the representation.
- form
Parameters ParameterContract Response[] - Collection of form parameters. Required if 'contentType' value is either 'application/x-www-form-urlencoded' or 'multipart/form-data'..
- schema
Id string - Schema identifier. Applicable only if 'contentType' value is neither 'application/x-www-form-urlencoded' nor 'multipart/form-data'.
- type
Name string - Type name defined by the schema. Applicable only if 'contentType' value is neither 'application/x-www-form-urlencoded' nor 'multipart/form-data'.
- content_
type str - Specifies a registered or custom content type for this representation, e.g. application/xml.
- examples
Mapping[str, Parameter
Example Contract Response] - Exampled defined for the representation.
- form_
parameters Sequence[ParameterContract Response] - Collection of form parameters. Required if 'contentType' value is either 'application/x-www-form-urlencoded' or 'multipart/form-data'..
- schema_
id str - Schema identifier. Applicable only if 'contentType' value is neither 'application/x-www-form-urlencoded' nor 'multipart/form-data'.
- type_
name str - Type name defined by the schema. Applicable only if 'contentType' value is neither 'application/x-www-form-urlencoded' nor 'multipart/form-data'.
- content
Type String - Specifies a registered or custom content type for this representation, e.g. application/xml.
- examples Map<Property Map>
- Exampled defined for the representation.
- form
Parameters List<Property Map> - Collection of form parameters. Required if 'contentType' value is either 'application/x-www-form-urlencoded' or 'multipart/form-data'..
- schema
Id String - Schema identifier. Applicable only if 'contentType' value is neither 'application/x-www-form-urlencoded' nor 'multipart/form-data'.
- type
Name String - Type name defined by the schema. Applicable only if 'contentType' value is neither 'application/x-www-form-urlencoded' nor 'multipart/form-data'.
RequestContractResponse
- Description string
- Operation request description.
- Headers
List<Pulumi.
Azure Native. Api Management. Inputs. Parameter Contract Response> - Collection of operation request headers.
- Query
Parameters List<Pulumi.Azure Native. Api Management. Inputs. Parameter Contract Response> - Collection of operation request query parameters.
- Representations
List<Pulumi.
Azure Native. Api Management. Inputs. Representation Contract Response> - Collection of operation request representations.
- Description string
- Operation request description.
- Headers
[]Parameter
Contract Response - Collection of operation request headers.
- Query
Parameters []ParameterContract Response - Collection of operation request query parameters.
- Representations
[]Representation
Contract Response - Collection of operation request representations.
- description String
- Operation request description.
- headers
List<Parameter
Contract Response> - Collection of operation request headers.
- query
Parameters List<ParameterContract Response> - Collection of operation request query parameters.
- representations
List<Representation
Contract Response> - Collection of operation request representations.
- description string
- Operation request description.
- headers
Parameter
Contract Response[] - Collection of operation request headers.
- query
Parameters ParameterContract Response[] - Collection of operation request query parameters.
- representations
Representation
Contract Response[] - Collection of operation request representations.
- description str
- Operation request description.
- headers
Sequence[Parameter
Contract Response] - Collection of operation request headers.
- query_
parameters Sequence[ParameterContract Response] - Collection of operation request query parameters.
- representations
Sequence[Representation
Contract Response] - Collection of operation request representations.
- description String
- Operation request description.
- headers List<Property Map>
- Collection of operation request headers.
- query
Parameters List<Property Map> - Collection of operation request query parameters.
- representations List<Property Map>
- Collection of operation request representations.
ResponseContractResponse
- Status
Code int - Operation response HTTP status code.
- Description string
- Operation response description.
- Headers
List<Pulumi.
Azure Native. Api Management. Inputs. Parameter Contract Response> - Collection of operation response headers.
- Representations
List<Pulumi.
Azure Native. Api Management. Inputs. Representation Contract Response> - Collection of operation response representations.
- Status
Code int - Operation response HTTP status code.
- Description string
- Operation response description.
- Headers
[]Parameter
Contract Response - Collection of operation response headers.
- Representations
[]Representation
Contract Response - Collection of operation response representations.
- status
Code Integer - Operation response HTTP status code.
- description String
- Operation response description.
- headers
List<Parameter
Contract Response> - Collection of operation response headers.
- representations
List<Representation
Contract Response> - Collection of operation response representations.
- status
Code number - Operation response HTTP status code.
- description string
- Operation response description.
- headers
Parameter
Contract Response[] - Collection of operation response headers.
- representations
Representation
Contract Response[] - Collection of operation response representations.
- status_
code int - Operation response HTTP status code.
- description str
- Operation response description.
- headers
Sequence[Parameter
Contract Response] - Collection of operation response headers.
- representations
Sequence[Representation
Contract Response] - Collection of operation response representations.
- status
Code Number - Operation response HTTP status code.
- description String
- Operation response description.
- headers List<Property Map>
- Collection of operation response headers.
- representations List<Property Map>
- Collection of operation response representations.
Package Details
- Repository
- Azure Native pulumi/pulumi-azure-native
- License
- Apache-2.0
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.77.0 published on Thursday, Dec 12, 2024 by Pulumi