azure-native.apimanagement.TagByApi
Explore with Pulumi AI
Tag Contract details. Azure REST API version: 2022-08-01. Prior API version in Azure Native 1.x: 2020-12-01.
Other available API versions: 2022-09-01-preview, 2023-03-01-preview, 2023-05-01-preview, 2023-09-01-preview, 2024-05-01, 2024-06-01-preview.
Example Usage
ApiManagementCreateApiTag
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;
return await Deployment.RunAsync(() =>
{
var tagByApi = new AzureNative.ApiManagement.TagByApi("tagByApi", new()
{
ApiId = "5931a75ae4bbd512a88c680b",
ResourceGroupName = "rg1",
ServiceName = "apimService1",
TagId = "tagId1",
});
});
package main
import (
apimanagement "github.com/pulumi/pulumi-azure-native-sdk/apimanagement/v2"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := apimanagement.NewTagByApi(ctx, "tagByApi", &apimanagement.TagByApiArgs{
ApiId: pulumi.String("5931a75ae4bbd512a88c680b"),
ResourceGroupName: pulumi.String("rg1"),
ServiceName: pulumi.String("apimService1"),
TagId: pulumi.String("tagId1"),
})
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.apimanagement.TagByApi;
import com.pulumi.azurenative.apimanagement.TagByApiArgs;
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 tagByApi = new TagByApi("tagByApi", TagByApiArgs.builder()
.apiId("5931a75ae4bbd512a88c680b")
.resourceGroupName("rg1")
.serviceName("apimService1")
.tagId("tagId1")
.build());
}
}
import pulumi
import pulumi_azure_native as azure_native
tag_by_api = azure_native.apimanagement.TagByApi("tagByApi",
api_id="5931a75ae4bbd512a88c680b",
resource_group_name="rg1",
service_name="apimService1",
tag_id="tagId1")
import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";
const tagByApi = new azure_native.apimanagement.TagByApi("tagByApi", {
apiId: "5931a75ae4bbd512a88c680b",
resourceGroupName: "rg1",
serviceName: "apimService1",
tagId: "tagId1",
});
resources:
tagByApi:
type: azure-native:apimanagement:TagByApi
properties:
apiId: 5931a75ae4bbd512a88c680b
resourceGroupName: rg1
serviceName: apimService1
tagId: tagId1
Create TagByApi Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new TagByApi(name: string, args: TagByApiArgs, opts?: CustomResourceOptions);
@overload
def TagByApi(resource_name: str,
args: TagByApiArgs,
opts: Optional[ResourceOptions] = None)
@overload
def TagByApi(resource_name: str,
opts: Optional[ResourceOptions] = None,
api_id: Optional[str] = None,
resource_group_name: Optional[str] = None,
service_name: Optional[str] = None,
tag_id: Optional[str] = None)
func NewTagByApi(ctx *Context, name string, args TagByApiArgs, opts ...ResourceOption) (*TagByApi, error)
public TagByApi(string name, TagByApiArgs args, CustomResourceOptions? opts = null)
public TagByApi(String name, TagByApiArgs args)
public TagByApi(String name, TagByApiArgs args, CustomResourceOptions options)
type: azure-native:apimanagement:TagByApi
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 TagByApiArgs
- 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 TagByApiArgs
- 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 TagByApiArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args TagByApiArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args TagByApiArgs
- 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 tagByApiResource = new AzureNative.ApiManagement.TagByApi("tagByApiResource", new()
{
ApiId = "string",
ResourceGroupName = "string",
ServiceName = "string",
TagId = "string",
});
example, err := apimanagement.NewTagByApi(ctx, "tagByApiResource", &apimanagement.TagByApiArgs{
ApiId: pulumi.String("string"),
ResourceGroupName: pulumi.String("string"),
ServiceName: pulumi.String("string"),
TagId: pulumi.String("string"),
})
var tagByApiResource = new TagByApi("tagByApiResource", TagByApiArgs.builder()
.apiId("string")
.resourceGroupName("string")
.serviceName("string")
.tagId("string")
.build());
tag_by_api_resource = azure_native.apimanagement.TagByApi("tagByApiResource",
api_id="string",
resource_group_name="string",
service_name="string",
tag_id="string")
const tagByApiResource = new azure_native.apimanagement.TagByApi("tagByApiResource", {
apiId: "string",
resourceGroupName: "string",
serviceName: "string",
tagId: "string",
});
type: azure-native:apimanagement:TagByApi
properties:
apiId: string
resourceGroupName: string
serviceName: string
tagId: string
TagByApi 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 TagByApi resource accepts the following input properties:
- Api
Id string - 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 stringName - The name of the resource group. The name is case insensitive.
- Service
Name string - The name of the API Management service.
- Tag
Id string - Tag identifier. Must be unique in the current API Management service instance.
- Api
Id string - 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 stringName - The name of the resource group. The name is case insensitive.
- Service
Name string - The name of the API Management service.
- Tag
Id string - Tag identifier. Must be unique in the current API Management service instance.
- api
Id String - 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 StringName - The name of the resource group. The name is case insensitive.
- service
Name String - The name of the API Management service.
- tag
Id String - Tag identifier. Must be unique in the current API Management service instance.
- api
Id string - 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 stringName - The name of the resource group. The name is case insensitive.
- service
Name string - The name of the API Management service.
- tag
Id string - Tag identifier. Must be unique in the current API Management service instance.
- api_
id str - 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_ strname - The name of the resource group. The name is case insensitive.
- service_
name str - The name of the API Management service.
- tag_
id str - Tag identifier. Must be unique in the current API Management service instance.
- api
Id String - 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 StringName - The name of the resource group. The name is case insensitive.
- service
Name String - The name of the API Management service.
- tag
Id String - Tag identifier. Must be unique in the current API Management service instance.
Outputs
All input properties are implicitly available as output properties. Additionally, the TagByApi resource produces the following output properties:
- Display
Name string - Tag name.
- 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.
- 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.
- 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.
- 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 str - Tag name.
- 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 String - Tag name.
- 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"
Import
An existing resource can be imported using its type token, name, and identifier, e.g.
$ pulumi import azure-native:apimanagement:TagByApi tagId1 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/tags/{tagId}
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- Azure Native pulumi/pulumi-azure-native
- License
- Apache-2.0