Content Item - Get

Service:

API Management

API Version:

2022-08-01

Devuelve el elemento de contenido del portal para desarrolladores especificado por su identificador.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/contentTypes/{contentTypeId}/contentItems/{contentItemId}?api-version=2022-08-01

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
contentItemId	path	True	string	Identificador de elemento de contenido.
contentTypeId	path	True	string	Identificador de tipo de contenido.
resourceGroupName	path	True	string	Nombre del grupo de recursos. El nombre distingue mayúsculas de minúsculas.
serviceName	path	True	string	Nombre del servicio API Management. Regex pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$
subscriptionId	path	True	string	Identificador de la suscripción de destino.
api-version	query	True	string	Versión de API que se usará para la operación.

Respuestas

Nombre	Tipo	Description
200 OK	ContentItemContract	Devuelve el elemento de contenido. Headers ETag: string
Other Status Codes	ErrorResponse	Respuesta de error que describe el motivo del error de la operación.

Seguridad

azure_auth

Flujo de OAuth2 de Azure Active Directory.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Nombre	Description
user_impersonation	suplantación de su cuenta de usuario

Ejemplos

ApiManagementGetContentTypeContentItem

Sample Request

HTTP

GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/contentTypes/page/contentItems/4e3cf6a5-574a-ba08-1f23-2e7a38faa6d8?api-version=2022-08-01

Java

/** Samples for ContentItem Get. */
public final class Main {
    /*
     * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementGetContentTypeContentItem.json
     */
    /**
     * Sample code: ApiManagementGetContentTypeContentItem.
     *
     * @param manager Entry point to ApiManagementManager.
     */
    public static void apiManagementGetContentTypeContentItem(
        com.azure.resourcemanager.apimanagement.ApiManagementManager manager) {
        manager
            .contentItems()
            .getWithResponse(
                "rg1",
                "apimService1",
                "page",
                "4e3cf6a5-574a-ba08-1f23-2e7a38faa6d8",
                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

Python

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_get_content_type_content_item.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.get(
        resource_group_name="rg1",
        service_name="apimService1",
        content_type_id="page",
        content_item_id="4e3cf6a5-574a-ba08-1f23-2e7a38faa6d8",
    )
    print(response)


# x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementGetContentTypeContentItem.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

Go

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/ApiManagementGetContentTypeContentItem.json
func ExampleContentItemClient_Get() {
	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)
	}
	res, err := clientFactory.NewContentItemClient().Get(ctx, "rg1", "apimService1", "page", "4e3cf6a5-574a-ba08-1f23-2e7a38faa6d8", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.ContentItemContract = 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

JavaScript

const { ApiManagementClient } = require("@azure/arm-apimanagement");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Returns the developer portal's content item specified by its identifier.
 *
 * @summary Returns the developer portal's content item specified by its identifier.
 * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementGetContentTypeContentItem.json
 */
async function apiManagementGetContentTypeContentItem() {
  const subscriptionId = process.env["APIMANAGEMENT_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["APIMANAGEMENT_RESOURCE_GROUP"] || "rg1";
  const serviceName = "apimService1";
  const contentTypeId = "page";
  const contentItemId = "4e3cf6a5-574a-ba08-1f23-2e7a38faa6d8";
  const credential = new DefaultAzureCredential();
  const client = new ApiManagementClient(credential, subscriptionId);
  const result = await client.contentItem.get(
    resourceGroupName,
    serviceName,
    contentTypeId,
    contentItemId
  );
  console.log(result);
}

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

Status code:

200

{
  "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"
    }
  }
}

Definiciones

Nombre	Description
ContentItemContract	Detalles del contrato de tipo de contenido.
ErrorFieldContract	Contrato de campo de error.
ErrorResponse	Respuesta de error.

ContentItemContract

Detalles del contrato de tipo de contenido.

Nombre	Tipo	Description
id	string	Identificador de recurso completo del recurso. Por ejemplo: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Nombre del recurso.
type	string	Tipo de recurso. Por ejemplo, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

ErrorFieldContract

Contrato de campo de error.

Nombre	Tipo	Description
code	string	Código de error de nivel de propiedad.
message	string	Representación legible del error de nivel de propiedad.
target	string	Nombre de propiedad.

ErrorResponse

Respuesta de error.

Nombre	Tipo	Description
error.code	string	Código del error definido por el servicio. Este código funciona como estado secundario del código de error HTTP especificado en la respuesta.
error.details	ErrorFieldContract[]	La lista de campos no válidos que se envían en la solicitud, en caso de error de validación.
error.message	string	Representación legible del error.