Profiles - Get

Service:

CDN

API Version:

2024-02-01

Gets an Azure Front Door Standard or Azure Front Door Premium or CDN profile with the specified profile name under the specified subscription and resource group.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}?api-version=2024-02-01

URI Parameters

Name	In	Required	Type	Description
profileName	path	True	string	Name of the Azure Front Door Standard or Azure Front Door Premium or CDN profile which is unique within the resource group.
resourceGroupName	path	True	string	Name of the Resource group within the Azure subscription. Regex pattern: ^[-\w\._\(\)]+$
subscriptionId	path	True	string	Azure Subscription ID.
api-version	query	True	string	Version of the API to be used with the client request. Current version is 2024-02-01.

Responses

Name	Type	Description
200 OK	Profile	OK. The request has succeeded.
Other Status Codes	ErrorResponse	CDN error response describing why the operation failed.

Security

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	impersonate your user account

Examples

Profiles_Get

Sample request

HTTP

GET https://management.azure.com/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1?api-version=2024-02-01

Java

/**
 * Samples for Profiles GetByResourceGroup.
 */
public final class Main {
    /*
     * x-ms-original-file: specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-02-01/examples/Profiles_Get.json
     */
    /**
     * Sample code: Profiles_Get.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void profilesGet(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.cdnProfiles().manager().serviceClient().getProfiles().getByResourceGroupWithResponse("RG", "profile1",
            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.cdn import CdnManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-cdn
# USAGE
    python profiles_get.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 = CdnManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="subid",
    )

    response = client.profiles.get(
        resource_group_name="RG",
        profile_name="profile1",
    )
    print(response)


# x-ms-original-file: specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-02-01/examples/Profiles_Get.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 armcdn_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/cdn/armcdn/v2"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/92de53a5f1e0e03c94b40475d2135d97148ed014/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-02-01/examples/Profiles_Get.json
func ExampleProfilesClient_Get() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armcdn.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewProfilesClient().Get(ctx, "RG", "profile1", 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.Profile = armcdn.Profile{
	// 	Name: to.Ptr("profile1"),
	// 	Type: to.Ptr("Microsoft.Cdn/profiles"),
	// 	ID: to.Ptr("/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1"),
	// 	Location: to.Ptr("global"),
	// 	Tags: map[string]*string{
	// 	},
	// 	Kind: to.Ptr("frontdoor"),
	// 	Properties: &armcdn.ProfileProperties{
	// 		FrontDoorID: to.Ptr("3b4682da-b3e2-47a1-96ca-08ab3cb7294e"),
	// 		LogScrubbing: &armcdn.ProfileLogScrubbing{
	// 			ScrubbingRules: []*armcdn.ProfileScrubbingRules{
	// 			},
	// 			State: to.Ptr(armcdn.ProfileScrubbingStateEnabled),
	// 		},
	// 		OriginResponseTimeoutSeconds: to.Ptr[int32](30),
	// 		ProvisioningState: to.Ptr(armcdn.ProfileProvisioningStateSucceeded),
	// 		ResourceState: to.Ptr(armcdn.ProfileResourceStateActive),
	// 	},
	// 	SKU: &armcdn.SKU{
	// 		Name: to.Ptr(armcdn.SKUNamePremiumAzureFrontDoor),
	// 	},
	// }
}

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 { CdnManagementClient } = require("@azure/arm-cdn");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Gets an Azure Front Door Standard or Azure Front Door Premium or CDN profile with the specified profile name under the specified subscription and resource group.
 *
 * @summary Gets an Azure Front Door Standard or Azure Front Door Premium or CDN profile with the specified profile name under the specified subscription and resource group.
 * x-ms-original-file: specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-02-01/examples/Profiles_Get.json
 */
async function profilesGet() {
  const subscriptionId = process.env["CDN_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["CDN_RESOURCE_GROUP"] || "RG";
  const profileName = "profile1";
  const credential = new DefaultAzureCredential();
  const client = new CdnManagementClient(credential, subscriptionId);
  const result = await client.profiles.get(resourceGroupName, profileName);
  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

dotnet

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Cdn.Models;
using Azure.ResourceManager.Resources;
using Azure.ResourceManager.Resources.Models;
using Azure.ResourceManager.Cdn;

// Generated from example definition: specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-02-01/examples/Profiles_Get.json
// this example is just showing the usage of "Profiles_Get" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this ProfileResource created on azure
// for more information of creating ProfileResource, please refer to the document of ProfileResource
string subscriptionId = "subid";
string resourceGroupName = "RG";
string profileName = "profile1";
ResourceIdentifier profileResourceId = ProfileResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, profileName);
ProfileResource profile = client.GetProfileResource(profileResourceId);

// invoke the operation
ProfileResource result = await profile.GetAsync();

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
ProfileData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

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

{
  "name": "profile1",
  "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1",
  "type": "Microsoft.Cdn/profiles",
  "tags": {},
  "location": "global",
  "sku": {
    "name": "Premium_AzureFrontDoor"
  },
  "kind": "frontdoor",
  "properties": {
    "originResponseTimeoutSeconds": 30,
    "logScrubbing": {
      "state": "Enabled",
      "scrubbingRules": []
    },
    "frontDoorId": "3b4682da-b3e2-47a1-96ca-08ab3cb7294e",
    "provisioningState": "Succeeded",
    "resourceState": "Active"
  }
}

Definitions

Name	Description
scrubbingRuleEntryMatchOperator	When matchVariable is a collection, operate on the selector to specify which elements in the collection this rule applies to.
scrubbingRuleEntryState	Defines the state of a log scrubbing rule. Default value is enabled.
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response
IdentityType	The type of identity that creates/modifies resources
ManagedServiceIdentity	Managed service identity (system assigned and/or user assigned identities)
ManagedServiceIdentityType	Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).
Profile	A profile is a logical grouping of endpoints that share the same settings.
ProfileLogScrubbing	Defines rules that scrub sensitive fields in the Azure Front Door profile logs.
ProfileProvisioningState	Provisioning status of the profile.
ProfileResourceState	Resource status of the profile.
ProfileScrubbingRules	Defines the contents of the log scrubbing rules.
ProfileScrubbingState	State of the log scrubbing config. Default value is Enabled.
scrubbingRuleEntryMatchVariable	The variable to be scrubbed from the logs.
Sku	Standard_Verizon = The SKU name for a Standard Verizon CDN profile. Premium_Verizon = The SKU name for a Premium Verizon CDN profile. Custom_Verizon = The SKU name for a Custom Verizon CDN profile. Standard_Akamai = The SKU name for an Akamai CDN profile. Standard_ChinaCdn = The SKU name for a China CDN profile for VOD, Web and download scenarios using GB based billing model. Standard_Microsoft = The SKU name for a Standard Microsoft CDN profile. Standard_AzureFrontDoor = The SKU name for an Azure Front Door Standard profile. Premium_AzureFrontDoor = The SKU name for an Azure Front Door Premium profile. Standard_955BandWidth_ChinaCdn = The SKU name for a China CDN profile for VOD, Web and download scenarios using 95-5 peak bandwidth billing model. Standard_AvgBandWidth_ChinaCdn = The SKU name for a China CDN profile for VOD, Web and download scenarios using monthly average peak bandwidth billing model. StandardPlus_ChinaCdn = The SKU name for a China CDN profile for live-streaming using GB based billing model. StandardPlus_955BandWidth_ChinaCdn = The SKU name for a China CDN live-streaming profile using 95-5 peak bandwidth billing model. StandardPlus_AvgBandWidth_ChinaCdn = The SKU name for a China CDN live-streaming profile using monthly average peak bandwidth billing model.
SkuName	Name of the pricing tier.
SystemData	Read only system data
UserAssignedIdentity	User assigned identity properties

scrubbingRuleEntryMatchOperator

When matchVariable is a collection, operate on the selector to specify which elements in the collection this rule applies to.

Name	Type	Description
EqualsAny	string

scrubbingRuleEntryState

Defines the state of a log scrubbing rule. Default value is enabled.

Name	Type	Description
Disabled	string
Enabled	string

ErrorAdditionalInfo

The resource management error additional info.

Name	Type	Description
info	object	The additional info.
type	string	The additional info type.

ErrorDetail

The error detail.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	The error additional info.
code	string	The error code.
details	ErrorDetail[]	The error details.
message	string	The error message.
target	string	The error target.

ErrorResponse

Error response

Name	Type	Description
error	ErrorDetail	The error object.

IdentityType

The type of identity that creates/modifies resources

Name	Type	Description
application	string
key	string
managedIdentity	string
user	string

ManagedServiceIdentity

Managed service identity (system assigned and/or user assigned identities)

Name	Type	Description
principalId	string	The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.
tenantId	string	The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.
type	ManagedServiceIdentityType	Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).
userAssignedIdentities	<string,  UserAssignedIdentity>	User-Assigned Identities The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests.

ManagedServiceIdentityType

Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).

Name	Type	Description
None	string
SystemAssigned	string
SystemAssigned, UserAssigned	string
UserAssigned	string

Profile

A profile is a logical grouping of endpoints that share the same settings.

Name	Type	Description
id	string	Resource ID.
identity	ManagedServiceIdentity	Managed service identity (system assigned and/or user assigned identities).
kind	string	Kind of the profile. Used by portal to differentiate traditional CDN profile and new AFD profile.
location	string	Resource location.
name	string	Resource name.
properties.extendedProperties	object	Key-Value pair representing additional properties for profiles.
properties.frontDoorId	string	The Id of the frontdoor.
properties.logScrubbing	ProfileLogScrubbing	Defines rules that scrub sensitive fields in the Azure Front Door profile logs.
properties.originResponseTimeoutSeconds	integer	Send and receive timeout on forwarding request to the origin. When timeout is reached, the request fails and returns.
properties.provisioningState	ProfileProvisioningState	Provisioning status of the profile.
properties.resourceState	ProfileResourceState	Resource status of the profile.
sku	Sku	The pricing tier (defines Azure Front Door Standard or Premium or a CDN provider, feature list and rate) of the profile.
systemData	SystemData	Read only system data
tags	object	Resource tags.
type	string	Resource type.

ProfileLogScrubbing

Defines rules that scrub sensitive fields in the Azure Front Door profile logs.

Name	Type	Description
scrubbingRules	ProfileScrubbingRules[]	List of log scrubbing rules applied to the Azure Front Door profile logs.
state	ProfileScrubbingState	State of the log scrubbing config. Default value is Enabled.

ProfileProvisioningState

Provisioning status of the profile.

Name	Type	Description
Creating	string
Deleting	string
Failed	string
Succeeded	string
Updating	string

ProfileResourceState

Resource status of the profile.

Name	Type	Description
AbortingMigration	string
Active	string
CommittingMigration	string
Creating	string
Deleting	string
Disabled	string
Migrated	string
Migrating	string
PendingMigrationCommit	string

ProfileScrubbingRules

Defines the contents of the log scrubbing rules.

Name	Type	Description
matchVariable	scrubbingRuleEntryMatchVariable	The variable to be scrubbed from the logs.
selector	string	When matchVariable is a collection, operator used to specify which elements in the collection this rule applies to.
selectorMatchOperator	scrubbingRuleEntryMatchOperator	When matchVariable is a collection, operate on the selector to specify which elements in the collection this rule applies to.
state	scrubbingRuleEntryState	Defines the state of a log scrubbing rule. Default value is enabled.

ProfileScrubbingState

State of the log scrubbing config. Default value is Enabled.

Name	Type	Description
Disabled	string
Enabled	string

scrubbingRuleEntryMatchVariable

The variable to be scrubbed from the logs.

Name	Type	Description
QueryStringArgNames	string
RequestIPAddress	string
RequestUri	string

Sku

Standard_Verizon = The SKU name for a Standard Verizon CDN profile. Premium_Verizon = The SKU name for a Premium Verizon CDN profile. Custom_Verizon = The SKU name for a Custom Verizon CDN profile. Standard_Akamai = The SKU name for an Akamai CDN profile. Standard_ChinaCdn = The SKU name for a China CDN profile for VOD, Web and download scenarios using GB based billing model. Standard_Microsoft = The SKU name for a Standard Microsoft CDN profile. Standard_AzureFrontDoor = The SKU name for an Azure Front Door Standard profile. Premium_AzureFrontDoor = The SKU name for an Azure Front Door Premium profile. Standard_955BandWidth_ChinaCdn = The SKU name for a China CDN profile for VOD, Web and download scenarios using 95-5 peak bandwidth billing model. Standard_AvgBandWidth_ChinaCdn = The SKU name for a China CDN profile for VOD, Web and download scenarios using monthly average peak bandwidth billing model. StandardPlus_ChinaCdn = The SKU name for a China CDN profile for live-streaming using GB based billing model. StandardPlus_955BandWidth_ChinaCdn = The SKU name for a China CDN live-streaming profile using 95-5 peak bandwidth billing model. StandardPlus_AvgBandWidth_ChinaCdn = The SKU name for a China CDN live-streaming profile using monthly average peak bandwidth billing model.

Name	Type	Description
name	SkuName	Name of the pricing tier.

SkuName

Name of the pricing tier.

Name	Type	Description
Custom_Verizon	string
Premium_AzureFrontDoor	string
Premium_Verizon	string
StandardPlus_955BandWidth_ChinaCdn	string
StandardPlus_AvgBandWidth_ChinaCdn	string
StandardPlus_ChinaCdn	string
Standard_955BandWidth_ChinaCdn	string
Standard_Akamai	string
Standard_AvgBandWidth_ChinaCdn	string
Standard_AzureFrontDoor	string
Standard_ChinaCdn	string
Standard_Microsoft	string
Standard_Verizon	string

SystemData

Read only system data

Name	Type	Description
createdAt	string	The timestamp of resource creation (UTC)
createdBy	string	An identifier for the identity that created the resource
createdByType	IdentityType	The type of identity that created the resource
lastModifiedAt	string	The timestamp of resource last modification (UTC)
lastModifiedBy	string	An identifier for the identity that last modified the resource
lastModifiedByType	IdentityType	The type of identity that last modified the resource

UserAssignedIdentity

User assigned identity properties

Name	Type	Description
clientId	string	The client ID of the assigned identity.
principalId	string	The principal ID of the assigned identity.