Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. apicenter
  5. getApiSource
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.73.0 published on Wednesday, Nov 20, 2024 by Pulumi
pulumi/pulumi-azure-native

azure-native.apicenter.getApiSource

Explore with Pulumi AI

azure-native logo
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.73.0 published on Wednesday, Nov 20, 2024 by Pulumi
pulumi/pulumi-azure-native

    Returns details of the API source. Azure REST API version: 2024-06-01-preview.

    Using getApiSource

    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 getApiSource(args: GetApiSourceArgs, opts?: InvokeOptions): Promise<GetApiSourceResult>
function getApiSourceOutput(args: GetApiSourceOutputArgs, opts?: InvokeOptions): Output<GetApiSourceResult>
    def get_api_source(api_source_name: Optional[str] = None,
                   resource_group_name: Optional[str] = None,
                   service_name: Optional[str] = None,
                   workspace_name: Optional[str] = None,
                   opts: Optional[InvokeOptions] = None) -> GetApiSourceResult
def get_api_source_output(api_source_name: Optional[pulumi.Input[str]] = None,
                   resource_group_name: Optional[pulumi.Input[str]] = None,
                   service_name: Optional[pulumi.Input[str]] = None,
                   workspace_name: Optional[pulumi.Input[str]] = None,
                   opts: Optional[InvokeOptions] = None) -> Output[GetApiSourceResult]
    func LookupApiSource(ctx *Context, args *LookupApiSourceArgs, opts ...InvokeOption) (*LookupApiSourceResult, error)
func LookupApiSourceOutput(ctx *Context, args *LookupApiSourceOutputArgs, opts ...InvokeOption) LookupApiSourceResultOutput

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

    public static class GetApiSource 
{
    public static Task<GetApiSourceResult> InvokeAsync(GetApiSourceArgs args, InvokeOptions? opts = null)
    public static Output<GetApiSourceResult> Invoke(GetApiSourceInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetApiSourceResult> getApiSource(GetApiSourceArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

    fn::invoke:
  function: azure-native:apicenter:getApiSource
  arguments:
    # arguments dictionary

    The following arguments are supported:

    ApiSourceName string
    The name of the API.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    ServiceName string
    The name of Azure API Center service.
    WorkspaceName string
    The name of the workspace.
    ApiSourceName string
    The name of the API.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    ServiceName string
    The name of Azure API Center service.
    WorkspaceName string
    The name of the workspace.
    apiSourceName String
    The name of the API.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    serviceName String
    The name of Azure API Center service.
    workspaceName String
    The name of the workspace.
    apiSourceName string
    The name of the API.
    resourceGroupName string
    The name of the resource group. The name is case insensitive.
    serviceName string
    The name of Azure API Center service.
    workspaceName string
    The name of the workspace.
    api_source_name str
    The name of the API.
    resource_group_name str
    The name of the resource group. The name is case insensitive.
    service_name str
    The name of Azure API Center service.
    workspace_name str
    The name of the workspace.
    apiSourceName String
    The name of the API.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    serviceName String
    The name of Azure API Center service.
    workspaceName String
    The name of the workspace.

    getApiSource Result

    The following output properties are available:

    Id string
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    LinkState Pulumi.AzureNative.ApiCenter.Outputs.LinkStateResponse
    The state of the API source link
    Name string
    The name of the resource
    SystemData Pulumi.AzureNative.ApiCenter.Outputs.SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    Type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    AzureApiManagementSource Pulumi.AzureNative.ApiCenter.Outputs.AzureApiManagementSourceResponse
    API source configuration for Azure API Management.
    ImportSpecification string
    Indicates if the specification should be imported along with metadata.
    TargetEnvironmentId string
    The target environment resource ID.
    TargetLifecycleStage string
    The target lifecycle stage.
    Id string
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    LinkState LinkStateResponse
    The state of the API source link
    Name string
    The name of the resource
    SystemData SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    Type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    AzureApiManagementSource AzureApiManagementSourceResponse
    API source configuration for Azure API Management.
    ImportSpecification string
    Indicates if the specification should be imported along with metadata.
    TargetEnvironmentId string
    The target environment resource ID.
    TargetLifecycleStage string
    The target lifecycle stage.
    id String
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    linkState LinkStateResponse
    The state of the API source link
    name String
    The name of the resource
    systemData SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type String
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    azureApiManagementSource AzureApiManagementSourceResponse
    API source configuration for Azure API Management.
    importSpecification String
    Indicates if the specification should be imported along with metadata.
    targetEnvironmentId String
    The target environment resource ID.
    targetLifecycleStage String
    The target lifecycle stage.
    id string
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    linkState LinkStateResponse
    The state of the API source link
    name string
    The name of the resource
    systemData SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    azureApiManagementSource AzureApiManagementSourceResponse
    API source configuration for Azure API Management.
    importSpecification string
    Indicates if the specification should be imported along with metadata.
    targetEnvironmentId string
    The target environment resource ID.
    targetLifecycleStage string
    The target lifecycle stage.
    id str
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    link_state LinkStateResponse
    The state of the API source link
    name str
    The name of the resource
    system_data SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type str
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    azure_api_management_source AzureApiManagementSourceResponse
    API source configuration for Azure API Management.
    import_specification str
    Indicates if the specification should be imported along with metadata.
    target_environment_id str
    The target environment resource ID.
    target_lifecycle_stage str
    The target lifecycle stage.
    id String
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    linkState Property Map
    The state of the API source link
    name String
    The name of the resource
    systemData Property Map
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type String
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    azureApiManagementSource Property Map
    API source configuration for Azure API Management.
    importSpecification String
    Indicates if the specification should be imported along with metadata.
    targetEnvironmentId String
    The target environment resource ID.
    targetLifecycleStage String
    The target lifecycle stage.

    Supporting Types

    AzureApiManagementSourceResponse

    ResourceId string
    API Management service resource ID.
    MsiResourceId string
    The resource ID of the managed identity that has access to the API Management instance.
    ResourceId string
    API Management service resource ID.
    MsiResourceId string
    The resource ID of the managed identity that has access to the API Management instance.
    resourceId String
    API Management service resource ID.
    msiResourceId String
    The resource ID of the managed identity that has access to the API Management instance.
    resourceId string
    API Management service resource ID.
    msiResourceId string
    The resource ID of the managed identity that has access to the API Management instance.
    resource_id str
    API Management service resource ID.
    msi_resource_id str
    The resource ID of the managed identity that has access to the API Management instance.
    resourceId String
    API Management service resource ID.
    msiResourceId String
    The resource ID of the managed identity that has access to the API Management instance.

    LinkStateResponse

    LastUpdatedOn string
    The timestamp of the last update of the link state.
    Message string
    The state message.
    State string
    The state of the link.
    LastUpdatedOn string
    The timestamp of the last update of the link state.
    Message string
    The state message.
    State string
    The state of the link.
    lastUpdatedOn String
    The timestamp of the last update of the link state.
    message String
    The state message.
    state String
    The state of the link.
    lastUpdatedOn string
    The timestamp of the last update of the link state.
    message string
    The state message.
    state string
    The state of the link.
    last_updated_on str
    The timestamp of the last update of the link state.
    message str
    The state message.
    state str
    The state of the link.
    lastUpdatedOn String
    The timestamp of the last update of the link state.
    message String
    The state message.
    state String
    The state of the link.

    SystemDataResponse

    CreatedAt string
    The timestamp of resource creation (UTC).
    CreatedBy string
    The identity that created the resource.
    CreatedByType string
    The type of identity that created the resource.
    LastModifiedAt string
    The timestamp of resource last modification (UTC)
    LastModifiedBy string
    The identity that last modified the resource.
    LastModifiedByType string
    The type of identity that last modified the resource.
    CreatedAt string
    The timestamp of resource creation (UTC).
    CreatedBy string
    The identity that created the resource.
    CreatedByType string
    The type of identity that created the resource.
    LastModifiedAt string
    The timestamp of resource last modification (UTC)
    LastModifiedBy string
    The identity that last modified the resource.
    LastModifiedByType string
    The type of identity that last modified the resource.
    createdAt String
    The timestamp of resource creation (UTC).
    createdBy String
    The identity that created the resource.
    createdByType String
    The type of identity that created the resource.
    lastModifiedAt String
    The timestamp of resource last modification (UTC)
    lastModifiedBy String
    The identity that last modified the resource.
    lastModifiedByType String
    The type of identity that last modified the resource.
    createdAt string
    The timestamp of resource creation (UTC).
    createdBy string
    The identity that created the resource.
    createdByType string
    The type of identity that created the resource.
    lastModifiedAt string
    The timestamp of resource last modification (UTC)
    lastModifiedBy string
    The identity that last modified the resource.
    lastModifiedByType string
    The type of identity that last modified the resource.
    created_at str
    The timestamp of resource creation (UTC).
    created_by str
    The identity that created the resource.
    created_by_type str
    The type of identity that created the resource.
    last_modified_at str
    The timestamp of resource last modification (UTC)
    last_modified_by str
    The identity that last modified the resource.
    last_modified_by_type str
    The type of identity that last modified the resource.
    createdAt String
    The timestamp of resource creation (UTC).
    createdBy String
    The identity that created the resource.
    createdByType String
    The type of identity that created the resource.
    lastModifiedAt String
    The timestamp of resource last modification (UTC)
    lastModifiedBy String
    The identity that last modified the resource.
    lastModifiedByType String
    The type of identity that last modified the resource.

    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 v1 docs if using the v1 version of this package.
    Azure Native v2.73.0 published on Wednesday, Nov 20, 2024 by Pulumi
    pulumi/pulumi-azure-native