Api Management Service - Get

Layanan:

API Management

Versi API:

2024-05-01

Mendapatkan deskripsi sumber daya layanan API Management.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}?api-version=2024-05-01

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nama grup sumber daya. Nama ini tidak peka huruf besar/kecil.
serviceName	path	True	string minLength: 1 maxLength: 50 pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$	Nama layanan API Management.
subscriptionId	path	True	string (uuid)	ID langganan target. Nilainya harus UUID.
api-version	query	True	string minLength: 1	Versi API yang akan digunakan untuk operasi ini.

Respons

Nama	Jenis	Deskripsi
200 OK	ApiManagementServiceResource	Berhasil mendapatkan Sumber Daya Layanan API Management.
Other Status Codes	ErrorResponse	Respons kesalahan yang menjelaskan mengapa operasi gagal.

Keamanan

azure_auth

Alur OAuth2 Azure Active Directory.

Jenis: oauth2
Alur: implicit
URL Otorisasi: https://login.microsoftonline.com/common/oauth2/authorize

Cakupan

Nama	Deskripsi
user_impersonation	meniru akun pengguna Anda

Contoh

ApiManagementServiceGetMultiRegionInternalVnet

ApiManagementServiceGetService

ApiManagementServiceGetServiceHavingMsi

ApiManagementServiceGetMultiRegionInternalVnet

Permintaan sampel

HTTP

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1?api-version=2024-05-01

Java

/**
 * Samples for ApiManagementService GetByResourceGroup.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2024-05-01/examples/
     * ApiManagementServiceGetMultiRegionInternalVnet.json
     */
    /**
     * Sample code: ApiManagementServiceGetMultiRegionInternalVnet.
     * 
     * @param manager Entry point to ApiManagementManager.
     */
    public static void apiManagementServiceGetMultiRegionInternalVnet(
        com.azure.resourcemanager.apimanagement.ApiManagementManager manager) {
        manager.apiManagementServices().getByResourceGroupWithResponse("rg1", "apimService1",
            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_service_get_multi_region_internal_vnet.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="00000000-0000-0000-0000-000000000000",
    )

    response = client.api_management_service.get(
        resource_group_name="rg1",
        service_name="apimService1",
    )
    print(response)


# x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2024-05-01/examples/ApiManagementServiceGetMultiRegionInternalVnet.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/v3"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/e436160e64c0f8d7fb20d662be2712f71f0a7ef5/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2024-05-01/examples/ApiManagementServiceGetMultiRegionInternalVnet.json
func ExampleServiceClient_Get_apiManagementServiceGetMultiRegionInternalVnet() {
	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.NewServiceClient().Get(ctx, "rg1", "apimService1", 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.ServiceResource = armapimanagement.ServiceResource{
	// 	Name: to.Ptr("apimservice1"),
	// 	Type: to.Ptr("Microsoft.ApiManagement/service"),
	// 	ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimservice1"),
	// 	Tags: map[string]*string{
	// 	},
	// 	Etag: to.Ptr("AAAAAADqC0c="),
	// 	Location: to.Ptr("West US"),
	// 	Properties: &armapimanagement.ServiceProperties{
	// 		AdditionalLocations: []*armapimanagement.AdditionalLocation{
	// 			{
	// 				DisableGateway: to.Ptr(false),
	// 				GatewayRegionalURL: to.Ptr("https://apimservice1-westus2-01.regional.azure-api.net"),
	// 				Location: to.Ptr("West US 2"),
	// 				PrivateIPAddresses: []*string{
	// 					to.Ptr("10.0.X.6")},
	// 					PublicIPAddresses: []*string{
	// 						to.Ptr("40.XXX.79.187")},
	// 						SKU: &armapimanagement.ServiceSKUProperties{
	// 							Name: to.Ptr(armapimanagement.SKUTypePremium),
	// 							Capacity: to.Ptr[int32](1),
	// 						},
	// 						VirtualNetworkConfiguration: &armapimanagement.VirtualNetworkConfiguration{
	// 							SubnetResourceID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/APIMVNet/subnets/apim-internal-sub"),
	// 						},
	// 				}},
	// 				APIVersionConstraint: &armapimanagement.APIVersionConstraint{
	// 				},
	// 				CreatedAtUTC: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2019-12-02T01:42:09.126Z"); return t}()),
	// 				CustomProperties: map[string]*string{
	// 					"Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Ssl30": to.Ptr("False"),
	// 					"Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10": to.Ptr("True"),
	// 					"Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11": to.Ptr("True"),
	// 					"Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168": to.Ptr("True"),
	// 					"Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Ssl30": to.Ptr("False"),
	// 					"Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10": to.Ptr("True"),
	// 					"Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11": to.Ptr("True"),
	// 				},
	// 				DeveloperPortalURL: to.Ptr("https://apimService1.developer.azure-api.net"),
	// 				DisableGateway: to.Ptr(false),
	// 				GatewayRegionalURL: to.Ptr("https://apimservice1-westus-01.regional.azure-api.net"),
	// 				GatewayURL: to.Ptr("https://apimservice1.azure-api.net"),
	// 				HostnameConfigurations: []*armapimanagement.HostnameConfiguration{
	// 					{
	// 						Type: to.Ptr(armapimanagement.HostnameTypeProxy),
	// 						CertificateSource: to.Ptr(armapimanagement.CertificateSourceBuiltIn),
	// 						DefaultSSLBinding: to.Ptr(false),
	// 						HostName: to.Ptr("apimService1.azure-api.net"),
	// 						NegotiateClientCertificate: to.Ptr(false),
	// 					},
	// 					{
	// 						Type: to.Ptr(armapimanagement.HostnameTypeProxy),
	// 						Certificate: &armapimanagement.CertificateInformation{
	// 							Expiry: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2019-08-16T16:51:34.000Z"); return t}()),
	// 							Subject: to.Ptr("CN=*.preview.net"),
	// 							Thumbprint: to.Ptr("B4330123DBAXXXXXXXXX1F35E84493476"),
	// 						},
	// 						CertificateSource: to.Ptr(armapimanagement.CertificateSourceCustom),
	// 						DefaultSSLBinding: to.Ptr(true),
	// 						HostName: to.Ptr("apimgatewaytest.preview.net"),
	// 						NegotiateClientCertificate: to.Ptr(false),
	// 				}},
	// 				ManagementAPIURL: to.Ptr("https://apimservice1.management.azure-api.net"),
	// 				NotificationSenderEmail: to.Ptr("apimgmt-noreply@mail.windowsazure.com"),
	// 				PortalURL: to.Ptr("https://apimservice1.portal.azure-api.net"),
	// 				PrivateIPAddresses: []*string{
	// 					to.Ptr("172.XX.0.5")},
	// 					ProvisioningState: to.Ptr("Succeeded"),
	// 					PublicIPAddresses: []*string{
	// 						to.Ptr("137.XXX.11.74")},
	// 						ScmURL: to.Ptr("https://apimservice1.scm.azure-api.net"),
	// 						TargetProvisioningState: to.Ptr(""),
	// 						VirtualNetworkConfiguration: &armapimanagement.VirtualNetworkConfiguration{
	// 							SubnetResourceID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/apim-appGateway-vnet/subnets/apim-subnet"),
	// 						},
	// 						VirtualNetworkType: to.Ptr(armapimanagement.VirtualNetworkTypeInternal),
	// 						PublisherEmail: to.Ptr("abcs@contoso.com"),
	// 						PublisherName: to.Ptr("contoso publisher"),
	// 					},
	// 					SKU: &armapimanagement.ServiceSKUProperties{
	// 						Name: to.Ptr(armapimanagement.SKUTypePremium),
	// 						Capacity: to.Ptr[int32](1),
	// 					},
	// 				}
}

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");
require("dotenv/config");

/**
 * This sample demonstrates how to Gets an API Management service resource description.
 *
 * @summary Gets an API Management service resource description.
 * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2024-05-01/examples/ApiManagementServiceGetMultiRegionInternalVnet.json
 */
async function apiManagementServiceGetMultiRegionInternalVnet() {
  const subscriptionId =
    process.env["APIMANAGEMENT_SUBSCRIPTION_ID"] || "00000000-0000-0000-0000-000000000000";
  const resourceGroupName = process.env["APIMANAGEMENT_RESOURCE_GROUP"] || "rg1";
  const serviceName = "apimService1";
  const credential = new DefaultAzureCredential();
  const client = new ApiManagementClient(credential, subscriptionId);
  const result = await client.apiManagementService.get(resourceGroupName, serviceName);
  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 System.Xml;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.ApiManagement.Models;
using Azure.ResourceManager.ApiManagement;

// Generated from example definition: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2024-05-01/examples/ApiManagementServiceGetMultiRegionInternalVnet.json
// this example is just showing the usage of "ApiManagementService_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 ApiManagementServiceResource created on azure
// for more information of creating ApiManagementServiceResource, please refer to the document of ApiManagementServiceResource
string subscriptionId = "00000000-0000-0000-0000-000000000000";
string resourceGroupName = "rg1";
string serviceName = "apimService1";
ResourceIdentifier apiManagementServiceResourceId = ApiManagementServiceResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, serviceName);
ApiManagementServiceResource apiManagementService = client.GetApiManagementServiceResource(apiManagementServiceResourceId);

// invoke the operation
ApiManagementServiceResource result = await apiManagementService.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
ApiManagementServiceData 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

Respon sampel

Kode status:

200

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimservice1",
  "name": "apimservice1",
  "type": "Microsoft.ApiManagement/service",
  "tags": {},
  "location": "West US",
  "etag": "AAAAAADqC0c=",
  "properties": {
    "publisherEmail": "abcs@contoso.com",
    "publisherName": "contoso publisher",
    "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com",
    "provisioningState": "Succeeded",
    "targetProvisioningState": "",
    "createdAtUtc": "2019-12-02T01:42:09.1268424Z",
    "gatewayUrl": "https://apimservice1.azure-api.net",
    "gatewayRegionalUrl": "https://apimservice1-westus-01.regional.azure-api.net",
    "portalUrl": "https://apimservice1.portal.azure-api.net",
    "developerPortalUrl": "https://apimService1.developer.azure-api.net",
    "managementApiUrl": "https://apimservice1.management.azure-api.net",
    "scmUrl": "https://apimservice1.scm.azure-api.net",
    "hostnameConfigurations": [
      {
        "type": "Proxy",
        "hostName": "apimService1.azure-api.net",
        "negotiateClientCertificate": false,
        "defaultSslBinding": false,
        "certificateSource": "BuiltIn"
      },
      {
        "type": "Proxy",
        "hostName": "apimgatewaytest.preview.net",
        "negotiateClientCertificate": false,
        "certificate": {
          "expiry": "2019-08-16T16:51:34+00:00",
          "thumbprint": "B4330123DBAXXXXXXXXX1F35E84493476",
          "subject": "CN=*.preview.net"
        },
        "defaultSslBinding": true,
        "certificateSource": "Custom"
      }
    ],
    "publicIPAddresses": [
      "137.XXX.11.74"
    ],
    "privateIPAddresses": [
      "172.XX.0.5"
    ],
    "additionalLocations": [
      {
        "location": "West US 2",
        "sku": {
          "name": "Premium",
          "capacity": 1
        },
        "publicIPAddresses": [
          "40.XXX.79.187"
        ],
        "privateIPAddresses": [
          "10.0.X.6"
        ],
        "virtualNetworkConfiguration": {
          "subnetResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/APIMVNet/subnets/apim-internal-sub"
        },
        "gatewayRegionalUrl": "https://apimservice1-westus2-01.regional.azure-api.net",
        "disableGateway": false
      }
    ],
    "virtualNetworkConfiguration": {
      "subnetResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/apim-appGateway-vnet/subnets/apim-subnet"
    },
    "customProperties": {
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10": "True",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11": "True",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Ssl30": "False",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168": "True",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10": "True",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11": "True",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Ssl30": "False"
    },
    "virtualNetworkType": "Internal",
    "disableGateway": false,
    "apiVersionConstraint": {}
  },
  "sku": {
    "name": "Premium",
    "capacity": 1
  }
}

ApiManagementServiceGetService

Permintaan sampel

HTTP

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1?api-version=2024-05-01

Java

/**
 * Samples for ApiManagementService GetByResourceGroup.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2024-05-01/examples/
     * ApiManagementServiceGetService.json
     */
    /**
     * Sample code: ApiManagementServiceGetService.
     * 
     * @param manager Entry point to ApiManagementManager.
     */
    public static void
        apiManagementServiceGetService(com.azure.resourcemanager.apimanagement.ApiManagementManager manager) {
        manager.apiManagementServices().getByResourceGroupWithResponse("rg1", "apimService1",
            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_service_get_service.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="00000000-0000-0000-0000-000000000000",
    )

    response = client.api_management_service.get(
        resource_group_name="rg1",
        service_name="apimService1",
    )
    print(response)


# x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2024-05-01/examples/ApiManagementServiceGetService.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/v3"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/e436160e64c0f8d7fb20d662be2712f71f0a7ef5/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2024-05-01/examples/ApiManagementServiceGetService.json
func ExampleServiceClient_Get_apiManagementServiceGetService() {
	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.NewServiceClient().Get(ctx, "rg1", "apimService1", 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.ServiceResource = armapimanagement.ServiceResource{
	// 	Name: to.Ptr("OGF-Z3-06162021-Premium"),
	// 	Type: to.Ptr("Microsoft.ApiManagement/service"),
	// 	ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/OGF-Z3-06162021-Premium"),
	// 	Tags: map[string]*string{
	// 		"ReleaseName": to.Ptr("Z3"),
	// 		"owner": to.Ptr("v-aswmoh"),
	// 	},
	// 	Etag: to.Ptr("AAAAAAAWN/4="),
	// 	Identity: &armapimanagement.ServiceIdentity{
	// 		Type: to.Ptr(armapimanagement.ApimIdentityTypeSystemAssignedUserAssigned),
	// 		PrincipalID: to.Ptr("306205e7-b21a-41bf-92e2-3e28af30041e"),
	// 		TenantID: to.Ptr("f686d426-8d16-42db-81b7-ab578e110ccd"),
	// 		UserAssignedIdentities: map[string]*armapimanagement.UserIdentityProperties{
	// 			"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/ogf-identity": &armapimanagement.UserIdentityProperties{
	// 				ClientID: to.Ptr("8d9791f2-0cdf-41f4-9e66-cdc39b496789"),
	// 				PrincipalID: to.Ptr("713784d2-ee37-412a-95f0-3768f397f82d"),
	// 			},
	// 		},
	// 	},
	// 	Location: to.Ptr("East US"),
	// 	Properties: &armapimanagement.ServiceProperties{
	// 		AdditionalLocations: []*armapimanagement.AdditionalLocation{
	// 			{
	// 				DisableGateway: to.Ptr(false),
	// 				GatewayRegionalURL: to.Ptr("https://ogf-z3-06162021-premium-eastus2-01.regional.azure-api.net"),
	// 				Location: to.Ptr("East US 2"),
	// 				PlatformVersion: to.Ptr(armapimanagement.PlatformVersionStv2),
	// 				PublicIPAddresses: []*string{
	// 					to.Ptr("40.70.24.106")},
	// 					SKU: &armapimanagement.ServiceSKUProperties{
	// 						Name: to.Ptr(armapimanagement.SKUTypePremium),
	// 						Capacity: to.Ptr[int32](1),
	// 					},
	// 					Zones: []*string{
	// 					},
	// 			}},
	// 			APIVersionConstraint: &armapimanagement.APIVersionConstraint{
	// 				MinAPIVersion: to.Ptr("2019-12-01"),
	// 			},
	// 			Certificates: []*armapimanagement.CertificateConfiguration{
	// 			},
	// 			CreatedAtUTC: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-06-16T09:40:00.945Z"); return t}()),
	// 			CustomProperties: map[string]*string{
	// 				"Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2": to.Ptr("false"),
	// 				"Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Ssl30": to.Ptr("false"),
	// 				"Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10": to.Ptr("false"),
	// 				"Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11": to.Ptr("false"),
	// 				"Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168": to.Ptr("false"),
	// 				"Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Ssl30": to.Ptr("false"),
	// 				"Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10": to.Ptr("false"),
	// 				"Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11": to.Ptr("false"),
	// 			},
	// 			DeveloperPortalURL: to.Ptr("https://ogf-z3-06162021-premium.developer.azure-api.net"),
	// 			DisableGateway: to.Ptr(false),
	// 			GatewayRegionalURL: to.Ptr("https://ogf-z3-06162021-premium-eastus-01.regional.azure-api.net"),
	// 			GatewayURL: to.Ptr("https://ogf-z3-06162021-premium.azure-api.net"),
	// 			HostnameConfigurations: []*armapimanagement.HostnameConfiguration{
	// 				{
	// 					Type: to.Ptr(armapimanagement.HostnameTypeProxy),
	// 					CertificateSource: to.Ptr(armapimanagement.CertificateSourceBuiltIn),
	// 					DefaultSSLBinding: to.Ptr(false),
	// 					HostName: to.Ptr("ogf-z3-06162021-premium.azure-api.net"),
	// 					NegotiateClientCertificate: to.Ptr(false),
	// 				},
	// 				{
	// 					Type: to.Ptr(armapimanagement.HostnameTypeProxy),
	// 					Certificate: &armapimanagement.CertificateInformation{
	// 						Expiry: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-01-08T22:32:32.000Z"); return t}()),
	// 						Subject: to.Ptr("CN=*.current.int-azure-api.net, O=Microsoft Corporation, L=Redmond, S=WA, C=US"),
	// 						Thumbprint: to.Ptr("BA0C286XXXXXXXX58A4A507E3DBD51"),
	// 					},
	// 					CertificateSource: to.Ptr(armapimanagement.CertificateSourceCustom),
	// 					DefaultSSLBinding: to.Ptr(true),
	// 					HostName: to.Ptr("gateway.current.int-azure-api.net"),
	// 					KeyVaultID: to.Ptr("https://ogf-testing.vault.azure.net/secrets/current-ssl"),
	// 					NegotiateClientCertificate: to.Ptr(true),
	// 				},
	// 				{
	// 					Type: to.Ptr(armapimanagement.HostnameTypeDeveloperPortal),
	// 					Certificate: &armapimanagement.CertificateInformation{
	// 						Expiry: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-01-08T22:32:32.000Z"); return t}()),
	// 						Subject: to.Ptr("CN=*.current.int-azure-api.net, O=Microsoft Corporation, L=Redmond, S=WA, C=US"),
	// 						Thumbprint: to.Ptr("BA0C286XXXXXXXX58A4A507E3DBD51"),
	// 					},
	// 					CertificateSource: to.Ptr(armapimanagement.CertificateSourceCustom),
	// 					DefaultSSLBinding: to.Ptr(false),
	// 					HostName: to.Ptr("developer.current.int-azure-api.net"),
	// 					KeyVaultID: to.Ptr("https://ogf-testing.vault.azure.net/secrets/current-ssl"),
	// 					NegotiateClientCertificate: to.Ptr(false),
	// 				},
	// 				{
	// 					Type: to.Ptr(armapimanagement.HostnameTypeManagement),
	// 					Certificate: &armapimanagement.CertificateInformation{
	// 						Expiry: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-01-08T22:32:32.000Z"); return t}()),
	// 						Subject: to.Ptr("CN=*.current.int-azure-api.net, O=Microsoft Corporation, L=Redmond, S=WA, C=US"),
	// 						Thumbprint: to.Ptr("BA0C286XXXXXXXX58A4A507E3DBD51"),
	// 					},
	// 					CertificateSource: to.Ptr(armapimanagement.CertificateSourceCustom),
	// 					DefaultSSLBinding: to.Ptr(false),
	// 					HostName: to.Ptr("mgmt.current.int-azure-api.net"),
	// 					KeyVaultID: to.Ptr("https://ogf-testing.vault.azure.net/secrets/current-ssl"),
	// 					NegotiateClientCertificate: to.Ptr(false),
	// 				},
	// 				{
	// 					Type: to.Ptr(armapimanagement.HostnameTypeConfigurationAPI),
	// 					Certificate: &armapimanagement.CertificateInformation{
	// 						Expiry: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-01-08T22:32:32.000Z"); return t}()),
	// 						Subject: to.Ptr("CN=*.current.int-azure-api.net, O=Microsoft Corporation, L=Redmond, S=WA, C=US"),
	// 						Thumbprint: to.Ptr("BA0C286XXXXXXXX58A4A507E3DBD51"),
	// 					},
	// 					CertificateSource: to.Ptr(armapimanagement.CertificateSourceCustom),
	// 					DefaultSSLBinding: to.Ptr(false),
	// 					HostName: to.Ptr("configuration-api.current.int-azure-api.net"),
	// 					KeyVaultID: to.Ptr("https://ogf-testing.vault.azure.net/secrets/current-ssl"),
	// 					NegotiateClientCertificate: to.Ptr(false),
	// 			}},
	// 			ManagementAPIURL: to.Ptr("https://ogf-z3-06162021-premium.management.azure-api.net"),
	// 			NotificationSenderEmail: to.Ptr("apimgmt-noreply@mail.windowsazure.com"),
	// 			PlatformVersion: to.Ptr(armapimanagement.PlatformVersionStv2),
	// 			PortalURL: to.Ptr("https://ogf-z3-06162021-premium.portal.azure-api.net"),
	// 			PrivateEndpointConnections: []*armapimanagement.RemotePrivateEndpointConnectionWrapper{
	// 				{
	// 					Name: to.Ptr("privateEndpointProxyName"),
	// 					Type: to.Ptr("Microsoft.ApiManagement/service/privateEndpointConnections"),
	// 					ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/privateEndpointConnections/privateEndpointProxyName"),
	// 					Properties: &armapimanagement.PrivateEndpointConnectionWrapperProperties{
	// 						GroupIDs: []*string{
	// 							to.Ptr("Gateway")},
	// 							PrivateEndpoint: &armapimanagement.ArmIDWrapper{
	// 								ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/privateEndpoints/privateEndpointName"),
	// 							},
	// 							PrivateLinkServiceConnectionState: &armapimanagement.PrivateLinkServiceConnectionState{
	// 								Description: to.Ptr("Please approve my request, thanks"),
	// 								ActionsRequired: to.Ptr("None"),
	// 								Status: to.Ptr(armapimanagement.PrivateEndpointServiceConnectionStatusPending),
	// 							},
	// 							ProvisioningState: to.Ptr("Succeeded"),
	// 						},
	// 				}},
	// 				ProvisioningState: to.Ptr("Succeeded"),
	// 				PublicIPAddresses: []*string{
	// 					to.Ptr("13.92.130.49")},
	// 					PublicNetworkAccess: to.Ptr(armapimanagement.PublicNetworkAccessEnabled),
	// 					ScmURL: to.Ptr("https://ogf-z3-06162021-premium.scm.azure-api.net"),
	// 					TargetProvisioningState: to.Ptr(""),
	// 					VirtualNetworkType: to.Ptr(armapimanagement.VirtualNetworkTypeNone),
	// 					PublisherEmail: to.Ptr("string"),
	// 					PublisherName: to.Ptr("Test Premium"),
	// 				},
	// 				SKU: &armapimanagement.ServiceSKUProperties{
	// 					Name: to.Ptr(armapimanagement.SKUTypePremium),
	// 					Capacity: to.Ptr[int32](1),
	// 				},
	// 				SystemData: &armapimanagement.SystemData{
	// 					CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-06-16T09:40:00.710Z"); return t}()),
	// 					CreatedBy: to.Ptr("string"),
	// 					CreatedByType: to.Ptr(armapimanagement.CreatedByTypeUser),
	// 					LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-06-20T06:33:09.615Z"); return t}()),
	// 					LastModifiedBy: to.Ptr("foo@contoso.com"),
	// 					LastModifiedByType: to.Ptr(armapimanagement.CreatedByTypeUser),
	// 				},
	// 			}
}

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");
require("dotenv/config");

/**
 * This sample demonstrates how to Gets an API Management service resource description.
 *
 * @summary Gets an API Management service resource description.
 * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2024-05-01/examples/ApiManagementServiceGetService.json
 */
async function apiManagementServiceGetService() {
  const subscriptionId =
    process.env["APIMANAGEMENT_SUBSCRIPTION_ID"] || "00000000-0000-0000-0000-000000000000";
  const resourceGroupName = process.env["APIMANAGEMENT_RESOURCE_GROUP"] || "rg1";
  const serviceName = "apimService1";
  const credential = new DefaultAzureCredential();
  const client = new ApiManagementClient(credential, subscriptionId);
  const result = await client.apiManagementService.get(resourceGroupName, serviceName);
  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 System.Xml;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.ApiManagement.Models;
using Azure.ResourceManager.ApiManagement;

// Generated from example definition: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2024-05-01/examples/ApiManagementServiceGetService.json
// this example is just showing the usage of "ApiManagementService_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 ApiManagementServiceResource created on azure
// for more information of creating ApiManagementServiceResource, please refer to the document of ApiManagementServiceResource
string subscriptionId = "00000000-0000-0000-0000-000000000000";
string resourceGroupName = "rg1";
string serviceName = "apimService1";
ResourceIdentifier apiManagementServiceResourceId = ApiManagementServiceResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, serviceName);
ApiManagementServiceResource apiManagementService = client.GetApiManagementServiceResource(apiManagementServiceResourceId);

// invoke the operation
ApiManagementServiceResource result = await apiManagementService.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
ApiManagementServiceData 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

Respon sampel

Kode status:

200

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/OGF-Z3-06162021-Premium",
  "name": "OGF-Z3-06162021-Premium",
  "type": "Microsoft.ApiManagement/service",
  "tags": {
    "owner": "v-aswmoh",
    "ReleaseName": "Z3"
  },
  "location": "East US",
  "etag": "AAAAAAAWN/4=",
  "properties": {
    "publisherEmail": "string",
    "publisherName": "Test Premium",
    "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com",
    "provisioningState": "Succeeded",
    "targetProvisioningState": "",
    "createdAtUtc": "2021-06-16T09:40:00.9453556Z",
    "gatewayUrl": "https://ogf-z3-06162021-premium.azure-api.net",
    "gatewayRegionalUrl": "https://ogf-z3-06162021-premium-eastus-01.regional.azure-api.net",
    "portalUrl": "https://ogf-z3-06162021-premium.portal.azure-api.net",
    "developerPortalUrl": "https://ogf-z3-06162021-premium.developer.azure-api.net",
    "managementApiUrl": "https://ogf-z3-06162021-premium.management.azure-api.net",
    "scmUrl": "https://ogf-z3-06162021-premium.scm.azure-api.net",
    "hostnameConfigurations": [
      {
        "type": "Proxy",
        "hostName": "ogf-z3-06162021-premium.azure-api.net",
        "negotiateClientCertificate": false,
        "defaultSslBinding": false,
        "certificateSource": "BuiltIn"
      },
      {
        "type": "Proxy",
        "hostName": "gateway.current.int-azure-api.net",
        "keyVaultId": "https://ogf-testing.vault.azure.net/secrets/current-ssl",
        "negotiateClientCertificate": true,
        "certificate": {
          "expiry": "2022-01-08T22:32:32+00:00",
          "thumbprint": "BA0C286XXXXXXXX58A4A507E3DBD51",
          "subject": "CN=*.current.int-azure-api.net, O=Microsoft Corporation, L=Redmond, S=WA, C=US"
        },
        "defaultSslBinding": true,
        "certificateSource": "Custom"
      },
      {
        "type": "DeveloperPortal",
        "hostName": "developer.current.int-azure-api.net",
        "keyVaultId": "https://ogf-testing.vault.azure.net/secrets/current-ssl",
        "negotiateClientCertificate": false,
        "certificate": {
          "expiry": "2022-01-08T22:32:32+00:00",
          "thumbprint": "BA0C286XXXXXXXX58A4A507E3DBD51",
          "subject": "CN=*.current.int-azure-api.net, O=Microsoft Corporation, L=Redmond, S=WA, C=US"
        },
        "defaultSslBinding": false,
        "certificateSource": "Custom"
      },
      {
        "type": "Management",
        "hostName": "mgmt.current.int-azure-api.net",
        "keyVaultId": "https://ogf-testing.vault.azure.net/secrets/current-ssl",
        "negotiateClientCertificate": false,
        "certificate": {
          "expiry": "2022-01-08T22:32:32+00:00",
          "thumbprint": "BA0C286XXXXXXXX58A4A507E3DBD51",
          "subject": "CN=*.current.int-azure-api.net, O=Microsoft Corporation, L=Redmond, S=WA, C=US"
        },
        "defaultSslBinding": false,
        "certificateSource": "Custom"
      },
      {
        "type": "ConfigurationApi",
        "hostName": "configuration-api.current.int-azure-api.net",
        "keyVaultId": "https://ogf-testing.vault.azure.net/secrets/current-ssl",
        "negotiateClientCertificate": false,
        "certificate": {
          "expiry": "2022-01-08T22:32:32+00:00",
          "thumbprint": "BA0C286XXXXXXXX58A4A507E3DBD51",
          "subject": "CN=*.current.int-azure-api.net, O=Microsoft Corporation, L=Redmond, S=WA, C=US"
        },
        "defaultSslBinding": false,
        "certificateSource": "Custom"
      }
    ],
    "publicIPAddresses": [
      "13.92.130.49"
    ],
    "additionalLocations": [
      {
        "location": "East US 2",
        "sku": {
          "name": "Premium",
          "capacity": 1
        },
        "zones": [],
        "publicIPAddresses": [
          "40.70.24.106"
        ],
        "gatewayRegionalUrl": "https://ogf-z3-06162021-premium-eastus2-01.regional.azure-api.net",
        "disableGateway": false,
        "platformVersion": "stv2"
      }
    ],
    "customProperties": {
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168": "false",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11": "false",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10": "false",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Ssl30": "false",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11": "false",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10": "false",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Ssl30": "false",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2": "false"
    },
    "virtualNetworkType": "None",
    "certificates": [],
    "disableGateway": false,
    "apiVersionConstraint": {
      "minApiVersion": "2019-12-01"
    },
    "publicNetworkAccess": "Enabled",
    "privateEndpointConnections": [
      {
        "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/privateEndpointConnections/privateEndpointProxyName",
        "type": "Microsoft.ApiManagement/service/privateEndpointConnections",
        "name": "privateEndpointProxyName",
        "properties": {
          "provisioningState": "Pending",
          "privateEndpoint": {
            "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/privateEndpoints/privateEndpointName"
          },
          "privateLinkServiceConnectionState": {
            "status": "Pending",
            "description": "Please approve my request, thanks",
            "actionsRequired": "None"
          },
          "groupIds": [
            "Gateway"
          ]
        }
      }
    ],
    "platformVersion": "stv2"
  },
  "sku": {
    "name": "Premium",
    "capacity": 1
  },
  "identity": {
    "type": "SystemAssigned, UserAssigned",
    "principalId": "306205e7-b21a-41bf-92e2-3e28af30041e",
    "tenantId": "f686d426-8d16-42db-81b7-ab578e110ccd",
    "userAssignedIdentities": {
      "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/ogf-identity": {
        "principalId": "713784d2-ee37-412a-95f0-3768f397f82d",
        "clientId": "8d9791f2-0cdf-41f4-9e66-cdc39b496789"
      }
    }
  },
  "systemData": {
    "createdBy": "string",
    "createdByType": "User",
    "createdAt": "2021-06-16T09:40:00.7106733Z",
    "lastModifiedBy": "foo@contoso.com",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2021-06-20T06:33:09.6159006Z"
  }
}

ApiManagementServiceGetServiceHavingMsi

Permintaan sampel

HTTP

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1?api-version=2024-05-01

Java

/**
 * Samples for ApiManagementService GetByResourceGroup.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2024-05-01/examples/
     * ApiManagementServiceGetServiceHavingMsi.json
     */
    /**
     * Sample code: ApiManagementServiceGetServiceHavingMsi.
     * 
     * @param manager Entry point to ApiManagementManager.
     */
    public static void
        apiManagementServiceGetServiceHavingMsi(com.azure.resourcemanager.apimanagement.ApiManagementManager manager) {
        manager.apiManagementServices().getByResourceGroupWithResponse("rg1", "apimService1",
            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_service_get_service_having_msi.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="00000000-0000-0000-0000-000000000000",
    )

    response = client.api_management_service.get(
        resource_group_name="rg1",
        service_name="apimService1",
    )
    print(response)


# x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2024-05-01/examples/ApiManagementServiceGetServiceHavingMsi.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/v3"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/e436160e64c0f8d7fb20d662be2712f71f0a7ef5/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2024-05-01/examples/ApiManagementServiceGetServiceHavingMsi.json
func ExampleServiceClient_Get_apiManagementServiceGetServiceHavingMsi() {
	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.NewServiceClient().Get(ctx, "rg1", "apimService1", 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.ServiceResource = armapimanagement.ServiceResource{
	// 	Name: to.Ptr("apimService1"),
	// 	Type: to.Ptr("Microsoft.ApiManagement/service"),
	// 	ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1"),
	// 	Tags: map[string]*string{
	// 	},
	// 	Etag: to.Ptr("AAAAAAAENfI="),
	// 	Identity: &armapimanagement.ServiceIdentity{
	// 		Type: to.Ptr(armapimanagement.ApimIdentityTypeSystemAssignedUserAssigned),
	// 		PrincipalID: to.Ptr("ca1d33f7-0000-42ec-0000-d526a1ee953a"),
	// 		TenantID: to.Ptr("72f988bf-0000-41af-0000-2d7cd011db47"),
	// 		UserAssignedIdentities: map[string]*armapimanagement.UserIdentityProperties{
	// 			"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/apimService1": &armapimanagement.UserIdentityProperties{
	// 				ClientID: to.Ptr("aaff9c7d-0000-4db2-0000-ab0e3e7806cf"),
	// 				PrincipalID: to.Ptr("95194df2-9208-0000-0000-a10d2af9b5a3"),
	// 			},
	// 		},
	// 	},
	// 	Location: to.Ptr("West Europe"),
	// 	Properties: &armapimanagement.ServiceProperties{
	// 		CreatedAtUTC: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2016-04-12T00:20:15.601Z"); return t}()),
	// 		CustomProperties: map[string]*string{
	// 			"Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2": to.Ptr("False"),
	// 			"Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Ssl30": to.Ptr("False"),
	// 			"Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10": to.Ptr("True"),
	// 			"Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11": to.Ptr("True"),
	// 			"Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168": to.Ptr("True"),
	// 			"Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Ssl30": to.Ptr("False"),
	// 			"Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10": to.Ptr("True"),
	// 			"Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11": to.Ptr("True"),
	// 		},
	// 		DeveloperPortalURL: to.Ptr("https://apimService1.developer.azure-api.net"),
	// 		DisableGateway: to.Ptr(false),
	// 		GatewayRegionalURL: to.Ptr("https://apimService1-westeurope-01.regional.azure-api.net"),
	// 		GatewayURL: to.Ptr("https://apimService1.azure-api.net"),
	// 		HostnameConfigurations: []*armapimanagement.HostnameConfiguration{
	// 			{
	// 				Type: to.Ptr(armapimanagement.HostnameTypeProxy),
	// 				CertificateSource: to.Ptr(armapimanagement.CertificateSourceBuiltIn),
	// 				DefaultSSLBinding: to.Ptr(false),
	// 				HostName: to.Ptr("apimService1.azure-api.net"),
	// 				NegotiateClientCertificate: to.Ptr(false),
	// 			},
	// 			{
	// 				Type: to.Ptr(armapimanagement.HostnameTypeProxy),
	// 				Certificate: &armapimanagement.CertificateInformation{
	// 					Expiry: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-12-18T11:11:47.000Z"); return t}()),
	// 					Subject: to.Ptr("CN=*.msitesting.net"),
	// 					Thumbprint: to.Ptr("9833D531D7A45XXXXXA85908BD3692E0BD3F"),
	// 				},
	// 				CertificateSource: to.Ptr(armapimanagement.CertificateSourceKeyVault),
	// 				DefaultSSLBinding: to.Ptr(true),
	// 				HostName: to.Ptr("proxy.msitesting.net"),
	// 				KeyVaultID: to.Ptr("https://samir-msi-keyvault.vault.azure.net/secrets/msicertificate"),
	// 				NegotiateClientCertificate: to.Ptr(false),
	// 		}},
	// 		ManagementAPIURL: to.Ptr("https://apimService1.management.azure-api.net"),
	// 		NotificationSenderEmail: to.Ptr("apimgmt-noreply@mail.windowsazure.com"),
	// 		PortalURL: to.Ptr("https://apimService1.portal.azure-api.net"),
	// 		ProvisioningState: to.Ptr("Succeeded"),
	// 		PublicIPAddresses: []*string{
	// 			to.Ptr("13.94.xxx.188")},
	// 			ScmURL: to.Ptr("https://apimService1.scm.azure-api.net"),
	// 			TargetProvisioningState: to.Ptr(""),
	// 			VirtualNetworkConfiguration: &armapimanagement.VirtualNetworkConfiguration{
	// 				SubnetResourceID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/dfVirtualNetwork/subnets/backendSubnet"),
	// 			},
	// 			VirtualNetworkType: to.Ptr(armapimanagement.VirtualNetworkTypeExternal),
	// 			PublisherEmail: to.Ptr("foo@contoso.com"),
	// 			PublisherName: to.Ptr("Contoso"),
	// 		},
	// 		SKU: &armapimanagement.ServiceSKUProperties{
	// 			Name: to.Ptr(armapimanagement.SKUTypePremium),
	// 			Capacity: to.Ptr[int32](1),
	// 		},
	// 	}
}

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");
require("dotenv/config");

/**
 * This sample demonstrates how to Gets an API Management service resource description.
 *
 * @summary Gets an API Management service resource description.
 * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2024-05-01/examples/ApiManagementServiceGetServiceHavingMsi.json
 */
async function apiManagementServiceGetServiceHavingMsi() {
  const subscriptionId =
    process.env["APIMANAGEMENT_SUBSCRIPTION_ID"] || "00000000-0000-0000-0000-000000000000";
  const resourceGroupName = process.env["APIMANAGEMENT_RESOURCE_GROUP"] || "rg1";
  const serviceName = "apimService1";
  const credential = new DefaultAzureCredential();
  const client = new ApiManagementClient(credential, subscriptionId);
  const result = await client.apiManagementService.get(resourceGroupName, serviceName);
  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 System.Xml;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.ApiManagement.Models;
using Azure.ResourceManager.ApiManagement;

// Generated from example definition: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2024-05-01/examples/ApiManagementServiceGetServiceHavingMsi.json
// this example is just showing the usage of "ApiManagementService_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 ApiManagementServiceResource created on azure
// for more information of creating ApiManagementServiceResource, please refer to the document of ApiManagementServiceResource
string subscriptionId = "00000000-0000-0000-0000-000000000000";
string resourceGroupName = "rg1";
string serviceName = "apimService1";
ResourceIdentifier apiManagementServiceResourceId = ApiManagementServiceResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, serviceName);
ApiManagementServiceResource apiManagementService = client.GetApiManagementServiceResource(apiManagementServiceResourceId);

// invoke the operation
ApiManagementServiceResource result = await apiManagementService.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
ApiManagementServiceData 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

Respon sampel

Kode status:

200

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1",
  "name": "apimService1",
  "type": "Microsoft.ApiManagement/service",
  "tags": {},
  "location": "West Europe",
  "etag": "AAAAAAAENfI=",
  "properties": {
    "publisherEmail": "foo@contoso.com",
    "publisherName": "Contoso",
    "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com",
    "provisioningState": "Succeeded",
    "targetProvisioningState": "",
    "createdAtUtc": "2016-04-12T00:20:15.6018952Z",
    "gatewayUrl": "https://apimService1.azure-api.net",
    "gatewayRegionalUrl": "https://apimService1-westeurope-01.regional.azure-api.net",
    "portalUrl": "https://apimService1.portal.azure-api.net",
    "developerPortalUrl": "https://apimService1.developer.azure-api.net",
    "managementApiUrl": "https://apimService1.management.azure-api.net",
    "scmUrl": "https://apimService1.scm.azure-api.net",
    "hostnameConfigurations": [
      {
        "type": "Proxy",
        "hostName": "apimService1.azure-api.net",
        "negotiateClientCertificate": false,
        "defaultSslBinding": false,
        "certificateSource": "BuiltIn"
      },
      {
        "type": "Proxy",
        "hostName": "proxy.msitesting.net",
        "keyVaultId": "https://samir-msi-keyvault.vault.azure.net/secrets/msicertificate",
        "negotiateClientCertificate": false,
        "certificate": {
          "expiry": "2020-12-18T11:11:47+00:00",
          "thumbprint": "9833D531D7A45XXXXXA85908BD3692E0BD3F",
          "subject": "CN=*.msitesting.net"
        },
        "defaultSslBinding": true,
        "certificateSource": "KeyVault"
      }
    ],
    "publicIPAddresses": [
      "13.94.xxx.188"
    ],
    "virtualNetworkConfiguration": {
      "subnetResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/dfVirtualNetwork/subnets/backendSubnet"
    },
    "customProperties": {
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10": "True",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11": "True",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Ssl30": "False",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168": "True",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10": "True",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11": "True",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Ssl30": "False",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2": "False"
    },
    "virtualNetworkType": "External",
    "disableGateway": false
  },
  "sku": {
    "name": "Premium",
    "capacity": 1
  },
  "identity": {
    "type": "SystemAssigned, UserAssigned",
    "principalId": "ca1d33f7-0000-42ec-0000-d526a1ee953a",
    "tenantId": "72f988bf-0000-41af-0000-2d7cd011db47",
    "userAssignedIdentities": {
      "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/apimService1": {
        "principalId": "95194df2-9208-0000-0000-a10d2af9b5a3",
        "clientId": "aaff9c7d-0000-4db2-0000-ab0e3e7806cf"
      }
    }
  }
}

Definisi

Nama	Deskripsi
AdditionalLocation	Deskripsi lokasi sumber daya API Management tambahan.
ApiManagementServiceIdentity	Properti identitas sumber daya layanan Api Management.
ApiManagementServiceResource	Satu sumber daya layanan API Management dalam Daftar atau Dapatkan respons.
ApiManagementServiceSkuProperties	Properti SKU sumber daya layanan API Management.
ApimIdentityType	Jenis identitas yang digunakan untuk sumber daya. Jenis 'SystemAssigned, UserAssigned' mencakup identitas yang dibuat secara implisit dan sekumpulan identitas yang ditetapkan pengguna. Jenis 'None' akan menghapus identitas apa pun dari layanan.
ApiVersionConstraint	Batasan versi Control Plane Apis untuk layanan API Management.
ArmIdWrapper	Pembungkus untuk id sumber daya ARM
CertificateConfiguration	Konfigurasi sertifikat yang terdiri dari perantara dan sertifikat akar yang tidak tepercaya.
CertificateInformation	Informasi sertifikat SSL.
CertificateSource	Sumber Sertifikat.
CertificateStatus	Status Sertifikat.
ConfigurationApi	Informasi mengenai API Konfigurasi layanan API Management.
createdByType	Jenis identitas yang membuat sumber daya.
developerPortalStatus	Status portal pengembang di layanan API Management ini.
ErrorAdditionalInfo	Info tambahan kesalahan manajemen sumber daya.
ErrorDetail	Detail kesalahan.
ErrorResponse	Respons kesalahan
HostnameConfiguration	Konfigurasi nama host kustom.
HostnameType	Jenis nama host.
LegacyApiState	Indikasi apakah API Konfigurasi warisan (v1) harus diekspos pada layanan API Management atau tidak. Nilai bersifat opsional tetapi harus 'Diaktifkan' atau 'Dinonaktifkan'. Jika 'Dinonaktifkan', API Konfigurasi warisan (v1) tidak akan tersedia untuk gateway yang dihost sendiri. Nilai defaultnya adalah 'Diaktifkan'
LegacyPortalStatus	Status portal warisan di layanan API Management.
NatGatewayState	Properti dapat digunakan untuk mengaktifkan NAT Gateway untuk layanan API Management ini.
PlatformVersion	Versi Platform Komputasi yang menjalankan layanan.
PrivateEndpointServiceConnectionStatus	Status koneksi titik akhir privat.
PrivateLinkServiceConnectionState	Kumpulan informasi tentang status koneksi antara konsumen layanan dan penyedia.
PublicNetworkAccess	Apakah akses titik akhir publik diizinkan atau tidak untuk layanan API Management ini. Nilai bersifat opsional tetapi jika diteruskan, harus 'Diaktifkan' atau 'Dinonaktifkan'. Jika 'Dinonaktifkan', titik akhir privat adalah metode akses eksklusif. Nilai defaultnya adalah 'Diaktifkan'
RemotePrivateEndpointConnectionWrapper	Sumber daya Koneksi Titik Akhir Privat Jarak Jauh.
SkuType	Nama Sku.
systemData	Metadata yang berkaitan dengan pembuatan dan modifikasi terakhir sumber daya.
UserIdentityProperties
VirtualNetworkConfiguration	Konfigurasi jaringan virtual tempat layanan API Management disebarkan.
VirtualNetworkType	Jenis VPN tempat layanan API Management perlu dikonfigurasi. Tidak Ada (Nilai Default) berarti layanan API Management bukan bagian dari Jaringan Virtual apa pun, Eksternal berarti penyebaran API Management disiapkan di dalam Jaringan Virtual yang memiliki Titik Akhir Yang Menghadap Internet, dan Internal berarti bahwa penyebaran API Management disiapkan di dalam Virtual Network yang hanya memiliki Titik Akhir Yang Menghadap Intranet.

AdditionalLocation

Objek

Deskripsi lokasi sumber daya API Management tambahan.

Nama	Jenis	Nilai default	Deskripsi
disableGateway	boolean	False	Properti hanya valid untuk layanan Api Management yang disebarkan di beberapa lokasi. Ini dapat digunakan untuk menonaktifkan gateway di lokasi tambahan ini.
gatewayRegionalUrl	string		URL gateway layanan API Management di Wilayah.
location	string		Nama lokasi wilayah tambahan di antara wilayah pusat Data Azure.
natGatewayState	NatGatewayState	Disabled	Properti dapat digunakan untuk mengaktifkan NAT Gateway untuk layanan API Management ini.
outboundPublicIPAddresses	string[]		Awalan alamat IPV4 publik keluar yang terkait dengan layanan yang disebarkan NAT Gateway. Hanya tersedia untuk SKU Premium pada platform stv2.
platformVersion	PlatformVersion		Versi Platform Komputasi yang menjalankan layanan.
privateIPAddresses	string[]		Alamat IP Privat Static Load Balanced dari layanan API Management yang disebarkan di Jaringan Virtual Internal di lokasi tambahan tertentu. Hanya tersedia untuk SKU Dasar, Standar, Premium, dan Terisolasi.
publicIPAddresses	string[]		Alamat IP Load Balanced Statis Publik dari layanan API Management di lokasi tambahan. Hanya tersedia untuk SKU Dasar, Standar, Premium, dan Terisolasi.
publicIpAddressId	string		Alamat IP berbasis IP V4 SKU Standar Publik yang akan dikaitkan dengan layanan yang disebarkan Virtual Network di lokasi tersebut. Hanya didukung untuk SKU Premium yang disebarkan di Virtual Network.
sku	ApiManagementServiceSkuProperties		Properti SKU dari layanan API Management.
virtualNetworkConfiguration	VirtualNetworkConfiguration		Konfigurasi jaringan virtual untuk lokasi tersebut.
zones	string[]		Daftar zona ketersediaan yang menunjukkan dari mana sumber daya perlu berasal.

ApiManagementServiceIdentity

Objek

Properti identitas sumber daya layanan Api Management.

Nama	Jenis	Deskripsi
principalId	string (uuid)	Id utama identitas.
tenantId	string (uuid)	Id penyewa klien identitas.
type	ApimIdentityType	Jenis identitas yang digunakan untuk sumber daya. Jenis 'SystemAssigned, UserAssigned' mencakup identitas yang dibuat secara implisit dan sekumpulan identitas yang ditetapkan pengguna. Jenis 'None' akan menghapus identitas apa pun dari layanan.
userAssignedIdentities	<string,  UserIdentityProperties>	Daftar identitas pengguna yang terkait dengan sumber daya. Referensi kunci kamus identitas pengguna akan menjadi id sumber daya ARM dalam formulir: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/ providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.

ApiManagementServiceResource

Objek

Satu sumber daya layanan API Management dalam Daftar atau Dapatkan respons.

Nama	Jenis	Nilai default	Deskripsi
etag	string		ETag sumber daya.
id	string		ID Sumber Daya.
identity	ApiManagementServiceIdentity		Identitas layanan terkelola dari layanan Api Management.
location	string		Lokasi sumber daya.
name	string		Nama sumber daya.
properties.additionalLocations	AdditionalLocation[]		Lokasi pusat data tambahan dari layanan API Management.
properties.apiVersionConstraint	ApiVersionConstraint		Batasan versi Control Plane Apis untuk layanan API Management.
properties.certificates	CertificateConfiguration[]		Daftar Sertifikat yang perlu diinstal di layanan API Management. Sertifikat maksimum yang didukung yang dapat diinstal adalah 10.
properties.configurationApi	ConfigurationApi		Konfigurasi API konfigurasi layanan API Management.
properties.createdAtUtc	string (date-time)		Tanggal pembuatan UTC layanan API Management. Tanggal sesuai dengan format berikut: yyyy-MM-ddTHH:mm:ssZ seperti yang ditentukan oleh standar ISO 8601.
properties.customProperties	object		Properti kustom layanan API Management. Pengaturan Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168 akan menonaktifkan cipher TLS_RSA_WITH_3DES_EDE_CBC_SHA untuk semua TLS(1.0, 1.1 dan 1.2). Pengaturan Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11 dapat digunakan untuk menonaktifkan hanya TLS 1.1. Pengaturan Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10 dapat digunakan untuk menonaktifkan TLS 1.0 pada layanan API Management. Pengaturan Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11 dapat digunakan untuk menonaktifkan hanya TLS 1.1 untuk komunikasi dengan backend. Pengaturan Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10 dapat digunakan untuk menonaktifkan TLS 1.0 untuk komunikasi dengan backend. Pengaturan Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2 dapat digunakan untuk mengaktifkan protokol HTTP2 pada layanan API Management. Tidak menentukan salah satu properti ini pada operasi PATCH akan mengatur ulang nilai properti yang dihilangkan ke defaultnya. Untuk semua pengaturan kecuali Http2, nilai default True jika layanan dibuat pada atau sebelum 1 April 2018 dan False sebaliknya. Nilai default pengaturan Http2 adalah False. Anda dapat menonaktifkan salah satu cipher berikut dengan menggunakan pengaturan Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.[cipher_name]: TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA, TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA, TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA, TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA, TLS_RSA_WITH_AES_128_GCM_SHA256, TLS_RSA_WITH_AES_256_CBC_SHA256, TLS_RSA_WITH_AES_128_CBC_SHA256, TLS_RSA_WITH_AES_256_CBC_SHA, TLS_RSA_WITH_AES_128_CBC_SHA. Misalnya, Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_128_CBC_SHA256:false. Nilai defaultnya adalah true untuk nilai tersebut. Catatan: Sandi berikut tidak dapat dinonaktifkan karena diperlukan oleh komponen platform internal: TLS_AES_256_GCM_SHA384,TLS_AES_128_GCM_SHA256,TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384,TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256,TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384,TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256, TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384,TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256,TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384,TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
properties.developerPortalStatus	developerPortalStatus	Enabled	Status portal pengembang di layanan API Management ini.
properties.developerPortalUrl	string		URL titik akhir Portal DEveloper dari layanan API Management.
properties.disableGateway	boolean	False	Properti hanya valid untuk layanan Api Management yang disebarkan di beberapa lokasi. Ini dapat digunakan untuk menonaktifkan gateway di wilayah master.
properties.enableClientCertificate	boolean	False	Properti hanya dimaksudkan untuk digunakan untuk Layanan SKU Konsumsi. Ini memberlakukan sertifikat klien untuk disajikan pada setiap permintaan ke gateway. Ini juga memungkinkan kemampuan untuk mengautentikasi sertifikat dalam kebijakan di gateway.
properties.gatewayRegionalUrl	string		URL Gateway layanan API Management di Wilayah Default.
properties.gatewayUrl	string		URL gateway layanan API Management.
properties.hostnameConfigurations	HostnameConfiguration[]		Konfigurasi nama host kustom layanan API Management.
properties.legacyPortalStatus	LegacyPortalStatus	Enabled	Status portal warisan di layanan API Management.
properties.managementApiUrl	string		URL titik akhir API Manajemen dari layanan API Management.
properties.natGatewayState	NatGatewayState	Disabled	Properti dapat digunakan untuk mengaktifkan NAT Gateway untuk layanan API Management ini.
properties.notificationSenderEmail	string maxLength: 100		Alamat email tempat pemberitahuan akan dikirim.
properties.outboundPublicIPAddresses	string[]		Awalan alamat IPV4 publik keluar yang terkait dengan layanan yang disebarkan NAT Gateway. Hanya tersedia untuk SKU Premium pada platform stv2.
properties.platformVersion	PlatformVersion		Versi Platform Komputasi yang menjalankan layanan di lokasi ini.
properties.portalUrl	string		Url titik akhir portal publisher dari layanan API Management.
properties.privateEndpointConnections	RemotePrivateEndpointConnectionWrapper[]		Daftar Koneksi Titik Akhir Privat layanan ini.
properties.privateIPAddresses	string[]		Alamat IP Privat Static Load Balanced dari layanan API Management di Wilayah utama yang disebarkan dalam Jaringan Virtual Internal. Hanya tersedia untuk SKU Dasar, Standar, Premium, dan Terisolasi.
properties.provisioningState	string		Status provisi layanan API Management saat ini yang dapat menjadi salah satu hal berikut: Dibuat/Diaktifkan/Berhasil/Diperbarui/Gagal/Dihentikan/Dihentikan/DiminasiFailed/Dihapus.
properties.publicIPAddresses	string[]		Alamat IP Seimbang Beban Statis Publik dari layanan API Management di Wilayah utama. Hanya tersedia untuk SKU Dasar, Standar, Premium, dan Terisolasi.
properties.publicIpAddressId	string		Alamat IP berbasis IP V4 SKU Standar Publik yang akan dikaitkan dengan layanan yang disebarkan Virtual Network di wilayah tersebut. Hanya didukung untuk Pengembang dan SKU Premium yang disebarkan di Virtual Network.
properties.publicNetworkAccess	PublicNetworkAccess		Apakah akses titik akhir publik diizinkan atau tidak untuk layanan API Management ini. Nilai bersifat opsional tetapi jika diteruskan, harus 'Diaktifkan' atau 'Dinonaktifkan'. Jika 'Dinonaktifkan', titik akhir privat adalah metode akses eksklusif. Nilai defaultnya adalah 'Diaktifkan'
properties.publisherEmail	string maxLength: 100		Email publisher.
properties.publisherName	string maxLength: 100		Nama penerbit.
properties.restore	boolean	False	Batalkan penghapusan Layanan Api Management jika sebelumnya dihapus sementara. Jika bendera ini ditentukan dan diatur ke True, semua properti lainnya akan diabaikan.
properties.scmUrl	string		URL titik akhir SCM dari layanan API Management.
properties.targetProvisioningState	string		Status provisi layanan API Management, yang ditargetkan oleh operasi jangka panjang yang dimulai pada layanan.
properties.virtualNetworkConfiguration	VirtualNetworkConfiguration		Konfigurasi jaringan virtual layanan API Management.
properties.virtualNetworkType	VirtualNetworkType	None	Jenis VPN tempat layanan API Management perlu dikonfigurasi. Tidak Ada (Nilai Default) berarti layanan API Management bukan bagian dari Jaringan Virtual apa pun, Eksternal berarti penyebaran API Management disiapkan di dalam Jaringan Virtual yang memiliki Titik Akhir Yang Menghadap Internet, dan Internal berarti bahwa penyebaran API Management disiapkan di dalam Virtual Network yang hanya memiliki Titik Akhir Yang Menghadap Intranet.
sku	ApiManagementServiceSkuProperties		Properti SKU dari layanan API Management.
systemData	systemData		Metadata yang berkaitan dengan pembuatan dan modifikasi terakhir sumber daya.
tags	object		Tag sumber daya.
type	string		Jenis sumber daya untuk sumber daya API Management diatur ke Microsoft.ApiManagement.
zones	string[]		Daftar zona ketersediaan yang menunjukkan dari mana sumber daya perlu berasal.

ApiManagementServiceSkuProperties

Objek

Properti SKU sumber daya layanan API Management.

Nama	Jenis	Deskripsi
capacity	integer (int32)	Kapasitas SKU (jumlah unit SKU yang disebarkan). Untuk kapasitas SKU Konsumsi harus ditentukan sebagai 0.
name	SkuType	Nama Sku.

ApimIdentityType

Enumeration

Jenis identitas yang digunakan untuk sumber daya. Jenis 'SystemAssigned, UserAssigned' mencakup identitas yang dibuat secara implisit dan sekumpulan identitas yang ditetapkan pengguna. Jenis 'None' akan menghapus identitas apa pun dari layanan.

Nilai	Deskripsi
None
SystemAssigned
SystemAssigned, UserAssigned
UserAssigned

ApiVersionConstraint

Objek

Batasan versi Control Plane Apis untuk layanan API Management.

Nama	Jenis	Deskripsi
minApiVersion	string	Batasi panggilan API sarana kontrol ke layanan API Management dengan versi yang sama dengan atau lebih baru dari nilai ini.

ArmIdWrapper

Objek

Pembungkus untuk id sumber daya ARM

Nama	Jenis	Deskripsi
id	string

CertificateConfiguration

Objek

Konfigurasi sertifikat yang terdiri dari perantara dan sertifikat akar yang tidak tepercaya.

Nama	Jenis	Deskripsi
certificate	CertificateInformation	Informasi sertifikat.
certificatePassword	string	Kata Sandi Sertifikat.
encodedCertificate	string	Sertifikat Yang Dikodekan Base64.
storeName	enum: CertificateAuthority Root	Lokasi penyimpanan sertifikat System.Security.Cryptography.x509certificates.StoreName. Hanya Root dan CertificateAuthority yang merupakan lokasi yang valid.

CertificateInformation

Objek

Informasi sertifikat SSL.

Nama	Jenis	Deskripsi
expiry	string (date-time)	Tanggal kedaluwarsa sertifikat. Tanggal sesuai dengan format berikut: yyyy-MM-ddTHH:mm:ssZ seperti yang ditentukan oleh standar ISO 8601.
subject	string	Subjek sertifikat.
thumbprint	string	Thumbprint sertifikat.

CertificateSource

Enumeration

Sumber Sertifikat.

Nilai	Deskripsi
BuiltIn
Custom
KeyVault
Managed

CertificateStatus

Enumeration

Status Sertifikat.

Nilai	Deskripsi
Completed
Failed
InProgress

ConfigurationApi

Objek

Informasi mengenai API Konfigurasi layanan API Management.

Nama	Jenis	Nilai default	Deskripsi
legacyApi	LegacyApiState	Enabled	Indikasi apakah API Konfigurasi warisan (v1) harus diekspos pada layanan API Management atau tidak. Nilai bersifat opsional tetapi harus 'Diaktifkan' atau 'Dinonaktifkan'. Jika 'Dinonaktifkan', API Konfigurasi warisan (v1) tidak akan tersedia untuk gateway yang dihost sendiri. Nilai defaultnya adalah 'Diaktifkan'

createdByType

Enumeration

Jenis identitas yang membuat sumber daya.

Nilai	Deskripsi
Application
Key
ManagedIdentity
User

developerPortalStatus

Enumeration

Status portal pengembang di layanan API Management ini.

Nilai	Deskripsi
Disabled	Portal Pengembang dinonaktifkan untuk layanan.
Enabled	Portal Pengembang diaktifkan untuk layanan.

ErrorAdditionalInfo

Objek

Info tambahan kesalahan manajemen sumber daya.

Nama	Jenis	Deskripsi
info	object	Info tambahan.
type	string	Jenis info tambahan.

ErrorDetail

Objek

Detail kesalahan.

Nama	Jenis	Deskripsi
additionalInfo	ErrorAdditionalInfo[]	Info tambahan kesalahan.
code	string	Kode kesalahan.
details	ErrorDetail[]	Detail kesalahan.
message	string	Pesan kesalahan.
target	string	Target kesalahan.

ErrorResponse

Objek

Respons kesalahan

Nama	Jenis	Deskripsi
error	ErrorDetail	Objek kesalahan.

HostnameConfiguration

Objek

Konfigurasi nama host kustom.

Nama	Jenis	Nilai default	Deskripsi
certificate	CertificateInformation		Informasi sertifikat.
certificatePassword	string		Kata Sandi Sertifikat.
certificateSource	CertificateSource		Sumber Sertifikat.
certificateStatus	CertificateStatus		Status Sertifikat.
defaultSslBinding	boolean	False	Tentukan true untuk menyiapkan sertifikat yang terkait dengan Nama Host ini sebagai Sertifikat SSL Default. Jika klien tidak mengirim header SNI, maka ini akan menjadi sertifikat yang akan ditantang. Properti ini berguna jika layanan mengaktifkan beberapa nama host kustom dan perlu memutuskan sertifikat ssl default. Pengaturan hanya diterapkan ke Jenis Nama Host gateway.
encodedCertificate	string		Sertifikat Yang Dikodekan Base64.
hostName	string		Nama host untuk dikonfigurasi pada layanan Api Management.
identityClientId	string		ClientId identitas Terkelola yang Ditetapkan Sistem atau Pengguna seperti yang dihasilkan oleh Azure ACTIVE Directory, yang memiliki akses GET ke keyVault yang berisi sertifikat SSL.
keyVaultId	string		Url ke Rahasia KeyVault yang berisi Sertifikat Ssl. Jika Url absolut yang berisi versi disediakan, pembaruan otomatis sertifikat ssl tidak akan berfungsi. Ini mengharuskan layanan Api Management dikonfigurasi dengan aka.ms/apimmsi. Rahasia harus berjenis application/x-pkcs12
negotiateClientCertificate	boolean	False	Tentukan true untuk selalu menegosiasikan sertifikat klien pada nama host. Nilai Default adalah false.
type	HostnameType		Jenis nama host.

HostnameType

Enumeration

Jenis nama host.

Nilai	Deskripsi
ConfigurationApi
DeveloperPortal
Management
Portal
Proxy
Scm

LegacyApiState

Enumeration

Indikasi apakah API Konfigurasi warisan (v1) harus diekspos pada layanan API Management atau tidak. Nilai bersifat opsional tetapi harus 'Diaktifkan' atau 'Dinonaktifkan'. Jika 'Dinonaktifkan', API Konfigurasi warisan (v1) tidak akan tersedia untuk gateway yang dihost sendiri. Nilai defaultnya adalah 'Diaktifkan'

Nilai	Deskripsi
Disabled	API Konfigurasi Warisan (v1) dinonaktifkan untuk layanan dan gateway yang dihost sendiri tidak dapat terhubung ke layanan tersebut.
Enabled	API Konfigurasi Warisan (v1) diaktifkan untuk layanan dan gateway yang dihost sendiri dapat terhubung ke layanan tersebut.

LegacyPortalStatus

Enumeration

Status portal warisan di layanan API Management.

Nilai	Deskripsi
Disabled	Portal Warisan dinonaktifkan untuk layanan.
Enabled	Portal Warisan diaktifkan untuk layanan.

NatGatewayState

Enumeration

Properti dapat digunakan untuk mengaktifkan NAT Gateway untuk layanan API Management ini.

Nilai	Deskripsi
Disabled	Nat Gateway dinonaktifkan untuk layanan.
Enabled	Nat Gateway diaktifkan untuk layanan.

PlatformVersion

Enumeration

Versi Platform Komputasi yang menjalankan layanan.

Nilai	Deskripsi
mtv1	Platform yang menjalankan layanan pada platform Multi Tenant V1.
stv1	Platform yang menjalankan layanan pada platform Penyewa Tunggal V1.
stv2	Platform yang menjalankan layanan pada platform Penyewa Tunggal V2.
stv2.1	Platform yang menjalankan layanan pada platform Penyewa Tunggal V2 pada Perangkat Keras yang lebih baru.
undetermined	Versi platform tidak dapat ditentukan, karena platform komputasi tidak disebarkan.

PrivateEndpointServiceConnectionStatus

Enumeration

Status koneksi titik akhir privat.

Nilai	Deskripsi
Approved
Pending
Rejected

PrivateLinkServiceConnectionState

Objek

Kumpulan informasi tentang status koneksi antara konsumen layanan dan penyedia.

Nama	Jenis	Deskripsi
actionsRequired	string	Pesan yang menunjukkan apakah perubahan pada penyedia layanan memerlukan pembaruan pada konsumen.
description	string	Alasan persetujuan/penolakan koneksi.
status	PrivateEndpointServiceConnectionStatus	Menunjukkan apakah koneksi telah Disetujui/Ditolak/Dihapus oleh pemilik layanan.

PublicNetworkAccess

Enumeration

Apakah akses titik akhir publik diizinkan atau tidak untuk layanan API Management ini. Nilai bersifat opsional tetapi jika diteruskan, harus 'Diaktifkan' atau 'Dinonaktifkan'. Jika 'Dinonaktifkan', titik akhir privat adalah metode akses eksklusif. Nilai defaultnya adalah 'Diaktifkan'

Nilai	Deskripsi
Disabled
Enabled

RemotePrivateEndpointConnectionWrapper

Objek

Sumber daya Koneksi Titik Akhir Privat Jarak Jauh.

Nama	Jenis	Deskripsi
id	string	Id sumber daya koneksi Titik Akhir Privat
name	string	Nama Koneksi Titik Akhir Privat
properties.groupIds	string[]	Semua id Grup.
properties.privateEndpoint	ArmIdWrapper	Sumber daya titik akhir privat.
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	Kumpulan informasi tentang status koneksi antara konsumen layanan dan penyedia.
properties.provisioningState	string	Status provisi sumber daya koneksi titik akhir privat.
type	string	Jenis Sumber Daya Koneksi Titik Akhir Privat

SkuType

Enumeration

Nama Sku.

Nilai	Deskripsi
Basic	SKU Dasar Api Management.
BasicV2	BasicV2 SKU of Api Management.
Consumption	Konsumsi SKU Api Management.
Developer	SKU Pengembang Api Management.
Isolated	SKU Api Management yang terisolasi.
Premium	Premium SKU of Api Management.
Standard	SKU Standar Api Management.
StandardV2	StandardV2 SKU of Api Management.

systemData

Objek

Metadata yang berkaitan dengan pembuatan dan modifikasi terakhir sumber daya.

Nama	Jenis	Deskripsi
createdAt	string (date-time)	Tanda waktu pembuatan sumber daya (UTC).
createdBy	string	Identitas yang membuat sumber daya.
createdByType	createdByType	Jenis identitas yang membuat sumber daya.
lastModifiedAt	string (date-time)	Tanda waktu modifikasi terakhir sumber daya (UTC)
lastModifiedBy	string	Identitas yang terakhir mengubah sumber daya.
lastModifiedByType	createdByType	Jenis identitas yang terakhir memodifikasi sumber daya.

UserIdentityProperties

Objek

Nama	Jenis	Deskripsi
clientId	string	Id klien identitas yang ditetapkan pengguna.
principalId	string	Id utama identitas yang ditetapkan pengguna.

VirtualNetworkConfiguration

Objek

Konfigurasi jaringan virtual tempat layanan API Management disebarkan.

Nama	Jenis	Deskripsi
subnetResourceId	string pattern: ^/subscriptions/[^/]*/resourceGroups/[^/]*/providers/Microsoft.(ClassicNetwork|Network)/virtualNetworks/[^/]*/subnets/[^/]*$	ID sumber daya lengkap subnet di jaringan virtual untuk menyebarkan layanan API Management.
subnetname	string	Nama subnet.
vnetid	string	ID jaringan virtual. Ini biasanya GUID. Mengharapkan GUID null secara default.

VirtualNetworkType

Enumeration

Jenis VPN tempat layanan API Management perlu dikonfigurasi. Tidak Ada (Nilai Default) berarti layanan API Management bukan bagian dari Jaringan Virtual apa pun, Eksternal berarti penyebaran API Management disiapkan di dalam Jaringan Virtual yang memiliki Titik Akhir Yang Menghadap Internet, dan Internal berarti bahwa penyebaran API Management disiapkan di dalam Virtual Network yang hanya memiliki Titik Akhir Yang Menghadap Intranet.

Nilai	Deskripsi
External	Layanan ini adalah bagian dari Virtual Network dan dapat diakses dari Internet.
Internal	Layanan ini adalah bagian dari Virtual Network dan hanya dapat diakses dari dalam jaringan virtual.
None	Layanan ini bukan bagian dari Virtual Network apa pun.