Bir hizmet örneği içinde tanımlanan etiket koleksiyonunu listeler.
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/tags?api-version=2022-08-01
With optional parameters:
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/tags?$filter={$filter}&$top={$top}&$skip={$skip}&scope={scope}&api-version=2022-08-01
URI Parametreleri
| Name |
İçinde |
Gerekli |
Tür |
Description |
|
resourceGroupName
|
path |
True
|
string
|
Kaynak grubunun adı. Ad büyük/küçük harfe duyarlı değildir.
|
|
serviceName
|
path |
True
|
string
|
API Management hizmetinin adı.
Regex pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$
|
|
subscriptionId
|
path |
True
|
string
|
Hedef aboneliğin kimliği.
|
|
api-version
|
query |
True
|
string
|
Bu işlem için kullanılacak API sürümü.
|
|
$filter
|
query |
|
string
|
| Alan | Kullanım | Desteklenen işleçler | Desteklenen işlevler |
|-------------|-------------|-------------|-------------|
| ad | filtre | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| displayName | filtre | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
|
|
$skip
|
query |
|
integer
int32
|
Atacak kayıt sayısı.
|
|
$top
|
query |
|
integer
int32
|
Döndürülecek kayıt sayısı.
|
|
scope
|
query |
|
string
|
'apis', 'products' veya 'apis/{apiId} gibi kapsam
|
Yanıtlar
| Name |
Tür |
Description |
|
200 OK
|
TagCollection
|
Etiket varlıklarından oluşan bir koleksiyonu listeler.
|
|
Other Status Codes
|
ErrorResponse
|
İşlemin neden başarısız olduğunu açıklayan hata yanıtı.
|
Güvenlik
azure_auth
Azure Active Directory OAuth2 Flow.
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
| Name |
Description |
|
user_impersonation
|
kullanıcı hesabınızın kimliğine bürünme
|
Örnekler
Sample Request
GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tags?api-version=2022-08-01
/** Samples for Tag ListByService. */
public final class Main {
/*
* x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementListTags.json
*/
/**
* Sample code: ApiManagementListTags.
*
* @param manager Entry point to ApiManagementManager.
*/
public static void apiManagementListTags(com.azure.resourcemanager.apimanagement.ApiManagementManager manager) {
manager.tags().listByService("rg1", "apimService1", null, null, null, null, com.azure.core.util.Context.NONE);
}
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
from azure.identity import DefaultAzureCredential
from azure.mgmt.apimanagement import ApiManagementClient
"""
# PREREQUISITES
pip install azure-identity
pip install azure-mgmt-apimanagement
# USAGE
python api_management_list_tags.py
Before run the sample, please set the values of the client ID, tenant ID and client secret
of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""
def main():
client = ApiManagementClient(
credential=DefaultAzureCredential(),
subscription_id="subid",
)
response = client.tag.list_by_service(
resource_group_name="rg1",
service_name="apimService1",
)
for item in response:
print(item)
# x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementListTags.json
if __name__ == "__main__":
main()
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
package armapimanagement_test
import (
"context"
"log"
"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/apimanagement/armapimanagement/v2"
)
// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/4cd95123fb961c68740565a1efcaa5e43bd35802/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementListTags.json
func ExampleTagClient_NewListByServicePager() {
cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armapimanagement.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
log.Fatalf("failed to create client: %v", err)
}
pager := clientFactory.NewTagClient().NewListByServicePager("rg1", "apimService1", &armapimanagement.TagClientListByServiceOptions{Filter: nil,
Top: nil,
Skip: nil,
Scope: nil,
})
for pager.More() {
page, err := pager.NextPage(ctx)
if err != nil {
log.Fatalf("failed to advance page: %v", err)
}
for _, v := range page.Value {
// You could use page here. We use blank identifier for just demo purposes.
_ = v
}
// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// page.TagCollection = armapimanagement.TagCollection{
// Count: to.Ptr[int64](2),
// Value: []*armapimanagement.TagContract{
// {
// Name: to.Ptr("5600b59375ff190048020001"),
// Type: to.Ptr("Microsoft.ApiManagement/service/tags"),
// ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tags/5600b59375ff190048020001"),
// Properties: &armapimanagement.TagContractProperties{
// DisplayName: to.Ptr("tag1"),
// },
// },
// {
// Name: to.Ptr("5600b59375ff190048020002"),
// Type: to.Ptr("Microsoft.ApiManagement/service/tags"),
// ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tags/5600b59375ff190048020002"),
// Properties: &armapimanagement.TagContractProperties{
// DisplayName: to.Ptr("tag2"),
// },
// }},
// }
}
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
const { ApiManagementClient } = require("@azure/arm-apimanagement");
const { DefaultAzureCredential } = require("@azure/identity");
/**
* This sample demonstrates how to Lists a collection of tags defined within a service instance.
*
* @summary Lists a collection of tags defined within a service instance.
* x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementListTags.json
*/
async function apiManagementListTags() {
const subscriptionId = process.env["APIMANAGEMENT_SUBSCRIPTION_ID"] || "subid";
const resourceGroupName = process.env["APIMANAGEMENT_RESOURCE_GROUP"] || "rg1";
const serviceName = "apimService1";
const credential = new DefaultAzureCredential();
const client = new ApiManagementClient(credential, subscriptionId);
const resArray = new Array();
for await (let item of client.tag.listByService(resourceGroupName, serviceName)) {
resArray.push(item);
}
console.log(resArray);
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
Sample Response
{
"value": [
{
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tags/5600b59375ff190048020001",
"type": "Microsoft.ApiManagement/service/tags",
"name": "5600b59375ff190048020001",
"properties": {
"displayName": "tag1"
}
},
{
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tags/5600b59375ff190048020002",
"type": "Microsoft.ApiManagement/service/tags",
"name": "5600b59375ff190048020002",
"properties": {
"displayName": "tag2"
}
}
],
"count": 2,
"nextLink": ""
}
Tanımlar
ErrorFieldContract
Hata Alanı sözleşmesi.
| Name |
Tür |
Description |
|
code
|
string
|
Özellik düzeyi hata kodu.
|
|
message
|
string
|
Özellik düzeyi hatanın insan tarafından okunabilir gösterimi.
|
|
target
|
string
|
Özellik adı.
|
ErrorResponse
Hata Yanıtı.
| Name |
Tür |
Description |
|
error.code
|
string
|
Hizmet tanımlı hata kodu. Bu kod, yanıtta belirtilen HTTP hata kodu için bir alt durum görevi görür.
|
|
error.details
|
ErrorFieldContract[]
|
Doğrulama hatası durumunda istekte gönderilen geçersiz alanların listesi.
|
|
error.message
|
string
|
Hatanın insan tarafından okunabilir gösterimi.
|
TagCollection
Sayfalanmış Etiket listesi gösterimi.
| Name |
Tür |
Description |
|
count
|
integer
|
Tüm sayfalardaki toplam kayıt sayısı.
|
|
nextLink
|
string
|
Varsa sonraki sayfa bağlantısı.
|
|
value
|
TagContract[]
|
Sayfa değerleri.
|
TagContract
Etiket Sözleşmesi ayrıntıları.
| Name |
Tür |
Description |
|
id
|
string
|
Kaynağın tam kaynak kimliği. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
|
|
name
|
string
|
Kaynağın adı
|
|
properties.displayName
|
string
|
Etiket adı.
|
|
type
|
string
|
Kaynağın türü. Örneğin, "Microsoft.Compute/virtualMachines" veya "Microsoft.Storage/storageAccounts"
|