Api Management Service - Backup

Service:

API Management

API Version:

2022-08-01

Skapar en säkerhetskopia av API Management-tjänsten till det angivna Azure Storage-kontot. Det här är en tidskrävande åtgärd som kan ta flera minuter att slutföra.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/backup?api-version=2022-08-01

URI-parametrar

Name	I	Obligatorisk	Typ	Description
resourceGroupName	path	True	string	Namnet på resursgruppen. Namnet är skiftlägesokänsligt.
serviceName	path	True	string	Namnet på API Management-tjänsten. Regex pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$
subscriptionId	path	True	string	ID för målprenumerationen.
api-version	query	True	string	Den API-version som ska användas för den här åtgärden.

Begärandetext

Name	Obligatorisk	Typ	Description
backupName	True	string	Namnet på säkerhetskopieringsfilen som ska skapas/hämtas.
containerName	True	string	Namnet på blobcontainern (används för att placera/hämta säkerhetskopian).
storageAccount	True	string	Namnet på Azure Storage-kontot (används för att placera/hämta säkerhetskopian).
accessKey		string	Åtkomstnyckel för lagringskonto. Krävs endast om accessType är inställt på AccessKey.
accessType		AccessType	Den typ av åtkomst som ska användas för lagringskontot.
clientId		string	Klient-ID för användartilldelad hanterad identitet. Krävs endast om accessType är inställt på UserAssignedManagedIdentity.

Svar

Name	Typ	Description
200 OK	ApiManagementServiceResource	Säkerhetskopierade API Management-tjänsten till lagringskontot.
202 Accepted		Godkänt: Platsrubriken innehåller url:en där statusen för den långvariga åtgärden kan kontrolleras. Headers Location: string
Other Status Codes	ErrorResponse	Felsvar som beskriver varför åtgärden misslyckades.

Säkerhet

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	personifiera ditt användarkonto

Exempel

ApiManagementBackupWithAccessKey

ApiManagementBackupWithSystemManagedIdentity

ApiManagementBackupWithUserAssignedManagedIdentity

ApiManagementBackupWithAccessKey

Sample Request

HTTP

POST https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/backup?api-version=2022-08-01

{
  "storageAccount": "teststorageaccount",
  "containerName": "backupContainer",
  "backupName": "apimService1backup_2017_03_19",
  "accessType": "AccessKey",
  "accessKey": "**************************************************"
}

Java

import com.azure.resourcemanager.apimanagement.models.AccessType;
import com.azure.resourcemanager.apimanagement.models.ApiManagementServiceBackupRestoreParameters;

/** Samples for ApiManagementService Backup. */
public final class Main {
    /*
     * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementBackupWithAccessKey.json
     */
    /**
     * Sample code: ApiManagementBackupWithAccessKey.
     *
     * @param manager Entry point to ApiManagementManager.
     */
    public static void apiManagementBackupWithAccessKey(
        com.azure.resourcemanager.apimanagement.ApiManagementManager manager) {
        manager
            .apiManagementServices()
            .backup(
                "rg1",
                "apimService1",
                new ApiManagementServiceBackupRestoreParameters()
                    .withStorageAccount("teststorageaccount")
                    .withContainerName("backupContainer")
                    .withBackupName("apimService1backup_2017_03_19")
                    .withAccessType(AccessType.ACCESS_KEY)
                    .withAccessKey("fakeTokenPlaceholder"),
                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_backup_with_access_key.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = ApiManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="subid",
    )

    response = client.api_management_service.begin_backup(
        resource_group_name="rg1",
        service_name="apimService1",
        parameters={
            "accessKey": "**************************************************",
            "accessType": "AccessKey",
            "backupName": "apimService1backup_2017_03_19",
            "containerName": "backupContainer",
            "storageAccount": "teststorageaccount",
        },
    ).result()
    print(response)


# x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementBackupWithAccessKey.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/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/apimanagement/armapimanagement/v2"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/4cd95123fb961c68740565a1efcaa5e43bd35802/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementBackupWithAccessKey.json
func ExampleServiceClient_BeginBackup_apiManagementBackupWithAccessKey() {
	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)
	}
	poller, err := clientFactory.NewServiceClient().BeginBackup(ctx, "rg1", "apimService1", armapimanagement.ServiceBackupRestoreParameters{
		AccessKey:      to.Ptr("**************************************************"),
		AccessType:     to.Ptr(armapimanagement.AccessTypeAccessKey),
		BackupName:     to.Ptr("apimService1backup_2017_03_19"),
		ContainerName:  to.Ptr("backupContainer"),
		StorageAccount: to.Ptr("teststorageaccount"),
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %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/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1"),
	// 	Tags: map[string]*string{
	// 		"tag1": to.Ptr("value1"),
	// 		"tag2": to.Ptr("value2"),
	// 		"tag3": to.Ptr("value3"),
	// 	},
	// 	Etag: to.Ptr("AAAAAAACXok="),
	// 	Location: to.Ptr("West US"),
	// 	Properties: &armapimanagement.ServiceProperties{
	// 		AdditionalLocations: []*armapimanagement.AdditionalLocation{
	// 			{
	// 				DisableGateway: to.Ptr(true),
	// 				GatewayRegionalURL: to.Ptr("https://apimService1-eastus-01.regional.azure-api.net"),
	// 				Location: to.Ptr("East US"),
	// 				PublicIPAddresses: []*string{
	// 					to.Ptr("23.101.138.153")},
	// 					SKU: &armapimanagement.ServiceSKUProperties{
	// 						Name: to.Ptr(armapimanagement.SKUTypePremium),
	// 						Capacity: to.Ptr[int32](1),
	// 					},
	// 			}},
	// 			APIVersionConstraint: &armapimanagement.APIVersionConstraint{
	// 				MinAPIVersion: to.Ptr("2019-01-01"),
	// 			},
	// 			CreatedAtUTC: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2019-12-18T06:26:20.334Z"); 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://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),
	// 					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, "2036-01-01T07:00:00.000Z"); return t}()),
	// 						Subject: to.Ptr("CN=*.msitesting.net"),
	// 						Thumbprint: to.Ptr("8E989XXXXXXXXXXXXXXXXB9C2C91F1D174FDB3A2"),
	// 					},
	// 					DefaultSSLBinding: to.Ptr(true),
	// 					HostName: to.Ptr("gateway1.msitesting.net"),
	// 					NegotiateClientCertificate: to.Ptr(false),
	// 				},
	// 				{
	// 					Type: to.Ptr(armapimanagement.HostnameTypeManagement),
	// 					Certificate: &armapimanagement.CertificateInformation{
	// 						Expiry: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2036-01-01T07:00:00.000Z"); return t}()),
	// 						Subject: to.Ptr("CN=*.msitesting.net"),
	// 						Thumbprint: to.Ptr("8E989XXXXXXXXXXXXXXXXB9C2C91F1D174FDB3A2"),
	// 					},
	// 					DefaultSSLBinding: to.Ptr(false),
	// 					HostName: to.Ptr("mgmt.msitesting.net"),
	// 					NegotiateClientCertificate: to.Ptr(false),
	// 				},
	// 				{
	// 					Type: to.Ptr(armapimanagement.HostnameTypePortal),
	// 					Certificate: &armapimanagement.CertificateInformation{
	// 						Expiry: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2036-01-01T07:00:00.000Z"); return t}()),
	// 						Subject: to.Ptr("CN=*.msitesting.net"),
	// 						Thumbprint: to.Ptr("8E989XXXXXXXXXXXXXXXXB9C2C91F1D174FDB3A2"),
	// 					},
	// 					DefaultSSLBinding: to.Ptr(false),
	// 					HostName: to.Ptr("portal1.msitesting.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"),
	// 			ProvisioningState: to.Ptr("Succeeded"),
	// 			PublicIPAddresses: []*string{
	// 				to.Ptr("13.91.32.113")},
	// 				ScmURL: to.Ptr("https://apimService1.scm.azure-api.net"),
	// 				TargetProvisioningState: to.Ptr(""),
	// 				VirtualNetworkType: to.Ptr(armapimanagement.VirtualNetworkTypeNone),
	// 				PublisherEmail: to.Ptr("apim@autorestsdk.com"),
	// 				PublisherName: to.Ptr("autorestsdk"),
	// 			},
	// 			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");

/**
 * This sample demonstrates how to Creates a backup of the API Management service to the given Azure Storage Account. This is long running operation and could take several minutes to complete.
 *
 * @summary Creates a backup of the API Management service to the given Azure Storage Account. This is long running operation and could take several minutes to complete.
 * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementBackupWithAccessKey.json
 */
async function apiManagementBackupWithAccessKey() {
  const subscriptionId = process.env["APIMANAGEMENT_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["APIMANAGEMENT_RESOURCE_GROUP"] || "rg1";
  const serviceName = "apimService1";
  const parameters = {
    accessKey: "**************************************************",
    accessType: "AccessKey",
    backupName: "apimService1backup_2017_03_19",
    containerName: "backupContainer",
    storageAccount: "teststorageaccount",
  };
  const credential = new DefaultAzureCredential();
  const client = new ApiManagementClient(credential, subscriptionId);
  const result = await client.apiManagementService.beginBackupAndWait(
    resourceGroupName,
    serviceName,
    parameters
  );
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample Response

Status code:

202

location: https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/dGVjaGVkX01hbmFnZVJvbGVfNWRiNGI3Ng==?api-version=2022-08-01

Status code:

200

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1",
  "name": "apimService1",
  "type": "Microsoft.ApiManagement/service",
  "tags": {
    "tag1": "value1",
    "tag2": "value2",
    "tag3": "value3"
  },
  "location": "West US",
  "etag": "AAAAAAACXok=",
  "properties": {
    "publisherEmail": "apim@autorestsdk.com",
    "publisherName": "autorestsdk",
    "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com",
    "provisioningState": "Succeeded",
    "targetProvisioningState": "",
    "createdAtUtc": "2019-12-18T06:26:20.3348609Z",
    "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
      },
      {
        "type": "Proxy",
        "hostName": "gateway1.msitesting.net",
        "negotiateClientCertificate": false,
        "certificate": {
          "expiry": "2036-01-01T07:00:00+00:00",
          "thumbprint": "8E989XXXXXXXXXXXXXXXXB9C2C91F1D174FDB3A2",
          "subject": "CN=*.msitesting.net"
        },
        "defaultSslBinding": true
      },
      {
        "type": "Management",
        "hostName": "mgmt.msitesting.net",
        "negotiateClientCertificate": false,
        "certificate": {
          "expiry": "2036-01-01T07:00:00+00:00",
          "thumbprint": "8E989XXXXXXXXXXXXXXXXB9C2C91F1D174FDB3A2",
          "subject": "CN=*.msitesting.net"
        },
        "defaultSslBinding": false
      },
      {
        "type": "Portal",
        "hostName": "portal1.msitesting.net",
        "negotiateClientCertificate": false,
        "certificate": {
          "expiry": "2036-01-01T07:00:00+00:00",
          "thumbprint": "8E989XXXXXXXXXXXXXXXXB9C2C91F1D174FDB3A2",
          "subject": "CN=*.msitesting.net"
        },
        "defaultSslBinding": false
      }
    ],
    "publicIPAddresses": [
      "13.91.32.113"
    ],
    "additionalLocations": [
      {
        "location": "East US",
        "sku": {
          "name": "Premium",
          "capacity": 1
        },
        "publicIPAddresses": [
          "23.101.138.153"
        ],
        "gatewayRegionalUrl": "https://apimService1-eastus-01.regional.azure-api.net",
        "disableGateway": true
      }
    ],
    "customProperties": {
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10": "False",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11": "False",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Ssl30": "False",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168": "False",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10": "False",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11": "False",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Ssl30": "False",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2": "False"
    },
    "virtualNetworkType": "None",
    "disableGateway": false,
    "apiVersionConstraint": {
      "minApiVersion": "2019-01-01"
    }
  },
  "sku": {
    "name": "Premium",
    "capacity": 1
  }
}

ApiManagementBackupWithSystemManagedIdentity

Sample Request

HTTP

POST https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/backup?api-version=2022-08-01

{
  "storageAccount": "contosorpstorage",
  "containerName": "apim-backups",
  "backupName": "backup5",
  "accessType": "SystemAssignedManagedIdentity"
}

Java

import com.azure.resourcemanager.apimanagement.models.AccessType;
import com.azure.resourcemanager.apimanagement.models.ApiManagementServiceBackupRestoreParameters;

/** Samples for ApiManagementService Backup. */
public final class Main {
    /*
     * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementBackupWithSystemManagedIdentity.json
     */
    /**
     * Sample code: ApiManagementBackupWithSystemManagedIdentity.
     *
     * @param manager Entry point to ApiManagementManager.
     */
    public static void apiManagementBackupWithSystemManagedIdentity(
        com.azure.resourcemanager.apimanagement.ApiManagementManager manager) {
        manager
            .apiManagementServices()
            .backup(
                "rg1",
                "apimService1",
                new ApiManagementServiceBackupRestoreParameters()
                    .withStorageAccount("contosorpstorage")
                    .withContainerName("apim-backups")
                    .withBackupName("backup5")
                    .withAccessType(AccessType.SYSTEM_ASSIGNED_MANAGED_IDENTITY),
                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_backup_with_system_managed_identity.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = ApiManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="subid",
    )

    response = client.api_management_service.begin_backup(
        resource_group_name="rg1",
        service_name="apimService1",
        parameters={
            "accessType": "SystemAssignedManagedIdentity",
            "backupName": "backup5",
            "containerName": "apim-backups",
            "storageAccount": "contosorpstorage",
        },
    ).result()
    print(response)


# x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementBackupWithSystemManagedIdentity.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/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/apimanagement/armapimanagement/v2"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/4cd95123fb961c68740565a1efcaa5e43bd35802/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementBackupWithSystemManagedIdentity.json
func ExampleServiceClient_BeginBackup_apiManagementBackupWithSystemManagedIdentity() {
	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)
	}
	poller, err := clientFactory.NewServiceClient().BeginBackup(ctx, "rg1", "apimService1", armapimanagement.ServiceBackupRestoreParameters{
		AccessType:     to.Ptr(armapimanagement.AccessTypeSystemAssignedManagedIdentity),
		BackupName:     to.Ptr("backup5"),
		ContainerName:  to.Ptr("apim-backups"),
		StorageAccount: to.Ptr("contosorpstorage"),
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %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/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1"),
	// 	Tags: map[string]*string{
	// 		"Owner": to.Ptr("apimService1"),
	// 	},
	// 	Etag: to.Ptr("AAAAAAAQM8o="),
	// 	Identity: &armapimanagement.ServiceIdentity{
	// 		Type: to.Ptr(armapimanagement.ApimIdentityTypeSystemAssignedUserAssigned),
	// 		PrincipalID: to.Ptr("00000000-5fb4-4916-95d4-64b306f9d924"),
	// 		TenantID: to.Ptr("00000000-86f1-0000-91ab-2d7cd011db47"),
	// 		UserAssignedIdentities: map[string]*armapimanagement.UserIdentityProperties{
	// 			"/subscriptions/subid/resourcegroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/rg1UserIdentity": &armapimanagement.UserIdentityProperties{
	// 				ClientID: to.Ptr("00000000-a154-4830-0000-46a12da1a1e2"),
	// 				PrincipalID: to.Ptr("00000000-a100-4478-0000-d65d98118ba0"),
	// 			},
	// 			"/subscriptions/subid/resourcegroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/vpnpremium": &armapimanagement.UserIdentityProperties{
	// 				ClientID: to.Ptr("00000000-6328-4db2-0000-ab0e3e7806cf"),
	// 				PrincipalID: to.Ptr("00000000-9208-4128-af2d-a10d2af9b5a3"),
	// 			},
	// 		},
	// 	},
	// 	Location: to.Ptr("Central US EUAP"),
	// 	Properties: &armapimanagement.ServiceProperties{
	// 		CreatedAtUTC: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-04-23T16:26:47.863Z"); 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://apimService1.developer.azure-api.net"),
	// 		DisableGateway: to.Ptr(false),
	// 		GatewayRegionalURL: to.Ptr("https://apimService1-centraluseuap-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(true),
	// 				HostName: to.Ptr("apimService1.azure-api.net"),
	// 				NegotiateClientCertificate: to.Ptr(false),
	// 		}},
	// 		ManagementAPIURL: to.Ptr("https://apimService1.management.azure-api.net"),
	// 		NotificationSenderEmail: to.Ptr("apimgmt-noreply@mail.windowsazure.com"),
	// 		PlatformVersion: to.Ptr(armapimanagement.PlatformVersionStv1),
	// 		PortalURL: to.Ptr("https://apimService1.portal.azure-api.net"),
	// 		ProvisioningState: to.Ptr("Succeeded"),
	// 		PublicIPAddresses: []*string{
	// 			to.Ptr("52.XXXX.160.66")},
	// 			PublicNetworkAccess: to.Ptr(armapimanagement.PublicNetworkAccessEnabled),
	// 			ScmURL: to.Ptr("https://apimService1.scm.azure-api.net"),
	// 			TargetProvisioningState: to.Ptr(""),
	// 			VirtualNetworkType: to.Ptr(armapimanagement.VirtualNetworkTypeNone),
	// 			PublisherEmail: to.Ptr("apimService1@corp.microsoft.com"),
	// 			PublisherName: to.Ptr("MS"),
	// 		},
	// 		SKU: &armapimanagement.ServiceSKUProperties{
	// 			Name: to.Ptr(armapimanagement.SKUTypePremium),
	// 			Capacity: to.Ptr[int32](1),
	// 		},
	// 		SystemData: &armapimanagement.SystemData{
	// 			LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-06-30T06:24:57.000Z"); return t}()),
	// 			LastModifiedBy: to.Ptr("contoso@microsoft.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");

/**
 * This sample demonstrates how to Creates a backup of the API Management service to the given Azure Storage Account. This is long running operation and could take several minutes to complete.
 *
 * @summary Creates a backup of the API Management service to the given Azure Storage Account. This is long running operation and could take several minutes to complete.
 * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementBackupWithSystemManagedIdentity.json
 */
async function apiManagementBackupWithSystemManagedIdentity() {
  const subscriptionId = process.env["APIMANAGEMENT_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["APIMANAGEMENT_RESOURCE_GROUP"] || "rg1";
  const serviceName = "apimService1";
  const parameters = {
    accessType: "SystemAssignedManagedIdentity",
    backupName: "backup5",
    containerName: "apim-backups",
    storageAccount: "contosorpstorage",
  };
  const credential = new DefaultAzureCredential();
  const client = new ApiManagementClient(credential, subscriptionId);
  const result = await client.apiManagementService.beginBackupAndWait(
    resourceGroupName,
    serviceName,
    parameters
  );
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample Response

Status code:

202

location: https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/dGVjaGVkX01hbmFnZVJvbGVfNWRiNGI3Ng==?api-version=2022-08-01

Status code:

200

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1",
  "name": "apimService1",
  "type": "Microsoft.ApiManagement/service",
  "tags": {
    "Owner": "apimService1"
  },
  "location": "Central US EUAP",
  "etag": "AAAAAAAQM8o=",
  "properties": {
    "publisherEmail": "apimService1@corp.microsoft.com",
    "publisherName": "MS",
    "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com",
    "provisioningState": "Succeeded",
    "targetProvisioningState": "",
    "createdAtUtc": "2020-04-23T16:26:47.8637967Z",
    "gatewayUrl": "https://apimService1.azure-api.net",
    "gatewayRegionalUrl": "https://apimService1-centraluseuap-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": true,
        "certificateSource": "BuiltIn"
      }
    ],
    "publicIPAddresses": [
      "52.XXXX.160.66"
    ],
    "customProperties": {
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10": "False",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11": "False",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Ssl30": "False",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168": "False",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10": "False",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11": "False",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Ssl30": "False",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2": "False"
    },
    "virtualNetworkType": "None",
    "disableGateway": false,
    "publicNetworkAccess": "Enabled",
    "platformVersion": "stv1"
  },
  "sku": {
    "name": "Premium",
    "capacity": 1
  },
  "identity": {
    "type": "SystemAssigned, UserAssigned",
    "principalId": "00000000-5fb4-4916-95d4-64b306f9d924",
    "tenantId": "00000000-86f1-0000-91ab-2d7cd011db47",
    "userAssignedIdentities": {
      "/subscriptions/subid/resourcegroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/rg1UserIdentity": {
        "principalId": "00000000-a100-4478-0000-d65d98118ba0",
        "clientId": "00000000-a154-4830-0000-46a12da1a1e2"
      },
      "/subscriptions/subid/resourcegroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/vpnpremium": {
        "principalId": "00000000-9208-4128-af2d-a10d2af9b5a3",
        "clientId": "00000000-6328-4db2-0000-ab0e3e7806cf"
      }
    }
  },
  "systemData": {
    "lastModifiedBy": "contoso@microsoft.com",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2021-06-30T06:24:57.0008037Z"
  }
}

ApiManagementBackupWithUserAssignedManagedIdentity

Sample Request

HTTP

POST https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/backup?api-version=2022-08-01

{
  "storageAccount": "contosorpstorage",
  "containerName": "apim-backups",
  "backupName": "backup5",
  "accessType": "UserAssignedManagedIdentity",
  "clientId": "XXXXX-a154-4830-XXXX-46a12da1a1e2"
}

Java

import com.azure.resourcemanager.apimanagement.models.AccessType;
import com.azure.resourcemanager.apimanagement.models.ApiManagementServiceBackupRestoreParameters;

/** Samples for ApiManagementService Backup. */
public final class Main {
    /*
     * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementBackupWithUserAssignedManagedIdentity.json
     */
    /**
     * Sample code: ApiManagementBackupWithUserAssignedManagedIdentity.
     *
     * @param manager Entry point to ApiManagementManager.
     */
    public static void apiManagementBackupWithUserAssignedManagedIdentity(
        com.azure.resourcemanager.apimanagement.ApiManagementManager manager) {
        manager
            .apiManagementServices()
            .backup(
                "rg1",
                "apimService1",
                new ApiManagementServiceBackupRestoreParameters()
                    .withStorageAccount("contosorpstorage")
                    .withContainerName("apim-backups")
                    .withBackupName("backup5")
                    .withAccessType(AccessType.USER_ASSIGNED_MANAGED_IDENTITY)
                    .withClientId("XXXXX-a154-4830-XXXX-46a12da1a1e2"),
                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_backup_with_user_assigned_managed_identity.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = ApiManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="subid",
    )

    response = client.api_management_service.begin_backup(
        resource_group_name="rg1",
        service_name="apimService1",
        parameters={
            "accessType": "UserAssignedManagedIdentity",
            "backupName": "backup5",
            "clientId": "XXXXX-a154-4830-XXXX-46a12da1a1e2",
            "containerName": "apim-backups",
            "storageAccount": "contosorpstorage",
        },
    ).result()
    print(response)


# x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementBackupWithUserAssignedManagedIdentity.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/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/apimanagement/armapimanagement/v2"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/4cd95123fb961c68740565a1efcaa5e43bd35802/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementBackupWithUserAssignedManagedIdentity.json
func ExampleServiceClient_BeginBackup_apiManagementBackupWithUserAssignedManagedIdentity() {
	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)
	}
	poller, err := clientFactory.NewServiceClient().BeginBackup(ctx, "rg1", "apimService1", armapimanagement.ServiceBackupRestoreParameters{
		AccessType:     to.Ptr(armapimanagement.AccessTypeUserAssignedManagedIdentity),
		BackupName:     to.Ptr("backup5"),
		ClientID:       to.Ptr("XXXXX-a154-4830-XXXX-46a12da1a1e2"),
		ContainerName:  to.Ptr("apim-backups"),
		StorageAccount: to.Ptr("contosorpstorage"),
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %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/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1"),
	// 	Tags: map[string]*string{
	// 		"Owner": to.Ptr("apimService1"),
	// 	},
	// 	Etag: to.Ptr("AAAAAAAQM8o="),
	// 	Identity: &armapimanagement.ServiceIdentity{
	// 		Type: to.Ptr(armapimanagement.ApimIdentityTypeSystemAssignedUserAssigned),
	// 		PrincipalID: to.Ptr("00000000-5fb4-4916-95d4-64b306f9d924"),
	// 		TenantID: to.Ptr("00000000-86f1-0000-91ab-2d7cd011db47"),
	// 		UserAssignedIdentities: map[string]*armapimanagement.UserIdentityProperties{
	// 			"/subscriptions/subid/resourcegroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/rg1UserIdentity": &armapimanagement.UserIdentityProperties{
	// 				ClientID: to.Ptr("00000000-a154-4830-0000-46a12da1a1e2"),
	// 				PrincipalID: to.Ptr("00000000-a100-4478-0000-d65d98118ba0"),
	// 			},
	// 			"/subscriptions/subid/resourcegroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/vpnpremium": &armapimanagement.UserIdentityProperties{
	// 				ClientID: to.Ptr("00000000-6328-4db2-0000-ab0e3e7806cf"),
	// 				PrincipalID: to.Ptr("00000000-9208-4128-af2d-a10d2af9b5a3"),
	// 			},
	// 		},
	// 	},
	// 	Location: to.Ptr("Central US EUAP"),
	// 	Properties: &armapimanagement.ServiceProperties{
	// 		CreatedAtUTC: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-04-23T16:26:47.863Z"); 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://apimService1.developer.azure-api.net"),
	// 		DisableGateway: to.Ptr(false),
	// 		GatewayRegionalURL: to.Ptr("https://apimService1-centraluseuap-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(true),
	// 				HostName: to.Ptr("apimService1.azure-api.net"),
	// 				NegotiateClientCertificate: to.Ptr(false),
	// 		}},
	// 		ManagementAPIURL: to.Ptr("https://apimService1.management.azure-api.net"),
	// 		NotificationSenderEmail: to.Ptr("apimgmt-noreply@mail.windowsazure.com"),
	// 		PlatformVersion: to.Ptr(armapimanagement.PlatformVersionStv1),
	// 		PortalURL: to.Ptr("https://apimService1.portal.azure-api.net"),
	// 		ProvisioningState: to.Ptr("Succeeded"),
	// 		PublicIPAddresses: []*string{
	// 			to.Ptr("52.XXXX.160.66")},
	// 			PublicNetworkAccess: to.Ptr(armapimanagement.PublicNetworkAccessEnabled),
	// 			ScmURL: to.Ptr("https://apimService1.scm.azure-api.net"),
	// 			TargetProvisioningState: to.Ptr(""),
	// 			VirtualNetworkType: to.Ptr(armapimanagement.VirtualNetworkTypeNone),
	// 			PublisherEmail: to.Ptr("apimService1@corp.microsoft.com"),
	// 			PublisherName: to.Ptr("MS"),
	// 		},
	// 		SKU: &armapimanagement.ServiceSKUProperties{
	// 			Name: to.Ptr(armapimanagement.SKUTypePremium),
	// 			Capacity: to.Ptr[int32](1),
	// 		},
	// 		SystemData: &armapimanagement.SystemData{
	// 			LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-06-30T06:24:57.000Z"); return t}()),
	// 			LastModifiedBy: to.Ptr("contoso@microsoft.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");

/**
 * This sample demonstrates how to Creates a backup of the API Management service to the given Azure Storage Account. This is long running operation and could take several minutes to complete.
 *
 * @summary Creates a backup of the API Management service to the given Azure Storage Account. This is long running operation and could take several minutes to complete.
 * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementBackupWithUserAssignedManagedIdentity.json
 */
async function apiManagementBackupWithUserAssignedManagedIdentity() {
  const subscriptionId = process.env["APIMANAGEMENT_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["APIMANAGEMENT_RESOURCE_GROUP"] || "rg1";
  const serviceName = "apimService1";
  const parameters = {
    accessType: "UserAssignedManagedIdentity",
    backupName: "backup5",
    clientId: "XXXXX-a154-4830-XXXX-46a12da1a1e2",
    containerName: "apim-backups",
    storageAccount: "contosorpstorage",
  };
  const credential = new DefaultAzureCredential();
  const client = new ApiManagementClient(credential, subscriptionId);
  const result = await client.apiManagementService.beginBackupAndWait(
    resourceGroupName,
    serviceName,
    parameters
  );
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample Response

Status code:

202

location: https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/dGVjaGVkX01hbmFnZVJvbGVfNWRiNGI3Ng==?api-version=2022-08-01

Status code:

200

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1",
  "name": "apimService1",
  "type": "Microsoft.ApiManagement/service",
  "tags": {
    "Owner": "apimService1"
  },
  "location": "Central US EUAP",
  "etag": "AAAAAAAQM8o=",
  "properties": {
    "publisherEmail": "apimService1@corp.microsoft.com",
    "publisherName": "MS",
    "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com",
    "provisioningState": "Succeeded",
    "targetProvisioningState": "",
    "createdAtUtc": "2020-04-23T16:26:47.8637967Z",
    "gatewayUrl": "https://apimService1.azure-api.net",
    "gatewayRegionalUrl": "https://apimService1-centraluseuap-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": true,
        "certificateSource": "BuiltIn"
      }
    ],
    "publicIPAddresses": [
      "52.XXXX.160.66"
    ],
    "customProperties": {
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10": "False",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11": "False",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Ssl30": "False",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168": "False",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10": "False",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11": "False",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Ssl30": "False",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2": "False"
    },
    "virtualNetworkType": "None",
    "disableGateway": false,
    "publicNetworkAccess": "Enabled",
    "platformVersion": "stv1"
  },
  "sku": {
    "name": "Premium",
    "capacity": 1
  },
  "identity": {
    "type": "SystemAssigned, UserAssigned",
    "principalId": "00000000-5fb4-4916-95d4-64b306f9d924",
    "tenantId": "00000000-86f1-0000-91ab-2d7cd011db47",
    "userAssignedIdentities": {
      "/subscriptions/subid/resourcegroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/rg1UserIdentity": {
        "principalId": "00000000-a100-4478-0000-d65d98118ba0",
        "clientId": "00000000-a154-4830-0000-46a12da1a1e2"
      },
      "/subscriptions/subid/resourcegroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/vpnpremium": {
        "principalId": "00000000-9208-4128-af2d-a10d2af9b5a3",
        "clientId": "00000000-6328-4db2-0000-ab0e3e7806cf"
      }
    }
  },
  "systemData": {
    "lastModifiedBy": "contoso@microsoft.com",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2021-06-30T06:24:57.0008037Z"
  }
}

Definitioner

Name	Description
AccessType	Vilken typ av åtkomst som ska användas för lagringskontot.
AdditionalLocation	Beskrivning av ytterligare en API Management resursplats.
ApiManagementServiceBackupRestoreParameters	Parametrar som anges för säkerhetskopiering/återställning av en API Management tjänståtgärd.
ApiManagementServiceIdentity	Identitetsegenskaper för Api Management-tjänstresursen.
ApiManagementServiceResource	En enda API Management tjänstresurs i Lista eller Hämta svar.
ApiManagementServiceSkuProperties	API Management SKU-egenskaper för tjänstresurser.
ApimIdentityType	Den typ av identitet som används för resursen. Typen "SystemAssigned, UserAssigned" innehåller både en implicit skapad identitet och en uppsättning användartilldelade identiteter. Typen "Ingen" tar bort eventuella identiteter från tjänsten.
ApiVersionConstraint	Kontrollplans-API:ets versionsbegränsning för API Management-tjänsten.
ArmIdWrapper	En omslutning för ett ARM-resurs-ID
CertificateConfiguration	Certifikatkonfiguration som består av icke-betrodda intermediärer och rotcertifikat.
CertificateInformation	SSL-certifikatinformation.
CertificateSource	Certifikatkälla.
CertificateStatus	Certifikatstatus.
createdByType	Den typ av identitet som skapade resursen.
ErrorFieldContract	Fel Fältkontrakt.
ErrorResponse	Felsvar.
HostnameConfiguration	Konfiguration av anpassat värdnamn.
HostnameType	Typ av värdnamn.
NatGatewayState	Egenskapen kan användas för att aktivera NAT Gateway för den här API Management-tjänsten.
PlatformVersion	Beräkningsplattformsversion som kör tjänsten.
PrivateEndpointServiceConnectionStatus	Anslutningsstatus för privat slutpunkt.
PrivateLinkServiceConnectionState	En samling information om tillståndet för anslutningen mellan tjänstkonsumenten och leverantören.
PublicNetworkAccess	Om offentlig slutpunktsåtkomst tillåts för den här API Management-tjänsten eller inte. Värdet är valfritt, men om det skickas måste det vara "Aktiverat" eller "Inaktiverat". Om "Inaktiverad" är privata slutpunkter den exklusiva åtkomstmetoden. Standardvärdet är "Aktiverat"
RemotePrivateEndpointConnectionWrapper	Fjärrresurs för privat slutpunktsanslutning.
SkuType	Namnet på SKU:n.
systemData	Metadata som rör skapande och senaste ändring av resursen.
UserIdentityProperties
VirtualNetworkConfiguration	Konfiguration av ett virtuellt nätverk som API Management tjänsten distribueras till.
VirtualNetworkType	Den typ av VPN som API Management tjänsten måste konfigureras i. Ingen (standardvärde) innebär att API Management-tjänsten inte ingår i någon Virtual Network, externt innebär att API Management-distributionen har konfigurerats i en Virtual Network med en Internetuppkopplad slutpunkt och intern innebär att API Management distributionen konfigureras i en Virtual Network endast har en intranätuppkopplad slutpunkt.

AccessType

Vilken typ av åtkomst som ska användas för lagringskontot.

Name	Typ	Description
AccessKey	string	Använd åtkomstnyckel.
SystemAssignedManagedIdentity	string	Använd systemtilldelad hanterad identitet.
UserAssignedManagedIdentity	string	Använd användartilldelad hanterad identitet.

AdditionalLocation

Beskrivning av ytterligare en API Management resursplats.

Name	Typ	Standardvärde	Description
disableGateway	boolean	False	Egenskapen är endast giltig för en Api Management-tjänst som distribuerats på flera platser. Detta kan användas för att inaktivera gatewayen på den här ytterligare platsen.
gatewayRegionalUrl	string		Gateway-URL för API Management-tjänsten i regionen.
location	string		Platsnamnet för den ytterligare regionen mellan Azure Data Center-regioner.
natGatewayState	NatGatewayState	Disabled	Egenskapen kan användas för att aktivera NAT Gateway för den här API Management-tjänsten.
outboundPublicIPAddresses	string[]		Utgående offentliga IPV4-adressprefix som är associerade med DEN NAT Gateway-distribuerade tjänsten. Endast tillgängligt för Premium SKU på stv2-plattformen.
platformVersion	PlatformVersion		Beräkningsplattformsversion som kör tjänsten.
privateIPAddresses	string[]		Privata statiska lastbalanserade IP-adresser för API Management-tjänsten som distribueras i en intern Virtual Network på en viss ytterligare plats. Endast tillgängligt för Basic, Standard, Premium och Isolerad SKU.
publicIPAddresses	string[]		Offentliga statiska belastningsutjämnings-IP-adresser för API Management-tjänsten på den ytterligare platsen. Endast tillgängligt för Basic, Standard, Premium och Isolerad SKU.
publicIpAddressId	string		Public Standard SKU IP V4-baserad IP-adress som ska associeras med Virtual Network distribuerad tjänst på platsen. Stöds endast för Premium SKU som distribueras i Virtual Network.
sku	ApiManagementServiceSkuProperties		SKU-egenskaper för API Management-tjänsten.
virtualNetworkConfiguration	VirtualNetworkConfiguration		Konfiguration av virtuellt nätverk för platsen.
zones	string[]		En lista över tillgänglighetszoner som anger var resursen behöver komma ifrån.

ApiManagementServiceBackupRestoreParameters

Parametrar som anges för säkerhetskopiering/återställning av en API Management tjänståtgärd.

Name	Typ	Standardvärde	Description
accessKey	string		Åtkomstnyckel för lagringskonto. Krävs endast om accessType är inställt på AccessKey.
accessType	AccessType	AccessKey	Vilken typ av åtkomst som ska användas för lagringskontot.
backupName	string		Namnet på den säkerhetskopieringsfil som ska skapas/hämtas.
clientId	string		Klient-ID för användartilldelad hanterad identitet. Krävs endast om accessType är inställt på UserAssignedManagedIdentity.
containerName	string		Namnet på blobcontainern (används för att placera/hämta säkerhetskopian).
storageAccount	string		Namnet på Azure Storage-kontot (används för att placera/hämta säkerhetskopian).

ApiManagementServiceIdentity

Identitetsegenskaper för Api Management-tjänstresursen.

Name	Typ	Description
principalId	string	Identitetens huvud-ID.
tenantId	string	Klientklient-ID:t för identiteten.
type	ApimIdentityType	Den typ av identitet som används för resursen. Typen "SystemAssigned, UserAssigned" innehåller både en implicit skapad identitet och en uppsättning användartilldelade identiteter. Typen "Ingen" tar bort eventuella identiteter från tjänsten.
userAssignedIdentities	<string,  UserIdentityProperties>	Listan över användaridentiteter som är associerade med resursen. Nyckelreferenserna för användaridentitetsordlistan är ARM-resurs-ID:er i formatet: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/ providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.

ApiManagementServiceResource

En enda API Management tjänstresurs i Lista eller Hämta svar.

Name	Typ	Standardvärde	Description
etag	string		ETag för resursen.
id	string		Resurs-ID.
identity	ApiManagementServiceIdentity		Hanterad tjänstidentitet för API Management-tjänsten.
location	string		Resursplats.
name	string		Resursnamn.
properties.additionalLocations	AdditionalLocation[]		Ytterligare datacenterplatser för API Management-tjänsten.
properties.apiVersionConstraint	ApiVersionConstraint		Kontrollplans-API:ets versionsbegränsning för API Management-tjänsten.
properties.certificates	CertificateConfiguration[]		Lista över certifikat som måste installeras i API Management-tjänsten. Maximalt antal certifikat som stöds som kan installeras är 10.
properties.createdAtUtc	string		Skapa UTC-datum för API Management-tjänsten. Datumet överensstämmer med följande format: yyyy-MM-ddTHH:mm:ssZ enligt iso 8601-standarden.
properties.customProperties	object		Anpassade egenskaper för API Management-tjänsten. Inställningen Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168 inaktiverar chiffer TLS_RSA_WITH_3DES_EDE_CBC_SHA för alla TLS(1.0, 1.1 och 1.2). Inställningen Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11 kan användas för att inaktivera bara TLS 1.1. Inställningen Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10 kan användas för att inaktivera TLS 1.0 på en API Management tjänst. Inställningen Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11 kan användas för att inaktivera bara TLS 1.1 för kommunikation med serverdelar. Inställningen Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10 kan användas för att inaktivera TLS 1.0 för kommunikation med serverdelar. Inställningen Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2 kan användas för att aktivera HTTP2-protokoll på en API Management-tjänst. Om du inte anger någon av de här egenskaperna för PATCH-åtgärden återställs egenskapernas värden till standardvärdena. För alla inställningar utom Http2 är True standardvärdet om tjänsten skapades den 1 april 2018 eller tidigare än den 1 april 2018.False Http2-inställningens standardvärde är False. Du kan inaktivera något av följande chiffer med hjälp av inställningarna 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. Till exempel Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_128_CBC_SHA256:false. Standardvärdet är true för dem. Obs! Följande chiffer kan inte inaktiveras eftersom de krävs av interna plattformskomponenter: 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.developerPortalUrl	string		DEveloper-portalens slutpunkts-URL för API Management-tjänsten.
properties.disableGateway	boolean	False	Egenskapen är endast giltig för en Api Management-tjänst som distribuerats på flera platser. Detta kan användas för att inaktivera gatewayen i huvudregionen.
properties.enableClientCertificate	boolean	False	Egenskapen är endast avsedd att användas för förbruknings-SKU-tjänsten. Detta framtvingar att ett klientcertifikat visas på varje begäran till gatewayen. Detta gör det också möjligt att autentisera certifikatet i principen på gatewayen.
properties.gatewayRegionalUrl	string		Gateway-URL för API Management-tjänsten i standardregionen.
properties.gatewayUrl	string		Gateway-URL för API Management-tjänsten.
properties.hostnameConfigurations	HostnameConfiguration[]		Konfiguration av anpassat värdnamn för API Management-tjänsten.
properties.managementApiUrl	string		API-slutpunkts-URL för hantering av API Management-tjänsten.
properties.natGatewayState	NatGatewayState	Disabled	Egenskapen kan användas för att aktivera NAT Gateway för den här API Management-tjänsten.
properties.notificationSenderEmail	string		Email adress som meddelandet ska skickas från.
properties.outboundPublicIPAddresses	string[]		Utgående offentliga IPV4-adressprefix som är associerade med DEN NAT Gateway-distribuerade tjänsten. Endast tillgängligt för Premium SKU på stv2-plattformen.
properties.platformVersion	PlatformVersion		Beräkningsplattformsversion som kör tjänsten på den här platsen.
properties.portalUrl	string		Slutpunkts-URL för utgivarportalen för API Management-tjänsten.
properties.privateEndpointConnections	RemotePrivateEndpointConnectionWrapper[]		Lista över privata slutpunktsanslutningar för den här tjänsten.
properties.privateIPAddresses	string[]		Privata statiska lastbalanserade IP-adresser för API Management-tjänsten i den primära regionen som distribueras i en intern Virtual Network. Endast tillgängligt för Basic, Standard, Premium och Isolerad SKU.
properties.provisioningState	string		Det aktuella etableringstillståndet för API Management-tjänsten som kan vara något av följande: Skapad/Aktivera/Lyckades/Uppdatera/Misslyckades/Stoppad/Avslutande/TerminationFailed/Borttagen.
properties.publicIPAddresses	string[]		Offentliga statiska belastningsutjämnings-IP-adresser för API Management-tjänsten i den primära regionen. Endast tillgängligt för Basic, Standard, Premium och Isolerad SKU.
properties.publicIpAddressId	string		Public Standard SKU IP V4-baserad IP-adress som ska associeras med Virtual Network distribuerade tjänsten i regionen. Stöds endast för utvecklare och Premium SKU som distribueras i Virtual Network.
properties.publicNetworkAccess	PublicNetworkAccess		Om offentlig slutpunktsåtkomst tillåts för den här API Management-tjänsten eller inte. Värdet är valfritt, men om det skickas måste det vara "Aktiverat" eller "Inaktiverat". Om "Inaktiverad" är privata slutpunkter den exklusiva åtkomstmetoden. Standardvärdet är "Aktiverat"
properties.publisherEmail	string		E-post för utgivare.
properties.publisherName	string		Utgivarens namn.
properties.restore	boolean	False	Ta bort Api Management-tjänsten om den tidigare togs bort mjukt. Om den här flaggan har angetts och angetts till Sant ignoreras alla andra egenskaper.
properties.scmUrl	string		SCM-slutpunkts-URL för API Management-tjänsten.
properties.targetProvisioningState	string		Etableringstillståndet för API Management-tjänsten, som är mål för den långvariga åtgärden som startades på tjänsten.
properties.virtualNetworkConfiguration	VirtualNetworkConfiguration		Konfiguration av virtuella nätverk för API Management-tjänsten.
properties.virtualNetworkType	VirtualNetworkType	None	Den typ av VPN som API Management tjänsten måste konfigureras i. Ingen (standardvärde) innebär att API Management-tjänsten inte ingår i någon Virtual Network, externt innebär att API Management-distributionen har konfigurerats i en Virtual Network med en Internetuppkopplad slutpunkt och intern innebär att API Management distributionen konfigureras i en Virtual Network endast har en intranätuppkopplad slutpunkt.
sku	ApiManagementServiceSkuProperties		SKU-egenskaper för API Management-tjänsten.
systemData	systemData		Metadata som rör skapande och senaste ändring av resursen.
tags	object		Resurstaggar.
type	string		Resurstyp för API Management resurs anges till Microsoft.ApiManagement.
zones	string[]		En lista över tillgänglighetszoner som anger var resursen behöver komma ifrån.

ApiManagementServiceSkuProperties

API Management SKU-egenskaper för tjänstresurser.

Name	Typ	Description
capacity	integer	SKU:ns kapacitet (antalet distribuerade enheter i SKU:n). För förbrukning måste SKU-kapaciteten anges som 0.
name	SkuType	Namnet på SKU:n.

ApimIdentityType

Den typ av identitet som används för resursen. Typen "SystemAssigned, UserAssigned" innehåller både en implicit skapad identitet och en uppsättning användartilldelade identiteter. Typen "Ingen" tar bort eventuella identiteter från tjänsten.

Name	Typ	Description
None	string
SystemAssigned	string
SystemAssigned, UserAssigned	string
UserAssigned	string

ApiVersionConstraint

Kontrollplans-API:ets versionsbegränsning för API Management-tjänsten.

Name	Typ	Description
minApiVersion	string	Begränsa API-anrop för kontrollplan till API Management tjänst med en version som är lika med eller nyare än det här värdet.

ArmIdWrapper

En omslutning för ett ARM-resurs-ID

Name	Typ	Description
id	string

CertificateConfiguration

Certifikatkonfiguration som består av icke-betrodda intermediärer och rotcertifikat.

Name	Typ	Description
certificate	CertificateInformation	Certifikatinformation.
certificatePassword	string	Certifikatlösenord.
encodedCertificate	string	Base64-kodat certifikat.
storeName	enum: CertificateAuthority Root	Certifikatarkivet System.Security.Cryptography.x509certificates.StoreName. Endast Rot- och CertificateAuthority är giltiga platser.

CertificateInformation

SSL-certifikatinformation.

Name	Typ	Description
expiry	string	Förfallodatum för certifikatet. Datumet överensstämmer med följande format: yyyy-MM-ddTHH:mm:ssZ enligt iso 8601-standarden.
subject	string	Certifikatets ämne.
thumbprint	string	Tumavtryck för certifikatet.

CertificateSource

Certifikatkälla.

Name	Typ	Description
BuiltIn	string
Custom	string
KeyVault	string
Managed	string

CertificateStatus

Certifikatstatus.

Name	Typ	Description
Completed	string
Failed	string
InProgress	string

createdByType

Den typ av identitet som skapade resursen.

Name	Typ	Description
Application	string
Key	string
ManagedIdentity	string
User	string

ErrorFieldContract

Fel Fältkontrakt.

Name	Typ	Description
code	string	Felkod på egenskapsnivå.
message	string	Mänsklig läsbar representation av fel på egenskapsnivå.
target	string	Egenskapsnamn.

ErrorResponse

Felsvar.

Name	Typ	Description
error.code	string	Tjänstdefinierad felkod. Den här koden fungerar som en understatus för HTTP-felkoden som anges i svaret.
error.details	ErrorFieldContract[]	Listan över ogiltiga fält som skickas i begäran, om verifieringsfel uppstår.
error.message	string	Mänsklig läsbar representation av felet.

HostnameConfiguration

Konfiguration av anpassat värdnamn.

Name	Typ	Standardvärde	Description
certificate	CertificateInformation		Certifikatinformation.
certificatePassword	string		Certifikatlösenord.
certificateSource	CertificateSource		Certifikatkälla.
certificateStatus	CertificateStatus		Certifikatstatus.
defaultSslBinding	boolean	False	Ange true för att konfigurera certifikatet som är associerat med det här värdnamnet som standard-SSL-certifikat. Om en klient inte skickar SNI-huvudet är detta certifikatet som kommer att utmanas. Egenskapen är användbar om en tjänst har flera anpassade värdnamn aktiverade och måste bestämma standard-SSL-certifikatet. Inställningen tillämpas endast på gatewayens värdnamnstyp.
encodedCertificate	string		Base64-kodat certifikat.
hostName	string		Värdnamn som ska konfigureras på Api Management-tjänsten.
identityClientId	string		ClientId för system- eller användartilldelad hanterad identitet som genereras av Azure AD, som har GET-åtkomst till keyVault som innehåller SSL-certifikatet.
keyVaultId	string		Url till KeyVault-hemligheten som innehåller Ssl-certifikatet. Om absolut URL som innehåller version tillhandahålls fungerar inte automatisk uppdatering av SSL-certifikatet. Detta kräver att Api Management-tjänsten konfigureras med aka.ms/apimmsi. Hemligheten ska vara av typen application/x-pkcs12
negotiateClientCertificate	boolean	False	Ange true för att alltid förhandla om klientcertifikatet på värdnamnet. Standardvärdet är falskt.
type	HostnameType		Typ av värdnamn.

HostnameType

Typ av värdnamn.

Name	Typ	Description
DeveloperPortal	string
Management	string
Portal	string
Proxy	string
Scm	string

NatGatewayState

Egenskapen kan användas för att aktivera NAT Gateway för den här API Management-tjänsten.

Name	Typ	Description
Disabled	string	Nat Gateway är inaktiverat för tjänsten.
Enabled	string	Nat Gateway är aktiverat för tjänsten.

PlatformVersion

Beräkningsplattformsversion som kör tjänsten.

Name	Typ	Description
mtv1	string	Plattform som kör tjänsten på V1-plattformen för flera innehavare.
stv1	string	Plattform som kör tjänsten på V1-plattformen för enskild klientorganisation.
stv2	string	Plattform som kör tjänsten på V2-plattformen för enskild klientorganisation.
undetermined	string	Det går inte att fastställa plattformsversionen eftersom beräkningsplattformen inte distribueras.

PrivateEndpointServiceConnectionStatus

Anslutningsstatus för privat slutpunkt.

Name	Typ	Description
Approved	string
Pending	string
Rejected	string

PrivateLinkServiceConnectionState

En samling information om tillståndet för anslutningen mellan tjänstkonsumenten och leverantören.

Name	Typ	Description
actionsRequired	string	Ett meddelande som anger om ändringar i tjänstleverantören kräver uppdateringar på konsumenten.
description	string	Anledningen till att anslutningen godkänns/avvisas.
status	PrivateEndpointServiceConnectionStatus	Anger om anslutningen har godkänts/avvisats/tagits bort av tjänstens ägare.

PublicNetworkAccess

Om offentlig slutpunktsåtkomst tillåts för den här API Management-tjänsten eller inte. Värdet är valfritt, men om det skickas måste det vara "Aktiverat" eller "Inaktiverat". Om "Inaktiverad" är privata slutpunkter den exklusiva åtkomstmetoden. Standardvärdet är "Aktiverat"

Name	Typ	Description
Disabled	string
Enabled	string

RemotePrivateEndpointConnectionWrapper

Fjärrresurs för privat slutpunktsanslutning.

Name	Typ	Description
id	string	Resurs-ID för privat slutpunktsanslutning
name	string	Anslutningsnamn för privat slutpunkt
properties.groupIds	string[]	Alla grupp-ID:t.
properties.privateEndpoint	ArmIdWrapper	Resursen för den privata slutpunkten.
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	En samling med information om tillståndet för anslutningen mellan tjänstekonsumenten och leverantören.
properties.provisioningState	string	Etableringstillståndet för den privata slutpunktsanslutningsresursen.
type	string	Resurstyp för privat slutpunktsanslutning

SkuType

Namnet på SKU:n.

Name	Typ	Description
Basic	string	Grundläggande SKU för Api Management.
Consumption	string	Förbruknings-SKU för Api Management.
Developer	string	Utvecklar-SKU för Api Management.
Isolated	string	Isolerad SKU för Api Management.
Premium	string	Premium SKU för Api Management.
Standard	string	Standard-SKU för Api Management.

systemData

Metadata som rör skapande och senaste ändring av resursen.

Name	Typ	Description
createdAt	string	Tidsstämpeln för resursskapande (UTC).
createdBy	string	Identiteten som skapade resursen.
createdByType	createdByType	Den typ av identitet som skapade resursen.
lastModifiedAt	string	Tidsstämpeln för resursens senaste ändring (UTC)
lastModifiedBy	string	Identiteten som senast ändrade resursen.
lastModifiedByType	createdByType	Den typ av identitet som senast ändrade resursen.

UserIdentityProperties

Name	Typ	Description
clientId	string	Klient-ID för användartilldelad identitet.
principalId	string	Huvud-ID för användartilldelad identitet.

VirtualNetworkConfiguration

Konfiguration av ett virtuellt nätverk som API Management tjänsten distribueras till.

Name	Typ	Description
subnetResourceId	string	Det fullständiga resurs-ID:t för ett undernät i ett virtuellt nätverk för att distribuera API Management-tjänsten i.
subnetname	string	Namnet på undernätet.
vnetid	string	Det virtuella nätverks-ID:t. Detta är vanligtvis ett GUID. Förvänta dig ett null-GUID som standard.

VirtualNetworkType

Den typ av VPN som API Management tjänsten måste konfigureras i. Ingen (standardvärde) innebär att API Management-tjänsten inte ingår i någon Virtual Network, externt innebär att API Management-distributionen har konfigurerats i en Virtual Network med en Internetuppkopplad slutpunkt och intern innebär att API Management distributionen konfigureras i en Virtual Network endast har en intranätuppkopplad slutpunkt.

Name	Typ	Description
External	string	Tjänsten är en del av Virtual Network och är tillgänglig från Internet.
Internal	string	Tjänsten är en del av Virtual Network och är endast tillgänglig inifrån det virtuella nätverket.
None	string	Tjänsten ingår inte i någon Virtual Network.