azure-native-v2.apimanagement.ApiTagDescription
Explore with Pulumi AI
Contract details. Azure REST API version: 2022-08-01. Prior API version in Azure Native 1.x: 2020-12-01.
Other available API versions: 2019-01-01, 2022-09-01-preview, 2023-03-01-preview, 2023-05-01-preview, 2023-09-01-preview, 2024-05-01, 2024-06-01-preview.
Create ApiTagDescription Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new ApiTagDescription(name: string, args: ApiTagDescriptionArgs, opts?: CustomResourceOptions);
@overload
def ApiTagDescription(resource_name: str,
args: ApiTagDescriptionArgs,
opts: Optional[ResourceOptions] = None)
@overload
def ApiTagDescription(resource_name: str,
opts: Optional[ResourceOptions] = None,
api_id: Optional[str] = None,
resource_group_name: Optional[str] = None,
service_name: Optional[str] = None,
description: Optional[str] = None,
external_docs_description: Optional[str] = None,
external_docs_url: Optional[str] = None,
tag_description_id: Optional[str] = None)
func NewApiTagDescription(ctx *Context, name string, args ApiTagDescriptionArgs, opts ...ResourceOption) (*ApiTagDescription, error)
public ApiTagDescription(string name, ApiTagDescriptionArgs args, CustomResourceOptions? opts = null)
public ApiTagDescription(String name, ApiTagDescriptionArgs args)
public ApiTagDescription(String name, ApiTagDescriptionArgs args, CustomResourceOptions options)
type: azure-native:apimanagement:ApiTagDescription
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. ApiTagDescriptionArgs - 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. ApiTagDescriptionArgs - 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. ApiTagDescriptionArgs - 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. ApiTagDescriptionArgs - 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. ApiTagDescriptionArgs - 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 apiTagDescriptionResource = new AzureNative.Apimanagement.ApiTagDescription("apiTagDescriptionResource", new()
{
ApiId = "string",
ResourceGroupName = "string",
ServiceName = "string",
Description = "string",
ExternalDocsDescription = "string",
ExternalDocsUrl = "string",
TagDescriptionId = "string",
});
example, err := apimanagement.NewApiTagDescription(ctx, "apiTagDescriptionResource", &apimanagement.ApiTagDescriptionArgs{
ApiId: "string",
ResourceGroupName: "string",
ServiceName: "string",
Description: "string",
ExternalDocsDescription: "string",
ExternalDocsUrl: "string",
TagDescriptionId: "string",
})
var apiTagDescriptionResource = new ApiTagDescription("apiTagDescriptionResource", ApiTagDescriptionArgs.builder()
.apiId("string")
.resourceGroupName("string")
.serviceName("string")
.description("string")
.externalDocsDescription("string")
.externalDocsUrl("string")
.tagDescriptionId("string")
.build());
api_tag_description_resource = azure_native.apimanagement.ApiTagDescription("apiTagDescriptionResource",
api_id=string,
resource_group_name=string,
service_name=string,
description=string,
external_docs_description=string,
external_docs_url=string,
tag_description_id=string)
const apiTagDescriptionResource = new azure_native.apimanagement.ApiTagDescription("apiTagDescriptionResource", {
apiId: "string",
resourceGroupName: "string",
serviceName: "string",
description: "string",
externalDocsDescription: "string",
externalDocsUrl: "string",
tagDescriptionId: "string",
});
type: azure-native:apimanagement:ApiTagDescription
properties:
apiId: string
description: string
externalDocsDescription: string
externalDocsUrl: string
resourceGroupName: string
serviceName: string
tagDescriptionId: string
ApiTagDescription 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 ApiTagDescription resource accepts the following input properties:
- Api
Id This property is required. Changes to this property will trigger replacement.
- API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.
- 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 the API Management service.
- Description string
- Description of the Tag.
- External
Docs stringDescription - Description of the external resources describing the tag.
- External
Docs stringUrl - Absolute URL of external resources describing the tag.
- Tag
Description Id Changes to this property will trigger replacement.
- Tag description identifier. Used when creating tagDescription for API/Tag association. Based on API and Tag names.
- Api
Id This property is required. Changes to this property will trigger replacement.
- API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.
- 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 the API Management service.
- Description string
- Description of the Tag.
- External
Docs stringDescription - Description of the external resources describing the tag.
- External
Docs stringUrl - Absolute URL of external resources describing the tag.
- Tag
Description Id Changes to this property will trigger replacement.
- Tag description identifier. Used when creating tagDescription for API/Tag association. Based on API and Tag names.
- api
Id This property is required. Changes to this property will trigger replacement.
- API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.
- 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 the API Management service.
- description String
- Description of the Tag.
- external
Docs StringDescription - Description of the external resources describing the tag.
- external
Docs StringUrl - Absolute URL of external resources describing the tag.
- tag
Description Id Changes to this property will trigger replacement.
- Tag description identifier. Used when creating tagDescription for API/Tag association. Based on API and Tag names.
- api
Id This property is required. Changes to this property will trigger replacement.
- API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.
- 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 the API Management service.
- description string
- Description of the Tag.
- external
Docs stringDescription - Description of the external resources describing the tag.
- external
Docs stringUrl - Absolute URL of external resources describing the tag.
- tag
Description Id Changes to this property will trigger replacement.
- Tag description identifier. Used when creating tagDescription for API/Tag association. Based on API and Tag names.
- api_
id This property is required. Changes to this property will trigger replacement.
- API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.
- 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 the API Management service.
- description str
- Description of the Tag.
- external_
docs_ strdescription - Description of the external resources describing the tag.
- external_
docs_ strurl - Absolute URL of external resources describing the tag.
- tag_
description_ id Changes to this property will trigger replacement.
- Tag description identifier. Used when creating tagDescription for API/Tag association. Based on API and Tag names.
- api
Id This property is required. Changes to this property will trigger replacement.
- API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.
- 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 the API Management service.
- description String
- Description of the Tag.
- external
Docs StringDescription - Description of the external resources describing the tag.
- external
Docs StringUrl - Absolute URL of external resources describing the tag.
- tag
Description Id Changes to this property will trigger replacement.
- Tag description identifier. Used when creating tagDescription for API/Tag association. Based on API and Tag names.
Outputs
All input properties are implicitly available as output properties. Additionally, the ApiTagDescription resource produces the following output properties:
- Id string
- The provider-assigned unique ID for this managed resource.
- Name string
- The name of the resource
- Type string
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- Display
Name string - Tag name.
- Tag
Id string - Identifier of the tag in the form of /tags/{tagId}
- Id string
- The provider-assigned unique ID for this managed resource.
- Name string
- The name of the resource
- Type string
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- Display
Name string - Tag name.
- Tag
Id string - Identifier of the tag in the form of /tags/{tagId}
- id String
- The provider-assigned unique ID for this managed resource.
- name String
- The name of the resource
- type String
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- display
Name String - Tag name.
- tag
Id String - Identifier of the tag in the form of /tags/{tagId}
- id string
- The provider-assigned unique ID for this managed resource.
- name string
- The name of the resource
- type string
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- display
Name string - Tag name.
- tag
Id string - Identifier of the tag in the form of /tags/{tagId}
- id str
- The provider-assigned unique ID for this managed resource.
- name str
- The name of the resource
- type str
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- display_
name str - Tag name.
- tag_
id str - Identifier of the tag in the form of /tags/{tagId}
- id String
- The provider-assigned unique ID for this managed resource.
- name String
- The name of the resource
- type String
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- display
Name String - Tag name.
- tag
Id String - Identifier of the tag in the form of /tags/{tagId}
Import
An existing resource can be imported using its type token, name, and identifier, e.g.
$ pulumi import azure-native:apimanagement:ApiTagDescription tagId1 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/tagDescriptions/{tagDescriptionId}
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- azure-native-v2 pulumi/pulumi-azure-native
- License
- Apache-2.0