Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native v2
  3. API Docs
  4. apimanagement
  5. getWorkspaceApiOperationPolicy
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native-v2.apimanagement.getWorkspaceApiOperationPolicy

Explore with Pulumi AI

These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native

Get the policy configuration at the API Operation level. 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 getWorkspaceApiOperationPolicy

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 getWorkspaceApiOperationPolicy(args: GetWorkspaceApiOperationPolicyArgs, opts?: InvokeOptions): Promise<GetWorkspaceApiOperationPolicyResult>
function getWorkspaceApiOperationPolicyOutput(args: GetWorkspaceApiOperationPolicyOutputArgs, opts?: InvokeOptions): Output<GetWorkspaceApiOperationPolicyResult>
Copy
def get_workspace_api_operation_policy(api_id: Optional[str] = None,
                                       format: Optional[str] = None,
                                       operation_id: Optional[str] = None,
                                       policy_id: Optional[str] = None,
                                       resource_group_name: Optional[str] = None,
                                       service_name: Optional[str] = None,
                                       workspace_id: Optional[str] = None,
                                       opts: Optional[InvokeOptions] = None) -> GetWorkspaceApiOperationPolicyResult
def get_workspace_api_operation_policy_output(api_id: Optional[pulumi.Input[str]] = None,
                                       format: Optional[pulumi.Input[str]] = None,
                                       operation_id: Optional[pulumi.Input[str]] = None,
                                       policy_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[GetWorkspaceApiOperationPolicyResult]
Copy
func LookupWorkspaceApiOperationPolicy(ctx *Context, args *LookupWorkspaceApiOperationPolicyArgs, opts ...InvokeOption) (*LookupWorkspaceApiOperationPolicyResult, error)
func LookupWorkspaceApiOperationPolicyOutput(ctx *Context, args *LookupWorkspaceApiOperationPolicyOutputArgs, opts ...InvokeOption) LookupWorkspaceApiOperationPolicyResultOutput
Copy

> Note: This function is named LookupWorkspaceApiOperationPolicy in the Go SDK.

public static class GetWorkspaceApiOperationPolicy 
{
    public static Task<GetWorkspaceApiOperationPolicyResult> InvokeAsync(GetWorkspaceApiOperationPolicyArgs args, InvokeOptions? opts = null)
    public static Output<GetWorkspaceApiOperationPolicyResult> Invoke(GetWorkspaceApiOperationPolicyInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetWorkspaceApiOperationPolicyResult> getWorkspaceApiOperationPolicy(GetWorkspaceApiOperationPolicyArgs args, InvokeOptions options)
public static Output<GetWorkspaceApiOperationPolicyResult> getWorkspaceApiOperationPolicy(GetWorkspaceApiOperationPolicyArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:apimanagement:getWorkspaceApiOperationPolicy
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

ApiId
This property is required.
Changes to this property will trigger replacement.
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.
OperationId
This property is required.
Changes to this property will trigger replacement.
string
Operation identifier within an API. Must be unique in the current API Management service instance.
PolicyId
This property is required.
Changes to this property will trigger replacement.
string
The identifier of the Policy.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
ServiceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the API Management service.
WorkspaceId
This property is required.
Changes to this property will trigger replacement.
string
Workspace identifier. Must be unique in the current API Management service instance.
Format string
Policy Export Format.
ApiId
This property is required.
Changes to this property will trigger replacement.
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.
OperationId
This property is required.
Changes to this property will trigger replacement.
string
Operation identifier within an API. Must be unique in the current API Management service instance.
PolicyId
This property is required.
Changes to this property will trigger replacement.
string
The identifier of the Policy.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
ServiceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the API Management service.
WorkspaceId
This property is required.
Changes to this property will trigger replacement.
string
Workspace identifier. Must be unique in the current API Management service instance.
Format string
Policy Export Format.
apiId
This property is required.
Changes to this property will trigger replacement.
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.
operationId
This property is required.
Changes to this property will trigger replacement.
String
Operation identifier within an API. Must be unique in the current API Management service instance.
policyId
This property is required.
Changes to this property will trigger replacement.
String
The identifier of the Policy.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
serviceName
This property is required.
Changes to this property will trigger replacement.
String
The name of the API Management service.
workspaceId
This property is required.
Changes to this property will trigger replacement.
String
Workspace identifier. Must be unique in the current API Management service instance.
format String
Policy Export Format.
apiId
This property is required.
Changes to this property will trigger replacement.
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.
operationId
This property is required.
Changes to this property will trigger replacement.
string
Operation identifier within an API. Must be unique in the current API Management service instance.
policyId
This property is required.
Changes to this property will trigger replacement.
string
The identifier of the Policy.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
serviceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the API Management service.
workspaceId
This property is required.
Changes to this property will trigger replacement.
string
Workspace identifier. Must be unique in the current API Management service instance.
format string
Policy Export Format.
api_id
This property is required.
Changes to this property will trigger replacement.
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
This property is required.
Changes to this property will trigger replacement.
str
Operation identifier within an API. Must be unique in the current API Management service instance.
policy_id
This property is required.
Changes to this property will trigger replacement.
str
The identifier of the Policy.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group. The name is case insensitive.
service_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the API Management service.
workspace_id
This property is required.
Changes to this property will trigger replacement.
str
Workspace identifier. Must be unique in the current API Management service instance.
format str
Policy Export Format.
apiId
This property is required.
Changes to this property will trigger replacement.
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.
operationId
This property is required.
Changes to this property will trigger replacement.
String
Operation identifier within an API. Must be unique in the current API Management service instance.
policyId
This property is required.
Changes to this property will trigger replacement.
String
The identifier of the Policy.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
serviceName
This property is required.
Changes to this property will trigger replacement.
String
The name of the API Management service.
workspaceId
This property is required.
Changes to this property will trigger replacement.
String
Workspace identifier. Must be unique in the current API Management service instance.
format String
Policy Export Format.

getWorkspaceApiOperationPolicy Result

The following output properties are available:

Id string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
Name string
The name of the resource
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
Value string
Contents of the Policy as defined by the format.
Format string
Format of the policyContent.
Id string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
Name string
The name of the resource
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
Value string
Contents of the Policy as defined by the format.
Format string
Format of the policyContent.
id String
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name String
The name of the resource
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
value String
Contents of the Policy as defined by the format.
format String
Format of the policyContent.
id string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name string
The name of the resource
type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
value string
Contents of the Policy as defined by the format.
format string
Format of the policyContent.
id str
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name str
The name of the resource
type str
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
value str
Contents of the Policy as defined by the format.
format str
Format of the policyContent.
id String
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name String
The name of the resource
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
value String
Contents of the Policy as defined by the format.
format String
Format of the policyContent.

Package Details

Repository
azure-native-v2 pulumi/pulumi-azure-native
License
Apache-2.0
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native