Azure Native

Pulumi Official
Package maintained by Pulumi
v1.64.0 published on Wednesday, May 4, 2022 by Pulumi

getApiPolicy

Policy Contract details. API Version: 2020-12-01.

Using getApiPolicy

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 getApiPolicy(args: GetApiPolicyArgs, opts?: InvokeOptions): Promise<GetApiPolicyResult>
function getApiPolicyOutput(args: GetApiPolicyOutputArgs, opts?: InvokeOptions): Output<GetApiPolicyResult>
def get_api_policy(api_id: Optional[str] = None,
                   format: Optional[str] = None,
                   policy_id: Optional[str] = None,
                   resource_group_name: Optional[str] = None,
                   service_name: Optional[str] = None,
                   opts: Optional[InvokeOptions] = None) -> GetApiPolicyResult
def get_api_policy_output(api_id: Optional[pulumi.Input[str]] = None,
                   format: 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,
                   opts: Optional[InvokeOptions] = None) -> Output[GetApiPolicyResult]
func LookupApiPolicy(ctx *Context, args *LookupApiPolicyArgs, opts ...InvokeOption) (*LookupApiPolicyResult, error)
func LookupApiPolicyOutput(ctx *Context, args *LookupApiPolicyOutputArgs, opts ...InvokeOption) LookupApiPolicyResultOutput

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

public static class GetApiPolicy 
{
    public static Task<GetApiPolicyResult> InvokeAsync(GetApiPolicyArgs args, InvokeOptions? opts = null)
    public static Output<GetApiPolicyResult> Invoke(GetApiPolicyInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetApiPolicyResult> getApiPolicy(GetApiPolicyArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
Fn::Invoke:
  Function: azure-native:apimanagement:getApiPolicy
  Arguments:
    # Arguments dictionary

The following arguments are supported:

ApiId 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.

PolicyId string

The identifier of the Policy.

ResourceGroupName string

The name of the resource group.

ServiceName string

The name of the API Management service.

Format string

Policy Export Format.

ApiId 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.

PolicyId string

The identifier of the Policy.

ResourceGroupName string

The name of the resource group.

ServiceName string

The name of the API Management service.

Format string

Policy Export Format.

apiId 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.

policyId String

The identifier of the Policy.

resourceGroupName String

The name of the resource group.

serviceName String

The name of the API Management service.

format String

Policy Export Format.

apiId 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.

policyId string

The identifier of the Policy.

resourceGroupName string

The name of the resource group.

serviceName string

The name of the API Management service.

format string

Policy Export Format.

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.

policy_id str

The identifier of the Policy.

resource_group_name str

The name of the resource group.

service_name str

The name of the API Management service.

format str

Policy Export Format.

apiId 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.

policyId String

The identifier of the Policy.

resourceGroupName String

The name of the resource group.

serviceName String

The name of the API Management service.

format String

Policy Export Format.

getApiPolicy Result

The following output properties are available:

Id string

Resource ID.

Name string

Resource name.

Type string

Resource type for API Management resource.

Value string

Contents of the Policy as defined by the format.

Format string

Format of the policyContent.

Id string

Resource ID.

Name string

Resource name.

Type string

Resource type for API Management resource.

Value string

Contents of the Policy as defined by the format.

Format string

Format of the policyContent.

id String

Resource ID.

name String

Resource name.

type String

Resource type for API Management resource.

value String

Contents of the Policy as defined by the format.

format String

Format of the policyContent.

id string

Resource ID.

name string

Resource name.

type string

Resource type for API Management resource.

value string

Contents of the Policy as defined by the format.

format string

Format of the policyContent.

id str

Resource ID.

name str

Resource name.

type str

Resource type for API Management resource.

value str

Contents of the Policy as defined by the format.

format str

Format of the policyContent.

id String

Resource ID.

name String

Resource name.

type String

Resource type for API Management resource.

value String

Contents of the Policy as defined by the format.

format String

Format of the policyContent.

Package Details

Repository
https://github.com/pulumi/pulumi-azure-native
License
Apache-2.0