azure-native.apicenter.Api
Explore with Pulumi AI
API entity.
Uses Azure REST API version 2024-03-15-preview. In version 2.x of the Azure Native provider, it used API version 2024-03-01.
Other available API versions: 2024-03-01, 2024-06-01-preview. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native apicenter [ApiVersion]
. See the version guide for details.
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)
type: azure-native:apicenter:Api
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name
This property is required. string - The unique name of the resource.
- args
This property is required. ApiArgs - The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name
This property is required. str - The unique name of the resource.
- args
This property is required. 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
This property is required. string - The unique name of the resource.
- args
This property is required. ApiArgs - The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name
This property is required. string - The unique name of the resource.
- args
This property is required. ApiArgs - The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name
This property is required. String - The unique name of the resource.
- args
This property is required. 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
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The Api resource accepts the following input properties:
- Kind
This property is required. string | Pulumi.Azure Native. Api Center. Api Kind - Kind of API. For example, REST or GraphQL.
- Resource
Group Name This property is required. Changes to this property will trigger replacement.
- The name of the resource group. The name is case insensitive.
- Service
Name This property is required. Changes to this property will trigger replacement.
- The name of Azure API Center service.
- Title
This property is required. string - API title.
- Workspace
Name This property is required. Changes to this property will trigger replacement.
- The name of the workspace.
- Api
Name Changes to this property will trigger replacement.
- The name of the API.
- Contacts
List<Pulumi.
Azure Native. Api Center. Inputs. Contact> - The set of contacts
- Custom
Properties object - The custom metadata defined for API catalog entities.
- Description string
- Description of the API.
- External
Documentation List<Pulumi.Azure Native. Api Center. Inputs. External Documentation> - The set of external documentation
- License
Pulumi.
Azure Native. Api Center. Inputs. License - The license information for the API.
- Summary string
- Short description of the API.
- Terms
Of Pulumi.Service Azure Native. Api Center. Inputs. Terms Of Service - Terms of service for the API.
- Kind
This property is required. string | ApiKind - Kind of API. For example, REST or GraphQL.
- Resource
Group Name This property is required. Changes to this property will trigger replacement.
- The name of the resource group. The name is case insensitive.
- Service
Name This property is required. Changes to this property will trigger replacement.
- The name of Azure API Center service.
- Title
This property is required. string - API title.
- Workspace
Name This property is required. Changes to this property will trigger replacement.
- The name of the workspace.
- Api
Name Changes to this property will trigger replacement.
- The name of the API.
- Contacts
[]Contact
Args - The set of contacts
- Custom
Properties interface{} - The custom metadata defined for API catalog entities.
- Description string
- Description of the API.
- External
Documentation []ExternalDocumentation Args - The set of external documentation
- License
License
Args - The license information for the API.
- Summary string
- Short description of the API.
- Terms
Of TermsService Of Service Args - Terms of service for the API.
- kind
This property is required. String | ApiKind - Kind of API. For example, REST or GraphQL.
- resource
Group Name This property is required. Changes to this property will trigger replacement.
- The name of the resource group. The name is case insensitive.
- service
Name This property is required. Changes to this property will trigger replacement.
- The name of Azure API Center service.
- title
This property is required. String - API title.
- workspace
Name This property is required. Changes to this property will trigger replacement.
- The name of the workspace.
- api
Name Changes to this property will trigger replacement.
- The name of the API.
- contacts List<Contact>
- The set of contacts
- custom
Properties Object - The custom metadata defined for API catalog entities.
- description String
- Description of the API.
- external
Documentation List<ExternalDocumentation> - The set of external documentation
- license License
- The license information for the API.
- summary String
- Short description of the API.
- terms
Of TermsService Of Service - Terms of service for the API.
- kind
This property is required. string | ApiKind - Kind of API. For example, REST or GraphQL.
- resource
Group Name This property is required. Changes to this property will trigger replacement.
- The name of the resource group. The name is case insensitive.
- service
Name This property is required. Changes to this property will trigger replacement.
- The name of Azure API Center service.
- title
This property is required. string - API title.
- workspace
Name This property is required. Changes to this property will trigger replacement.
- The name of the workspace.
- api
Name Changes to this property will trigger replacement.
- The name of the API.
- contacts Contact[]
- The set of contacts
- custom
Properties any - The custom metadata defined for API catalog entities.
- description string
- Description of the API.
- external
Documentation ExternalDocumentation[] - The set of external documentation
- license License
- The license information for the API.
- summary string
- Short description of the API.
- terms
Of TermsService Of Service - Terms of service for the API.
- kind
This property is required. str | ApiKind - Kind of API. For example, REST or GraphQL.
- resource_
group_ name This property is required. Changes to this property will trigger replacement.
- The name of the resource group. The name is case insensitive.
- service_
name This property is required. Changes to this property will trigger replacement.
- The name of Azure API Center service.
- title
This property is required. str - API title.
- workspace_
name This property is required. Changes to this property will trigger replacement.
- The name of the workspace.
- api_
name Changes to this property will trigger replacement.
- The name of the API.
- contacts
Sequence[Contact
Args] - The set of contacts
- custom_
properties Any - The custom metadata defined for API catalog entities.
- description str
- Description of the API.
- external_
documentation Sequence[ExternalDocumentation Args] - The set of external documentation
- license
License
Args - The license information for the API.
- summary str
- Short description of the API.
- terms_
of_ Termsservice Of Service Args - Terms of service for the API.
- kind
This property is required. String | "rest" | "graphql" | "grpc" | "soap" | "webhook" | "websocket" - Kind of API. For example, REST or GraphQL.
- resource
Group Name This property is required. Changes to this property will trigger replacement.
- The name of the resource group. The name is case insensitive.
- service
Name This property is required. Changes to this property will trigger replacement.
- The name of Azure API Center service.
- title
This property is required. String - API title.
- workspace
Name This property is required. Changes to this property will trigger replacement.
- The name of the workspace.
- api
Name Changes to this property will trigger replacement.
- The name of the API.
- contacts List<Property Map>
- The set of contacts
- custom
Properties Any - The custom metadata defined for API catalog entities.
- description String
- Description of the API.
- external
Documentation List<Property Map> - The set of external documentation
- license Property Map
- The license information for the API.
- summary String
- Short description of the API.
- terms
Of Property MapService - 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:
- Azure
Api stringVersion - The Azure API version of the resource.
- Id string
- The provider-assigned unique ID for this managed resource.
- Lifecycle
Stage string - Current lifecycle stage of the API.
- Name string
- The name of the resource
- System
Data Pulumi.Azure Native. Api Center. Outputs. System Data Response - 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"
- Azure
Api stringVersion - The Azure API version of the resource.
- Id string
- The provider-assigned unique ID for this managed resource.
- Lifecycle
Stage string - Current lifecycle stage of the API.
- Name string
- The name of the resource
- System
Data SystemData Response - 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"
- azure
Api StringVersion - The Azure API version of the resource.
- id String
- The provider-assigned unique ID for this managed resource.
- lifecycle
Stage String - Current lifecycle stage of the API.
- name String
- The name of the resource
- system
Data SystemData Response - 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"
- azure
Api stringVersion - The Azure API version of the resource.
- id string
- The provider-assigned unique ID for this managed resource.
- lifecycle
Stage string - Current lifecycle stage of the API.
- name string
- The name of the resource
- system
Data SystemData Response - 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"
- azure_
api_ strversion - The Azure API version of the resource.
- 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 SystemData Response - 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 StringVersion - The Azure API version of the resource.
- id String
- The provider-assigned unique ID for this managed resource.
- lifecycle
Stage String - Current lifecycle stage of the API.
- name String
- The name of the resource
- system
Data 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
- Api
Kind Rest - restA Representational State Transfer Api
- Api
Kind Graphql - graphqlA Graph query language Api
- Api
Kind Grpc - grpcA gRPC Api
- Api
Kind Soap - soapA SOAP Api
- Api
Kind Webhook - webhookWeb Hook
- Api
Kind 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
- "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
ContactResponse, ContactResponseArgs
ExternalDocumentation, ExternalDocumentationArgs
- Url
This property is required. string - URL pointing to the documentation.
- Description string
- Description of the documentation.
- Title string
- Title of the documentation.
- Url
This property is required. string - URL pointing to the documentation.
- Description string
- Description of the documentation.
- Title string
- Title of the documentation.
- url
This property is required. String - URL pointing to the documentation.
- description String
- Description of the documentation.
- title String
- Title of the documentation.
- url
This property is required. string - URL pointing to the documentation.
- description string
- Description of the documentation.
- title string
- Title of the documentation.
- url
This property is required. str - URL pointing to the documentation.
- description str
- Description of the documentation.
- title str
- Title of the documentation.
- url
This property is required. String - URL pointing to the documentation.
- description String
- Description of the documentation.
- title String
- Title of the documentation.
ExternalDocumentationResponse, ExternalDocumentationResponseArgs
- Url
This property is required. string - URL pointing to the documentation.
- Description string
- Description of the documentation.
- Title string
- Title of the documentation.
- Url
This property is required. string - URL pointing to the documentation.
- Description string
- Description of the documentation.
- Title string
- Title of the documentation.
- url
This property is required. String - URL pointing to the documentation.
- description String
- Description of the documentation.
- title String
- Title of the documentation.
- url
This property is required. string - URL pointing to the documentation.
- description string
- Description of the documentation.
- title string
- Title of the documentation.
- url
This property is required. str - URL pointing to the documentation.
- description str
- Description of the documentation.
- title str
- Title of the documentation.
- url
This property is required. 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
- Created
At string - The timestamp of resource creation (UTC).
- Created
By string - The identity that created the resource.
- Created
By stringType - The type of identity that created the resource.
- Last
Modified stringAt - The timestamp of resource last modification (UTC)
- Last
Modified stringBy - The identity that last modified the resource.
- Last
Modified stringBy Type - The type of identity that last modified the resource.
- Created
At string - The timestamp of resource creation (UTC).
- Created
By string - The identity that created the resource.
- Created
By stringType - The type of identity that created the resource.
- Last
Modified stringAt - The timestamp of resource last modification (UTC)
- Last
Modified stringBy - The identity that last modified the resource.
- Last
Modified stringBy Type - The type of identity that last modified the resource.
- created
At String - The timestamp of resource creation (UTC).
- created
By String - The identity that created the resource.
- created
By StringType - The type of identity that created the resource.
- last
Modified StringAt - The timestamp of resource last modification (UTC)
- last
Modified StringBy - The identity that last modified the resource.
- last
Modified StringBy Type - The type of identity that last modified the resource.
- created
At string - The timestamp of resource creation (UTC).
- created
By string - The identity that created the resource.
- created
By stringType - The type of identity that created the resource.
- last
Modified stringAt - The timestamp of resource last modification (UTC)
- last
Modified stringBy - The identity that last modified the resource.
- last
Modified stringBy Type - 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_ strtype - The type of identity that created the resource.
- last_
modified_ strat - The timestamp of resource last modification (UTC)
- last_
modified_ strby - The identity that last modified the resource.
- last_
modified_ strby_ type - The type of identity that last modified the resource.
- created
At String - The timestamp of resource creation (UTC).
- created
By String - The identity that created the resource.
- created
By StringType - The type of identity that created the resource.
- last
Modified StringAt - The timestamp of resource last modification (UTC)
- last
Modified StringBy - The identity that last modified the resource.
- last
Modified StringBy Type - The type of identity that last modified the resource.
TermsOfService, TermsOfServiceArgs
- Url
This property is required. string - URL pointing to the terms of service.
- Url
This property is required. string - URL pointing to the terms of service.
- url
This property is required. String - URL pointing to the terms of service.
- url
This property is required. string - URL pointing to the terms of service.
- url
This property is required. str - URL pointing to the terms of service.
- url
This property is required. String - URL pointing to the terms of service.
TermsOfServiceResponse, TermsOfServiceResponseArgs
- Url
This property is required. string - URL pointing to the terms of service.
- Url
This property is required. string - URL pointing to the terms of service.
- url
This property is required. String - URL pointing to the terms of service.
- url
This property is required. string - URL pointing to the terms of service.
- url
This property is required. str - URL pointing to the terms of service.
- url
This property is required. 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