1. Packages
  2. Azure Native
  3. API Docs
  4. apicenter
  5. Api
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.50.1 published on Tuesday, Jul 16, 2024 by Pulumi

azure-native.apicenter.Api

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.50.1 published on Tuesday, Jul 16, 2024 by Pulumi

    API entity. Azure REST API version: 2024-03-01.

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

    Example Usage

    Apis_CreateOrUpdate

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using AzureNative = Pulumi.AzureNative;
    
    return await Deployment.RunAsync(() => 
    {
        var api = new AzureNative.ApiCenter.Api("api", new()
        {
            ApiName = "echo-api",
            CustomProperties = new Dictionary<string, object?>
            {
                ["author"] = "John Doe",
            },
            Description = "A simple HTTP request/response service.",
            ExternalDocumentation = new[]
            {
                new AzureNative.ApiCenter.Inputs.ExternalDocumentationArgs
                {
                    Title = "Onboarding docs",
                    Url = "https://docs.contoso.com",
                },
            },
            Kind = AzureNative.ApiCenter.ApiKind.Rest,
            License = new AzureNative.ApiCenter.Inputs.LicenseArgs
            {
                Url = "https://contoso.com/license",
            },
            ResourceGroupName = "contoso-resources",
            ServiceName = "contoso",
            TermsOfService = new AzureNative.ApiCenter.Inputs.TermsOfServiceArgs
            {
                Url = "https://contoso.com/terms-of-service",
            },
            Title = "Echo API",
            WorkspaceName = "default",
        });
    
    });
    
    package main
    
    import (
    	apicenter "github.com/pulumi/pulumi-azure-native-sdk/apicenter/v2"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := apicenter.NewApi(ctx, "api", &apicenter.ApiArgs{
    			ApiName: pulumi.String("echo-api"),
    			CustomProperties: pulumi.Any(map[string]interface{}{
    				"author": "John Doe",
    			}),
    			Description: pulumi.String("A simple HTTP request/response service."),
    			ExternalDocumentation: apicenter.ExternalDocumentationArray{
    				&apicenter.ExternalDocumentationArgs{
    					Title: pulumi.String("Onboarding docs"),
    					Url:   pulumi.String("https://docs.contoso.com"),
    				},
    			},
    			Kind: pulumi.String(apicenter.ApiKindRest),
    			License: &apicenter.LicenseArgs{
    				Url: pulumi.String("https://contoso.com/license"),
    			},
    			ResourceGroupName: pulumi.String("contoso-resources"),
    			ServiceName:       pulumi.String("contoso"),
    			TermsOfService: &apicenter.TermsOfServiceArgs{
    				Url: pulumi.String("https://contoso.com/terms-of-service"),
    			},
    			Title:         pulumi.String("Echo API"),
    			WorkspaceName: pulumi.String("default"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.azurenative.apicenter.Api;
    import com.pulumi.azurenative.apicenter.ApiArgs;
    import com.pulumi.azurenative.apicenter.inputs.ExternalDocumentationArgs;
    import com.pulumi.azurenative.apicenter.inputs.LicenseArgs;
    import com.pulumi.azurenative.apicenter.inputs.TermsOfServiceArgs;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            var api = new Api("api", ApiArgs.builder()
                .apiName("echo-api")
                .customProperties(Map.of("author", "John Doe"))
                .description("A simple HTTP request/response service.")
                .externalDocumentation(ExternalDocumentationArgs.builder()
                    .title("Onboarding docs")
                    .url("https://docs.contoso.com")
                    .build())
                .kind("rest")
                .license(LicenseArgs.builder()
                    .url("https://contoso.com/license")
                    .build())
                .resourceGroupName("contoso-resources")
                .serviceName("contoso")
                .termsOfService(TermsOfServiceArgs.builder()
                    .url("https://contoso.com/terms-of-service")
                    .build())
                .title("Echo API")
                .workspaceName("default")
                .build());
    
        }
    }
    
    import pulumi
    import pulumi_azure_native as azure_native
    
    api = azure_native.apicenter.Api("api",
        api_name="echo-api",
        custom_properties={
            "author": "John Doe",
        },
        description="A simple HTTP request/response service.",
        external_documentation=[{
            "title": "Onboarding docs",
            "url": "https://docs.contoso.com",
        }],
        kind=azure_native.apicenter.ApiKind.REST,
        license={
            "url": "https://contoso.com/license",
        },
        resource_group_name="contoso-resources",
        service_name="contoso",
        terms_of_service={
            "url": "https://contoso.com/terms-of-service",
        },
        title="Echo API",
        workspace_name="default")
    
    import * as pulumi from "@pulumi/pulumi";
    import * as azure_native from "@pulumi/azure-native";
    
    const api = new azure_native.apicenter.Api("api", {
        apiName: "echo-api",
        customProperties: {
            author: "John Doe",
        },
        description: "A simple HTTP request/response service.",
        externalDocumentation: [{
            title: "Onboarding docs",
            url: "https://docs.contoso.com",
        }],
        kind: azure_native.apicenter.ApiKind.Rest,
        license: {
            url: "https://contoso.com/license",
        },
        resourceGroupName: "contoso-resources",
        serviceName: "contoso",
        termsOfService: {
            url: "https://contoso.com/terms-of-service",
        },
        title: "Echo API",
        workspaceName: "default",
    });
    
    resources:
      api:
        type: azure-native:apicenter:Api
        properties:
          apiName: echo-api
          customProperties:
            author: John Doe
          description: A simple HTTP request/response service.
          externalDocumentation:
            - title: Onboarding docs
              url: https://docs.contoso.com
          kind: rest
          license:
            url: https://contoso.com/license
          resourceGroupName: contoso-resources
          serviceName: contoso
          termsOfService:
            url: https://contoso.com/terms-of-service
          title: Echo API
          workspaceName: default
    

    Create Api Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Api(name: string, args: ApiArgs, opts?: CustomResourceOptions);
    @overload
    def Api(resource_name: str,
            args: ApiArgs,
            opts: Optional[ResourceOptions] = None)
    
    @overload
    def Api(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            kind: Optional[Union[str, ApiKind]] = None,
            workspace_name: Optional[str] = None,
            title: Optional[str] = None,
            service_name: Optional[str] = None,
            resource_group_name: Optional[str] = None,
            license: Optional[LicenseArgs] = None,
            api_name: Optional[str] = None,
            external_documentation: Optional[Sequence[ExternalDocumentationArgs]] = None,
            description: Optional[str] = None,
            summary: Optional[str] = None,
            terms_of_service: Optional[TermsOfServiceArgs] = None,
            custom_properties: Optional[Any] = None,
            contacts: Optional[Sequence[ContactArgs]] = None)
    func NewApi(ctx *Context, name string, args ApiArgs, opts ...ResourceOption) (*Api, error)
    public Api(string name, ApiArgs args, CustomResourceOptions? opts = null)
    public Api(String name, ApiArgs args)
    public Api(String name, ApiArgs args, CustomResourceOptions options)
    
    type: azure-native:apicenter:Api
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args ApiArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args ApiArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args ApiArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ApiArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ApiArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var apiResource = new AzureNative.ApiCenter.Api("apiResource", new()
    {
        Kind = "string",
        WorkspaceName = "string",
        Title = "string",
        ServiceName = "string",
        ResourceGroupName = "string",
        License = new AzureNative.ApiCenter.Inputs.LicenseArgs
        {
            Identifier = "string",
            Name = "string",
            Url = "string",
        },
        ApiName = "string",
        ExternalDocumentation = new[]
        {
            new AzureNative.ApiCenter.Inputs.ExternalDocumentationArgs
            {
                Url = "string",
                Description = "string",
                Title = "string",
            },
        },
        Description = "string",
        Summary = "string",
        TermsOfService = new AzureNative.ApiCenter.Inputs.TermsOfServiceArgs
        {
            Url = "string",
        },
        CustomProperties = "any",
        Contacts = new[]
        {
            new AzureNative.ApiCenter.Inputs.ContactArgs
            {
                Email = "string",
                Name = "string",
                Url = "string",
            },
        },
    });
    
    example, err := apicenter.NewApi(ctx, "apiResource", &apicenter.ApiArgs{
    	Kind:              pulumi.String("string"),
    	WorkspaceName:     pulumi.String("string"),
    	Title:             pulumi.String("string"),
    	ServiceName:       pulumi.String("string"),
    	ResourceGroupName: pulumi.String("string"),
    	License: &apicenter.LicenseArgs{
    		Identifier: pulumi.String("string"),
    		Name:       pulumi.String("string"),
    		Url:        pulumi.String("string"),
    	},
    	ApiName: pulumi.String("string"),
    	ExternalDocumentation: apicenter.ExternalDocumentationArray{
    		&apicenter.ExternalDocumentationArgs{
    			Url:         pulumi.String("string"),
    			Description: pulumi.String("string"),
    			Title:       pulumi.String("string"),
    		},
    	},
    	Description: pulumi.String("string"),
    	Summary:     pulumi.String("string"),
    	TermsOfService: &apicenter.TermsOfServiceArgs{
    		Url: pulumi.String("string"),
    	},
    	CustomProperties: pulumi.Any("any"),
    	Contacts: apicenter.ContactArray{
    		&apicenter.ContactArgs{
    			Email: pulumi.String("string"),
    			Name:  pulumi.String("string"),
    			Url:   pulumi.String("string"),
    		},
    	},
    })
    
    var apiResource = new Api("apiResource", ApiArgs.builder()
        .kind("string")
        .workspaceName("string")
        .title("string")
        .serviceName("string")
        .resourceGroupName("string")
        .license(LicenseArgs.builder()
            .identifier("string")
            .name("string")
            .url("string")
            .build())
        .apiName("string")
        .externalDocumentation(ExternalDocumentationArgs.builder()
            .url("string")
            .description("string")
            .title("string")
            .build())
        .description("string")
        .summary("string")
        .termsOfService(TermsOfServiceArgs.builder()
            .url("string")
            .build())
        .customProperties("any")
        .contacts(ContactArgs.builder()
            .email("string")
            .name("string")
            .url("string")
            .build())
        .build());
    
    api_resource = azure_native.apicenter.Api("apiResource",
        kind="string",
        workspace_name="string",
        title="string",
        service_name="string",
        resource_group_name="string",
        license={
            "identifier": "string",
            "name": "string",
            "url": "string",
        },
        api_name="string",
        external_documentation=[{
            "url": "string",
            "description": "string",
            "title": "string",
        }],
        description="string",
        summary="string",
        terms_of_service={
            "url": "string",
        },
        custom_properties="any",
        contacts=[{
            "email": "string",
            "name": "string",
            "url": "string",
        }])
    
    const apiResource = new azure_native.apicenter.Api("apiResource", {
        kind: "string",
        workspaceName: "string",
        title: "string",
        serviceName: "string",
        resourceGroupName: "string",
        license: {
            identifier: "string",
            name: "string",
            url: "string",
        },
        apiName: "string",
        externalDocumentation: [{
            url: "string",
            description: "string",
            title: "string",
        }],
        description: "string",
        summary: "string",
        termsOfService: {
            url: "string",
        },
        customProperties: "any",
        contacts: [{
            email: "string",
            name: "string",
            url: "string",
        }],
    });
    
    type: azure-native:apicenter:Api
    properties:
        apiName: string
        contacts:
            - email: string
              name: string
              url: string
        customProperties: any
        description: string
        externalDocumentation:
            - description: string
              title: string
              url: string
        kind: string
        license:
            identifier: string
            name: string
            url: string
        resourceGroupName: string
        serviceName: string
        summary: string
        termsOfService:
            url: string
        title: string
        workspaceName: string
    

    Api Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The Api resource accepts the following input properties:

    Kind string | Pulumi.AzureNative.ApiCenter.ApiKind
    Kind of API. For example, REST or GraphQL.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    ServiceName string
    The name of Azure API Center service.
    Title string
    API title.
    WorkspaceName string
    The name of the workspace.
    ApiName string
    The name of the API.
    Contacts List<Pulumi.AzureNative.ApiCenter.Inputs.Contact>
    The set of contacts
    CustomProperties object
    The custom metadata defined for API catalog entities.
    Description string
    Description of the API.
    ExternalDocumentation List<Pulumi.AzureNative.ApiCenter.Inputs.ExternalDocumentation>
    The set of external documentation
    License Pulumi.AzureNative.ApiCenter.Inputs.License
    The license information for the API.
    Summary string
    Short description of the API.
    TermsOfService Pulumi.AzureNative.ApiCenter.Inputs.TermsOfService
    Terms of service for the API.
    Kind string | ApiKind
    Kind of API. For example, REST or GraphQL.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    ServiceName string
    The name of Azure API Center service.
    Title string
    API title.
    WorkspaceName string
    The name of the workspace.
    ApiName string
    The name of the API.
    Contacts []ContactArgs
    The set of contacts
    CustomProperties interface{}
    The custom metadata defined for API catalog entities.
    Description string
    Description of the API.
    ExternalDocumentation []ExternalDocumentationArgs
    The set of external documentation
    License LicenseArgs
    The license information for the API.
    Summary string
    Short description of the API.
    TermsOfService TermsOfServiceArgs
    Terms of service for the API.
    kind String | ApiKind
    Kind of API. For example, REST or GraphQL.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    serviceName String
    The name of Azure API Center service.
    title String
    API title.
    workspaceName String
    The name of the workspace.
    apiName String
    The name of the API.
    contacts List<Contact>
    The set of contacts
    customProperties Object
    The custom metadata defined for API catalog entities.
    description String
    Description of the API.
    externalDocumentation List<ExternalDocumentation>
    The set of external documentation
    license License
    The license information for the API.
    summary String
    Short description of the API.
    termsOfService TermsOfService
    Terms of service for the API.
    kind string | ApiKind
    Kind of API. For example, REST or GraphQL.
    resourceGroupName string
    The name of the resource group. The name is case insensitive.
    serviceName string
    The name of Azure API Center service.
    title string
    API title.
    workspaceName string
    The name of the workspace.
    apiName string
    The name of the API.
    contacts Contact[]
    The set of contacts
    customProperties any
    The custom metadata defined for API catalog entities.
    description string
    Description of the API.
    externalDocumentation ExternalDocumentation[]
    The set of external documentation
    license License
    The license information for the API.
    summary string
    Short description of the API.
    termsOfService TermsOfService
    Terms of service for the API.
    kind str | ApiKind
    Kind of API. For example, REST or GraphQL.
    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.
    title str
    API title.
    workspace_name str
    The name of the workspace.
    api_name str
    The name of the API.
    contacts Sequence[ContactArgs]
    The set of contacts
    custom_properties Any
    The custom metadata defined for API catalog entities.
    description str
    Description of the API.
    external_documentation Sequence[ExternalDocumentationArgs]
    The set of external documentation
    license LicenseArgs
    The license information for the API.
    summary str
    Short description of the API.
    terms_of_service TermsOfServiceArgs
    Terms of service for the API.
    kind String | "rest" | "graphql" | "grpc" | "soap" | "webhook" | "websocket"
    Kind of API. For example, REST or GraphQL.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    serviceName String
    The name of Azure API Center service.
    title String
    API title.
    workspaceName String
    The name of the workspace.
    apiName String
    The name of the API.
    contacts List<Property Map>
    The set of contacts
    customProperties Any
    The custom metadata defined for API catalog entities.
    description String
    Description of the API.
    externalDocumentation List<Property Map>
    The set of external documentation
    license Property Map
    The license information for the API.
    summary String
    Short description of the API.
    termsOfService Property Map
    Terms of service for the API.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Api resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    LifecycleStage string
    Current lifecycle stage of the API.
    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"
    Id string
    The provider-assigned unique ID for this managed resource.
    LifecycleStage string
    Current lifecycle stage of the API.
    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"
    id String
    The provider-assigned unique ID for this managed resource.
    lifecycleStage String
    Current lifecycle stage of the API.
    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"
    id string
    The provider-assigned unique ID for this managed resource.
    lifecycleStage string
    Current lifecycle stage of the API.
    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"
    id str
    The provider-assigned unique ID for this managed resource.
    lifecycle_stage str
    Current lifecycle stage of the API.
    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"
    id String
    The provider-assigned unique ID for this managed resource.
    lifecycleStage String
    Current lifecycle stage of the API.
    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"

    Supporting Types

    ApiKind, ApiKindArgs

    Rest
    restA Representational State Transfer Api
    Graphql
    graphqlA Graph query language Api
    Grpc
    grpcA gRPC Api
    Soap
    soapA SOAP Api
    Webhook
    webhookWeb Hook
    Websocket
    websocketWeb Socket
    ApiKindRest
    restA Representational State Transfer Api
    ApiKindGraphql
    graphqlA Graph query language Api
    ApiKindGrpc
    grpcA gRPC Api
    ApiKindSoap
    soapA SOAP Api
    ApiKindWebhook
    webhookWeb Hook
    ApiKindWebsocket
    websocketWeb Socket
    Rest
    restA Representational State Transfer Api
    Graphql
    graphqlA Graph query language Api
    Grpc
    grpcA gRPC Api
    Soap
    soapA SOAP Api
    Webhook
    webhookWeb Hook
    Websocket
    websocketWeb Socket
    Rest
    restA Representational State Transfer Api
    Graphql
    graphqlA Graph query language Api
    Grpc
    grpcA gRPC Api
    Soap
    soapA SOAP Api
    Webhook
    webhookWeb Hook
    Websocket
    websocketWeb Socket
    REST
    restA Representational State Transfer Api
    GRAPHQL
    graphqlA Graph query language Api
    GRPC
    grpcA gRPC Api
    SOAP
    soapA SOAP Api
    WEBHOOK
    webhookWeb Hook
    WEBSOCKET
    websocketWeb Socket
    "rest"
    restA Representational State Transfer Api
    "graphql"
    graphqlA Graph query language Api
    "grpc"
    grpcA gRPC Api
    "soap"
    soapA SOAP Api
    "webhook"
    webhookWeb Hook
    "websocket"
    websocketWeb Socket

    Contact, ContactArgs

    Email string
    Email address of the contact.
    Name string
    Name of the contact.
    Url string
    URL for the contact.
    Email string
    Email address of the contact.
    Name string
    Name of the contact.
    Url string
    URL for the contact.
    email String
    Email address of the contact.
    name String
    Name of the contact.
    url String
    URL for the contact.
    email string
    Email address of the contact.
    name string
    Name of the contact.
    url string
    URL for the contact.
    email str
    Email address of the contact.
    name str
    Name of the contact.
    url str
    URL for the contact.
    email String
    Email address of the contact.
    name String
    Name of the contact.
    url String
    URL for the contact.

    ContactResponse, ContactResponseArgs

    Email string
    Email address of the contact.
    Name string
    Name of the contact.
    Url string
    URL for the contact.
    Email string
    Email address of the contact.
    Name string
    Name of the contact.
    Url string
    URL for the contact.
    email String
    Email address of the contact.
    name String
    Name of the contact.
    url String
    URL for the contact.
    email string
    Email address of the contact.
    name string
    Name of the contact.
    url string
    URL for the contact.
    email str
    Email address of the contact.
    name str
    Name of the contact.
    url str
    URL for the contact.
    email String
    Email address of the contact.
    name String
    Name of the contact.
    url String
    URL for the contact.

    ExternalDocumentation, ExternalDocumentationArgs

    Url string
    URL pointing to the documentation.
    Description string
    Description of the documentation.
    Title string
    Title of the documentation.
    Url string
    URL pointing to the documentation.
    Description string
    Description of the documentation.
    Title string
    Title of the documentation.
    url String
    URL pointing to the documentation.
    description String
    Description of the documentation.
    title String
    Title of the documentation.
    url string
    URL pointing to the documentation.
    description string
    Description of the documentation.
    title string
    Title of the documentation.
    url str
    URL pointing to the documentation.
    description str
    Description of the documentation.
    title str
    Title of the documentation.
    url String
    URL pointing to the documentation.
    description String
    Description of the documentation.
    title String
    Title of the documentation.

    ExternalDocumentationResponse, ExternalDocumentationResponseArgs

    Url string
    URL pointing to the documentation.
    Description string
    Description of the documentation.
    Title string
    Title of the documentation.
    Url string
    URL pointing to the documentation.
    Description string
    Description of the documentation.
    Title string
    Title of the documentation.
    url String
    URL pointing to the documentation.
    description String
    Description of the documentation.
    title String
    Title of the documentation.
    url string
    URL pointing to the documentation.
    description string
    Description of the documentation.
    title string
    Title of the documentation.
    url str
    URL pointing to the documentation.
    description str
    Description of the documentation.
    title str
    Title of the documentation.
    url String
    URL pointing to the documentation.
    description String
    Description of the documentation.
    title String
    Title of the documentation.

    License, LicenseArgs

    Identifier string
    SPDX license information for the API. The identifier field is mutually exclusive of the URL field.
    Name string
    Name of the license.
    Url string
    URL pointing to the license details. The URL field is mutually exclusive of the identifier field.
    Identifier string
    SPDX license information for the API. The identifier field is mutually exclusive of the URL field.
    Name string
    Name of the license.
    Url string
    URL pointing to the license details. The URL field is mutually exclusive of the identifier field.
    identifier String
    SPDX license information for the API. The identifier field is mutually exclusive of the URL field.
    name String
    Name of the license.
    url String
    URL pointing to the license details. The URL field is mutually exclusive of the identifier field.
    identifier string
    SPDX license information for the API. The identifier field is mutually exclusive of the URL field.
    name string
    Name of the license.
    url string
    URL pointing to the license details. The URL field is mutually exclusive of the identifier field.
    identifier str
    SPDX license information for the API. The identifier field is mutually exclusive of the URL field.
    name str
    Name of the license.
    url str
    URL pointing to the license details. The URL field is mutually exclusive of the identifier field.
    identifier String
    SPDX license information for the API. The identifier field is mutually exclusive of the URL field.
    name String
    Name of the license.
    url String
    URL pointing to the license details. The URL field is mutually exclusive of the identifier field.

    LicenseResponse, LicenseResponseArgs

    Identifier string
    SPDX license information for the API. The identifier field is mutually exclusive of the URL field.
    Name string
    Name of the license.
    Url string
    URL pointing to the license details. The URL field is mutually exclusive of the identifier field.
    Identifier string
    SPDX license information for the API. The identifier field is mutually exclusive of the URL field.
    Name string
    Name of the license.
    Url string
    URL pointing to the license details. The URL field is mutually exclusive of the identifier field.
    identifier String
    SPDX license information for the API. The identifier field is mutually exclusive of the URL field.
    name String
    Name of the license.
    url String
    URL pointing to the license details. The URL field is mutually exclusive of the identifier field.
    identifier string
    SPDX license information for the API. The identifier field is mutually exclusive of the URL field.
    name string
    Name of the license.
    url string
    URL pointing to the license details. The URL field is mutually exclusive of the identifier field.
    identifier str
    SPDX license information for the API. The identifier field is mutually exclusive of the URL field.
    name str
    Name of the license.
    url str
    URL pointing to the license details. The URL field is mutually exclusive of the identifier field.
    identifier String
    SPDX license information for the API. The identifier field is mutually exclusive of the URL field.
    name String
    Name of the license.
    url String
    URL pointing to the license details. The URL field is mutually exclusive of the identifier field.

    SystemDataResponse, SystemDataResponseArgs

    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.

    TermsOfService, TermsOfServiceArgs

    Url string
    URL pointing to the terms of service.
    Url string
    URL pointing to the terms of service.
    url String
    URL pointing to the terms of service.
    url string
    URL pointing to the terms of service.
    url str
    URL pointing to the terms of service.
    url String
    URL pointing to the terms of service.

    TermsOfServiceResponse, TermsOfServiceResponseArgs

    Url string
    URL pointing to the terms of service.
    Url string
    URL pointing to the terms of service.
    url String
    URL pointing to the terms of service.
    url string
    URL pointing to the terms of service.
    url str
    URL pointing to the terms of service.
    url String
    URL pointing to the terms of service.

    Import

    An existing resource can be imported using its type token, name, and identifier, e.g.

    $ pulumi import azure-native:apicenter:Api echo-api /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiCenter/services/{serviceName}/workspaces/{workspaceName}/apis/{apiName} 
    

    To learn more about importing existing cloud resources, see Importing resources.

    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.50.1 published on Tuesday, Jul 16, 2024 by Pulumi