1. Packages
  2. Azure Native v2
  3. API Docs
  4. apimanagement
  5. getApiWiki
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

azure-native-v2.apimanagement.getApiWiki

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

Gets the details of the Wiki for an API specified by its identifier. Azure REST API version: 2022-08-01.

Other available API versions: 2022-09-01-preview, 2023-03-01-preview, 2023-05-01-preview, 2023-09-01-preview, 2024-05-01, 2024-06-01-preview.

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>
Copy
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]
Copy
func LookupApiWiki(ctx *Context, args *LookupApiWikiArgs, opts ...InvokeOption) (*LookupApiWikiResult, error)
func LookupApiWikiOutput(ctx *Context, args *LookupApiWikiOutputArgs, opts ...InvokeOption) LookupApiWikiResultOutput
Copy

> 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)
}
Copy
public static CompletableFuture<GetApiWikiResult> getApiWiki(GetApiWikiArgs args, InvokeOptions options)
public static Output<GetApiWikiResult> getApiWiki(GetApiWikiArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:apimanagement:getApiWiki
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

ApiId
This property is required.
Changes to this property will trigger replacement.
string
API identifier. Must be unique in the current API Management service instance.
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.
ApiId
This property is required.
Changes to this property will trigger replacement.
string
API identifier. Must be unique in the current API Management service instance.
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.
apiId
This property is required.
Changes to this property will trigger replacement.
String
API identifier. Must be unique in the current API Management service instance.
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.
apiId
This property is required.
Changes to this property will trigger replacement.
string
API identifier. Must be unique in the current API Management service instance.
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.
api_id
This property is required.
Changes to this property will trigger replacement.
str
API identifier. Must be unique in the current API Management service instance.
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.
apiId
This property is required.
Changes to this property will trigger replacement.
String
API identifier. Must be unique in the current API Management service instance.
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.

getApiWiki 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"
Documents List<Pulumi.AzureNative.ApiManagement.Outputs.WikiDocumentationContractResponse>
Collection wiki documents included into this wiki.
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.
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.
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.
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.
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-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