Docs Packages
  1. Packages
  2. Azure Native
  3. API Docs
  4. apicenter
  5. getEnvironment
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.41.0 published on Tuesday, May 14, 2024 by Pulumi
pulumi/pulumi-azure-native

azure-native.apicenter.getEnvironment

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.41.0 published on Tuesday, May 14, 2024 by Pulumi
pulumi/pulumi-azure-native

    Returns details of the environment. Azure REST API version: 2024-03-01.

    Other available API versions: 2024-03-15-preview.

    Using getEnvironment

    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 getEnvironment(args: GetEnvironmentArgs, opts?: InvokeOptions): Promise<GetEnvironmentResult>
function getEnvironmentOutput(args: GetEnvironmentOutputArgs, opts?: InvokeOptions): Output<GetEnvironmentResult>
    def get_environment(environment_name: Optional[str] = None,
                    resource_group_name: Optional[str] = None,
                    service_name: Optional[str] = None,
                    workspace_name: Optional[str] = None,
                    opts: Optional[InvokeOptions] = None) -> GetEnvironmentResult
def get_environment_output(environment_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[GetEnvironmentResult]
    func LookupEnvironment(ctx *Context, args *LookupEnvironmentArgs, opts ...InvokeOption) (*LookupEnvironmentResult, error)
func LookupEnvironmentOutput(ctx *Context, args *LookupEnvironmentOutputArgs, opts ...InvokeOption) LookupEnvironmentResultOutput

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

    public static class GetEnvironment 
{
    public static Task<GetEnvironmentResult> InvokeAsync(GetEnvironmentArgs args, InvokeOptions? opts = null)
    public static Output<GetEnvironmentResult> Invoke(GetEnvironmentInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetEnvironmentResult> getEnvironment(GetEnvironmentArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

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

    The following arguments are supported:

    EnvironmentName string
    The name of the environment.
    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.
    EnvironmentName string
    The name of the environment.
    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.
    environmentName String
    The name of the environment.
    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.
    environmentName string
    The name of the environment.
    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.
    environment_name str
    The name of the environment.
    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.
    environmentName String
    The name of the environment.
    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.

    getEnvironment 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}"
    Kind string
    Environment kind.
    Name string
    The name of the resource
    SystemData Pulumi.AzureNative.ApiCenter.Outputs.SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    Title string
    Environment title.
    Type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    CustomProperties object
    The custom metadata defined for API catalog entities.
    Description string
    The environment description.
    Onboarding Pulumi.AzureNative.ApiCenter.Outputs.OnboardingResponse
    Environment onboarding information
    Server Pulumi.AzureNative.ApiCenter.Outputs.EnvironmentServerResponse
    Server information of the environment.
    Id string
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    Kind string
    Environment kind.
    Name string
    The name of the resource
    SystemData SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    Title string
    Environment title.
    Type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    CustomProperties interface{}
    The custom metadata defined for API catalog entities.
    Description string
    The environment description.
    Onboarding OnboardingResponse
    Environment onboarding information
    Server EnvironmentServerResponse
    Server information of the environment.
    id String
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    kind String
    Environment kind.
    name String
    The name of the resource
    systemData SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    title String
    Environment title.
    type String
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    customProperties Object
    The custom metadata defined for API catalog entities.
    description String
    The environment description.
    onboarding OnboardingResponse
    Environment onboarding information
    server EnvironmentServerResponse
    Server information of the environment.
    id string
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    kind string
    Environment kind.
    name string
    The name of the resource
    systemData SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    title string
    Environment title.
    type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    customProperties any
    The custom metadata defined for API catalog entities.
    description string
    The environment description.
    onboarding OnboardingResponse
    Environment onboarding information
    server EnvironmentServerResponse
    Server information of the environment.
    id str
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    kind str
    Environment kind.
    name str
    The name of the resource
    system_data SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    title str
    Environment title.
    type str
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    custom_properties Any
    The custom metadata defined for API catalog entities.
    description str
    The environment description.
    onboarding OnboardingResponse
    Environment onboarding information
    server EnvironmentServerResponse
    Server information of the environment.
    id String
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    kind String
    Environment kind.
    name String
    The name of the resource
    systemData Property Map
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    title String
    Environment title.
    type String
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    customProperties Any
    The custom metadata defined for API catalog entities.
    description String
    The environment description.
    onboarding Property Map
    Environment onboarding information
    server Property Map
    Server information of the environment.

    Supporting Types

    EnvironmentServerResponse

    ManagementPortalUri List<string>
    The location of the management portal
    Type string
    Type of the server that represents the environment.
    ManagementPortalUri []string
    The location of the management portal
    Type string
    Type of the server that represents the environment.
    managementPortalUri List<String>
    The location of the management portal
    type String
    Type of the server that represents the environment.
    managementPortalUri string[]
    The location of the management portal
    type string
    Type of the server that represents the environment.
    management_portal_uri Sequence[str]
    The location of the management portal
    type str
    Type of the server that represents the environment.
    managementPortalUri List<String>
    The location of the management portal
    type String
    Type of the server that represents the environment.

    OnboardingResponse

    DeveloperPortalUri List<string>
    The location of the development portal
    Instructions string
    Onboarding guide.
    DeveloperPortalUri []string
    The location of the development portal
    Instructions string
    Onboarding guide.
    developerPortalUri List<String>
    The location of the development portal
    instructions String
    Onboarding guide.
    developerPortalUri string[]
    The location of the development portal
    instructions string
    Onboarding guide.
    developer_portal_uri Sequence[str]
    The location of the development portal
    instructions str
    Onboarding guide.
    developerPortalUri List<String>
    The location of the development portal
    instructions String
    Onboarding guide.

    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.41.0 published on Tuesday, May 14, 2024 by Pulumi
    pulumi/pulumi-azure-native