Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. apimanagement
  5. getApiWiki
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.apimanagement.getApiWiki

Explore with Pulumi AI

azure-native logo
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-azure-native

    Gets the details of the Wiki for an API specified by its identifier.

    Uses Azure REST API version 2022-09-01-preview.

    Other available API versions: 2022-08-01, 2023-03-01-preview, 2023-05-01-preview, 2023-09-01-preview, 2024-05-01, 2024-06-01-preview. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native apimanagement [ApiVersion]. See the version guide for details.

    Using getApiWiki

    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 getApiWiki(args: GetApiWikiArgs, opts?: InvokeOptions): Promise<GetApiWikiResult>
function getApiWikiOutput(args: GetApiWikiOutputArgs, opts?: InvokeOptions): Output<GetApiWikiResult>
    def get_api_wiki(api_id: Optional[str] = None,
                 resource_group_name: Optional[str] = None,
                 service_name: Optional[str] = None,
                 opts: Optional[InvokeOptions] = None) -> GetApiWikiResult
def get_api_wiki_output(api_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[GetApiWikiResult]
    func LookupApiWiki(ctx *Context, args *LookupApiWikiArgs, opts ...InvokeOption) (*LookupApiWikiResult, error)
func LookupApiWikiOutput(ctx *Context, args *LookupApiWikiOutputArgs, opts ...InvokeOption) LookupApiWikiResultOutput

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

    public static class GetApiWiki 
{
    public static Task<GetApiWikiResult> InvokeAsync(GetApiWikiArgs args, InvokeOptions? opts = null)
    public static Output<GetApiWikiResult> Invoke(GetApiWikiInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetApiWikiResult> getApiWiki(GetApiWikiArgs args, InvokeOptions options)
public static Output<GetApiWikiResult> getApiWiki(GetApiWikiArgs args, InvokeOptions options)

    fn::invoke:
  function: azure-native:apimanagement:getApiWiki
  arguments:
    # arguments dictionary

    The following arguments are supported:

    ApiId string
    API identifier. Must be unique in the current API Management service instance.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    ServiceName string
    The name of the API Management service.
    ApiId string
    API identifier. Must be unique in the current API Management service instance.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    ServiceName string
    The name of the API Management service.
    apiId String
    API identifier. Must be unique in the current API Management service instance.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    serviceName String
    The name of the API Management service.
    apiId string
    API identifier. Must be unique in the current API Management service instance.
    resourceGroupName string
    The name of the resource group. The name is case insensitive.
    serviceName string
    The name of the API Management service.
    api_id str
    API identifier. Must be unique in the current API Management service instance.
    resource_group_name str
    The name of the resource group. The name is case insensitive.
    service_name str
    The name of the API Management service.
    apiId String
    API identifier. Must be unique in the current API Management service instance.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    serviceName String
    The name of the API Management service.

    getApiWiki Result

    The following output properties are available:

    AzureApiVersion string
    The Azure API version of the resource.
    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"
    Documents List<Pulumi.AzureNative.ApiManagement.Outputs.WikiDocumentationContractResponse>
    Collection wiki documents included into this wiki.
    AzureApiVersion string
    The Azure API version of the resource.
    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"
    Documents []WikiDocumentationContractResponse
    Collection wiki documents included into this wiki.
    azureApiVersion String
    The Azure API version of the resource.
    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"
    documents List<WikiDocumentationContractResponse>
    Collection wiki documents included into this wiki.
    azureApiVersion string
    The Azure API version of the resource.
    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"
    documents WikiDocumentationContractResponse[]
    Collection wiki documents included into this wiki.
    azure_api_version str
    The Azure API version of the resource.
    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"
    documents Sequence[WikiDocumentationContractResponse]
    Collection wiki documents included into this wiki.
    azureApiVersion String
    The Azure API version of the resource.
    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"
    documents List<Property Map>
    Collection wiki documents included into this wiki.

    Supporting Types

    WikiDocumentationContractResponse

    DocumentationId string
    Documentation Identifier
    DocumentationId string
    Documentation Identifier
    documentationId String
    Documentation Identifier
    documentationId string
    Documentation Identifier
    documentation_id str
    Documentation Identifier
    documentationId String
    Documentation Identifier

    Package Details

    Repository
    Azure Native pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native logo
    This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
    Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi
    pulumi/pulumi-azure-native