Lista os itens de conteúdo do portal do desenvolvedor especificados pelo tipo de conteúdo fornecido.
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/contentTypes/{contentTypeId}/contentItems?api-version=2022-08-01
Parâmetros de URI
Nome |
Em |
Obrigatório |
Tipo |
Description |
contentTypeId
|
path |
True
|
string
|
Identificador de tipo de conteúdo.
|
resourceGroupName
|
path |
True
|
string
|
O nome do grupo de recursos. O nome diferencia maiúsculas de minúsculas.
|
serviceName
|
path |
True
|
string
|
O nome do serviço Gerenciamento de API.
Regex pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$
|
subscriptionId
|
path |
True
|
string
|
A ID da assinatura de destino.
|
api-version
|
query |
True
|
string
|
A versão da API a ser usada para esta operação.
|
Respostas
Nome |
Tipo |
Description |
200 OK
|
ContentItemCollection
|
Retorna uma coleção de entidades de Tipo de Conteúdo.
|
Other Status Codes
|
ErrorResponse
|
Resposta de erro que descreve por que a operação falhou.
|
Segurança
azure_auth
Fluxo OAuth2 do Azure Active Directory.
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Nome |
Description |
user_impersonation
|
representar sua conta de usuário
|
Exemplos
ApiManagementListContentTypeContentItems
Sample Request
GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/contentTypes/page/contentItems?api-version=2022-08-01
/** Samples for ContentItem ListByService. */
public final class Main {
/*
* x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementListContentTypeContentItems.json
*/
/**
* Sample code: ApiManagementListContentTypeContentItems.
*
* @param manager Entry point to ApiManagementManager.
*/
public static void apiManagementListContentTypeContentItems(
com.azure.resourcemanager.apimanagement.ApiManagementManager manager) {
manager.contentItems().listByService("rg1", "apimService1", "page", 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_content_type_content_items.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.content_item.list_by_service(
resource_group_name="rg1",
service_name="apimService1",
content_type_id="page",
)
for item in response:
print(item)
# x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementListContentTypeContentItems.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/ApiManagementListContentTypeContentItems.json
func ExampleContentItemClient_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.NewContentItemClient().NewListByServicePager("rg1", "apimService1", "page", 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.ContentItemCollection = armapimanagement.ContentItemCollection{
// Value: []*armapimanagement.ContentItemContract{
// {
// Name: to.Ptr("4e3cf6a5-574a-ba08-1f23-2e7a38faa6d8"),
// Type: to.Ptr("Microsoft.ApiManagement/service/contentTypes/contentItems"),
// ID: to.Ptr("/contentTypes/page/contentItems/4e3cf6a5-574a-ba08-1f23-2e7a38faa6d8"),
// Properties: map[string]any{
// "en_us": map[string]any{
// "description": "Short story about the company.",
// "documentId": "contentTypes/document/contentItems/4e3cf6a5-574a-ba08-1f23-2e7a38faa6d8",
// "keywords": "company, about",
// "permalink": "/about",
// "title": "About",
// },
// },
// }},
// }
}
}
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 developer portal's content items specified by the provided content type.
*
* @summary Lists developer portal's content items specified by the provided content type.
* x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementListContentTypeContentItems.json
*/
async function apiManagementListContentTypeContentItems() {
const subscriptionId = process.env["APIMANAGEMENT_SUBSCRIPTION_ID"] || "subid";
const resourceGroupName = process.env["APIMANAGEMENT_RESOURCE_GROUP"] || "rg1";
const serviceName = "apimService1";
const contentTypeId = "page";
const credential = new DefaultAzureCredential();
const client = new ApiManagementClient(credential, subscriptionId);
const resArray = new Array();
for await (let item of client.contentItem.listByService(
resourceGroupName,
serviceName,
contentTypeId
)) {
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": "/contentTypes/page/contentItems/4e3cf6a5-574a-ba08-1f23-2e7a38faa6d8",
"type": "Microsoft.ApiManagement/service/contentTypes/contentItems",
"name": "4e3cf6a5-574a-ba08-1f23-2e7a38faa6d8",
"properties": {
"en_us": {
"title": "About",
"description": "Short story about the company.",
"keywords": "company, about",
"documentId": "contentTypes/document/contentItems/4e3cf6a5-574a-ba08-1f23-2e7a38faa6d8",
"permalink": "/about"
}
}
}
]
}
Definições
ContentItemCollection
Lista paginada de itens de conteúdo.
Nome |
Tipo |
Description |
nextLink
|
string
|
Próximo link da página, se houver.
|
value
|
ContentItemContract[]
|
Coleção de itens de conteúdo.
|
ContentItemContract
Detalhes do contrato do tipo de conteúdo.
Nome |
Tipo |
Description |
id
|
string
|
ID de recurso totalmente qualificada para o recurso. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
|
name
|
string
|
O nome do recurso
|
type
|
string
|
Tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"
|
ErrorFieldContract
Contrato de campo de erro.
Nome |
Tipo |
Description |
code
|
string
|
Código de erro no nível da propriedade.
|
message
|
string
|
Representação legível por humanos do erro no nível da propriedade.
|
target
|
string
|
Nome da propriedade.
|
ErrorResponse
Resposta de erro.
Nome |
Tipo |
Description |
error.code
|
string
|
Código de erro definido pelo serviço. Esse código atua como um substatus do código de erro HTTP especificado na resposta.
|
error.details
|
ErrorFieldContract[]
|
A lista de campos inválidos enviados na solicitação, em caso de erro de validação.
|
error.message
|
string
|
Representação legível ao olho humano do erro.
|